Interface IModalToolContainer

ReadonlycurrentTools

onSelectedToolChanged

addTool

• addTool(id: string, params: ModalToolCreationParameters): IModalTool

  Parameters

  • id: string

    Unique identifier for the tool

  • params: ModalToolCreationParameters

    Construction parameters for the new tool

  Returns IModalTool

  Remarks

  Create a new tool in the modal tool container represented via button on the tool rail.

focusToolInputContext

• focusToolInputContext(): void

  Returns void

  Remarks

  Activates input bindings for the selected tool by enabling viewport focus

getSelectedToolId

• getSelectedToolId(): string

  Returns string

  Remarks

  Returns identifier of the selected tool.

getSortOrder

• getSortOrder(): string[]

  Returns string[]

  Array of tool identifiers in sort order, or undefined if not set

  Remarks

  Returns the current sort order of tools.

removeTool

• removeTool(id: string): void

  Parameters

  • id: string

    Name of the tool to remove.

  Returns void

  Remarks

  Remove an existing tool by id from the tool container

setSelectedToolId

• setSelectedToolId(id: string): void

  Parameters

  • id: string

    Identifier of the tool

  Returns void

  Remarks

  Selects a tool in the container.

setSortOrder

• setSortOrder(ids: string[]): void

  Parameters

  • ids: string[]

    Array of tool identifiers in the desired order, or undefined to clear

  Returns void

  Remarks

  Sets the sort order for tools in the container.