Skip to main content

Enumeration: ToolModes

ToolModes - This enum defines the 4 tool states which are available.

Enumeration Members​

Active​

Active: "Active"

Active:

  • Can be actively used by mouse/touch events mapped to its ToolBindings.
  • Can add data if an annotation tool.
  • Can be passively interacted by grabbing a tool or its handles.
  • Renders data if the tool has a renderAnnotation method.

Defined in​

tools/src/enums/ToolModes.ts:12

Disabled​

Disabled: "Disabled"

Disabled:

  • Annotation does not render.

Defined in​

tools/src/enums/ToolModes.ts:28

Enabled​

Enabled: "Enabled"

Enabled:

  • Renders data if the tool has a renderAnnotation method.

Defined in​

tools/src/enums/ToolModes.ts:23

Passive​

Passive: "Passive"

Passive:

  • Can be passively interacted by grabbing a tool or its handles.
  • Renders data if the tool has a renderAnnotation method.

Defined in​

tools/src/enums/ToolModes.ts:18