@twinfinity/core
    Preparing search index...

    Interface TrackCoordinate2D<Tracked3D>

    Represents information on a 3D coordinate's location on screen (2D).

    interface TrackCoordinate2D<Tracked3D extends Vertex3 = Vertex3> {
        canvasPosition: DeepImmutable<Vertex2>;
        distance: number;
        id: unknown;
        position: DeepImmutable<Vertex2>;
        state: TrackCoordinate2DState;
        trackedCoordinate: Tracked3D;
        visible: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    canvasPosition distance id position state trackedCoordinate visible

    Properties

    canvasPosition: DeepImmutable<Vertex2>

    Position in 2D of the tracked coordinate relative to the canvas. Canvas refers to the the HTML canvas that BimApi uses.

    This is useful when one wants to position HTML elements on top of the canvas and make those HTML elements children to the canvas.

    distance: number

    If active camera is a perspective camera, this is the distance from the camera to the 3D coordinate For an orthographic camera, it is the height of the frustum.

    id: unknown

    Id of tracked 3D coordinate

    position: DeepImmutable<Vertex2>

    Position in 2D of the tracked coordinate

    state: TrackCoordinate2DState

    Current state. Tells whether item is detached, added, updated or deleted.

    trackedCoordinate: Tracked3D

    3D coordinate we subscribed to.

    visible: boolean

    Whether the 3D coordinate is visible on screen or not

    Settings

    Member Visibility

    On This Page

    Properties