Pivotick / ModeStore
Interface: ModeStore
Definiert in: ui/ModeStore.ts:84
Ein winziges Observable, das den Mode-Rail-Zustand hält. Die Leiste, das Kontext-Tool-Panel und die Einstellungs-Flyouts abonnieren es; Klicks/Tastenkombinationen senden dorthin. Setter sind idempotent – sie benachrichtigen nur, wenn sich der Wert tatsächlich ändert – und jede Benachrichtigung enthält einen neuen Snapshot, sodass ein Listener den internen Status des Speichers nicht ändern kann.
Die vier integrierten Modi sind immer vorhanden. Durch addRailMode registrierte Modi werden mit registerMode hinzugefügt und behalten den Status genau wie ein eingebauter Modus.
subscribe löst nur bei Änderungen aus; Rendern Sie zuerst den Anfangszustand von getState und abonnieren Sie dann Updates.
Methoden
armTool()
armTool(
mode,tool):void
Definiert in: ui/ModeStore.ts:193
Aktivieren Sie ein Werkzeug im Zeigermodus (der Schienenschlitz spiegelt dies wider). Idempotent.
Parameter
mode
string
tool
string | null
Rückgabewert
void
dispose()
dispose():
void
Definiert in: ui/ModeStore.ts:218
Löschen Sie jeden Abonnenten (aufgerufen beim UI-Teardown).
Rückgabewert
void
getArmedTool()
getArmedTool(
mode):string|null
Definiert in: ui/ModeStore.ts:162
Das scharfgeschaltete Werkzeug für einen Zeigermodus ('pointer'/null = Standard).
Parameter
mode
string
Rückgabewert
string | null
getDefaultTool()
getDefaultTool(
mode):string|null
Definiert in: ui/ModeStore.ts:118
Das Werkzeug, auf dem ein Modus basiert, wenn nichts Besonderes aktiviert ist.
Parameter
mode
string
Rückgabewert
string | null
getMode()
getMode():
string
Definiert in: ui/ModeStore.ts:103
Rückgabewert
string
getState()
getState():
Readonly<ModeState>
Definiert in: ui/ModeStore.ts:172
Eine Kopie des aktuellen Zustands (sicher lesbar; Mutationen dringen nicht zurück).
Rückgabewert
Readonly<ModeState>
hasMode()
hasMode(
mode):boolean
Definiert in: ui/ModeStore.ts:113
Ob ein Modus derzeit registriert ist (die vier integrierten Funktionen sind immer registriert).
Parameter
mode
string
Rückgabewert
boolean
isFlyoutActive()
isFlyoutActive(
mode):boolean
Definiert in: ui/ModeStore.ts:147
Ob ein Flyout geöffnet ist (d. h. sein Modus ist der aktive).
Parameter
mode
string
Rückgabewert
boolean
isPanelOpen()
isPanelOpen(
mode):boolean
Definiert in: ui/ModeStore.ts:167
Ob die Werkzeugleiste eines Zeigermodus derzeit erweitert ist.
Parameter
mode
string
Rückgabewert
boolean
isPointerMode()
isPointerMode(
mode):boolean
Definiert in: ui/ModeStore.ts:108
Ob ein Modus das Werkzeugfeld besitzt. Unbekannte Modi sind keine Zeigermodi.
Parameter
mode
string
Rückgabewert
boolean
isViewActive()
isViewActive():
boolean
Definiert in: ui/ModeStore.ts:152
Rückgabewert
boolean
Deprecated
Verwenden Sie isFlyoutActive('view') – die Schiene verfügt jetzt über mehr als ein Flyout.
registerMode()
registerMode(
mode,kind,defaultTool,panelOpen):void
Definiert in: ui/ModeStore.ts:127
Fügen Sie dem Store den Status eines Modus hinzu. Wird von der Rail-Mode-Registrierung aufgerufen; Die vier Einbauten sind bereits vorhanden. Durch die erneute Registrierung einer ID wird deren Datensatz überschrieben, der Werkzeug-/Bedienfeldstatus, den sie bereits hatte, bleibt jedoch erhalten.
Parameter
mode
string
kind
defaultTool
string | null
panelOpen
boolean = true
Rückgabewert
void
setMode()
setMode(
mode):void
Definiert in: ui/ModeStore.ts:180
Parameter
mode
string
Rückgabewert
void
setPanelOpen()
setPanelOpen(
mode,open):void
Definiert in: ui/ModeStore.ts:200
Erweitern/Reduzieren Sie die Werkzeugleiste eines Zeigermodus. Idempotent.
Parameter
mode
string
open
boolean
Rückgabewert
void
subscribe()
subscribe(
listener): () =>void
Definiert in: ui/ModeStore.ts:212
Abonnieren Sie Statusänderungen. Gibt eine Abmelde-FN zurück (Übergabe an UIComponent.track).
Parameter
listener
ModeListener
Rückgabewert
():
void
Rückgabewert
void
toggleFlyout()
toggleFlyout(
mode):void
Definiert in: ui/ModeStore.ts:188
Öffnen Sie einen Flyout-Modus oder schließen Sie ihn zurück zum letzten Zeigermodus.
Parameter
mode
string
Rückgabewert
void
toggleToolPanel()
toggleToolPanel(
mode):void
Definiert in: ui/ModeStore.ts:207
Schaltet die Werkzeugleiste eines Zeigermodus auf/zu.
Parameter
mode
string
Rückgabewert
void
toggleView()
toggleView():
void
Definiert in: ui/ModeStore.ts:157
Rückgabewert
void
Deprecated
Verwenden Sie toggleFlyout('view') – die Schiene verfügt jetzt über mehr als ein Flyout.
unregisterMode()
unregisterMode(
mode):void
Definiert in: ui/ModeStore.ts:138
Den Status eines Modus löschen. Es liegt in der Verantwortung des Anrufers, die Funktion zuerst zu deaktivieren. Das Geschäft entscheidet nicht, was stattdessen aktiviert wird.
Parameter
mode
string
Rückgabewert
void