Class PointSelector

@description: 在屏幕上选点

Hierarchy

Subscribe<EventMap>
- PointSelector

Index

Constructors

Properties

_cursorError actionIfNoIntersection adhereLine adherePlane adhereRadius five hook plane? planeMode pointSelectorHelper

Accessors

cursorError enabled outOfFive position

Methods

disable dispose emit enable hasListener off on once select setAdherePoints

Constructors

constructor

new PointSelector(five, config?): PointSelector
Parameters
- five: Five
- Optionalconfig: Partial<Config>
Returns PointSelector
Overrides Subscribe<EventMap>.constructor
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:191

Properties

_cursorError

_cursorError: boolean = false

actionIfNoIntersection

actionIfNoIntersection: ActionIfNoIntersection = 'virtualPoint'

adhereLine

adhereLine: Line3[] = []

Description

吸附线

adherePlane

adherePlane: Plane[] = []

Description

吸附面

adhereRadius

adhereRadius: number = 0.1

Description

吸附半径

five

five: Five

`Readonly`hook

hook: PointSelector = ...

Deprecated

directly use pointSelector.on/off instead

`Optional`plane

plane?: Plane

planeMode

planeMode: "vertical" | "onlyPlane" | "onlyVirtual" = 'onlyVirtual'

Description

结果区别：vertical: 射线和模型的交点在plane上的投影点；onlyPlane: 不论射线和模型是否有交点，都为射线和plane的焦点；onlyVirtual: 仅当射线和模型没有交点时，为射线和plane的焦点

`Readonly`pointSelectorHelper

pointSelectorHelper: PointSelectorHelper

Accessors

cursorError

get cursorError(): boolean
Returns boolean
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:105
set cursorError(cursorError): void
Parameters
- cursorError: boolean
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:109

enabled

get enabled(): boolean
Returns boolean
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:101
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:158

outOfFive

get outOfFive(): boolean
@description: 不在 five canvas 上时为 true

Returns boolean
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:97
set outOfFive(outOfFive): void
Parameters
- outOfFive: boolean
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:153

position

get position(): PointIntersection
Returns PointIntersection
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:89

Methods

disable

disable(): void
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:278

dispose

dispose(): void
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:321

emit

emit<K>(name, ...data): boolean
触发事件
Type Parameters
- K extends keyof EventMap
  预设的监听事件名称
Parameters
- name: K
  事件类型
- Rest...data: Parameters<EventMap[K]>
  触发事件的数据
Returns boolean
canceled 是否被触发取消
Inherited from Subscribe.emit
- Defined in plugins/src/shared-utils/Subscribe.ts:117

enable

enable(): void
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:223

hasListener

hasListener(name): boolean
判断是否注册了事件
Parameters
- name: keyof EventMap
  事件类型
Returns boolean
Inherited from Subscribe.hasListener
- Defined in plugins/src/shared-utils/Subscribe.ts:48

off

off<K>(name?, callback?): void
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件
Type Parameters
- K extends keyof EventMap
  预设的监听事件名称
Parameters
- Optionalname: K
  事件类型
- Optionalcallback: ((...args: Parameters<EventMap[K]>) => ReturnType<EventMap[K]>)
  事件回调函数
  - - (...args): ReturnType<EventMap[K]>
    - Parameters
      Rest...args: Parameters<EventMap[K]>
      Returns ReturnType<EventMap[K]>
Returns void
Inherited from Subscribe.off
- Defined in plugins/src/shared-utils/Subscribe.ts:90

on

on<K>(name, callback, once?): (() => void)
注册事件
Type Parameters
- K extends keyof EventMap
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: ((...args: Parameters<EventMap[K]>) => ReturnType<EventMap[K]>)
  事件回调函数
  - - (...args): ReturnType<EventMap[K]>
    - Parameters
      Rest...args: Parameters<EventMap[K]>
      Returns ReturnType<EventMap[K]>
- Optionalonce: boolean
  是否只执行一次
Returns (() => void)
解除事件
- - (): void
  - Returns void
Inherited from Subscribe.on
- Defined in plugins/src/shared-utils/Subscribe.ts:62

once

once<K>(name, callback): (() => void)
注册事件(是否只执行一次)
Type Parameters
- K extends keyof EventMap
  预设的监听事件名称
Parameters
- name: K
  事件类型
- callback: ((...args: Parameters<EventMap[K]>) => ReturnType<EventMap[K]>)
  事件回调函数
  - - (...args): ReturnType<EventMap[K]>
    - Parameters
      Rest...args: Parameters<EventMap[K]>
      Returns ReturnType<EventMap[K]>
Returns (() => void)
解除事件
- - (): void
  - Returns void
Inherited from Subscribe.once
- Defined in plugins/src/shared-utils/Subscribe.ts:77

select

select(intersection?): boolean
@description: 主动触发一次选点 @return: select 是否成功
Parameters
- Optionalintersection: PointIntersection
Returns boolean
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:346

setAdherePoints

setAdherePoints(points, radius?): void
Parameters
- points: AdherePoint[] | ((params: {
  intersection: PointIntersection;
  pointSelectorInstance: PointSelector;
  }) => AdherePoint[])
- Optionalradius: number
  Deprecated
  use .adhereRadius = 0.1 instead
Returns void
- Defined in plugins/src/shared-utils/three/PointSelector/index.ts:326