接口 IModalTool

只读id

只读isActive

onModalToolActivation

bindPropertyPane

• bindPropertyPane(pane: IRootPropertyPane): void

  参数

  • pane: IRootPropertyPane

    Root pane associated with the modal tool

  返回 void

  备注

  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

  参数

  • action: SupportedKeyboardActionTypes

    Action to register the binding for.

  • binding: KeyBinding

    Keyboard binding to invoke action.

  • 可选info: KeyBindingInfo

    Additional information about key binding.

  返回 IRegisteredKeyBinding

  备注

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

registerMouseButtonBinding

• registerMouseButtonBinding(action: SupportedMouseActionTypes): void

  参数

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  返回 void

  备注

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

registerMouseDragBinding

• registerMouseDragBinding(action: SupportedMouseActionTypes): void

  参数

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  返回 void

  备注

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

registerMouseWheelBinding

• registerMouseWheelBinding(action: SupportedMouseActionTypes): void

  参数

  • action: SupportedMouseActionTypes

    Action to register the binding for.

  返回 void

  备注

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

setMouseIcon

• setMouseIcon(mouseIcon: MouseCursorIconType): void

  参数

  • mouseIcon: MouseCursorIconType

    The mouse cursor icon, or undefined to reset to default.

  返回 void

  备注

  Set the mouse cursor icon for this tool when it's active. The icon will only be visible when this tool is the currently selected tool.

unregisterInputBindings

• unregisterInputBindings(): void

  返回 void

  备注

  Unregister all input binding for this tool.