Skip to main content
Version: 4.x

Class: AxisGizmoTool

Beta

Class for axis gizmo like the one in Blender

Extends​

Constructors​

new AxisGizmoTool()​

new AxisGizmoTool(option?): AxisGizmoTool

Beta

Parameters​

• option?: AxisGizmoOptions

Returns​

AxisGizmoTool

Overrides​

Cognite3DViewerToolBase . constructor

Defined in​

packages/tools/src/AxisGizmo/AxisGizmoTool.ts:48

Accessors​

options​

get options(): AxisGizmoOptions

Beta

Returns​

AxisGizmoOptions

Defined in​

packages/tools/src/AxisGizmo/AxisGizmoTool.ts:100

Methods​

connect()​

connect(viewer): void

Beta

Connects the AxisGizmoTool to a Cognite3DViewer instance.

Parameters​

• 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

Beta

Returns​

void

Overrides​

Cognite3DViewerToolBase . dispose

Defined in​

packages/tools/src/AxisGizmo/AxisGizmoTool.ts:60


off()​

off(event, handler): void

Beta

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

Parameters​

• event: "disposed"

• handler

Returns​

void

Inherited from​

Cognite3DViewerToolBase . off

Defined in​

packages/tools/src/Cognite3DViewerToolBase.ts:38