Class ExtendedPointerEventData

An extension to PointerEventData which makes additional data about the input event available.

Inheritance

Object

UnityEngine.EventSystems.AbstractEventData

UnityEngine.EventSystems.BaseEventData

UnityEngine.EventSystems.PointerEventData

ExtendedPointerEventData

Inherited Members

UnityEngine.EventSystems.PointerEventData.hovered

UnityEngine.EventSystems.PointerEventData.IsPointerMoving()

UnityEngine.EventSystems.PointerEventData.IsScrolling()

UnityEngine.EventSystems.PointerEventData.pointerEnter

UnityEngine.EventSystems.PointerEventData.lastPress

UnityEngine.EventSystems.PointerEventData.rawPointerPress

UnityEngine.EventSystems.PointerEventData.pointerDrag

UnityEngine.EventSystems.PointerEventData.pointerCurrentRaycast

UnityEngine.EventSystems.PointerEventData.pointerPressRaycast

UnityEngine.EventSystems.PointerEventData.eligibleForClick

UnityEngine.EventSystems.PointerEventData.pointerId

UnityEngine.EventSystems.PointerEventData.position

UnityEngine.EventSystems.PointerEventData.delta

UnityEngine.EventSystems.PointerEventData.pressPosition

UnityEngine.EventSystems.PointerEventData.clickTime

UnityEngine.EventSystems.PointerEventData.clickCount

UnityEngine.EventSystems.PointerEventData.scrollDelta

UnityEngine.EventSystems.PointerEventData.useDragThreshold

UnityEngine.EventSystems.PointerEventData.dragging

UnityEngine.EventSystems.PointerEventData.button

UnityEngine.EventSystems.PointerEventData.enterEventCamera

UnityEngine.EventSystems.PointerEventData.pressEventCamera

UnityEngine.EventSystems.PointerEventData.pointerPress

UnityEngine.EventSystems.BaseEventData.currentInputModule

UnityEngine.EventSystems.BaseEventData.selectedObject

UnityEngine.EventSystems.AbstractEventData.m_Used

UnityEngine.EventSystems.AbstractEventData.Reset()

UnityEngine.EventSystems.AbstractEventData.Use()

UnityEngine.EventSystems.AbstractEventData.used

Namespace: UnityEngine.InputSystem.UI

Syntax

public class ExtendedPointerEventData : PointerEventData

Remarks

Instances of this class are sent instead of UnityEngine.EventSystems.PointerEventData by InputSystemUIInputModule for all pointer-type input.

The UnityEngine.EventSystems.PointerEventData.pointerId property will generally correspond to the deviceId of device. An exception to this are touches as each Touchscreen may generate several pointers (one for each active finger).

Constructors

ExtendedPointerEventData(EventSystem)

Declaration

public ExtendedPointerEventData(EventSystem eventSystem)

Parameters

Type	Name	Description
UnityEngine.EventSystems.EventSystem	eventSystem

Properties

control

The InputControl that generated the pointer input. The device associated with this control should be the same as this event's device.

Declaration

public InputControl control { get; set; }

Property Value

Type	Description
InputControl

See Also

device

device

The InputDevice that generated the pointer input.

Declaration

public InputDevice device { get; set; }

Property Value

Type	Description
InputDevice

See Also

Pointer

Touchscreen

Mouse

Pen

pointerType

Type of pointer that generated the input.

Declaration

public UIPointerType pointerType { get; set; }

Property Value

Type	Description
UIPointerType

touchId

For Touch type pointer input, this is the touch ID as reported by the Touchscreen device.

Declaration

public int touchId { get; set; }

Property Value

Type	Description
Int32

Remarks

For pointer input that is not coming from touch, this will be 0 (which is not considered a valid touch ID by the input system).

Note that for touch input, UnityEngine.EventSystems.PointerEventData.pointerId will be a combination of the device ID of device and the touch ID to generate a unique pointer ID even if there are multiple touchscreens.

See Also

touchId

trackedDeviceOrientation

For Tracked type pointer input, this is the world-space orientation of the TrackedDevice.

Declaration

public Quaternion trackedDeviceOrientation { get; set; }

Property Value

Type	Description
Quaternion

See Also

trackedDeviceOrientation

trackedDevicePosition

For Tracked type pointer input, this is the world-space position of the TrackedDevice.

Declaration

public Vector3 trackedDevicePosition { get; set; }

Property Value

Type	Description
Vector3

See Also

trackedDevicePosition

uiToolkitPointerId

Declaration

public int uiToolkitPointerId { get; set; }

Property Value

Type	Description
Int32

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

UnityEngine.EventSystems.PointerEventData.ToString()