Class HintCommand

Hierarchy

Command
- HintCommand

Constructors

constructor

new HintCommand(holder, parent?): HintCommand
Parameters
- holder: CommandManager
- Optional parent: Command
Returns HintCommand
Inherited from Command.constructor
- Defined in packages/command-manager/typings/Command.d.ts:12

Properties

`Protected` $children

$children: {
[key: string]: Command;
}

Type declaration

[key: string]: Command

`Private` hintDomain

hintDomain: Hint = ...

`Protected` holder

holder: CommandManager

`Private` `Optional` selection

selection?: SelectionCommand

Methods

active

active(selectionCommand?): void
Parameters
- Optional selectionCommand: SelectionCommand
  selection command 实例，hint 与 select 同时启用时需要传入
Returns void
Overrides Command.active
- Defined in packages/design-engine/src/hint-command/index.ts:28

apply

apply(...args): void
应用当前 Command 及其子级，该方法不仅会强制激活当前 Command 及其子级，还会使它们的交互事件生效同时只能有一个 Command 节点处于应用状态（兄弟节点的交互事件是互斥的）永远不用重写该方法，相关初始化逻辑请在 active 接口中编码
Parameters
- Rest ...args: any[]
Returns void
Inherited from Command.apply
- Defined in packages/command-manager/typings/Command.d.ts:18

dispose

dispose(...args): void
注销当前 Command 及其子级，同时将停止响应该指令及子级的交互事件
Parameters
- Rest ...args: any[]
Returns void
Inherited from Command.dispose
- Defined in packages/command-manager/typings/Command.d.ts:26

distributeEvent

distributeEvent(eventType, ev, event, tools): void
Parameters
- eventType: EventType
- ev: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.distributeEvent
- Defined in packages/command-manager/typings/Command.d.ts:27

`Protected` distributeToSelf

distributeToSelf(eventType, ev, event, tools): void
将交互事件分发给自身的回调函数处理
Parameters
- eventType: EventType
- ev: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.distributeToSelf
- Defined in packages/command-manager/typings/Interaction.d.ts:29

getHintedEntity

getHintedEntity(): undefined | EntityObject
获取被 hover 的 entity

Returns undefined | EntityObject
- Defined in packages/design-engine/src/hint-command/index.ts:33

hint

hint(model): void
hint 指定 entity
Parameters
- model: EntityObject
Returns void
- Defined in packages/design-engine/src/hint-command/index.ts:38

`Protected` onCarriageEnd

onCarriageEnd(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onCarriageEnd
- Defined in packages/command-manager/typings/Interaction.d.ts:21

`Protected` onCarriageMove

onCarriageMove(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onCarriageMove
- Defined in packages/command-manager/typings/Interaction.d.ts:20

`Protected` onClick

onClick(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onClick
- Defined in packages/command-manager/typings/Interaction.d.ts:4

`Protected` onDBClick

onDBClick(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onDBClick
- Defined in packages/command-manager/typings/Interaction.d.ts:5

`Protected` onDragEnd

onDragEnd(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onDragEnd
- Defined in packages/command-manager/typings/Interaction.d.ts:9

`Protected` onDragMove

onDragMove(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onDragMove
- Defined in packages/command-manager/typings/Interaction.d.ts:8

`Protected` onDragStart

onDragStart(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onDragStart
- Defined in packages/command-manager/typings/Interaction.d.ts:7

onHoverIn

onHoverIn(viewEntity): void
Parameters
- viewEntity: ViewEntity
Returns void
Overrides Command.onHoverIn
- Defined in packages/design-engine/src/hint-command/index.ts:47

onHoverOut

onHoverOut(): void
Returns void
Overrides Command.onHoverOut
- Defined in packages/design-engine/src/hint-command/index.ts:78

`Protected` onPinch

onPinch(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onPinch
- Defined in packages/command-manager/typings/Interaction.d.ts:11

`Protected` onPinchEnd

onPinchEnd(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onPinchEnd
- Defined in packages/command-manager/typings/Interaction.d.ts:12

`Protected` onPinchStart

onPinchStart(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onPinchStart
- Defined in packages/command-manager/typings/Interaction.d.ts:10

`Protected` onPress

onPress(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onPress
- Defined in packages/command-manager/typings/Interaction.d.ts:16

`Protected` onPressUp

onPressUp(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onPressUp
- Defined in packages/command-manager/typings/Interaction.d.ts:17

`Protected` onRightClick

onRightClick(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onRightClick
- Defined in packages/command-manager/typings/Interaction.d.ts:6

`Protected` onRotate

onRotate(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onRotate
- Defined in packages/command-manager/typings/Interaction.d.ts:14

`Protected` onRotateEnd

onRotateEnd(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onRotateEnd
- Defined in packages/command-manager/typings/Interaction.d.ts:15

`Protected` onRotateStart

onRotateStart(entity, event, tools): void
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onRotateStart
- Defined in packages/command-manager/typings/Interaction.d.ts:13

`Protected` onWheel

onWheel(entity, event, tools): void
画布的缩放事件
Parameters
- entity: ViewEntity
- event: SceneEvent<any>
- tools: SceneTool
Returns void
Inherited from Command.onWheel
- Defined in packages/command-manager/typings/Interaction.d.ts:25

unHint

unHint(): void
取消 hint

Returns void
- Defined in packages/design-engine/src/hint-command/index.ts:43

Generated using TypeDoc