Class: SmartOverlayTool<MetadataType>
@cognite/reveal/tools.SmartOverlayTool
Base class for tools attaching to a Cognite3DViewer.
Type parameters
| Name | Type |
|---|---|
MetadataType | DefaultMetadataType |
Hierarchy
↳
SmartOverlayTool
Constructors
constructor
• new SmartOverlayTool<MetadataType>(viewer, toolParameters?)
Type parameters
| Name | Type |
|---|---|
MetadataType | DefaultMetadataType |
Parameters
| Name | Type |
|---|---|
viewer | Cognite3DViewer |
toolParameters? | SmartOverlayToolParameters |
Overrides
Cognite3DViewerToolBase.constructor
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:57
Accessors
collections
• get collections(): OverlayCollection<MetadataType>[]
Gets all added overlay collections.
Returns
OverlayCollection<MetadataType>[]
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:113
textOverlayVisible
• get textOverlayVisible(): boolean
Returns
boolean
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:138
• set textOverlayVisible(visible): void
Parameters
| Name | Type |
|---|---|
visible | boolean |
Returns
void
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:133
visible
• get visible(): boolean
Returns
boolean
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:129
• set visible(visible): void
Sets whether overlays are visible.
Parameters
| Name | Type |
|---|---|
visible | boolean |
Returns
void
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:120
Methods
clear
▸ clear(): void
Removes all overlays.
Returns
void
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:145
createOverlayCollection
▸ createOverlayCollection(overlays?): OverlayCollection<MetadataType>
Creates new OverlayCollection.
Parameters
| Name | Type | Description |
|---|---|---|
overlays? | OverlayInfo<MetadataType>[] | Array of overlays to add. |
Returns
OverlayCollection<MetadataType>
Overlay group containing it's id.
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:76
dispose
▸ dispose(): void
Disposes the element and triggeres the 'disposed' event before clearing the list of dipose-listeners.
Returns
void
Overrides
Cognite3DViewerToolBase.dispose
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:198
off
▸ off(event, eventHandler): void
Unregisters an event handler for the 'disposed'-event.
Parameters
| Name | Type |
|---|---|
event | "hover" |
eventHandler | OverlayEventHandler<MetadataType> |
Returns
void
Overrides
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:178
▸ off(event, eventHandler): void
Parameters
| Name | Type |
|---|---|
event | "click" |
eventHandler | OverlayEventHandler<MetadataType> |
Returns
void
Overrides
Cognite3DViewerToolBase.off
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:179
▸ off(event, eventHandler): void
Parameters
| Name | Type |
|---|---|
event | "disposed" |
eventHandler | DisposedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.off
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:180
on
▸ on(event, eventHandler): void
Subscribes to overlay events.
Parameters
| Name | Type | Description |
|---|---|---|
event | "hover" | event to subscribe to. |
eventHandler | OverlayEventHandler<MetadataType> |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:158
▸ on(event, eventHandler): void
Parameters
| Name | Type |
|---|---|
event | "click" |
eventHandler | OverlayEventHandler<MetadataType> |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:159
▸ on(event, eventHandler): void
Parameters
| Name | Type |
|---|---|
event | "disposed" |
eventHandler | DisposedDelegate |
Returns
void
Overrides
Cognite3DViewerToolBase.on
Defined in
packages/tools/src/SmartOverlay/SmartOverlayTool.ts:160
removeOverlayCollection
▸ removeOverlayCollection(overlayCollection): void
Removes overlays that were added with addOverlays method.
Parameters
| Name | Type | Description |
|---|---|---|
overlayCollection | OverlayCollection<MetadataType> | Id of the overlay group to remove. |
Returns
void