Interface: ISimpleToolRailOptions

The tool rail component allows the tool to register an icon and button (and dynamic tooltip) in the tool rail on the left side of the display. Adding a tool rail component to a tool will cause the tool to be considered a modal tool, and only one single modal tool can be active at any one time. Modal tools are generally tools which take focus and control of the cursor (e.g. selection, clipboards, entity selection, etc) Global tools (tools which do not have a tool rail) are generally things like property pages, settings, etc - things that do not require an active cursor or gameplay interaction

Properties

displayAltText

displayAltText: string

---

displayStringId?

optional displayStringId: string

---

icon

icon: string

---

onActivate()?

optional onActivate: (component) => void

Parameters

Parameter	Type
component	ISimpleToolRailComponent

Returns

void

---

onDeactivate()?

optional onDeactivate: (component) => void

Parameters

Parameter	Type
component	ISimpleToolRailComponent

Returns

void

---

onFinalize()?

optional onFinalize: (component) => void

Parameters

Parameter	Type
component	ISimpleToolRailComponent

Returns

void

---

onTeardown()?

optional onTeardown: (component) => void

Parameters

Parameter	Type
component	ISimpleToolRailComponent

Returns

void

---

tooltipAltText

tooltipAltText: string

---

tooltipStringId?

optional tooltipStringId: string