Interface: Overlay3D<ContentType>
@cognite/reveal.Overlay3D
Represents one 3d overlay
Type parameters
| Name |
|---|
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
| Name | Type |
|---|---|
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
| Name | Type |
|---|---|
visible | boolean |
Returns
void