Vertex Viewer SDK
    Preparing search index...

    Interface VertexViewerDomElement

    The ViewerDomElement is responsible for managing a <vertex-viewer-dom-element> element. These elements are intended to be added as children to a <vertex-viewer-dom-renderer> and represent an individual DOM element within a local 3D scene.

    interface VertexViewerDomElement {
        billboardOff?: boolean;
        detached?: boolean;
        detachedOff?: boolean;
        interactionsOff?: boolean;
        matrix?: Matrix4.Matrix4;
        occluded?: boolean;
        occlusionOff?: boolean;
        onDetachedStateChanged?: (
            event: VertexViewerDomElementCustomEvent<boolean>,
        ) => void;
        onOcclusionStateChanged?: (
            event: VertexViewerDomElementCustomEvent<boolean>,
        ) => void;
        onPropertyChange?: (event: VertexViewerDomElementCustomEvent<void>) => void;
        position?: Vector3.Vector3;
        positionJson?: string;
        quaternion?: Quaternion.Quaternion;
        quaternionJson?: string;
        rotation?: Euler.Euler;
        rotationJson?: string;
        scale?: Vector3.Vector3;
        scaleJson?: string;
    }
    Index
    billboardOff? detached? detachedOff? interactionsOff? matrix? occluded? occlusionOff? onDetachedStateChanged? onOcclusionStateChanged? onPropertyChange? position? positionJson? quaternion? quaternionJson? rotation? rotationJson? scale? scaleJson?
    billboardOff?: boolean

    Disables the billboarding behavior of the element. When billboarding is enabled, the element will always be oriented towards the screen.

    false
    detached?: boolean

    EXPERIMENTAL Indicates if the element is detached from geometry. This property can be used with a CSS selector to modify the appearance of the element when it's detached.

    <style>
      vertex-viewer-dom-element[detached] {
        opacity: 0;
      }
    </style>

    false
    detachedOff?: boolean

    EXPERIMENTAL Disables detached testing for this element. Defaults to disabled. When enabled, the elements position will be tested against the current depth buffer. If the position is detached, then the detached attribute will be set.

    true
    interactionsOff?: boolean

    Disables interaction events from children.

    false
    matrix?: Matrix4.Matrix4

    The local matrix of this element.

    Matrix4.makeIdentity()
    occluded?: boolean

    Indicates if the element is hidden by geometry. This property can be used with a CSS selector to modify the appearance of the element when its occluded.

    <style>
      vertex-viewer-dom-element[occluded] {
        opacity: 0;
      }
    </style>

    false
    occlusionOff?: boolean

    Disables occlusion testing for this element. Defaults to enabled. When enabled, the elements position will be tested against the current depth buffer. If the position is occluded, then the occluded attribute will be set.

    false
    onDetachedStateChanged?: (
        event: VertexViewerDomElementCustomEvent<boolean>,
    ) => void

    EXPERIMENTAL Dispatched when the detached state is changed.

    onOcclusionStateChanged?: (
        event: VertexViewerDomElementCustomEvent<boolean>,
    ) => void

    Dispatched when the occlusion state is changed.

    onPropertyChange?: (event: VertexViewerDomElementCustomEvent<void>) => void

    An event that is emitted when any property on the dom group changes

    position?: Vector3.Vector3

    The local 3D position of where this element is located.

    Vector3.origin()
    positionJson?: string

    The local 3D position of where this element is located, as a JSON string. JSON representation can either be in the format of [x, y, z] or {"x": 0, "y": 0, "z": 0}.

    ''
    quaternion?: Quaternion.Quaternion

    The local rotation of this element.

    Quaternion.create()
    quaternionJson?: string

    The local quaternion rotation of this element, as a JSON string. JSON representation can either be [x, y, z, w] or {"x": 0, "y": 0, "z": 0, "w": 1}.

    ''
    rotation?: Euler.Euler

    The local rotation of this element in Euler angles.

    rotationJson?: string

    The local rotation of this element in Euler angles, as a JSON string. JSON representation can either be [x, y, z, order] or {"x": 0, "y": 0, "z": 0, "order": "xyz"}.

    scale?: Vector3.Vector3

    The local scale of this element.

    Vector3.create(1, 1, 1)
    scaleJson?: string

    The local scale of this element, as a JSON string. JSON string representation can either be in the format of [x, y, z] or {"x": 0, "y": 0, "z": 0}.

    ''

    Settings
    Member Visibility

    On This Page
    Properties