Class Hand

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

Hand

Inherited Members

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

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)

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

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.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

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.Component.rigidbody

UnityEngine.Component.rigidbody2D

UnityEngine.Component.camera

UnityEngine.Component.light

UnityEngine.Component.animation

UnityEngine.Component.constantForce

UnityEngine.Component.renderer

UnityEngine.Component.audio

UnityEngine.Component.guiText

UnityEngine.Component.networkView

UnityEngine.Component.guiElement

UnityEngine.Component.guiTexture

UnityEngine.Component.collider

UnityEngine.Component.collider2D

UnityEngine.Component.hingeJoint

UnityEngine.Component.particleEmitter

UnityEngine.Component.particleSystem

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.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.ToString()

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.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType<T>()

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: Valve.VR.InteractionSystem

Assembly: Assembly-CSharp.dll

Syntax

public class Hand : MonoBehaviour

Fields

AngularVelocityMagic

Declaration

protected const float AngularVelocityMagic = 50F

Field Value

Type	Description
System.Single

controllerHoverComponent

Declaration

public string controllerHoverComponent

Field Value

Type	Description
System.String

controllerHoverRadius

Declaration

public float controllerHoverRadius

Field Value

Type	Description
System.Single

defaultAttachmentFlags

Declaration

public const Hand.AttachmentFlags defaultAttachmentFlags = Hand.AttachmentFlags.SnapOnAttach | Hand.AttachmentFlags.DetachOthers | Hand.AttachmentFlags.DetachFromOtherHand | Hand.AttachmentFlags.ParentToHand | Hand.AttachmentFlags.TurnOnKinematic

Field Value

Type	Description
Hand.AttachmentFlags

fingerJointHover

Declaration

public SteamVR_Skeleton_JointIndexEnum fingerJointHover

Field Value

Type	Description
SteamVR_Skeleton_JointIndexEnum

fingerJointHoverRadius

Declaration

public float fingerJointHoverRadius

Field Value

Type	Description
System.Single

grabGripAction

Declaration

public SteamVR_Action_Boolean grabGripAction

Field Value

Type	Description
SteamVR_Action_Boolean

grabPinchAction

Declaration

public SteamVR_Action_Boolean grabPinchAction

Field Value

Type	Description
SteamVR_Action_Boolean

handType

Declaration

public SteamVR_Input_Sources handType

Field Value

Type	Description
SteamVR_Input_Sources

hapticAction

Declaration

public SteamVR_Action_Vibration hapticAction

Field Value

Type	Description
SteamVR_Action_Vibration

hoverhighlightRenderModel

Declaration

protected RenderModel hoverhighlightRenderModel

Field Value

Type	Description
RenderModel

hoverLayerMask

Declaration

public LayerMask hoverLayerMask

Field Value

Type	Description
UnityEngine.LayerMask

hoverSphereRadius

Declaration

public float hoverSphereRadius

Field Value

Type	Description
System.Single

hoverSphereTransform

Declaration

public Transform hoverSphereTransform

Field Value

Type	Description
UnityEngine.Transform

hoverUpdateInterval

Declaration

public float hoverUpdateInterval

Field Value

Type	Description
System.Single

mainRenderModel

Declaration

protected RenderModel mainRenderModel

Field Value

Type	Description
RenderModel

MaxAngularVelocityChange

Declaration

protected const float MaxAngularVelocityChange = 20F

Field Value

Type	Description
System.Single

MaxVelocityChange

Declaration

protected const float MaxVelocityChange = 10F

Field Value

Type	Description
System.Single

noSteamVRFallbackCamera

Declaration

public Camera noSteamVRFallbackCamera

Field Value

Type	Description
UnityEngine.Camera

noSteamVRFallbackMaxDistanceNoItem

Declaration

public float noSteamVRFallbackMaxDistanceNoItem

Field Value

Type	Description
System.Single

noSteamVRFallbackMaxDistanceWithItem

Declaration

public float noSteamVRFallbackMaxDistanceWithItem

Field Value

Type	Description
System.Single

objectAttachmentPoint

Declaration

[Tooltip("A transform on the hand to center attached objects on")]
public Transform objectAttachmentPoint

Field Value

Type	Description
UnityEngine.Transform

otherHand

Declaration

public Hand otherHand

Field Value

Type	Description
Hand

renderModelPrefab

Declaration

public GameObject renderModelPrefab

Field Value

Type	Description
UnityEngine.GameObject

