Skip to main content
Version: Next

Class: AxisGizmoTool

Defined in: packages/tools/src/AxisGizmo/AxisGizmoTool.ts:21

Beta

Class for axis gizmo like the one in Blender

Extends​

Constructors​

Constructor​

new AxisGizmoTool(option?): AxisGizmoTool

Defined in: packages/tools/src/AxisGizmo/AxisGizmoTool.ts:50

Beta

Parameters​

option?​

AxisGizmoOptions

Returns​

AxisGizmoTool

Overrides​

Cognite3DViewerToolBase.constructor

Accessors​

options​

Get Signature​

get options(): AxisGizmoOptions

Defined in: packages/tools/src/AxisGizmo/AxisGizmoTool.ts:102

Beta

Returns​

AxisGizmoOptions

Methods​

connect()​

connect(viewer): void

Defined in: packages/tools/src/AxisGizmo/AxisGizmoTool.ts:86

Beta

Connects the AxisGizmoTool to a Cognite3DViewer instance.

Parameters​

viewer​

Cognite3DViewer<DataSourceType>

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


dispose()​

dispose(): void

Defined in: packages/tools/src/AxisGizmo/AxisGizmoTool.ts:62

Beta

Disposes the element and triggeres the 'disposed' event before clearing the list of dipose-listeners.

Returns​

void

Overrides​

Cognite3DViewerToolBase.dispose


off()​

off(event, handler): void

Defined in: packages/tools/src/Cognite3DViewerToolBase.ts:38

Beta

Unregisters an event handler for the 'disposed'-event.

Parameters​

event​

"disposed"

handler​

() => void

Returns​

void

Inherited from​

Cognite3DViewerToolBase.off