Class PointerEventData

This pointer event data object is passed to all event receivers that are currently active
It contains hit information if an object was hovered or clicked
If the event is received in onPointerDown or onPointerMove, you can call setPointerCapture to receive onPointerMove events even when the pointer has left the object until you call releasePointerCapture or when the pointerUp event happens
You can get additional information about the event or event source via the event property (of type NEPointerEvent)

Implements

  • IInputEventArgs

Constructors

constructor

Properties

button distance? event face? inputSource instanceId? intersection? normal? object point?

Accessors

deviceIndex mode pointerId pressure propagationStopped used

Methods

StopPropagation Use clone releasePointerCapture setPointerCapture stopImmediatePropagation stopPropagation use

Constructors

constructor

Properties

Readonly button

button: number

mouse button 0 === LEFT, 1 === MIDDLE, 2 === RIGHT

Optional distance

distance?: number

The distance of the hit point from the origin

Readonly event

event: NEPointerEvent

the original event

Optional face

face?: any

inputSource

inputSource: any

Who initiated this event

Optional instanceId

instanceId?: number

The instance ID of an object hit by a raycast (if a instanced object was hit)

Optional intersection

intersection?: Intersection

The three intersection

Optional normal

normal?: Vector3

The object-space normal of this event

object

object: Object3D

The object this event hit or interacted with

Optional point

point?: Vector3

The world position of this event

Accessors

deviceIndex

  • get deviceIndex(): number

  • the index of the used device
    mouse and touch are always 0, controller is the gamepad index or XRController index

    Returns number

mode

  • get mode(): any

  • Returns the input target ray mode e.g. "screen" for 2D mouse and touch events

    Returns any

pointerId

  • get pointerId(): number

  • a combination of the pointerId + button to uniquely identify the exact input (e.g. LeftController:Button0 = 0, RightController:Button1 = 101)

    Returns number

pressure

  • get pressure(): number

  • Returns number

propagationStopped

  • get propagationStopped(): boolean

  • Returns boolean

used

  • get used(): boolean

  • Returns boolean

    true when use() has been called. Default: false

Methods

StopPropagation

  • StopPropagation(): void

  • Returns void

    Deprecated

    use stopPropagation()

Use

  • Use(): void

  • Returns void

    Deprecated

    use use()

clone

releasePointerCapture

  • releasePointerCapture(): void

  • call this method in onPointerDown or onPointerMove to stop receiving onPointerMove events

    Returns void

setPointerCapture

  • setPointerCapture(): void

  • Call this method in onPointerDown or onPointerMove to receive onPointerMove events for this pointerId even when the pointer has left the object until you call releasePointerCapture or when the pointerUp event happens

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Call this method to stop immediate propagation on the event object.

    Returns void

stopPropagation

  • stopPropagation(): void

  • Call this method to stop immediate propagation on the event object.
    WARNING: this is currently equivalent to stopImmediatePropagation

    Returns void

use

  • use(): void

  • mark this event to be used

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorbuttondistanceeventfaceinputSourceinstanceIdintersectionnormalobjectpointdeviceIndexmodepointerIdpressurepropagationStoppedusedStopPropagationUseclonereleasePointerCapturesetPointerCapturestopImmediatePropagationstopPropagationuse

Generated using TypeDoc