Skip to main content
Version: 4.x

Interface: Overlay3D<ContentType>

Represents one 3d overlay

Type Parameters

ContentType

Methods

getColor()

getColor(): Color

Get the display color of this overlay.

Returns

Color

Defined in

packages/3d-overlays/src/Overlay3D.ts:30


getContent()

getContent(): ContentType

Get the metadata associated with this overlay.

Returns

ContentType

Defined in

packages/3d-overlays/src/Overlay3D.ts:34


getPosition()

getPosition(): Vector3

Get the position of this overlay.

Returns

Vector3

Defined in

packages/3d-overlays/src/Overlay3D.ts:22


getVisible()

getVisible(): boolean

Get whether this overlay is visible.

Returns

boolean

Defined in

packages/3d-overlays/src/Overlay3D.ts:18


setColor()

setColor(color): void

Set the display color of this overlay.

Parameters

color: Color

Returns

void

Defined in

packages/3d-overlays/src/Overlay3D.ts:26


setVisible()

setVisible(visible): void

Set whether this overlay should be visible.

Parameters

visible: boolean

Returns

void

Defined in

packages/3d-overlays/src/Overlay3D.ts:14