Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

  • 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

Properties

eventSearch playground for event

Defines the related dom event

localPositionSearch playground for localPosition

localPosition: Vector2

Defines the local position of the pointer on the canvas.

nearInteractionPickingInfoSearch playground for nearInteractionPickingInfo

nearInteractionPickingInfo: Nullable<PickingInfo>

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

raySearch playground for ray

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

skipOnPointerObservableSearch playground for skipOnPointerObservable

skipOnPointerObservable: boolean

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

typeSearch playground for type

type: number

Defines the type of event (PointerEventTypes)

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method