Class HVRJointHand

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRJointHand
Inherited Members
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopAllCoroutines()
UnityEngine.MonoBehaviour.print(System.Object)
UnityEngine.MonoBehaviour.useGUILayout
UnityEngine.MonoBehaviour.runInEditMode
UnityEngine.Behaviour.enabled
UnityEngine.Behaviour.isActiveAndEnabled
UnityEngine.Component.GetComponent(System.Type)
UnityEngine.Component.GetComponent<T>()
UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)
UnityEngine.Component.TryGetComponent<T>(T)
UnityEngine.Component.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInChildren<T>()
UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentInParent(System.Type)
UnityEngine.Component.GetComponentInParent<T>()
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentsInParent(System.Type)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponentsInParent<T>()
UnityEngine.Component.GetComponents(System.Type)
UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
UnityEngine.Component.GetComponents<T>()
UnityEngine.Component.CompareTag(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
UnityEngine.Component.SendMessageUpwards(System.String)
UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
UnityEngine.Component.BroadcastMessage(System.String, System.Object)
UnityEngine.Component.BroadcastMessage(System.String)
UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
UnityEngine.Component.transform
UnityEngine.Component.gameObject
UnityEngine.Component.tag
UnityEngine.Object.GetInstanceID()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
UnityEngine.Object.Destroy(UnityEngine.Object)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
UnityEngine.Object.FindObjectsOfType(System.Type)
UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.ToString()
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: HurricaneVR.Framework.Core.Player
Assembly: HurricaneVR.Framework.dll
Syntax
[RequireComponent(typeof(Rigidbody))]
public class HVRJointHand : MonoBehaviour

Fields

| Improve this Doc View Source

Anchor

Optional anchor point to test distance to the hand, could the shoulder of an arm or full body avatar. Works in tandem with the ArmLength field to limit the distance of the hand.

Declaration
[Header("Arm Limit")]
[Tooltip("Optional 'Shoulder', if populated the hand and it's object will snap back based on the MaxDistanceBehaviour assigned.")]
public Transform Anchor
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

ArmLength

Max distance allowed from the Anchor point if supplied.

Declaration
[Tooltip("Max allowed length from the Anchor to the hand.")]
public float ArmLength
Field Value
Type Description
System.Single
| Improve this Doc View Source

IsReturningToController

Declaration
[Header("Debug")]
public bool IsReturningToController
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

JointSettings

Default hand strength settings.

Declaration
[Header("Settings")]
[Tooltip("Default hand strength settings.")]
public HVRJointSettings JointSettings
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

MaxDistanceBehaviour

Defines the action taken after max distance from the controller is exceeeded.

Declaration
[Tooltip("Behaviour when arm length is exceeded, or distance from the hand to the controller is exceeded.")]
public MaxDistanceBehaviour MaxDistanceBehaviour
Field Value
Type Description
MaxDistanceBehaviour
| Improve this Doc View Source

MaxDistanceReached

Invoked once the max distance is reached from the controller target.

Declaration
[Header("Events")]
public UnityEvent MaxDistanceReached
Field Value
Type Description
UnityEngine.Events.UnityEvent
| Improve this Doc View Source

MaxTargetDistance

The max distance the hand is allowed to stray from it's target.

Declaration
[FormerlySerializedAs("MaxDistance")]
[Tooltip("Max distance between the hand and the controller target.")]
public float MaxTargetDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

ParentRigidBody

Kinematic rigidbody that will hold the joint for stability.

Declaration
public Rigidbody ParentRigidBody
Field Value
Type Description
UnityEngine.Rigidbody
| Improve this Doc View Source

ReturnedToController

If the max distance behaviour in effect is not a HandSweep, this will invoke after the hand has returned to the controller.

Declaration
public UnityEvent ReturnedToController
Field Value
Type Description
UnityEngine.Events.UnityEvent
| Improve this Doc View Source

ReturnSpeed

The speed at which the hand returns to the controller when the MaxDistanceBehaviour is not set to HandSweep

Declaration
[Tooltip("Speed at which the hand returns to the controller when the max limit is breached, does not work in HandSweep mode.")]
public float ReturnSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

SolverIterations

Declaration
[Tooltip("Physx constraint iterations")]
public int SolverIterations
Field Value
Type Description
System.Int32
| Improve this Doc View Source

SolverVelocityIterations

Declaration
[Tooltip("Physx constraint iterations")]
public int SolverVelocityIterations
Field Value
Type Description
System.Int32
| Improve this Doc View Source

StrengthHandler

This component manages the strength overrides that come from grabbable override fields.

Declaration
public HVRHandStrengthHandler StrengthHandler
Field Value
Type Description
HVRHandStrengthHandler
| Improve this Doc View Source

Target

This hand will chase after the supplied transform, usually set to the offset child of the tracked device transform.

Declaration
[Header("Components")]
[Tooltip("Target transform for position and rotation tracking")]
public Transform Target
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

Teleporter

Referenced to keep track of a recent teleport to prevent the Max Distance behaviour from executing after a teleport.

Declaration
public HVRTeleporter Teleporter
Field Value
Type Description
HVRTeleporter

Properties

| Improve this Doc View Source

Grabber

Declaration
public HVRHandGrabber Grabber { get; }
Property Value
Type Description
HVRHandGrabber
| Improve this Doc View Source

Joint

Declaration
public ConfigurableJoint Joint { get; set; }
Property Value
Type Description
UnityEngine.ConfigurableJoint
| Improve this Doc View Source

RigidBody

Declaration
public Rigidbody RigidBody { get; }
Property Value
Type Description
UnityEngine.Rigidbody

Methods

| Improve this Doc View Source

Awake()

Declaration
protected virtual void Awake()
| Improve this Doc View Source

Disable()

Declaration
public void Disable()
| Improve this Doc View Source

Enable()

Declaration
public void Enable()
| Improve this Doc View Source

FixedUpdate()

Declaration
protected virtual void FixedUpdate()
| Improve this Doc View Source

GetBehaviour()

Declaration
protected MaxDistanceBehaviour GetBehaviour()
Returns
Type Description
MaxDistanceBehaviour
| Improve this Doc View Source

OnEnable()

Declaration
protected virtual void OnEnable()
| Improve this Doc View Source

OnMaxDistanceReached()

Declaration
protected virtual void OnMaxDistanceReached()
| Improve this Doc View Source

OnReturned()

Declaration
protected virtual void OnReturned()
| Improve this Doc View Source

SetupJoint()

Declaration
public virtual void SetupJoint()
| Improve this Doc View Source

Start()

Declaration
protected virtual void Start()
| Improve this Doc View Source

StopHandsRoutine()

Declaration
protected virtual IEnumerator StopHandsRoutine()
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

UpdateDistanceCheck()

Declaration
protected virtual void UpdateDistanceCheck()
| Improve this Doc View Source

UpdateTargetVelocity()

Declaration
public virtual void UpdateTargetVelocity()

Extension Methods