Skip to main content

Class: ObjectPicker

Interaction.ObjectPicker

Hierarchy​

  • SimpleEventDispatcher<"hoverObjectChanged" | "selectedObjectChanged" | "hitObject">

    ↳ ObjectPicker

Properties​

PointerClickMaxTime​

▪ Static PointerClickMaxTime: number = 200

PointerClickMaxDistance​

▪ Static PointerClickMaxDistance: number = 0.1

hoverEnabled​

• hoverEnabled: boolean = false

selectionCondition​

• selectionCondition: (o: Object3D<Object3DEventMap>) => boolean

Type declaration​

▸ (o): boolean

Parameters​
NameType
oObject3D<Object3DEventMap>
Returns​

boolean

raycaster​

• raycaster: Raycaster

mouse​

• mouse: Vector2

cursorStyles​

• cursorStyles: Object

Type declaration​

NameType
defaultstring
downstring

domElement​

• domElement: HTMLElement

Accessors​

scene​

• get scene(): IScene<any, ICamera<ICameraOptions, any, any>, ISceneEventMap>

Returns​

IScene<any, ICamera<ICameraOptions, any, any>, ISceneEventMap>

• set scene(value): void

Parameters​

NameType
valueIScene<any, ICamera<ICameraOptions, any, any>, ISceneEventMap>

Returns​

void

camera​

• get camera(): undefined | ICamera<ICameraOptions, any, any>

Returns​

undefined | ICamera<ICameraOptions, any, any>

• set camera(value): void

Parameters​

NameType
valueundefined | ICamera<ICameraOptions, any, any>

Returns​

void

selectedObject​

• get selectedObject(): null | Object3D<Object3DEventMap>

Returns​

null | Object3D<Object3DEventMap>

• set selectedObject(object): void

Parameters​

NameType
objectnull | Object3D<Object3DEventMap>

Returns​

void

hoverObject​

• get hoverObject(): null | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

Returns​

null | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

• set hoverObject(object): void

Parameters​

NameType
objectnull | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

Returns​

void

time​

• get time(): number

Returns​

number

isMouseDown​

• get isMouseDown(): boolean

Returns​

boolean

mouseDownDeltaTime​

• get mouseDownDeltaTime(): number

Returns​

number

Constructors​

constructor​

• new ObjectPicker(scene, domElement, camera?, selectionCondition?)

Parameters​

NameType
sceneIScene<any, ICamera<ICameraOptions, any, any>, ISceneEventMap>
domElementHTMLElement
camera?ICamera<ICameraOptions, any, any>
selectionCondition?(o: Object3D<Object3DEventMap>) => boolean

Overrides​

SimpleEventDispatcher<'hoverObjectChanged'|'selectedObjectChanged'|'hitObject'\>.constructor

Methods​

onPointerMove​

▸ onPointerMove(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

onPointerLeave​

▸ onPointerLeave(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

onPointerEnter​

▸ onPointerEnter(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

onPointerCancel​

▸ onPointerCancel(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

updateMouseFromEvent​

▸ updateMouseFromEvent(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

onPointerDown​

▸ onPointerDown(event): undefined

Parameters​

NameType
eventPointerEvent

Returns​

undefined

onDoubleClick​

▸ onDoubleClick(event): undefined

Parameters​

NameType
eventMouseEvent

Returns​

undefined

onPointerUp​

▸ onPointerUp(event): undefined

Parameters​

NameType
eventPointerEvent

Returns​

undefined

onPointerClick​

▸ onPointerClick(event): void

Parameters​

NameType
eventPointerEvent

Returns​

void

addPasses​

▸ addPasses(): void

Returns​

void

checkIntersection​

▸ checkIntersection(): null | { selectedObject: Object3D<Object3DEventMap> ; intersect: Intersection<Object3D<Object3DEventMap>> ; intersects: Intersection<Object3D<Object3DEventMap>>[] ; mouse: Vector2Tuple }

Returns​

null | { selectedObject: Object3D<Object3DEventMap> ; intersect: Intersection<Object3D<Object3DEventMap>> ; intersects: Intersection<Object3D<Object3DEventMap>>[] ; mouse: Vector2Tuple }

isHovering​

▸ isHovering(): boolean

Returns​

boolean

isSelected​

▸ isSelected(): boolean

Returns​

boolean