Class PointSelector

@description: 在屏幕上选点

Hierarchy

  • Subscribe<EventMap>
    • PointSelector

Constructors

constructor

Properties

_cursorError actionIfNoModelUnderMouse hook plane? 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

Properties

_cursorError

_cursorError: boolean = false

actionIfNoModelUnderMouse

actionIfNoModelUnderMouse: ActionIfNoModelUnderMouse = 'virtualPoint'

Readonlyhook

hook: PointSelector = ...

Deprecated

directly use pointSelector.on/off instead

Optionalplane

plane?: Plane

ReadonlypointSelectorHelper

pointSelectorHelper: PointSelectorHelper

Accessors

cursorError

  • get cursorError(): boolean

  • Returns boolean

  • set cursorError(cursorError): void

  • Parameters

    • cursorError: boolean

    Returns void

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(enabled): void

  • Parameters

    • enabled: boolean

    Returns void

outOfFive

  • get outOfFive(): boolean

  • @description: 不在 five canvas 上时为 true

    Returns boolean

  • set outOfFive(outOfFive): void

  • Parameters

    • outOfFive: boolean

    Returns void

position

Methods

disable

  • disable(): void

  • Returns void

dispose

  • dispose(): void

  • Returns void

emit

  • emit<K>(name, ...data): boolean

  • 触发事件

    Type Parameters

    • K extends keyof EventMap

      预设的监听事件名称

    Parameters

    • name: K

      事件类型

    • Rest...data: Parameters<EventMap[K]>

      触发事件的数据

    Returns boolean

    canceled 是否被触发取消

enable

  • enable(): void

  • Returns void

hasListener

  • hasListener(name): boolean

  • 判断是否注册了事件

    Parameters

    • name: keyof EventMap

      事件类型

    Returns boolean

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

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

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

select

  • select(intersection?): boolean

  • @description: 主动触发一次选点 @return: select 是否成功

    Parameters

    Returns boolean

setAdherePoints

  • setAdherePoints(points, radius?): void

  • Parameters

    • points: Vector3[] | ((params: {
          intersection: PointIntersection;
          pointSelectorInstance: PointSelector;
      }) => Vector3[])
    • Optionalradius: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods