UxrFingerPointingVolume Class
Component that describes a box volume where any UxrAvatar hand that gets inside automatically adopts a finger pointing pose. This is useful to place in front of UI screens or where precise finger pressing interaction is required.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
UltimateXR.Core.Components.UxrComponent
UltimateXR.Core.Components.UxrComponent(UxrFingerPointingVolume)
UltimateXR.Avatar.Controllers.UxrFingerPointingVolume
Namespace: UltimateXR.Avatar.Controllers
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
[RequireComponent(typeof(BoxCollider))]
public class UxrFingerPointingVolume : UxrComponent<UxrFingerPointingVolume>
The UxrFingerPointingVolume type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | UxrFingerPointingVolume |
Properties
Name | Description | |
---|---|---|
![]() | Box | Gets the BoxCollider component describing the enclosed space where to adopt the finger pointing pose. |
![]() | UseLeftHand | Gets or sets whether the left hand should adopt the pose when inside. |
![]() | UseRightHand | Gets or sets whether the right hand should adopt the pose when inside. |
Methods
Name | Description | |
---|---|---|
![]() | IsCompatible | Checks if the volume is compatible with the given hand. This allows some volumes to work for the left or right hand only. |
![]() | IsPointInside | Checks if a point is inside the BoxCollider attached to the GameObject this component is attached to. |
Extension Methods
Name | Description | |
---|---|---|
![]() | CheckSetEnabled | Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.) |
![]() | GetOrAddComponent<T> | Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.) |
![]() | GetPathUnderScene | Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.) |
![]() | GetSceneUid | Gets an unique identifier string for the given component. (Defined by ComponentExt.) |
![]() | GetUniqueScenePath | 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.) |
![]() | LoopCoroutine | Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.) |
![]() | SafeGetComponentInParent<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.) |
![]() | ShowInInspector(Boolean) | Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.) |
![]() | ShowInInspector(Boolean, Boolean) | Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.) |
![]() | ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |
Remarks
The finger pointing pose should only be adopted if it doesn’t interfere with any other interaction, such as the grab pose while grabbing an object inside the volume.