pivotick / ModeStore
Interface: ModeStore
Défini dans : ui/ModeStore.ts:84
Un minuscule observable détenant l’état mode-rail. Le rail, le panneau d'outils contextuels et les menus volants de paramètres y sont abonnés ; les clics / raccourcis clavier y sont envoyés. Les setters sont idempotents : ils ne notifient que lorsque la valeur change réellement - et chaque notification contient un nouvel instantané afin qu'un auditeur ne puisse pas muter l'état interne du magasin.
Les quatre modes intégrés sont toujours présents. Les modes enregistrés via addRailMode sont ajoutés avec registerMode et conservent leur état exactement comme le fait un mode intégré.
subscribe se déclenche sur change uniquement ; restituez d'abord l'état initial à partir de getState, puis abonnez-vous pour les mises à jour.
Méthodes
armTool()
armTool(
mode,tool):void
Défini dans : ui/ModeStore.ts:193
Armez un outil en mode pointeur (la fente du rail le reflète). Idempotent.
Paramètres
mode
string
tool
string | null
Renvoie
void
dispose()
dispose():
void
Défini dans : ui/ModeStore.ts:218
Supprimez chaque abonné (appelé lors du démontage de l'interface utilisateur).
Renvoie
void
getArmedTool()
getArmedTool(
mode):string|null
Défini dans : ui/ModeStore.ts:162
L'outil armé pour un mode pointeur ('pointer'/null = par défaut).
Paramètres
mode
string
Renvoie
string | null
getDefaultTool()
getDefaultTool(
mode):string|null
Défini dans : ui/ModeStore.ts:118
L'outil sur lequel repose un mode lorsque rien de spécial n'est armé.
Paramètres
mode
string
Renvoie
string | null
getMode()
getMode():
string
Défini dans : ui/ModeStore.ts:103
Renvoie
string
getState()
getState():
Readonly<ModeState>
Défini dans : ui/ModeStore.ts:172
Une copie de l'état actuel (à lire en toute sécurité ; les mutations ne fuient pas).
Renvoie
Readonly<ModeState>
hasMode()
hasMode(
mode):boolean
Défini dans : ui/ModeStore.ts:113
Si un mode est actuellement enregistré (les quatre intégrés le sont toujours).
Paramètres
mode
string
Renvoie
boolean
isFlyoutActive()
isFlyoutActive(
mode):boolean
Défini dans : ui/ModeStore.ts:147
Si un flyout est ouvert (c'est-à-dire que son mode est celui actif).
Paramètres
mode
string
Renvoie
boolean
isPanelOpen()
isPanelOpen(
mode):boolean
Défini dans : ui/ModeStore.ts:167
Indique si le panneau d'outils d'un mode pointeur est actuellement développé.
Paramètres
mode
string
Renvoie
boolean
isPointerMode()
isPointerMode(
mode):boolean
Défini dans : ui/ModeStore.ts:108
Indique si un mode possède le panneau d'outils. Les modes inconnus ne sont pas des modes pointeur.
Paramètres
mode
string
Renvoie
boolean
isViewActive()
isViewActive():
boolean
Défini dans : ui/ModeStore.ts:152
Renvoie
boolean
Deprecated
utilisez isFlyoutActive('view') — le rail a maintenant plus d'un menu volant.
registerMode()
registerMode(
mode,kind,defaultTool,panelOpen):void
Défini dans : ui/ModeStore.ts:127
Ajoutez l'état d'un mode au magasin. Appelé par le registre en mode ferroviaire ; les quatre éléments intégrés sont déjà présents. Le réenregistrement d'un identifiant écrase son enregistrement mais conserve l'état de l'outil/panneau qu'il avait déjà.
Paramètres
mode
string
kind
defaultTool
string | null
panelOpen
boolean = true
Renvoie
void
setMode()
setMode(
mode):void
Défini dans : ui/ModeStore.ts:180
Paramètres
mode
string
Renvoie
void
setPanelOpen()
setPanelOpen(
mode,open):void
Défini dans : ui/ModeStore.ts:200
Développez/réduisez le panneau d'outils d'un mode pointeur. Idempotent.
Paramètres
mode
string
open
boolean
Renvoie
void
subscribe()
subscribe(
listener): () =>void
Défini dans : ui/ModeStore.ts:212
Abonnez-vous aux changements d'état. Renvoie un fn de désabonnement (passer à UIComponent.track).
Paramètres
listener
ModeListener
Renvoie
():
void
Renvoie
void
toggleFlyout()
toggleFlyout(
mode):void
Défini dans : ui/ModeStore.ts:188
Ouvrez un mode volant ou fermez-le au dernier mode pointeur.
Paramètres
mode
string
Renvoie
void
toggleToolPanel()
toggleToolPanel(
mode):void
Défini dans : ui/ModeStore.ts:207
Activer/Fermer le panneau d'outils d'un mode pointeur.
Paramètres
mode
string
Renvoie
void
toggleView()
toggleView():
void
Défini dans : ui/ModeStore.ts:157
Renvoie
void
Deprecated
utilisez toggleFlyout('view') — le rail a maintenant plus d'un menu volant.
unregisterMode()
unregisterMode(
mode):void
Défini dans : ui/ModeStore.ts:138
Supprimez l’état d’un mode. L’appelant est responsable de s’éloigner en premier – le magasin ne décidera pas quoi activer à la place.
Paramètres
mode
string
Renvoie
void