renderModels

Declaration

protected List<RenderModel> renderModels

Field Value

Type	Description
System.Collections.Generic.List<RenderModel>

showDebugInteractables

Declaration

public bool showDebugInteractables

Field Value

Type	Description
System.Boolean

showDebugText

Declaration

public bool showDebugText

Field Value

Type	Description
System.Boolean

spewDebugText

Declaration

public bool spewDebugText

Field Value

Type	Description
System.Boolean

trackedObject

Declaration

public SteamVR_Behaviour_Pose trackedObject

Field Value

Type	Description
SteamVR_Behaviour_Pose

uiInteractAction

Declaration

public SteamVR_Action_Boolean uiInteractAction

Field Value

Type	Description
SteamVR_Action_Boolean

useControllerHoverComponent

Declaration

public bool useControllerHoverComponent

Field Value

Type	Description
System.Boolean

useFingerJointHover

Declaration

public bool useFingerJointHover

Field Value

Type	Description
System.Boolean

useHoverSphere

Declaration

public bool useHoverSphere

Field Value

Type	Description
System.Boolean

VelocityMagic

Declaration

protected const float VelocityMagic = 6000F

Field Value

Type	Description
System.Single

Properties

AttachedObjects

Declaration

public ReadOnlyCollection<Hand.AttachedObject> AttachedObjects { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<Hand.AttachedObject>

currentAttachedObject

Declaration

public GameObject currentAttachedObject { get; }

Property Value

Type	Description
UnityEngine.GameObject

currentAttachedObjectInfo

Declaration

public Hand.AttachedObject? currentAttachedObjectInfo { get; }

Property Value

Type	Description
System.Nullable<Hand.AttachedObject>

hoveringInteractable

Declaration

public Interactable hoveringInteractable { get; set; }

Property Value

Type	Description
Interactable

hoverLocked

Declaration

public bool hoverLocked { get; }

Property Value

Type	Description
System.Boolean

isActive

Declaration

public bool isActive { get; }

Property Value

Type	Description
System.Boolean

isPoseValid

Declaration

public bool isPoseValid { get; }

Property Value

Type	Description
System.Boolean

skeleton

Declaration

public SteamVR_Behaviour_Skeleton skeleton { get; }

Property Value

Type	Description
SteamVR_Behaviour_Skeleton

Methods

AttachObject(GameObject, GrabTypes, Hand.AttachmentFlags, Transform)

Declaration

public void AttachObject(GameObject objectToAttach, GrabTypes grabbedWithType, Hand.AttachmentFlags flags = Hand.AttachmentFlags.SnapOnAttach | Hand.AttachmentFlags.DetachOthers | Hand.AttachmentFlags.DetachFromOtherHand | Hand.AttachmentFlags.ParentToHand | Hand.AttachmentFlags.TurnOnKinematic, Transform attachmentOffset = null)

Parameters

Type	Name	Description
UnityEngine.GameObject	objectToAttach
GrabTypes	grabbedWithType
Hand.AttachmentFlags	flags
UnityEngine.Transform	attachmentOffset

Awake()

Declaration

protected virtual void Awake()

CheckHoveringForTransform(Vector3, Single, ref Single, ref Interactable, Color)

Declaration

protected virtual bool CheckHoveringForTransform(Vector3 hoverPosition, float hoverRadius, ref float closestDistance, ref Interactable closestInteractable, Color debugColor)

Parameters

Type	Name	Description
UnityEngine.Vector3	hoverPosition
System.Single	hoverRadius
System.Single	closestDistance
Interactable	closestInteractable
UnityEngine.Color	debugColor

Returns

Type	Description
System.Boolean

DetachObject(GameObject, Boolean)

Declaration

public void DetachObject(GameObject objectToDetach, bool restoreOriginalParent = true)

Parameters

Type	Name	Description
UnityEngine.GameObject	objectToDetach
System.Boolean	restoreOriginalParent

FixedUpdate()

Declaration

protected virtual void FixedUpdate()

ForceHoverUnlock()

Declaration

public void ForceHoverUnlock()

GetBestGrabbingType()

Declaration

public GrabTypes GetBestGrabbingType()

Returns

Type	Description
GrabTypes

GetBestGrabbingType(GrabTypes, Boolean)

Declaration

public GrabTypes GetBestGrabbingType(GrabTypes preferred, bool forcePreference = false)

Parameters

Type	Name	Description
GrabTypes	preferred
System.Boolean	forcePreference

Returns

Type	Description
GrabTypes

GetDeviceIndex()

Declaration

public int GetDeviceIndex()

Returns

Type	Description
System.Int32

GetEstimatedPeakVelocities(out Vector3, out Vector3)

Declaration

public void GetEstimatedPeakVelocities(out Vector3 velocity, out Vector3 angularVelocity)

Parameters

Type	Name	Description
UnityEngine.Vector3	velocity
UnityEngine.Vector3	angularVelocity

GetGrabEnding(GrabTypes)

Declaration

public GrabTypes GetGrabEnding(GrabTypes explicitType = GrabTypes.None)

Parameters

Type	Name	Description
GrabTypes	explicitType

Returns

Type	Description
GrabTypes

GetGrabStarting(GrabTypes)

Declaration

public GrabTypes GetGrabStarting(GrabTypes explicitType = GrabTypes.None)

Parameters

Type	Name	Description
GrabTypes	explicitType

Returns

Type	Description
GrabTypes

GetTrackedObjectAngularVelocity(Single)

Declaration

public Vector3 GetTrackedObjectAngularVelocity(float timeOffset = 0F)

Parameters

Type	Name	Description
System.Single	timeOffset

Returns

Type	Description
UnityEngine.Vector3

GetTrackedObjectVelocity(Single)

Declaration

public Vector3 GetTrackedObjectVelocity(float timeOffset = 0F)

Parameters

Type	Name	Description
System.Single	timeOffset

Returns

Type	Description
UnityEngine.Vector3

GetUpdatedAttachedVelocities(Hand.AttachedObject, out Vector3, out Vector3)

Declaration

protected bool GetUpdatedAttachedVelocities(Hand.AttachedObject attachedObjectInfo, out Vector3 velocityTarget, out Vector3 angularTarget)

Parameters

Type	Name	Description
Hand.AttachedObject	attachedObjectInfo
UnityEngine.Vector3	velocityTarget
UnityEngine.Vector3	angularTarget

Returns

Type	Description
System.Boolean

HandFollowUpdate()

Declaration

protected virtual void HandFollowUpdate()

HasSkeleton()

Declaration

public bool HasSkeleton()

Returns

Type	Description
System.Boolean

Hide()

Declaration

public void Hide()

HideController(Boolean)

Declaration

public void HideController(bool permanent = false)

Parameters

Type	Name	Description
System.Boolean	permanent

HideGrabHint()

Declaration

public void HideGrabHint()

HideSkeleton(Boolean)

Declaration

public void HideSkeleton(bool permanent = false)

Parameters

Type	Name	Description
System.Boolean	permanent

HoverLock(Interactable)

Declaration

public void HoverLock(Interactable interactable)

Parameters

Type	Name	Description
Interactable	interactable

HoverUnlock(Interactable)

Declaration

public void HoverUnlock(Interactable interactable)

Parameters

Type	Name	Description
Interactable	interactable

IsGrabbingWithOppositeType(GrabTypes)

Declaration

public bool IsGrabbingWithOppositeType(GrabTypes type)

Parameters

Type	Name	Description
GrabTypes	type

Returns

Type	Description
System.Boolean

IsGrabbingWithType(GrabTypes)

Declaration

public bool IsGrabbingWithType(GrabTypes type)

Parameters

Type	Name	Description
GrabTypes	type

Returns

Type	Description
System.Boolean

IsGrabEnding(GameObject)

Declaration

public bool IsGrabEnding(GameObject attachedObject)

Parameters

Type	Name	Description
UnityEngine.GameObject	attachedObject

Returns

Type	Description
System.Boolean

IsStillHovering(Interactable)

Returns true when the hand is currently hovering over the interactable passed in

Declaration

public bool IsStillHovering(Interactable interactable)

Parameters

Type	Name	Description
Interactable	interactable

Returns

Type	Description
System.Boolean

ObjectIsAttached(GameObject)

Declaration

public bool ObjectIsAttached(GameObject go)

Parameters

Type	Name	Description
UnityEngine.GameObject	go

Returns

Type	Description
System.Boolean

OnDestroy()

Declaration

protected virtual void OnDestroy()

OnDisable()

Declaration

protected virtual void OnDisable()

OnDrawGizmos()

Declaration

protected virtual void OnDrawGizmos()

OnEnable()

Declaration

protected virtual void OnEnable()

OnInputFocus(Boolean)

Declaration

protected virtual void OnInputFocus(bool hasFocus)

Parameters

Type	Name	Description
System.Boolean	hasFocus

OnTransformUpdated(SteamVR_Behaviour_Pose, SteamVR_Input_Sources)

Declaration

protected virtual void OnTransformUpdated(SteamVR_Behaviour_Pose updatedPose, SteamVR_Input_Sources updatedSource)

Parameters

Type	Name	Description
SteamVR_Behaviour_Pose	updatedPose
SteamVR_Input_Sources	updatedSource

ResetTemporarySkeletonRangeOfMotion(Single)

Declaration

public void ResetTemporarySkeletonRangeOfMotion(float blendOverSeconds = 0.1F)

Parameters

Type	Name	Description
System.Single	blendOverSeconds

SetAnimationState(Int32)

Declaration

public void SetAnimationState(int stateValue)

Parameters

Type	Name	Description
System.Int32	stateValue

SetHoverRenderModel(RenderModel)

Declaration

public void SetHoverRenderModel(RenderModel hoverRenderModel)

Parameters

Type	Name	Description
RenderModel	hoverRenderModel

SetRenderModel(GameObject)

Declaration

public void SetRenderModel(GameObject prefab)

Parameters

Type	Name	Description
UnityEngine.GameObject	prefab

SetSkeletonRangeOfMotion(EVRSkeletalMotionRange, Single)

Declaration

public void SetSkeletonRangeOfMotion(EVRSkeletalMotionRange newRangeOfMotion, float blendOverSeconds = 0.1F)

Parameters

Type	Name	Description
EVRSkeletalMotionRange	newRangeOfMotion
System.Single	blendOverSeconds

SetTemporarySkeletonRangeOfMotion(SkeletalMotionRangeChange, Single)

Declaration

public void SetTemporarySkeletonRangeOfMotion(SkeletalMotionRangeChange temporaryRangeOfMotionChange, float blendOverSeconds = 0.1F)

Parameters

Type	Name	Description
SkeletalMotionRangeChange	temporaryRangeOfMotionChange
System.Single	blendOverSeconds

SetVisibility(Boolean)

Declaration

public void SetVisibility(bool visible)

Parameters

Type	Name	Description
System.Boolean	visible

Show()

Declaration

public void Show()

ShowController(Boolean)

Declaration

public void ShowController(bool permanent = false)

Parameters

Type	Name	Description
System.Boolean	permanent

ShowGrabHint()

Declaration

public void ShowGrabHint()

ShowGrabHint(String)

Declaration

public void ShowGrabHint(string text)

Parameters

Type	Name	Description
System.String	text

ShowSkeleton(Boolean)

Declaration

public void ShowSkeleton(bool permanent = false)

Parameters

Type	Name	Description
System.Boolean	permanent

Start()

Declaration

protected virtual IEnumerator Start()

Returns

Type	Description
System.Collections.IEnumerator

StopAnimation()

Declaration

public void StopAnimation()

TargetItemPosition(Hand.AttachedObject)

Declaration

protected Vector3 TargetItemPosition(Hand.AttachedObject attachedObject)

Parameters

Type	Name	Description
Hand.AttachedObject	attachedObject

Returns

Type	Description
UnityEngine.Vector3

TargetItemRotation(Hand.AttachedObject)

Declaration

protected Quaternion TargetItemRotation(Hand.AttachedObject attachedObject)

Parameters

Type	Name	Description
Hand.AttachedObject	attachedObject

Returns

Type	Description
UnityEngine.Quaternion

TriggerHapticPulse(Single, Single, Single)

Declaration

public void TriggerHapticPulse(float duration, float frequency, float amplitude)

Parameters

Type	Name	Description
System.Single	duration
System.Single	frequency
System.Single	amplitude

TriggerHapticPulse(UInt16)

Declaration

public void TriggerHapticPulse(ushort microSecondsDuration)

Parameters

Type	Name	Description
System.UInt16	microSecondsDuration

Update()

Declaration

protected virtual void Update()

UpdateAttachedVelocity(Hand.AttachedObject)

Declaration

protected void UpdateAttachedVelocity(Hand.AttachedObject attachedObjectInfo)

Parameters

Type	Name	Description
Hand.AttachedObject	attachedObjectInfo

UpdateHovering()

Declaration

protected virtual void UpdateHovering()

UpdateNoSteamVRFallback()

Declaration

protected virtual void UpdateNoSteamVRFallback()