API
API|
@babylonjs/core|
PointerInfoPre

Class PointerInfoPre

This class is used to store pointer related info for the onPrePointerObservable event. Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable

Hierarchy (View Summary)

Index
constructor
event localPosition nearInteractionPickingInfo originalPickingInfo ray skipOnPointerObservable type

  • Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.

    Parameters

    • type: number

      Defines the type of event (PointerEventTypes)

    • event: IMouseEvent

      Defines the related dom event

    • localX: number

      Defines the local x coordinates of the pointer when the event occured

    • localY: number

      Defines the local y coordinates of the pointer when the event occured

    Returns PointerInfoPre

event: IMouseEvent

Defines the related dom event

localPosition: Vector2

Defines the local position of the pointer on the canvas.

nearInteractionPickingInfo: Nullable<PickingInfo>

Defines picking info coming from a near interaction (proximity instead of ray-based picking)

originalPickingInfo: Nullable<PickingInfo> = null

The original picking info that was used to trigger the pointer event

ray: Nullable<Ray> = null

Ray from a pointer if available (eg. 6dof controller)

skipOnPointerObservable: boolean

Defines whether the engine should skip the next OnPointerObservable associated to this pre.

type: number

Defines the type of event (PointerEventTypes)