Class MeasureLinePlugin

Plugin adding measure lines: chains of anchors that let users measure distances in the scene.

Hierarchy

PluginBaseClass
- MeasureLinePlugin

Index

Constructors

Properties

measureLineController name settings viewer

Methods

clear dependencies hasSettings onRegister onUnregister Create

Constructors

constructor

new MeasureLinePlugin(viewer: Viewer): MeasureLinePlugin
Parameters
- viewer: Viewer
Returns MeasureLinePlugin
Overrides PluginBaseClass.constructor
- Defined in plugins/src/MeasureLinePlugin/MeasureLinePlugin.tsx:36

Properties

`Readonly`measureLineController

measureLineController: MeasureLineController

`Readonly`name

name: string

Display name of the plugin

`Readonly`settings

settings: { measureLineSpriteSize: NumberController }

Plugin settings

Type Declaration

measureLineSpriteSize: NumberController
Size of the MeasureLines sprite in the scene
Default Value
```
0.5
```
Min
0.1

Max
1

`Readonly`viewer

viewer: Viewer

Methods

clear

clear(): void
Returns void
Inherited from PluginBaseClass.clear
- Defined in viewer/src/core/ViewerPlugin.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:87

hasSettings

hasSettings(): boolean
Indicates whether the plugin has settings

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

onRegister

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

Returns void
Overrides PluginBaseClass.onRegister
- Defined in plugins/src/MeasureLinePlugin/MeasureLinePlugin.tsx:42

onUnregister

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

Returns void
Overrides PluginBaseClass.onUnregister
- Defined in plugins/src/MeasureLinePlugin/MeasureLinePlugin.tsx:50

`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:109