pivotick / ModeStore
Interface: ModeStore
Definido em: ui/ModeStore.ts:84
Um pequeno observável que mantém o estado do modo ferroviário. O trilho, o painel de ferramentas contextuais e os submenus de configurações se inscrevem nele; cliques / atalhos de teclado são enviados para ele. Os setters são idempotentes — eles só notificam quando o valor realmente muda — e cada notificação carrega um novo instantâneo para que um ouvinte não possa alterar o estado interno do armazenamento.
Os quatro modos integrados estão sempre presentes. Os modos registrados por meio de addRailMode são adicionados com registerMode e mantêm o estado exatamente como um modo integrado.
subscribe dispara em apenas alterações; renderize o estado inicial de getState primeiro e depois inscreva-se para atualizações.
Métodos
armTool()
armTool(
mode,tool):void
Definido em: ui/ModeStore.ts:193
Arme uma ferramenta em modo de ponteiro (a ranhura do trilho reflete). Idempotente.
Parâmetros
mode
string
tool
string | null
Retorno
void
dispose()
dispose():
void
Definido em: ui/ModeStore.ts:218
Descarte todos os assinantes (chamado na desmontagem da IU).
Retorno
void
getArmedTool()
getArmedTool(
mode):string|null
Definido em: ui/ModeStore.ts:162
A ferramenta armada para um modo ponteiro ('pointer'/null = padrão).
Parâmetros
mode
string
Retorno
string | null
getDefaultTool()
getDefaultTool(
mode):string|null
Definido em: ui/ModeStore.ts:118
A ferramenta em que um modo permanece quando nada especial está armado.
Parâmetros
mode
string
Retorno
string | null
getMode()
getMode():
string
Definido em: ui/ModeStore.ts:103
Retorno
string
getState()
getState():
Readonly<ModeState>
Definido em: ui/ModeStore.ts:172
Uma cópia do estado atual (segura para leitura; as mutações não retornam).
Retorno
Readonly<ModeState>
hasMode()
hasMode(
mode):boolean
Definido em: ui/ModeStore.ts:113
Se um modo está atualmente registrado (os quatro integrados sempre estão).
Parâmetros
mode
string
Retorno
boolean
isFlyoutActive()
isFlyoutActive(
mode):boolean
Definido em: ui/ModeStore.ts:147
Se um submenu está aberto (ou seja, seu modo é o ativo).
Parâmetros
mode
string
Retorno
boolean
isPanelOpen()
isPanelOpen(
mode):boolean
Definido em: ui/ModeStore.ts:167
Se o painel de ferramentas do modo ponteiro está atualmente expandido.
Parâmetros
mode
string
Retorno
boolean
isPointerMode()
isPointerMode(
mode):boolean
Definido em: ui/ModeStore.ts:108
Se um modo possui o painel de ferramentas. Os modos desconhecidos não são modos de ponteiro.
Parâmetros
mode
string
Retorno
boolean
isViewActive()
isViewActive():
boolean
Definido em: ui/ModeStore.ts:152
Retorno
boolean
Deprecated
use isFlyoutActive('view') — o trilho tem mais de um submenu agora.
registerMode()
registerMode(
mode,kind,defaultTool,panelOpen):void
Definido em: ui/ModeStore.ts:127
Adicione o estado de um modo à loja. Chamado pelo registro do modo ferroviário; os quatro integrados já estão presentes. O novo registro de um ID substitui seu registro, mas mantém qualquer estado de ferramenta/painel que ele já possuía.
Parâmetros
mode
string
kind
defaultTool
string | null
panelOpen
boolean = true
Retorno
void
setMode()
setMode(
mode):void
Definido em: ui/ModeStore.ts:180
Parâmetros
mode
string
Retorno
void
setPanelOpen()
setPanelOpen(
mode,open):void
Definido em: ui/ModeStore.ts:200
Expandir/recolher o painel de ferramentas do modo ponteiro. Idempotente.
Parâmetros
mode
string
open
boolean
Retorno
void
subscribe()
subscribe(
listener): () =>void
Definido em: ui/ModeStore.ts:212
Assine as mudanças de estado. Retorna um fn de cancelamento de assinatura (passa para UIComponent.track).
Parâmetros
listener
ModeListener
Retorno
():
void
Retorno
void
toggleFlyout()
toggleFlyout(
mode):void
Definido em: ui/ModeStore.ts:188
Abra um modo flyout ou feche-o para o último modo de ponteiro.
Parâmetros
mode
string
Retorno
void
toggleToolPanel()
toggleToolPanel(
mode):void
Definido em: ui/ModeStore.ts:207
Alternar entre aberto/fechado o painel de ferramentas do modo ponteiro.
Parâmetros
mode
string
Retorno
void
toggleView()
toggleView():
void
Definido em: ui/ModeStore.ts:157
Retorno
void
Deprecated
use toggleFlyout('view') — o trilho tem mais de um submenu agora.
unregisterMode()
unregisterMode(
mode):void
Definido em: ui/ModeStore.ts:138
Elimine o estado de um modo. O chamador é responsável por sair primeiro – a loja não decidirá o que ativar.
Parâmetros
mode
string
Retorno
void