Class MeasureLine

A chain of MeasureLineAnchor points connected by segments, displaying the total distance of the path on its MeasureLineGlobalSprite.

Hierarchy (View Summary)

SceneObject
- MeasureLine

Constructors

constructor

new MeasureLine(sprite: MeasureLineGlobalSprite): MeasureLine
Parameters
- sprite: MeasureLineGlobalSprite
Returns MeasureLine
Overrides SceneObject.constructor
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:26

Properties

`Readonly`children

children: SceneObject[] = ...

`Readonly`isMeasureLine

isMeasureLine: true

`Readonly`isSceneObject

isSceneObject: true

isSelectable

isSelectable: boolean = true

Indicates whether the object is selectable in the scene

isTransformable

isTransformable: boolean = true

name

name: string = ''

parent

parent: SceneObject | null = null

`Readonly`signals

signals: {
onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
} = ...

`Readonly`sprite

sprite: MeasureLineGlobalSprite

The sprite displaying the total lenght of the measure line

`Readonly`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

Accessors

active

get active(): boolean
Returns boolean
Inherited from SceneObject.active
- Defined in viewer/src/scene/objects/SceneObject.ts:180

anchorsLength

get anchorsLength(): number
Returns number
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:77

hover

get hover(): boolean
Returns boolean
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:31
set hover(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:35

selected

get selected(): boolean
Returns boolean
Overrides SceneObject.selected
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:73
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneObject.selected
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:54

type

get type(): string
Returns string
Inherited from SceneObject.type
- Defined in viewer/src/scene/objects/SceneObject.ts:102

visible

get visible(): boolean
Returns boolean
Overrides SceneObject.visible
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:161
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides SceneObject.visible
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:149

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
Inherited from SceneObject.addChild
- Defined in viewer/src/scene/objects/SceneObject.ts:128

applyMatrix

applyMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from SceneObject.applyMatrix
- Defined in viewer/src/scene/objects/SceneObject.ts:122

dispose

dispose(): void
Returns void
Inherited from SceneObject.dispose
- Defined in viewer/src/scene/objects/SceneObject.ts:212

getAnchorAt

getAnchorAt(index: number): MeasureLineAnchor | undefined
Parameters
- index: number
Returns MeasureLineAnchor | undefined
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:107

getAnchors

getAnchors(): Generator<MeasureLineAnchor, void, unknown>
Returns Generator<MeasureLineAnchor, void, unknown>
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:85

getMatrix

getMatrix(target: Matrix4): Matrix4
Return a matrix that is the center of the measure line
Parameters
- target: Matrix4
Returns Matrix4
Overrides SceneObject.getMatrix
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:116

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
Overrides SceneObject.getPosition
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:135

getStateController

getStateController(): ObjectStateController<MeasureLine, ObjectState>
Returns ObjectStateController<MeasureLine, ObjectState>
Inherited from SceneObject.getStateController
- Defined in viewer/src/scene/objects/SceneObject.ts:155

hideSprite

hideSprite(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:81

insertAnchor

insertAnchor(anchor: MeasureLineAnchor, index: number): void
Parameters
- anchor: MeasureLineAnchor
- index: number
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:99

parentsGenerator

parentsGenerator(): Generator<SceneObject, void, unknown>
Returns Generator<SceneObject, void, unknown>
Inherited from SceneObject.parentsGenerator
- Defined in viewer/src/scene/objects/SceneObject.ts:140

pushAnchor

pushAnchor(anchor: MeasureLineAnchor): void
Parameters
- anchor: MeasureLineAnchor
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:91

removeAnchor

removeAnchor(anchor: MeasureLineAnchor): void
Parameters
- anchor: MeasureLineAnchor
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:103

removeFromParent

removeFromParent(): void
Returns void
Inherited from SceneObject.removeFromParent
- Defined in viewer/src/scene/objects/SceneObject.ts:148

setMatrix

setMatrix(matrix: Matrix4): void
Move the whole measure line to the given matrix
Parameters
- matrix: Matrix4
Returns void
Overrides SceneObject.setMatrix
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:126

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
Overrides SceneObject.setPosition
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:142

toJson

toJson(): Record<string, any>
Returns Record<string, any>
Inherited from SceneObject.toJson
- Defined in viewer/src/scene/objects/SceneObject.ts:195

unshiftAnchor

unshiftAnchor(anchor: MeasureLineAnchor): void
Parameters
- anchor: MeasureLineAnchor
Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:95

updateSpritePosition

updateSpritePosition(): void
Update the sprite position displaying the total lenght of the measureline

Returns void
- Defined in plugins/src/MeasureLinePlugin/objects/MeasureLine.ts:168

Class MeasureLine

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeasureLine

Properties

Readonlychildren

ReadonlyisMeasureLine

ReadonlyisSceneObject

isSelectable

isTransformable

name

parent

Readonlysignals

Readonlysprite

ReadonlytransformConfig

userData

Readonlyuuid

Accessors

active

Returns boolean

anchorsLength

Returns number

hover

Returns boolean

Parameters

Returns void

selected

Returns boolean

Parameters

Returns void

type

Returns string

visible

Returns boolean

Parameters

Returns void

Methods

addChild

Parameters

Returns void

applyMatrix

Parameters

Returns void

dispose

Returns void

getAnchorAt

Parameters

Returns MeasureLineAnchor | undefined

getAnchors

Returns Generator<MeasureLineAnchor, void, unknown>

getMatrix

Parameters

Returns Matrix4

getPosition

Parameters

Returns Vector3

getStateController

Returns ObjectStateController<MeasureLine, ObjectState>

hideSprite

Parameters

Returns void

insertAnchor

Parameters

Returns void

parentsGenerator

Returns Generator<SceneObject, void, unknown>

pushAnchor

Parameters

Returns void

removeAnchor

Parameters

Returns void

removeFromParent

`Readonly`children

`Readonly`isMeasureLine

`Readonly`isSceneObject

`Readonly`signals

`Readonly`sprite

`Readonly`transformConfig

`Readonly`uuid