Class SceneObject`Abstract`

Hierarchy (View Summary)

SceneObject
- DrawableSceneObject
- MeasureLine

Index

Constructors

Properties

children isSceneObject isSelectable isTransformable name parent signals transformConfig userData uuid

Accessors

active selected type visible

Methods

addChild applyMatrix dispose getMatrix getPosition getStateController parentsGenerator removeFromParent setMatrix setPosition toJson

Constructors

constructor

new SceneObject(uuid?: string): SceneObject
Parameters
- uuid: string = ...
Returns SceneObject
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:82

Properties

`Readonly`children

children: SceneObject[] = ...

`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`transformConfig

transformConfig: ObjectTransformConfig = ...

userData

userData: Record<string, any> = {}

`Readonly`uuid

uuid: string

Unique identifier of the object

Accessors

active

get active(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:164

selected

get selected(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:175
set selected(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:168

type

get type(): string
Returns string
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:86

visible

get visible(): boolean
Returns boolean
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:150
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:143

Methods

addChild

addChild(child: SceneObject): void
Parameters
- child: SceneObject
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:112

applyMatrix

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

dispose

dispose(): void
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:196

`Abstract`getMatrix

getMatrix(target: Matrix4): Matrix4
Parameters
- target: Matrix4
Returns Matrix4
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:90

getPosition

getPosition(target: Vector3): Vector3
Parameters
- target: Vector3
Returns Vector3
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:94

getStateController

getStateController(): ObjectStateController<SceneObject, ObjectState>
Returns ObjectStateController<SceneObject, ObjectState>
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:139

parentsGenerator

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

removeFromParent

removeFromParent(): void
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:132

`Abstract`setMatrix

setMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:92

setPosition

setPosition(position: Vector3): void
Parameters
- position: Vector3
Returns void
- Defined in packages/viewer/src/scene/objects/SceneObject.ts:100

toJson

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