Documentation - v19.12.0-dev
    Preparing search index...

    Class SceneObjectAbstract

    Base class of the scene graph: every object placed in a ViewerScene extends this. It is not a three.js Object3D — it has its own uuid, parent/children hierarchy, visibility/selection state and an abstract transform (getMatrix / setMatrix) instead of position/quaternion/scale.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    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

    • Parameters

      • uuid: string = ...

      Returns SceneObject

    Properties

    children: SceneObject[] = ...
    isSceneObject: true
    isSelectable: boolean = true

    Indicates whether the object is selectable in the scene

    isTransformable: boolean = true
    name: string = ''
    parent: SceneObject | null = null
    signals: {
        onSelectedChanged: ViewerSignal<(...args: any[]) => any>;
        onVisibilityChanged: ViewerSignal<(...args: any[]) => any>;
    } = ...
    transformConfig: ObjectTransformConfig = ...
    userData: Record<string, any> = {}
    uuid: string

    Unique identifier of the object

    Accessors

    • get active(): boolean

      Returns boolean

    • get selected(): boolean

      Returns boolean

    • set selected(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get type(): string

      Returns string

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Parameters

      Returns void

    • Parameters

      • matrix: Matrix4

      Returns void

    • Returns void

    • Parameters

      • target: Matrix4

      Returns Matrix4

    • Parameters

      • target: Vector3

      Returns Vector3

    • Returns Generator<SceneObject, void, unknown>

    • Returns void

    • Parameters

      • matrix: Matrix4

      Returns void

    • Parameters

      • position: Vector3

      Returns void

    • Returns Record<string, any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods