Interface IToolStateModule

interface IToolStateModule {
    addTool: ((Tool) => void);
    getCurrentTool: (() => StateNode);
    getCurrentToolId: (() => string);
    getStateDescendant: (<T>(path) => T);
    getStatePath: (() => string);
    isInActiveTool: (() => boolean);
    removeTool: ((Tool) => void);
    rootState: StateNode;
    setCurrentTool: ((id?, info?) => App);
    stateInAny: ((...paths) => boolean);
    stateIsIn: ((path) => boolean);
    transformObject: ((options) => Promise<StateNode>);
    isInteracting(): boolean;
}

Implemented by

App

Index

Properties

addTool getCurrentTool getCurrentToolId getStateDescendant getStatePath isInActiveTool removeTool rootState setCurrentTool stateInAny stateIsIn transformObject

Methods

Properties

addTool

addTool: ((Tool) => void)

Type declaration

- (Tool): void
- Parameters
  - Tool: TLStateNodeConstructor
  Returns void

getCurrentTool

getCurrentTool: (() => StateNode)

Type declaration

- (): StateNode
- Returns StateNode

getCurrentToolId

getCurrentToolId: (() => string)

Type declaration

- (): string
- Returns string

getStateDescendant

getStateDescendant: (<T>(path) => T)

Type declaration

- <T>(path): T
- Type Parameters
  - T extends StateNode
  Parameters
  - path: string
  Returns T

getStatePath

getStatePath: (() => string)

Type declaration

- (): string
- Returns string

isInActiveTool

isInActiveTool: (() => boolean)

判断当前是否有工具处于运行中

Type declaration

- (): boolean
- 判断当前是否有工具处于运行中
  
  Returns boolean

removeTool

removeTool: ((Tool) => void)

Type declaration

- (Tool): void
- Parameters
  - Tool: TLStateNodeConstructor
  Returns void

`Readonly` rootState

rootState: StateNode

setCurrentTool

setCurrentTool: ((id?, info?) => App)

Type declaration

- (id?, info?): App
- Parameters
  - Optional id: string
  - Optional info: Record<string, any>
  Returns App

stateInAny

stateInAny: ((...paths) => boolean)

Type declaration

- (...paths): boolean
- Parameters
  - Rest ...paths: string[]
  Returns boolean

stateIsIn

stateIsIn: ((path) => boolean)

Type declaration

- (path): boolean
- Parameters
  - path: string
  Returns boolean

transformObject

transformObject: ((options) => Promise<StateNode>)

对一个物体进行变换控制器操作

Type declaration

- (options): Promise<StateNode>
- 对一个物体进行变换控制器操作
  Parameters
  - options: TransformEnterOptions
  Returns Promise<StateNode>

Methods

isInteracting

isInteracting(): boolean
是否正在交互

Returns boolean