Class ExtendedPointerEventData

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

Inheritance
object
AbstractEventData
BaseEventData
PointerEventData
ExtendedPointerEventData
Inherited Members
PointerEventData.pointerEnter
PointerEventData.lastPress
PointerEventData.rawPointerPress
PointerEventData.pointerDrag
PointerEventData.pointerCurrentRaycast
PointerEventData.pointerPressRaycast
PointerEventData.hovered
PointerEventData.eligibleForClick
PointerEventData.pointerId
PointerEventData.position
PointerEventData.delta
PointerEventData.pressPosition
PointerEventData.clickTime
PointerEventData.clickCount
PointerEventData.scrollDelta
PointerEventData.useDragThreshold
PointerEventData.dragging
PointerEventData.button
PointerEventData.IsPointerMoving()
PointerEventData.IsScrolling()
PointerEventData.enterEventCamera
PointerEventData.pressEventCamera
PointerEventData.pointerPress
BaseEventData.currentInputModule
BaseEventData.selectedObject
AbstractEventData.m_Used
AbstractEventData.Reset()
AbstractEventData.Use()
AbstractEventData.used
Namespace: UnityEngine.InputSystem.UI
Assembly: Unity.InputSystem.dll
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
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

The InputDevice that generated the pointer input.

Declaration
public InputDevice device { get; set; }
Property Value
Type Description
InputDevice
See Also

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
int
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

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

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

uiToolkitPointerId

Declaration
public int uiToolkitPointerId { get; set; }
Property Value
Type Description
int

Methods

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
UnityEngine.EventSystems.PointerEventData.ToString()