UxrFingerTipRaycaster Class

Raycaster compatible with Unity UI to use UxrFingerTip components on canvases, enabling touch interaction.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UIBehaviour
            BaseRaycaster
              GraphicRaycaster
                UltimateXR.UI.UnityInputModule.UxrFingerTipRaycaster
Namespace: UltimateXR.UI.UnityInputModule
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

[RequireComponent(typeof(Canvas))]
public class UxrFingerTipRaycaster : GraphicRaycaster


The UxrFingerTipRaycaster type exposes the following members.

Constructors

NameDescription
Public methodUxrFingerTipRaycaster

Properties

NameDescription
Public propertyFingerTipMinHoverDistance Gets or sets the maximum distance a UxrFingerTip can have to a canvas in order to generate hovering events.

Methods

NameDescription
Public methodRaycast (Overrides GraphicRaycaster.Raycast(PointerEventData, List(RaycastResult)).)

Fields

NameDescription
Public fieldStatic memberFingerTipMaxAllowedTipAngle Default maximum angle between the finger and the canvas for a UxrFingerTip component to generate input events.
Public fieldStatic memberFingerTipMinHoverDistanceDefault Default maximum distance a UxrFingerTip can have to a canvas in order to start generating hovering events.

Extension Methods

NameDescription
Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<T> Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.UI.UnityInputModule Namespace