Class: AxisGizmoTool
@cognite/reveal/tools.AxisGizmoTool
Class for axis gizmo like the one in Blender
Hierarchy
↳
AxisGizmoTool
Constructors
constructor
• new AxisGizmoTool(option?): AxisGizmoTool
Parameters
| Name | Type |
|---|---|
option? | AxisGizmoOptions |
Returns
Overrides
Cognite3DViewerToolBase.constructor
Defined in
packages/tools/src/AxisGizmo/AxisGizmoTool.ts:48
Accessors
options
• get options(): AxisGizmoOptions
Returns
Defined in
packages/tools/src/AxisGizmo/AxisGizmoTool.ts:100
Methods
connect
▸ connect(viewer): void
Connects the AxisGizmoTool to a Cognite3DViewer instance.
Parameters
| Name | Type | Description |
|---|---|---|
viewer | Cognite3DViewer | The Cognite3DViewer instance to connect to. Note: After it is connected to the viewer the tool can not be moved or changed size by changing the fields: size, corner, yMargin and yMargin in the AxisGizmoOptions |
Returns
void
Defined in
packages/tools/src/AxisGizmo/AxisGizmoTool.ts:84
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/AxisGizmo/AxisGizmoTool.ts:60
off
▸ off(event, handler): void
Unregisters an event handler for the 'disposed'-event.
Parameters
| Name | Type |
|---|---|
event | "disposed" |
handler | () => void |
Returns
void