Interface: Overlay3D<MetadataType>
@cognite/reveal.Overlay3D
Type parameters
| Name |
|---|
MetadataType |
Accessors
color
• get color(): Color
Get the display color of this overlay.
Returns
Color
Defined in
packages/3d-overlays/src/Overlay3D.ts:24
position
• get position(): Vector3
Get the position of this overlay.
Returns
Vector3
Defined in
packages/3d-overlays/src/Overlay3D.ts:16
visible
• get visible(): boolean
Get whether this overlay is visible.
Returns
boolean
Defined in
packages/3d-overlays/src/Overlay3D.ts:12
• set visible(visible): void
Set whether this overlay should be visible.
Parameters
| Name | Type |
|---|---|
visible | boolean |
Returns
void
Defined in
packages/3d-overlays/src/Overlay3D.ts:8
Methods
getMetadata
▸ getMetadata(): undefined | MetadataType
Get the metadata associated with this overlay.
Returns
undefined | MetadataType
Defined in
packages/3d-overlays/src/Overlay3D.ts:28
setColor
▸ setColor(color): void
Set the display color of this overlay.
Parameters
| Name | Type |
|---|---|
color | Color |
Returns
void