gpu-curtains
    Preparing search index...

    This special kind of ProjectedObject3D uses an HTMLElement to convert the corresponding X and Y scale and position relative to the 3D world space.

    Internally used by the DOMMesh and Plane, but can also be used as any Mesh parent to map it with an HTMLElement size and position values.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    up: Vec3

    Vec3 used by the lookAt method, to determine the orientation of the result. Default to new Vec3(0, 1, 0).

    actualPosition: Vec3

    Vec3 holding the actual position of this Object3D from its worldMatrix.

    children: Object3D[]

    Children Object3D in the scene graph, used to compute their own worldMatrix.

    object3DIndex: number

    Index (order of creation) of this Object3D. Used in the parent / children relation.

    matricesNeedUpdate: boolean

    Whether at least one of this Object3D matrix needs an update.

    camera: Camera

    Camera object used to compute model view and model view projection matrices

    GPUCurtainsRenderer used to create this DOMObject3D.

    Defines the DOMObject3D bounding boxes in both document and world spaces.

    domElement: DOMElement

    DOMElement used to track the given HTMLElement size change.

    watchScroll: boolean

    Whether to automatically update the DOMObject3D document and world positions on scroll.

    boundingBox: Box3 = ...

    Helper bounding box used to map the 3D object onto the 2D DOM element.

    _onAfterDOMElementResizeCallback: () => void = ...

    function assigned to the onAfterDOMElementResize callback.

    Accessors

    • get visible(): boolean

      Get whether this Object3D is visible (if it is itself visible, and all its parents are visible as well).

      Returns boolean

    • set visible(value: boolean): void

      Set this Object3D visible property, and its children parentVisibility property.

      Parameters

      • value: boolean

        New visibility value.

      Returns void

    • get parentVisibility(): boolean

      Get whether all this Object3D parents are visible or not. Should not be used directly.

      Returns boolean

    • set parentVisibility(value: boolean): void

      Set to false if at least one of this Object3D parent is not visible, true otherwise. Should not be used directly.

      Parameters

      • value: boolean

        New parent visibility value.

      Returns void

    • set DOMObjectDepthScaleRatio(value: number): void

      Set DOMObjectDepthScaleRatio. Since it can be difficult to guess the most accurate scale along the Z axis of an object mapped to 2D coordinates, this helps with adjusting the scale along the Z axis.

      Parameters

      • value: number

        Depth scale ratio value to use.

      Returns void

    Methods