Class MultiSelector

Hierarchy

Tool<MultiSelectorOptions, MultiSelectorEventMap>
- MultiSelector

Index

Constructors

constructor

new MultiSelector(options: MultiSelectorOptions): MultiSelector
Parameters
- options: MultiSelectorOptions
Returns MultiSelector
Overrides Tool.constructor
- Defined in src/tools/selector/multiSelector.ts:61

Properties

app

app: AppBase

`Private` isSelecting

isSelecting: boolean = false

`Private` pickLayers

pickLayers: Layer[]

`Private` pickNodes

pickNodes: GraphNode[] = []

`Private` pickRect

pickRect: Vec4

`Private` picker

picker: Picker

toolOptions

toolOptions: MultiSelectorOptions

`Protected` toolOptionsDefault

toolOptionsDefault: MultiSelectorOptions = ...

Accessors

enabled

get enabled(): boolean
获得工具的启用状态

Returns boolean
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:43
set enabled(value: boolean): void
设置工具启用状态（触发启用和禁用时的额外操作）
Parameters
- value: boolean
Returns void
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:34

Methods

`Protected` fire

fire<EventName>(eventName: EventName, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, arg6?: any, arg7?: any, arg8?: any): EventHandler
手动触发事件

Returns
EventHandler
Type Parameters
- EventName extends keyof MultiSelectorEventMap
Parameters
- eventName: EventName
  
  事件名称
- Optional arg1: any
  
  参数1
- Optional arg2: any
  
  参数2
- Optional arg3: any
  
  参数3
- Optional arg4: any
  
  参数4
- Optional arg5: any
  
  参数5
- Optional arg6: any
  
  参数6
- Optional arg7: any
  
  参数7
- Optional arg8: any
  
  参数8
Returns EventHandler
Inherited from Tool.fire
- Defined in src/utils/helpers/toolBase.ts:128

hasEvent

hasEvent<EventName>(eventName: EventName): boolean
检测是否监听此事件

Returns
是否监听此事件
Type Parameters
- EventName extends keyof MultiSelectorEventMap
Parameters
- eventName: EventName
  
  事件名称
Returns boolean
Inherited from Tool.hasEvent
- Defined in src/utils/helpers/toolBase.ts:111

`Private` isNodesEqual

isNodesEqual(arr1: GraphNode[], arr2: GraphNode[]): boolean
判断两个节点数组是否无序相等

Returns
两数组是否无序相等
Parameters
- arr1: GraphNode[]
  
  数组1
- arr2: GraphNode[]
  
  数组2
Returns boolean
- Defined in src/tools/selector/multiSelector.ts:158

off

off<EventName>(eventName: EventName, linstener: MultiSelectorEventMap[EventName], scope?: object): EventHandler
注销事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof MultiSelectorEventMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: MultiSelectorEventMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.off
- Defined in src/utils/helpers/toolBase.ts:102

on

on<EventName>(eventName: EventName, linstener: MultiSelectorEventMap[EventName], scope?: object): EventHandler
注册事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof MultiSelectorEventMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: MultiSelectorEventMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.on
- Defined in src/utils/helpers/toolBase.ts:80

`Private` onControlDown

onControlDown(event: { x: number; y: number }): void
按键按下事件回调
Parameters
- event: { x: number; y: number }
  
  按键按下事件
  - x: number
  - y: number
Returns void
- Defined in src/tools/selector/multiSelector.ts:179

`Protected` onDisable

onDisable(): void
Returns void
Overrides Tool.onDisable
- Defined in src/tools/selector/multiSelector.ts:221

`Private` onDragEnd

onDragEnd(event: { x: number; y: number }): void
拖拽结束时调用
Parameters
- event: { x: number; y: number }
  
  拖拽结束事件
  - x: number
  - y: number
Returns void
- Defined in src/tools/selector/multiSelector.ts:206

`Private` onDragging

onDragging(event: { ox: number; oy: number; x: number; y: number }): void
拖拽中调用

Returns
Parameters
- event: { ox: number; oy: number; x: number; y: number }
  
  拖拽中事件
  - ox: number
  - oy: number
  - x: number
  - y: number
Returns void
- Defined in src/tools/selector/multiSelector.ts:193

`Protected` onEnable

