UxrPointerEventData Class

Event data class that adds information required by UxrPointerInputModule to facilitate the processing of UI interaction events.

Inheritance Hierarchy

System.Object
  AbstractEventData
    BaseEventData
      PointerEventData
        UltimateXR.UI.UnityInputModule.UxrPointerEventData
Namespace: UltimateXR.UI.UnityInputModule
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrPointerEventData : PointerEventData


The UxrPointerEventData type exposes the following members.

Constructors

NameDescription
Public methodUxrPointerEventData(EventSystem, UxrFingerTip) Constructor.
Public methodUxrPointerEventData(EventSystem, UxrLaserPointer) Constructor.

Properties

NameDescription
Public propertyAvatar Gets the UxrAvatar responsible for the interaction.
Public propertyFingerTip Gets the finger tip if this event is being processed by one. Null if not.
Public propertyGameObject2D Gets the gameObject if the raycast element is an object with a 2D collider.
Public propertyGameObject3D Gets the gameObject if the raycast element is an object with a 3D collider.
Public propertyGameObjectClicked Gets the GameObject that was clicked, if there was one.
Public propertyHandSide Gets the hand responsible for the interaction.
Public propertyHasData Gets whether the event data contains valid information.
Public propertyIgnoredGameObject Gets the UI gameObject that was ignored because it could not be interacted with.
Public propertyIsInteractive Gets whether the current raycast UI element is interactive.
Public propertyIsNonUI Gets whether the current raycast UI element is not a UI GameObject. This happens when the raycast is valid and the object has either a 2D or 3D collider.
Public propertyLaserPointer Gets the laser pointer if this event is being processed by one. Null if not.
Public propertyPressedThisFrame Gets whether the pointer is pressing this frame.
Public propertyPreviousWorldPos Gets the pointer world position during the last frame.
Public propertyReleasedThisFrame Gets whether the pointer is pressing this frame.
Public propertySpeed Gets the current cursor speed.
Public propertyWorldPos Gets the current pointer world position.
Public propertyWorldPosInitialized Gets whether the world position has been initialized.

Extension Methods

NameDescription
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.UI.UnityInputModule Namespace