#Interface: IModalToolContainer

inventory

Beta

#Properties

#currentTools

readonly currentTools: IModalTool[]

Beta

#Remarks

Tools within this container.

---

#onSelectedToolChanged

实验性

onSelectedToolChanged: EventSink<SelectedModalToolChangedEventPayload>

Beta

#Remarks

Provides events when the selected modal tool changes.

#Methods

#addTool()

addTool(id, params): IModalTool

Beta

#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

Beta

#Returns

void

#Remarks

Activates input bindings for the selected tool by enabling viewport focus

---

#getSelectedToolId()

getSelectedToolId(): string | undefined

Beta

#Returns

string | undefined

#Remarks

Returns identifier of the selected tool.

---

#getSortOrder()

getSortOrder(): string[] | undefined

Beta

#Returns

string[] | undefined

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

#Remarks

Returns the current sort order of tools.

---

#removeTool()

removeTool(id): void

Beta

#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): void

Beta

#Parameters

#id

string | undefined

Identifier of the tool

#Returns

void

#Remarks

Selects a tool in the container.

---

#setSortOrder()

setSortOrder(ids): void

Beta

#Parameters

#ids

string[] | undefined

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

#Returns

void

#Remarks

Sets the sort order for tools in the container.

#同领域相关

• IMenuContainer
• ITagContainerPropertyItem
• ITagContainerPropertyItemOptions
• SelectionContainerBase
• SelectionContainerEntity
• SelectionContainerVolume