Class BaseToolAbstract

Readonly description

canReceiveInputInReadOnlyEditor

• canReceiveInputInReadOnlyEditor(): boolean

• Override this to allow this tool to be enabled in a read-only editor

  Returns boolean

enabledValue

• enabledValue(): ReactiveValue<boolean>

• Returns a ReactiveValue that updates based on whether this tool is enabled.

  Returns ReactiveValue<boolean>

  Example

  const tool = new SomeTool();
  
  // Watch for changes in enabled status
  tool.enabledValue().onUpdate(enabled => doSomething(enabled));
  Copy

getInputMapper

• getInputMapper(): null | default

• Returns null | default

getToolGroup

• getToolGroup(): null | ToolEnabledGroup

• Returns null | ToolEnabledGroup

isEnabled

• isEnabled(): boolean

• Returns boolean

onCopy

• onCopy(_event): boolean

• Parameters

  • _event: CopyEvent

  Returns boolean

onDestroy

• onDestroy(): void

• Called when the tool is removed/when the editor is destroyed. Subclasses that override this method must call super.onDestroy().

  Returns void

onGestureCancel

• onGestureCancel(_event): void

• Parameters

  • _event: GestureCancelEvt

  Returns void

onKeyPress

• onKeyPress(_event): boolean

• Parameters

  • _event: KeyPressEvent

  Returns boolean

onKeyUp

• onKeyUp(_event): boolean

• Parameters

  • _event: KeyUpEvent

  Returns boolean

onPaste

• onPaste(_event): boolean

• Parameters

  • _event: PasteEvent

  Returns boolean

onPointerDown

• onPointerDown(_event): boolean

• Returns true iff the tool handled the event and thus should receive additional events.

  Parameters

  • _event: PointerDownEvt

  Returns boolean

onPointerMove

• onPointerMove(_event): void

• Parameters

  • _event: PointerMoveEvt

  Returns void

onPointerUp

• onPointerUp(_event): boolean | void

• Returns true iff there are additional pointers down and the tool should remain active to handle the additional events.

  For most purposes, this should return false or nothing.

  Parameters

  • _event: PointerUpEvt

  Returns boolean | void

onWheel

• onWheel(_event): boolean

• Parameters

  • _event: WheelEvt

  Returns boolean

setEnabled

• setEnabled(enabled): void

• Parameters

  • enabled: boolean

  Returns void

setInputMapper

• setInputMapper(mapper): void

• Parameters

  • mapper: null | default

  Returns void

setToolGroup

• setToolGroup(group): void

• Connect this tool to a set of other tools, ensuring that at most one of the tools in the group is enabled.

  Parameters

  • group: ToolEnabledGroup

  Returns void