Class ObjectPicker

Hierarchy

EventDispatcher<Event, "hoverObjectChanged" | "selectedObjectChanged" | "hitObject">
- ObjectPicker

Constructors

constructor

new ObjectPicker(root, domElement, camera, selectionCondition?): ObjectPicker
Parameters
- root: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- domElement: HTMLElement
- camera: ICamera<ICameraEvent, ICameraEventTypes>
- Optional selectionCondition: ((o) => boolean)
  - - (o): boolean
    - Parameters
      o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns boolean
Returns ObjectPicker
Overrides EventDispatcher<Event, 'hoverObjectChanged'|'selectedObjectChanged'|'hitObject'>.constructor
- Defined in src/three/utils/ObjectPicker.ts:31

Properties

`Private` _mouseDownPos

_mouseDownPos: Vector2 = ...

`Private` _mouseDownTime

_mouseDownTime: number

`Private` _mouseUpTime

_mouseUpTime: number

`Private` _root

_root: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Private` _selected

_selected: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Private` _time

_time: number

cursorStyles

cursorStyles: {
default: string;
down: string;
}

Type declaration

default: string
down: string

domElement

domElement: HTMLElement

hoverEnabled

hoverEnabled: boolean = false

mouse

mouse: Vector2

raycaster

raycaster: Raycaster

selectionCondition

selectionCondition: ((o) => boolean)

Type declaration

- (o): boolean
- Parameters
  - o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Returns boolean

`Static` PointerClickMaxDistance

PointerClickMaxDistance: number = 0.1

Distance threshold for a pointer click event

`Static` PointerClickMaxTime

PointerClickMaxTime: number = 200

Time threshold for a pointer click event

Accessors

camera

get camera(): ICamera<ICameraEvent, ICameraEventTypes>
Returns ICamera<ICameraEvent, ICameraEventTypes>
- Defined in src/three/utils/ObjectPicker.ts:82
set camera(value): void
Parameters
- value: ICamera<ICameraEvent, ICameraEventTypes>
Returns void
- Defined in src/three/utils/ObjectPicker.ts:86

hoverObject

get hoverObject(): null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- Defined in src/three/utils/ObjectPicker.ts:100
set hoverObject(object): void
Parameters
- object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Returns void
- Defined in src/three/utils/ObjectPicker.ts:104

isMouseDown

get isMouseDown(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:115

mouseDownDeltaTime

get mouseDownDeltaTime(): number
Returns number
- Defined in src/three/utils/ObjectPicker.ts:119

selectedObject

get selectedObject(): null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- Defined in src/three/utils/ObjectPicker.ts:90
set selectedObject(object): void
Parameters
- object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns void
- Defined in src/three/utils/ObjectPicker.ts:94

time

get time(): number
Returns number
- Defined in src/three/utils/ObjectPicker.ts:110

Methods

`Private` _onPointerCancel

_onPointerCancel(_): void
Parameters
- _: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:147

`Private` _onPointerClick

_onPointerClick(event): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:182

`Private` _onPointerDown

_onPointerDown(event): undefined
Parameters
- event: PointerEvent
Returns undefined
- Defined in src/three/utils/ObjectPicker.ts:157

`Private` _onPointerEnter

_onPointerEnter(_): void
Parameters
- _: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:144

`Private` _onPointerLeave

_onPointerLeave(event): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:133

`Private` _onPointerMove

_onPointerMove(event): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:123

`Private` _onPointerUp

_onPointerUp(event): undefined
Parameters
- event: PointerEvent
Returns undefined
- Defined in src/three/utils/ObjectPicker.ts:167

checkIntersection

checkIntersection(): null | {
    intersect: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>;
    intersects: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>[];
    mouse: Vector2Tuple;
    selectedObject: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
}
Returns null | {
    intersect: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>;
    intersects: Intersection<IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>>[];
    mouse: Vector2Tuple;
    selectedObject: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
}
- Defined in src/three/utils/ObjectPicker.ts:192

dispose

dispose(): void
Returns void
- Defined in src/three/utils/ObjectPicker.ts:69

isHovering

isHovering(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:265

isSelected

isSelected(): boolean
Returns boolean
- Defined in src/three/utils/ObjectPicker.ts:269

updateMouseFromEvent

updateMouseFromEvent(event): void
Parameters
- event: PointerEvent
Returns void
- Defined in src/three/utils/ObjectPicker.ts:151

Class ObjectPicker

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

domElement: HTMLElement

camera: ICamera<ICameraEvent, ICameraEventTypes>

Optional selectionCondition: ((o) => boolean)

Parameters

o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns boolean

Returns ObjectPicker

Properties

Private _camera

Private _firstHit

Private _hovering

Private _mouseDownPos

Private _mouseDownTime

Private _mouseUpTime

Private _root

Private _selected

Private _time

cursorStyles

Type declaration

default: string

down: string

domElement

hoverEnabled

mouse

raycaster

selectionCondition

Type declaration

Parameters

o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns boolean

Static PointerClickMaxDistance

Static PointerClickMaxTime

Accessors

camera

Returns ICamera<ICameraEvent, ICameraEventTypes>

Parameters

value: ICamera<ICameraEvent, ICameraEventTypes>

Returns void

hoverObject

Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

Returns void

isMouseDown

Returns boolean

mouseDownDeltaTime

Returns number

selectedObject

Returns null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

object: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Returns void

time

Returns number

Methods

Private _onPointerCancel

Parameters

_: PointerEvent

Returns void

Private _onPointerClick

Parameters

event: PointerEvent

Returns void

Private _onPointerDown

Parameters

event: PointerEvent

Returns undefined

Private _onPointerEnter

Parameters

`Optional` selectionCondition: ((o) => boolean)

`Private` _camera

`Private` _firstHit

`Private` _hovering

`Private` _mouseDownPos

`Private` _mouseDownTime

`Private` _mouseUpTime

`Private` _root

`Private` _selected

`Private` _time

`Static` PointerClickMaxDistance

`Static` PointerClickMaxTime

`Private` _onPointerCancel

`Private` _onPointerClick

`Private` _onPointerDown

`Private` _onPointerEnter

`Private` _onPointerLeave

`Private` _onPointerMove

`Private` _onPointerUp