Class PathPlugin

Hierarchy

PluginBaseClass
- PathPlugin

Index

Constructors

Properties

name navigationGraphController navigationGraphSceneController navigationGraphSettings pathController settings viewer

Methods

clear dependencies hasSettings onRegister onUnregister Create

Constructors

constructor

new PathPlugin(viewer: Viewer): PathPlugin
Parameters
- viewer: Viewer
Returns PathPlugin
Overrides PluginBaseClass.constructor
- Defined in plugins/src/PathPlugin/PathPlugin.ts:79

Properties

`Readonly`name

name: string

Display name of the plugin

`Readonly`navigationGraphController

navigationGraphController: NavigationGraphController

`Readonly`navigationGraphSceneController

navigationGraphSceneController: NavigationGraphSceneController

`Readonly`navigationGraphSettings

navigationGraphSettings: {
connectNodesAutomatically: BooleanController;
mergeThreshold: NumberController;
} = ...

Runtime settings used by the navigation graph editing tools.

`Readonly`pathController

pathController: PathController

`Readonly`settings

settings: {
    color: ColorController;
    cornerRadius: NumberController;
    heightOffset: NumberController;
    opacity: NumberController;
    pointRadius: NumberController;
    segmentLength: NumberController;
    segmentSpacing: NumberController;
    smoothing: NumberController;
    speed: NumberController;
    thickness: NumberController;
}

Plugin settings

`Readonly`viewer

viewer: Viewer

Methods

clear

clear(): void
Returns void
Overrides PluginBaseClass.clear
- Defined in plugins/src/PathPlugin/PathPlugin.ts:105

dependencies

dependencies(): readonly (keyof ViewerPluginRegistry)[]
List of plugins this plugin depends on

Returns readonly (keyof ViewerPluginRegistry)[]
Inherited from PluginBaseClass.dependencies
- Defined in viewer/src/core/ViewerPlugin.ts:60

hasSettings

hasSettings(): boolean
Indicates whether the plugin has settings

Returns boolean
Inherited from PluginBaseClass.hasSettings
- Defined in viewer/src/core/ViewerPlugin.ts:52

onRegister

onRegister(): void
Called when the plugin is registered in the viewer.

Returns void
Overrides PluginBaseClass.onRegister
- Defined in plugins/src/PathPlugin/PathPlugin.ts:87

onUnregister

onUnregister(): void
Called when the plugin is unregistred from the viewer.

Returns void
Overrides PluginBaseClass.onUnregister
- Defined in plugins/src/PathPlugin/PathPlugin.ts:95

`Static`Create

Create<S extends SettingsRecord = Record<string, never>>(
name: string,
settingFunc?: PluginSettingBuildFunction<S>,
): typeof PluginClass
Type Parameters
- S extends SettingsRecord = Record<string, never>
Parameters
- name: string
- settingFunc: PluginSettingBuildFunction<S> = ...
Returns typeof PluginClass
Inherited from TeiaPlugin.Create
- Defined in viewer/src/core/ViewerPlugin.ts:82