Skip to main content

TrackCoordinate2D <Tracked3D>

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

Hierarchy

Index

Properties

Properties

readonlycanvasPosition

canvasPosition: DeepImmutableObject<Vertex2>

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

@remarks

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

readonlydistance

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.

readonlyid

id: unknown

Id of tracked 3D coordinate

readonlyposition

position: DeepImmutableObject<Vertex2>

Position in 2D of trackedCoordinate

readonlystate

state: TrackCoordinate2DState

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

readonlytrackedCoordinate

trackedCoordinate: Tracked3D

3D coordinate we subscribed to.

readonlyvisible

visible: boolean

Whether the 3D coordinate is visible on screen or not