Class SelectionCommand

Hierarchy

Command
- SelectionCommand

Constructors

constructor

new SelectionCommand(holder, parent?): SelectionCommand
Parameters
- holder: CommandManager
- Optional parent: Command
Returns SelectionCommand
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` `Optional` hint

hint?: any

`Protected` holder

holder: CommandManager

`Private` modeMap

modeMap: any

onSelectHandler

onSelectHandler: ((models) => void)

Type declaration

- (models): void
- Parameters
  - models: EntityObject[]
  Returns void

onUnselectHandler

onUnselectHandler: ((models) => void)

Type declaration

- (models): void
- Parameters
  - models: EntityObject[]
  Returns void

`Private` selection

selection: any

`Private` `Optional` targetRootEntity

targetRootEntity?: any

`Static` ESelectMode

ESelectMode: typeof ESelectMode

Methods

active

active(params?): void
激活当前 Command 及其子级，为即将到来的交互事件做好准备
Parameters
- Optional params: ISelectCommandParams
Returns void
Overrides Command.active
- Defined in packages/design-engine/typings/selection-command/command.d.ts:63

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

clearAllSelected

clearAllSelected(): void
清除已选中模型

Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:52

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

getLayerDepth

getLayerDepth(): number
获取选中层级深度

Returns number
- Defined in packages/design-engine/typings/selection-command/command.d.ts:56

getSelectEntityTypes

getSelectEntityTypes(): undefined | symbol[]
获取可选中的 entity 类型

Returns undefined | symbol[]
- Defined in packages/design-engine/typings/selection-command/command.d.ts:60

getSelectMode

getSelectMode(): ESelectMode
获取当前选择模式

Returns ESelectMode
- Defined in packages/design-engine/typings/selection-command/command.d.ts:40

getSelectedEntities

getSelectedEntities(): EntityObject[]
获取被选中的 entities

Returns EntityObject[]
- Defined in packages/design-engine/typings/selection-command/command.d.ts:36

`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(viewEntity, event): void
Parameters
- viewEntity: ViewEntity
- event: SceneEvent<any>
Returns void
Overrides Command.onClick
- Defined in packages/design-engine/typings/selection-command/command.d.ts:64

`Protected` onDBClick

onDBClick(viewEntity): void
Parameters
- viewEntity: ViewEntity
Returns void
Overrides Command.onDBClick
- Defined in packages/design-engine/typings/selection-command/command.d.ts:65

`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

`Protected` onHoverIn

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

`Protected` onHoverOut

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

`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

select

select(models, clearExisted?): void
选中指定模型
Parameters
- models: EntityObject[]
- Optional clearExisted: boolean
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:48

selectHandler

selectHandler(viewEntity, action): void
选中实体通用逻辑
Parameters
- viewEntity: ViewEntity
- action: EClickAction
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:67

setLayerDepth

setLayerDepth(depth): void
设置选中层级深度
Parameters
- depth: number
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:54

setMultiSelect

setMultiSelect(isMultiple): void
设置事件的多选状态，每次事件行为都会根据此状态判断是否为多选行为

注意：每次选择事件之前都需要设置，因为事件完成后状态会被清除，这只在需要自定义多选按键/状态的情况下才会用到（默认情况下按 shift 会设置）
Parameters
- isMultiple: boolean
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:46

setSelectEntityTypes

setSelectEntityTypes(types?): void
设置可选中的 entity 类型
Parameters
- Optional types: symbol[]
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:58

switchSelectMode

switchSelectMode(selectMode): void
切换选择模式
Parameters
- selectMode: ESelectMode
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:38

unselect

unselect(models): void
取消选中指定模型
Parameters
- models: EntityObject[]
Returns void
- Defined in packages/design-engine/typings/selection-command/command.d.ts:50

Generated using TypeDoc