UxrFingerTip Class

Component that, added to the tip of an UxrAvatar finger, allows it to interact with user interfaces. It is normally added only to the index fingers so that other fingers don’t generate unwanted interactions, but it can be added to any finger.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrFingerTip)
              UltimateXR.Core.Components.Composite.UxrAvatarComponent(UxrFingerTip)
                UltimateXR.UI.UxrFingerTip
Namespace: UltimateXR.UI
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public class UxrFingerTip : UxrAvatarComponent<UxrFingerTip>


The UxrFingerTip type exposes the following members.

Constructors

NameDescription
Public methodUxrFingerTip

Properties

NameDescription
Public propertyHandGrabber Gets the UxrGrabber component of the hand the finger tip belongs to.
Public propertyIsHandGrabbing Gets whether the UxrGrabber component belonging to the same hand the finger tip is, is currently grabbing something.
Public propertySide Gets the hand the finger tip belongs to.
Public propertyWorldDir Gets the current world direction. The direction points in the direction the finger would be pointing. It is used to filter out interactions where the forward vector is not perpendicular enough to the UI to interact with it.
Public propertyWorldPos Gets the current world position.
Public propertyWorldSpeed Gets the current world speed the finger tip is travelling at.

Methods

NameDescription
Protected methodAwake Initializes the component. (Overrides UxrAvatarComponent<T>.Awake().)
Public methodIsInside Checks whether the finger tip is inside a box collider.
Protected methodOnEnable Resets the internal state. (Overrides UxrComponent<T>.OnEnable().)
Protected methodStart Initializes the component. (Overrides UxrComponent.Start().)

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 Namespace