Class ToolStateModule

EntityBase.

Hierarchy (view full)

AppModuleBase
- ToolStateModule

Implements

IAppModuleBase

Constructors

constructor

new ToolStateModule(app?, options?): ToolStateModule
Parameters
- Optional app: App
- Optional options: ToolStateModuleOptions
Returns ToolStateModule
Overrides AppModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

_rootState

_rootState: StateNode

appRenderIndex

appRenderIndex: number = 0

data

data: ShallowReactive<{
[key: string]: any;
}> = ...

Type declaration

[key: string]: any

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

options

options: ToolStateModuleOptions

`Static` moduleName

moduleName: string = "ToolStateModule"

Accessors

app

get app(): App
Returns App
Inherited from AppModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from AppModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from AppModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from AppModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase.enabled

rootState

get rootState(): StateNode
Returns StateNode

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from AppModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from AppModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from AppModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from AppModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from AppModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from AppModuleBase._setActive

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.addDispose

addTool

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

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from AppModuleBase.applyMixinsTo

destroy

destroy(): void
Destroy self.

Returns void
Inherited from AppModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from AppModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from AppModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from AppModuleBase.eventNames

getCurrentTool

getCurrentTool(): StateNode
The current selected tool.

Returns StateNode

getCurrentToolId

getCurrentToolId(): string
The id of the current selected tool.

Returns string

getStateDescendant

getStateDescendant<T>(path): T
Get a descendant by its path.
Type Parameters
- T extends StateNode
Parameters
- path: string
  The descendant's path of state ids, separated by periods.
Returns T
Example
```
app.getStateDescendant('select')
app.getStateDescendant('select.brushing')
```

getStatePath

getStatePath(): string
The editor's current path of active states.

Returns string
Example
```
app.getStatePath() // "draw.idle"
```

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from AppModuleBase.hasEvent

isInActiveTool

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

Returns boolean

isInteracting

isInteracting(): boolean
是否正在交互

Returns boolean

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from AppModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from AppModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.on

onAwake

onAwake(): void
Returns void
Implementation of IAppModuleBase.onAwake

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from AppModuleBase.once

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from AppModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from AppModuleBase.removeDispose

removeTool

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

setCurrentTool

setCurrentTool(id?, info?): App
Set the selected tool.
Parameters
- Optional id: string
  The id of the tool to select.
- Optional info: Record<string, any>
  Arbitrary data to pass along into the transition.
Returns App
Example
```
app.setCurrentTool('transform')
app.setCurrentTool("draw.drawpolygon", {color: 0xff0000})
```

setupUiConfig

setupUiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>

stateInAny

stateInAny(...paths): boolean
Get whether the state node is in any of the given active paths.
Parameters
- Rest ...paths: string[]
Returns boolean
Example
```
app.stateInAny('draw', 'pick')
app.stateInAny('draw.drawpoint', 'pick.idle')
```

stateIsIn

stateIsIn(path): boolean
Get whether a certain tool (or other state node) is currently active.
Parameters
- path: string
  The path of active states, separated by periods.
Returns boolean
Example
```
app.stateIsIn('draw')
app.stateIsIn('draw.drawpoint')
```

transformObject

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