onEnable(): void
Returns void
Overrides Tool.onEnable
- Defined in src/tools/selector/multiSelector.ts:213

once

once<EventName>(eventName: EventName, linstener: MultiSelectorEventMap[EventName], scope?: object): EventHandler
注册单次事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof MultiSelectorEventMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: MultiSelectorEventMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.once
- Defined in src/utils/helpers/toolBase.ts:91

`Private` pick

pick(rect: Vec4): void
根据框选区域选择模型
Parameters
- rect: Vec4
  
  框选区域
Returns void
- Defined in src/tools/selector/multiSelector.ts:88

setOptions

setOptions(options: MultiSelectorOptions): void
设置多选模型选项
Parameters
- options: MultiSelectorOptions
Returns void
Overrides Tool.setOptions
- Defined in src/tools/selector/multiSelector.ts:75

updateOptions

updateOptions(options: { boxLayer?: Layer; excludeLayers?: Layer[]; expectCondition?: (() => boolean); inputHandler?: Tool<any, InputEventsMap>; pickAreaScale?: number; pickCamera?: CameraComponent }): void
更新选项
Parameters
- options: { boxLayer?: Layer; excludeLayers?: Layer[]; expectCondition?: (() => boolean); inputHandler?: Tool<any, InputEventsMap>; pickAreaScale?: number; pickCamera?: CameraComponent }
  
  选项
  - Optional boxLayer?: Layer
  - Optional excludeLayers?: Layer[]
  - Optional expectCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
  - Optional inputHandler?: Tool<any, InputEventsMap>
  - Optional pickAreaScale?: number
  - Optional pickCamera?: CameraComponent
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65

`Private` updatePickNodes

updatePickNodes(nodes: GraphNode[]): GraphNode[]
框选时使用增量更新

Returns
增量更新后的node集合
Parameters
- nodes: GraphNode[]
  
  框选node集合
Returns GraphNode[]
- Defined in src/tools/selector/multiSelector.ts:129

Class MultiSelector

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: MultiSelectorOptions

Returns MultiSelector

Properties

app

Private isSelecting

Private pickLayers

Private pickNodes

Private pickRect

Private picker

toolOptions

Protected toolOptionsDefault

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected fire

Returns

Type Parameters

EventName extends keyof MultiSelectorEventMap

Parameters

eventName: EventName

Optional arg1: any

Optional arg2: any

Optional arg3: any

Optional arg4: any

Optional arg5: any

Optional arg6: any

Optional arg7: any

Optional arg8: any

Returns EventHandler

hasEvent

Returns

Type Parameters

EventName extends keyof MultiSelectorEventMap

Parameters

eventName: EventName

Returns boolean

Private isNodesEqual

Returns

Parameters

arr1: GraphNode[]

arr2: GraphNode[]

Returns boolean

off

Returns

Type Parameters

EventName extends keyof MultiSelectorEventMap

Parameters

eventName: EventName

linstener: MultiSelectorEventMap[EventName]

Optional scope: object

Returns EventHandler

on

Returns

Type Parameters

EventName extends keyof MultiSelectorEventMap

Parameters

eventName: EventName

linstener: MultiSelectorEventMap[EventName]

Optional scope: object

Returns EventHandler

Private onControlDown

Parameters

event: { x: number; y: number }

x: number

y: number

Returns void

`Private` isSelecting

`Private` pickLayers

`Private` pickNodes

`Private` pickRect

`Private` picker

`Protected` toolOptionsDefault

`Protected` fire

`Optional` arg1: any

`Optional` arg2: any

`Optional` arg3: any

`Optional` arg4: any

`Optional` arg5: any

`Optional` arg6: any

`Optional` arg7: any

`Optional` arg8: any

`Private` isNodesEqual

`Optional` scope: object

`Optional` scope: object

`Private` onControlDown

`Protected` onDisable

`Private` onDragEnd

`Private` onDragging

`Protected` onEnable

`Optional` scope: object

`Private` pick

`Optional` boxLayer?: Layer

`Optional` excludeLayers?: Layer[]

`Optional` expectCondition?: (() => boolean)

`Optional` inputHandler?: Tool<any, InputEventsMap>

`Optional` pickAreaScale?: number

`Optional` pickCamera?: CameraComponent

`Private` updatePickNodes