Interface IModalTool

Readonlyid

ReadonlyisActive

onModalToolActivation

bindPropertyPane

• bindPropertyPane(pane: IRootPropertyPane): void

  Parameters

  • pane: IRootPropertyPane

    Root pane associated with the modal tool

  Returns void

  Remarks

  Binds a property pane to the tool. When the tool is selected, the pane's visibility updates. Only one pane can be bound at a time.

registerKeyBinding

• registerKeyBinding(
      action: SupportedKeyboardActionTypes,
      binding: KeyBinding,
      info?: KeyBindingInfo,
  ): IRegisteredKeyBinding

  Parameters

  • action: SupportedKeyboardActionTypes

    Action to register the binding for.

  • binding: KeyBinding

    Keyboard binding to invoke action.

  • Optionalinfo: KeyBindingInfo

    Additional information about key binding.

  Returns IRegisteredKeyBinding

  Remarks

  Register a key press binding for an action which will be handled by the tool input context.

registerMouseButtonBinding

• registerMouseButtonBinding(action: SupportedMouseActionTypes): void

  Parameters

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  Returns void

  Remarks

  Register an action to be called when mouse left/middle/right buttons are pressed or released.

registerMouseDragBinding

• registerMouseDragBinding(action: SupportedMouseActionTypes): void

  Parameters

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  Returns void

  Remarks

  Register an action to be called when mouse is dragged while left mouse button is down.

registerMouseWheelBinding

• registerMouseWheelBinding(action: SupportedMouseActionTypes): void

  Parameters

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  Returns void

  Remarks

  Register an action to be called when mouse wheel is scrolled.

unregisterInputBindings

• unregisterInputBindings(): void

  Returns void

  Remarks

  Unregister all input binding for this tool.