Skip to content

pivotick v3.0.0


pivotick / RailMode

Type Alias: RailMode ​

RailMode = string

Defined in: ui/ModeStore.ts:28

Every mode the rail can be in: the four built-ins — 'select', 'create', 'view' and 'physics' — plus the id of any mode registered through addRailMode. Modes are mutually exclusive: opening a flyout deactivates the active pointer-mode (and vice-versa), and only one flyout is open at a time.

A plain string, since a registered id is arbitrary. Adding | (string & {}) would keep editor autocomplete for the four names above, but TypeDoc renders it as string & object.