Guide Line

GuideLinePlugin

Overview

GuideLinePlugin renders navigation paths inside the VR scene.

Live Demo

Drag the VR view and rotate the camera to see the guide-line effect. Use the toggle in the lower-left corner to switch modes and compare the effect across different modes.

Open the official GuideLinePlugin demo.

Installation

import { GuideLinePlugin } from "@realsee/dnalogel"

Development Guide

Initialization

When creating a Five instance, pass GuideLinePlugin in the plugin initialization parameters.

import { Five } from '@realsee/five'
import { GuideLinePlugin } from "@realsee/dnalogel";

const five = new Five({
    plugins: [
        [
            GuideLinePlugin,
            'guideLinePlugin', // custom plugin name
        ]
    ]
})

Loading Data

You must load route-planning data in order to see the correct result:

// custom route data
const guideLineServerData = [{ 
    panoIndexList: [0, 1, 2, 3, 4, 5],
    // arrowTextureUrl: '', // custom route arrow icon
}]
// load the route data
five.plugins.guideLinePlugin.load({ routes: guideLineServerData }, { visible: true })

Core Methods

• load(serverData: PluginServerData | PluginData) loads the plugin data

You need to load the plugin data manually. For the data source, see the OpenAPI reference.

• show: (options?: { userAction?: boolean }) => void shows the path
• hide: (options?: { userAction?: boolean }) => void hides the path
• enable: (options?: { userAction?: boolean }) => void enables the plugin
• disable: (options?: { userAction?: boolean }) => void disables the plugin
• dispose: () => void destroys the plugin

Source Reference

GuideLinePlugin example source