Class Selector

Hierarchy

Tool<SelectorOptions, SelectorEventsMap>
- Selector

Index

Constructors

constructor

new Selector(options: SelectorOptions): Selector
创建模型点选器
Parameters
- options: SelectorOptions
Returns Selector
Overrides Tool.constructor
- Defined in src/tools/selector/selector.ts:61

Properties

app

app: AppBase

`Private` pickLayers

pickLayers: Layer[]

`Private` picker

picker: Picker

`Private` preSelectedNode

preSelectedNode: GraphNode

toolOptions

toolOptions: SelectorOptions

`Protected` toolOptionsDefault

toolOptionsDefault: SelectorOptions = ...

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 "select"
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

`Private` getModelHasTag

getModelHasTag(model: GraphNode, tag: string): Entity
从下至上找到含有某个标签的模型对象

Returns
包含标签的模型对象
Parameters
- model: GraphNode
  
  模型
- tag: string
  
  标签
Returns Entity
- Defined in src/tools/selector/selector.ts:126

hasEvent

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

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

off

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

Returns
EventHandler
Type Parameters
- EventName extends "select"
Parameters
- eventName: EventName
  
  事件名称
- linstener: SelectorEventsMap[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: SelectorEventsMap[EventName], scope?: object): EventHandler
注册事件监听

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

`Protected` onDisable

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

`Protected` onEnable

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

once

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

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

`Private` pick

pick(event: { x: number; y: number }): void
点选模型
Parameters
- event: { x: number; y: number }
  
  输入事件
  - x: number
    
    输入事件屏幕x坐标
  - y: number
    
    输入事件屏幕y坐标
Returns void
- Defined in src/tools/selector/selector.ts:88

setOptions

setOptions(options: SelectorOptions): void
设置模型点选器
Parameters
- options: SelectorOptions
Returns void
Overrides Tool.setOptions
- Defined in src/tools/selector/selector.ts:73

updateOptions

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

Class Selector

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: SelectorOptions

Returns Selector

Properties

app

Private pickLayers

Private picker

Private preSelectedNode

toolOptions

Protected toolOptionsDefault

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected fire

Returns

Type Parameters

EventName extends "select"

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

Private getModelHasTag

Returns

Parameters

model: GraphNode

tag: string

Returns Entity

hasEvent

Returns

Type Parameters

EventName extends "select"

Parameters

eventName: EventName

Returns boolean

off

Returns

Type Parameters

EventName extends "select"

Parameters

eventName: EventName

linstener: SelectorEventsMap[EventName]

Optional scope: object

Returns EventHandler

on

Returns

Type Parameters

EventName extends "select"

Parameters

eventName: EventName

linstener: SelectorEventsMap[EventName]

Optional scope: object

Returns EventHandler

Protected onDisable

Returns void

Protected onEnable

Returns void

once

Returns

Type Parameters

EventName extends "select"

`Private` pickLayers

`Private` picker

`Private` preSelectedNode

`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` getModelHasTag

`Optional` scope: object

`Optional` scope: object

`Protected` onDisable

`Protected` onEnable

`Optional` scope: object

`Private` pick

`Optional` excludeLayers?: Layer[]

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

`Optional` pickAreaScale?: number

`Optional` pickCamera?: CameraComponent

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

`Optional` pickNull?: boolean

`Optional` pickSame?: boolean

`Optional` pickTag?: string