Skip to main content
Version: Next

Interface: Overlay3D<ContentType>

Defined in: packages/3d-overlays/src/Overlay3D.ts:10

Represents one 3d overlay

Type Parameters​

ContentType​

ContentType

Methods​

getColor()​

getColor(): Color

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

Get the display color of this overlay.

Returns​

Color

getContent()​

getContent(): ContentType

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

Get the metadata associated with this overlay.

Returns​

ContentType

getPosition()​

getPosition(): Vector3

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

Get the position of this overlay.

Returns​

Vector3

getVisible()​

getVisible(): boolean

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

Get whether this overlay is visible.

Returns​

boolean

setColor()​

setColor(color): void

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

Set the display color of this overlay.

Parameters​

color​

Color

Returns​

void

setVisible()​

setVisible(visible): void

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

Set whether this overlay should be visible.

Parameters​

visible​

boolean

Returns​

void