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

Index

Constructors

Properties

Constructors

constructor

Find examples in Playground
  • new PointerInfoPre(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number): PointerInfoPre

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

    Parameters

    • type: number

      Defines the type of event (PointerEventTypes)

    • event: PointerEvent | MouseWheelEvent

      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

Properties

event

Find examples in Playground
event: PointerEvent | MouseWheelEvent

Defines the related dom event

localPosition

Find examples in Playground
localPosition: Vector2

Defines the local position of the pointer on the canvas.

ray

Find examples in Playground
ray: Nullable<Ray>

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

skipOnPointerObservable

Find examples in Playground
skipOnPointerObservable: boolean

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

type

Find examples in Playground
type: number

Defines the type of event (PointerEventTypes)

Generated using TypeDoc