Class: ObjectPicker
Interaction.ObjectPicker
Hierarchy
SimpleEventDispatcher<"hoverObjectChanged"|"selectedObjectChanged"|"hitObject">↳
ObjectPicker
Properties
PointerClickMaxTime
▪ Static PointerClickMaxTime: number = 200
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:18
PointerClickMaxDistance
▪ Static PointerClickMaxDistance: number = 0.1
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:19
hoverEnabled
• hoverEnabled: boolean = false
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:17
selectionCondition
• selectionCondition: (o: Object3D<Event, string>) => boolean
Type declaration
▸ (o): boolean
Parameters
| Name | Type |
|---|---|
o | Object3D<Event, string> |
Returns
boolean
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:27
raycaster
• raycaster: Raycaster
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:28
mouse
• mouse: Vector2
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:29
cursorStyles
• cursorStyles: Object
Type declaration
| Name | Type |
|---|---|
default | string |
down | string |
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:32
domElement
• domElement: HTMLElement
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:33
Accessors
scene
• get scene(): IScene<any, ICamera<ICameraOptions, any, any>>
Returns
IScene<any, ICamera<ICameraOptions, any, any>>
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:7
• set scene(value): void
Parameters
| Name | Type |
|---|---|
value | IScene<any, ICamera<ICameraOptions, any, any>> |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:11
camera
• get camera(): undefined | ICamera<ICameraOptions, any, any>
Returns
undefined | ICamera<ICameraOptions, any, any>
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:84
• set camera(value): void
Parameters
| Name | Type |
|---|---|
value | undefined | ICamera<ICameraOptions, any, any> |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:88
selectedObject
• get selectedObject(): null | Object3D<Event, string>
Returns
null | Object3D<Event, string>
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:93
• set selectedObject(object): void
Parameters
| Name | Type |
|---|---|
object | null | Object3D<Event, string> |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:100
hoverObject
• get hoverObject(): null | Object3D<Event, string> | Object3D<Event, string>[]
Returns
null | Object3D<Event, string> | Object3D<Event, string>[]
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:107
• set hoverObject(object): void
Parameters
| Name | Type |
|---|---|
object | null | Object3D<Event, string> | Object3D<Event, string>[] |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:114
time
• get time(): number
Returns
number
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:120
isMouseDown
• get isMouseDown(): boolean
Returns
boolean
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:125
mouseDownDeltaTime
• get mouseDownDeltaTime(): number
Returns
number
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:129
Constructors
constructor
• new ObjectPicker(scene, domElement, camera?, selectionCondition?)
Parameters
| Name | Type |
|---|---|
scene | IScene<any, ICamera<ICameraOptions, any, any>> |
domElement | HTMLElement |
camera? | ICamera<ICameraOptions, any, any> |
selectionCondition? | (o: Object3D<Event, string>) => boolean |
Overrides
SimpleEventDispatcher<'hoverObjectChanged'|'selectedObjectChanged'|'hitObject'\>.constructor
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:37
Methods
onPointerMove
▸ onPointerMove(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:133
onPointerLeave
▸ onPointerLeave(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:143
onPointerEnter
▸ onPointerEnter(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:154
onPointerCancel
▸ onPointerCancel(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:157
updateMouseFromEvent
▸ updateMouseFromEvent(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:161
onPointerDown
▸ onPointerDown(event): undefined
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
undefined
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:167
onDoubleClick
▸ onDoubleClick(event): undefined
Parameters
| Name | Type |
|---|---|
event | MouseEvent |
Returns
undefined
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:177
onPointerUp
▸ onPointerUp(event): undefined
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
undefined
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:184
onPointerClick
▸ onPointerClick(event): void
Parameters
| Name | Type |
|---|---|
event | PointerEvent |
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:200
addPasses
▸ addPasses(): void
Returns
void
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:211
checkIntersection
▸ checkIntersection(): null | { selectedObject: Object3D<Event, string> ; intersect: Intersection<Object3D<Event, string>> ; intersects: Intersection<Object3D<Event, string>>[] ; mouse: Vector2Tuple }
Returns
null | { selectedObject: Object3D<Event, string> ; intersect: Intersection<Object3D<Event, string>> ; intersects: Intersection<Object3D<Event, string>>[] ; mouse: Vector2Tuple }
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:239
isHovering
▸ isHovering(): boolean
Returns
boolean
Defined in
webgi/src/extras/interaction/ObjectPicker.ts:322
isSelected
▸ isSelected(): boolean
Returns
boolean