Class MeasureLineController

Hierarchy (View Summary)

SceneObjectController<MeasureLineAnchor>
- MeasureLineController

Constructors

constructor

new MeasureLineController(viewer: Viewer): MeasureLineController
Parameters
- viewer: Viewer
Returns MeasureLineController
Overrides SceneObjectController.constructor
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:57

Properties

`Protected` `Readonly`_objects

_objects: Map<string, MeasureLineAnchor> = ...

`Protected` `Readonly`_viewer

_viewer: Viewer

`Readonly`isMeasureLineController

isMeasureLineController: true

`Readonly`isSceneObjectController

isSceneObjectController: true

`Readonly`signals

signals: {
    onObjectAdded: ViewerSignal<(object: MeasureLineAnchor) => void>;
    onObjectRemoved: ViewerSignal<(object: MeasureLineAnchor) => void>;
    onObjectUpdated: ViewerSignal<(object: MeasureLineAnchor) => void>;
    onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

Accessors

count

get count(): number
Controller objects count

Returns number
Inherited from SceneObjectController.count
- Defined in viewer/src/scene/objects/SceneObjectController.ts:50

firstObject

get firstObject(): TObject | null
Returns TObject | null
Inherited from SceneObjectController.firstObject
- Defined in viewer/src/scene/objects/SceneObjectController.ts:77

uuids

get uuids(): MapIterator<string>
Iterator over all the uuids contained in the controller.

Returns MapIterator<string>
Inherited from SceneObjectController.uuids
- Defined in viewer/src/scene/objects/SceneObjectController.ts:122

visible

get visible(): boolean
Returns boolean
Inherited from SceneObjectController.visible
- Defined in viewer/src/scene/objects/SceneObjectController.ts:43
set visible(value: boolean): void
Controller visibility (independant from object own visibility).

Hiding a controller will hide all its children without modifying their own visibility.
Parameters
- value: boolean
Returns void
Inherited from SceneObjectController.visible
- Defined in viewer/src/scene/objects/SceneObjectController.ts:34

Methods

`Protected`_setVisibility

_setVisibility(value: boolean): void
To be implemented by controllers to set global visibility (at controller level)
Parameters
- value: boolean
Returns void
Overrides SceneObjectController._setVisibility
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:249

accepts

accepts(object: SceneObject): boolean
Indicates whether the controller accepts the SceneObject as a potential child.
Parameters
- object: SceneObject
Returns boolean
Overrides SceneObjectController.accepts
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:195

addMeasureLine

addMeasureLine(measureLine: MeasureLine): void
Parameters
- measureLine: MeasureLine
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:129

addObject

addObject(anchor: MeasureLineAnchor): void
Adds the given object to the controller. Controllers may not support object hierarchy.
Parameters
- anchor: MeasureLineAnchor
  The object to add.
Returns void
Overrides SceneObjectController.addObject
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:282

clear

clear(): void
Clears all objects from the controller

Returns void
Overrides SceneObjectController.clear
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:237

createAnchor

createAnchor(measureLine: MeasureLine, index?: number): MeasureLineAnchor
Parameters
- measureLine: MeasureLine
- Optionalindex: number
Returns MeasureLineAnchor
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:146

createMeasureLine

createMeasureLine(): MeasureLine
Returns MeasureLine
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:110

dispose

dispose(): void
Disposes the controller and destroy its data

Returns void
Inherited from SceneObjectController.dispose
- Defined in viewer/src/scene/objects/SceneObjectController.ts:218

getAllHiddenObjects

getAllHiddenObjects(): Generator<MeasureLineAnchor>
Returns a generator of hidden objects of this controller

Returns Generator<MeasureLineAnchor>
Inherited from SceneObjectController.getAllHiddenObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:186

getAllHiddenObjectUuids

getAllHiddenObjectUuids(): Generator<string>
Returns a generator of hidden object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllHiddenObjectUuids
- Defined in viewer/src/scene/objects/SceneObjectController.ts:208

getAllObjects

getAllObjects(): Generator<MeasureLineAnchor>
Returns a generator of objects of this controller

Returns Generator<MeasureLineAnchor>
Inherited from SceneObjectController.getAllObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:160

getAllObjectUuids

getAllObjectUuids(): Generator<string>
Returns a generator of object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllObjectUuids
- Defined in viewer/src/scene/objects/SceneObjectController.ts:167

getAllVisibleObjects

getAllVisibleObjects(): Generator<MeasureLineAnchor>
Returns a generator of visible objects of this controller

Returns Generator<MeasureLineAnchor>
Inherited from SceneObjectController.getAllVisibleObjects
- Defined in viewer/src/scene/objects/SceneObjectController.ts:174

getAllVisibleObjectUuids

getAllVisibleObjectUuids(): Generator<string>
Returns a generator if visible object uuids of this controller

Returns Generator<string>
Inherited from SceneObjectController.getAllVisibleObjectUuids
- Defined in viewer/src/scene/objects/SceneObjectController.ts:198

getFirstObject

getFirstObject(): MeasureLineAnchor | null
Returns MeasureLineAnchor | null
Inherited from SceneObjectController.getFirstObject
- Defined in viewer/src/scene/objects/SceneObjectController.ts:110

getObjectByUUID

getObjectByUUID(uuid: string): MeasureLineAnchor | null
Returns the object associated with the given uuid if found
Parameters
- uuid: string
Returns MeasureLineAnchor | null
Inherited from SceneObjectController.getObjectByUUID
- Defined in viewer/src/scene/objects/SceneObjectController.ts:140

getObjectsByUUID

getObjectsByUUID(uuids: Iterable<string>): Generator<MeasureLineAnchor>
Returns a generator of objects with the given uuids
Parameters
- uuids: Iterable<string>
Returns Generator<MeasureLineAnchor>
Inherited from SceneObjectController.getObjectsByUUID
- Defined in viewer/src/scene/objects/SceneObjectController.ts:148

hasObjectUUID

hasObjectUUID(uuid: string): boolean
Returns whether the controller has the given uuid
Parameters
- uuid: string
Returns boolean
Inherited from SceneObjectController.hasObjectUUID
- Defined in viewer/src/scene/objects/SceneObjectController.ts:131

onSceneClear

onSceneClear(scene: ViewerScene): void
Callback to clean the controller from the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.onSceneClear
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:185

onSceneSetup

onSceneSetup(scene: ViewerScene): void
Callback to setup the controller into the scene
Parameters
- scene: ViewerScene
Returns void
Overrides SceneObjectController.onSceneSetup
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:175

removeMeasureLine

removeMeasureLine(measureLine: MeasureLine): void
Parameters
- measureLine: MeasureLine
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:138

removeObject

removeObject(anchor: MeasureLineAnchor): void
Removes the given object from the controller.
Parameters
- anchor: MeasureLineAnchor
Returns void
Overrides SceneObjectController.removeObject
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:308

updateSpritesScale

updateSpritesScale(): void
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLineController.tsx:227

Class MeasureLineController

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeasureLineController

Properties

Protected Readonly_objects

Protected Readonly_viewer

ReadonlyisMeasureLineController

ReadonlyisSceneObjectController

Readonlysignals

Accessors

count

Returns number

firstObject

Returns TObject | null

uuids

Returns MapIterator<string>

visible

Returns boolean

Parameters

Returns void

Methods

Protected_setVisibility

Parameters

Returns void

accepts

Parameters

Returns boolean

addMeasureLine

Parameters

Returns void

addObject

Parameters

Returns void

clear

Returns void

createAnchor

Parameters

Returns MeasureLineAnchor

createMeasureLine

Returns MeasureLine

dispose

Returns void

getAllHiddenObjects

Returns Generator<MeasureLineAnchor>

getAllHiddenObjectUuids

Returns Generator<string>

getAllObjects

Returns Generator<MeasureLineAnchor>

getAllObjectUuids

Returns Generator<string>

getAllVisibleObjects

Returns Generator<MeasureLineAnchor>

getAllVisibleObjectUuids

Returns Generator<string>

getFirstObject

Returns MeasureLineAnchor | null

getObjectByUUID

Parameters

Returns MeasureLineAnchor | null

getObjectsByUUID

Parameters

Returns Generator<MeasureLineAnchor>

hasObjectUUID

Parameters

Returns boolean

onSceneClear

Parameters

Returns void

onSceneSetup

Parameters

Returns void

removeMeasureLine

`Protected` `Readonly`_objects

`Protected` `Readonly`_viewer

`Readonly`isMeasureLineController

`Readonly`isSceneObjectController

`Readonly`signals

`Protected`_setVisibility