Class HVRHandGrabber

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRGrabberBase
HVRHandGrabber
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.Grabbers
Assembly: HurricaneVR.Framework.dll
Syntax
public class HVRHandGrabber : HVRGrabberBase

Fields

| Improve this Doc View Source

AllowMultiplayerSwap

Declaration
[Tooltip("If in a networked game, can someone take this an object from your hand?")]
public bool AllowMultiplayerSwap
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ApplyHandLayer

Declaration
[Tooltip("If true the default hand layer will be applied to this object on start")]
public bool ApplyHandLayer
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

BreakDistanceReached

Declaration
[Tooltip("Invoked when the hand and object are too far apart")]
public VRHandGrabberEvent BreakDistanceReached
Field Value
Type Description
VRHandGrabberEvent
| Improve this Doc View Source

CloneHandModel

Declaration
[Tooltip("If true the hand model will be cloned for collision use, and colliders removed off the original hand. This will preventunwanted center of mass and inertia tensor recalculations on grabbable objects due to hand model parenting.")]
public bool CloneHandModel
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CollisionHandler

Declaration
public HVRTeleportCollisonHandler CollisionHandler
Field Value
Type Description
HVRTeleportCollisonHandler
| Improve this Doc View Source

ControllerOffset

Declaration
public HVRControllerOffset ControllerOffset
Field Value
Type Description
HVRControllerOffset
| Improve this Doc View Source

CountPeakVelocities

Declaration
[DrawIf("TakePeakVelocities", true, DrawIfAttribute.DisablingType.DontDraw)]
public int CountPeakVelocities
Field Value
Type Description
System.Int32
| Improve this Doc View Source

DrawCenterOfMass

Declaration
[Header("Debugging")]
[Tooltip("If enabled displays vectors involved in throwing calculation.")]
public bool DrawCenterOfMass
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DynamicGrabPalmAdjust

Declaration
[Tooltip("When dynamic grabbing the palm faces closest point on the collider surface before closing the fingers.")]
public bool DynamicGrabPalmAdjust
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DynamicPoseIndicator

Declaration
public HVRGrabbableHoverBase DynamicPoseIndicator
Field Value
Type Description
HVRGrabbableHoverBase
| Improve this Doc View Source

DynamicPoseIndicatorMode

Declaration
public DynamicPoseGrabIndicator DynamicPoseIndicatorMode
Field Value
Type Description
DynamicPoseGrabIndicator
| Improve this Doc View Source

FallbackPoser

Declaration
[Tooltip("Default hand pose to fall back to.")]
public HVRHandPoser FallbackPoser
Field Value
Type Description
HVRHandPoser
| Improve this Doc View Source

ForceGrabber

Declaration
public HVRForceGrabber ForceGrabber
Field Value
Type Description
HVRForceGrabber
| Improve this Doc View Source

GrabIndicator

Declaration
[Header("Grab Indicators")]
public HVRGrabbableHoverBase GrabIndicator
Field Value
Type Description
HVRGrabbableHoverBase
| Improve this Doc View Source

GrabPoser

Declaration
public HVRHandPoser GrabPoser
Field Value
Type Description
HVRHandPoser
| Improve this Doc View Source

GrabToggleActive

Declaration
public bool GrabToggleActive
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

GrabTrigger

Declaration
[Tooltip("Hold down or Toggle grabbing")]
public HVRGrabTrigger GrabTrigger
Field Value
Type Description
HVRGrabTrigger
| Improve this Doc View Source

HandAnimator

Declaration
[Header("Components")]
[Tooltip("The hand animator component, loads from children on startup if not supplied.")]
public HVRHandAnimator HandAnimator
Field Value
Type Description
HVRHandAnimator
| Improve this Doc View Source

HandGrabs

Declaration
[Header("Grab Settings")]
[Tooltip("If true the hand will move to the grabbable instead of pulling the grabbable to the hand")]
public bool HandGrabs
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

HandGrabSpeed

Declaration
[Tooltip("Hand move speed when HandGrabs = true")]
public float HandGrabSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

HandModel

Declaration
[Header("Required Transforms")]
[Tooltip("Object holding the hand model.")]
public Transform HandModel
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

HandPhysics

Declaration
[Tooltip("Component that holds collider information about the hands. Auto populated from children if not set.")]
public HVRHandPhysics HandPhysics
Field Value
Type Description
HVRHandPhysics
| Improve this Doc View Source

HandSide

Declaration
[Tooltip("Left or right hand.")]
public HVRHandSide HandSide
Field Value
Type Description
HVRHandSide
| Improve this Doc View Source

HoveredSocket

Declaration
public HVRSocket HoveredSocket
Field Value
Type Description
HVRSocket
| Improve this Doc View Source

HoverPoser

Declaration
public HVRHandPoser HoverPoser
Field Value
Type Description
HVRHandPoser
| Improve this Doc View Source

IgnoreParentingAngle

Declaration
[Tooltip("Ignores hand model parenting angle check.")]
public bool IgnoreParentingAngle
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IgnoreParentingDistance

Declaration
[Tooltip("Ignores hand model parenting distance check.")]
public bool IgnoreParentingDistance
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Inputs

Declaration
public HVRPlayerInputs Inputs
Field Value
Type Description
HVRPlayerInputs
| Improve this Doc View Source

InverseKinematics

Declaration
[Header("HandSettings")]
[Tooltip("Set to true if the HandModel is an IK target")]
public bool InverseKinematics
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsGripGrabActivated

Declaration
protected bool IsGripGrabActivated
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsGripGrabActive

Declaration
protected bool IsGripGrabActive
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTriggerGrabActivated

Declaration
protected bool IsTriggerGrabActivated
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTriggerGrabActive

Declaration
protected bool IsTriggerGrabActive
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

JointAnchor

Declaration
[Tooltip("Configurable joints are anchored here")]
public Transform JointAnchor
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

MoveThreshold

Declaration
[Tooltip("If the grabbable still isn't in pose orientation after the timeout, the hand will retrieve the object if the pose rotation delta is greater than this.")]
public float MoveThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

OverlappingGrabbables

Declaration
public Dictionary<HVRGrabbable, Coroutine> OverlappingGrabbables
Field Value
Type Description
System.Collections.Generic.Dictionary<HVRGrabbable, UnityEngine.Coroutine>
| Improve this Doc View Source

OverlapSizer

Declaration
[Tooltip("Sphere collider that checks when collisions should be re-enabled between a released grabbable and this hand.")]
public Transform OverlapSizer
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

ParentingMaxAngleDelta

Declaration
[Tooltip("Angle to meet before hand model parents to the grabbable.")]
public float ParentingMaxAngleDelta
Field Value
Type Description
System.Single
| Improve this Doc View Source

ParentingMaxDistance

Declaration
[Tooltip("Distance to meet before hand model parents to the grabbable")]
public float ParentingMaxDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

PhysicsPoser

Declaration
public HVRPhysicsPoser PhysicsPoser
Field Value
Type Description
HVRPhysicsPoser
| Improve this Doc View Source

PullingSettings

Declaration
[Tooltip("Settings used to pull and rotate the object into position")]
public HVRJointSettings PullingSettings
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

PullLerpTime

Declaration
[Header("Pull Settings")]
[Tooltip("Lerps between grabbable starting position and final hand posed position over this amount of time")]
public float PullLerpTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

Pusher

Declaration
[Tooltip("Used to push objects away from the hand, or unstuck the hand if desired by calling StartPushing.")]
public BoxCollider Pusher
Field Value
Type Description
UnityEngine.BoxCollider
| Improve this Doc View Source

PushoutTime

Declaration
[Tooltip("How quickly does the push out box collider go from zero to full size.")]
public float PushoutTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

RaycastLayermask

Declaration
[Tooltip("Layer mask to determine line of sight to the grabbable.")]
public LayerMask RaycastLayermask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

RaycastOrigin

Declaration
[Tooltip("Used to shoot ray casts at the grabbable to check if there is line of sight before grabbing.")]
public Transform RaycastOrigin
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

RecentAngularVelocities

Declaration
public readonly CircularBuffer<Vector3> RecentAngularVelocities
Field Value
Type Description
CircularBuffer<UnityEngine.Vector3>
| Improve this Doc View Source

RecentVelocities

Declaration
public readonly CircularBuffer<Vector3> RecentVelocities
Field Value
Type Description
CircularBuffer<UnityEngine.Vector3>
| Improve this Doc View Source

ReleasedAngularConversionFactor

Declaration
[Tooltip("Factor to apply to the angular to linear calculation.")]
public float ReleasedAngularConversionFactor
Field Value
Type Description
System.Single
| Improve this Doc View Source

ReleasedAngularThreshold

Declaration
[Tooltip("Hand angular velocity must exceed this to add linear velocity based on angular velocity.")]
public float ReleasedAngularThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

ReleasedVelocityFactor

Declaration
[Header("Throw Settings")]
[Tooltip("Factor to apply to the linear velocity of the throw.")]
public float ReleasedVelocityFactor
Field Value
Type Description
System.Single
| Improve this Doc View Source

SocketBag

Declaration
[Tooltip("HVRSocketBag used for placing and removing from sockets")]
public HVRSocketBag SocketBag
Field Value
Type Description
HVRSocketBag
| Improve this Doc View Source

TakePeakVelocities

Declaration
[Tooltip("If true throwing takes only the top peak velocities for throwing.")]
public bool TakePeakVelocities
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ThrowingCenterOfMass

Declaration
[Tooltip("Uses the center of mass that should match with current controller type you are using.")]
public HVRThrowingCenterOfMass ThrowingCenterOfMass
Field Value
Type Description
HVRThrowingCenterOfMass
| Improve this Doc View Source

ThrowLookback

Declaration
[Tooltip("Number of frames to average velocity for throwing.")]
public int ThrowLookback
Field Value
Type Description
System.Int32
| Improve this Doc View Source

ThrowLookbackStart

Declaration
[Tooltip("Number of frames to skip while averaging velocity.")]
public int ThrowLookbackStart
Field Value
Type Description
System.Int32
| Improve this Doc View Source

TrackedController

Declaration
[Tooltip("The transform that is handling device tracking.")]
public Transform TrackedController
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

TriggerGrabIndicator

Declaration
public HVRGrabbableHoverBase TriggerGrabIndicator
Field Value
Type Description
HVRGrabbableHoverBase

Properties

| Improve this Doc View Source

BaseLineGrabAnchor

Declaration
public Vector3 BaseLineGrabAnchor { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

CachedWorldPosition

Declaration
public Vector3 CachedWorldPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

CachedWorldRotation

Declaration
public Quaternion CachedWorldRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

CanActivate

Declaration
public bool CanActivate { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CanRelease

Declaration
public bool CanRelease { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Controller

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

ControllerRotation

Declaration
public override Quaternion ControllerRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
Overrides
| Improve this Doc View Source

GrabAnchorLocal

Declaration
public Vector3 GrabAnchorLocal { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GrabAnchorWorld

Declaration
public Vector3 GrabAnchorWorld { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GrabPoint

Declaration
public override Transform GrabPoint { get; set; }
Property Value
Type Description
UnityEngine.Transform
Overrides
| Improve this Doc View Source

HandAnchorLocal

Declaration
public Vector3 HandAnchorLocal { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandAnchorWorld

Declaration
public Vector3 HandAnchorWorld { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandModelParent

Declaration
public Transform HandModelParent { get; }
Property Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

HandModelPosition

Declaration
public Vector3 HandModelPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandModelRotation

Declaration
public Quaternion HandModelRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

HandModelScale

Declaration
public Vector3 HandModelScale { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandWorldPosition

Declaration
public Vector3 HandWorldPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

HandWorldRotation

Declaration
public Quaternion HandWorldRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

HVRTrackedController

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

IsClimbing

Declaration
public bool IsClimbing { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHandGrabber

Declaration
public override bool IsHandGrabber { get; }
Property Value
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

IsHoveringSocket

Declaration
public bool IsHoveringSocket { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsInitialLineGrab

Declaration
public bool IsInitialLineGrab { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsLineGrab

Declaration
public bool IsLineGrab { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsPhysicsPose

Declaration
public bool IsPhysicsPose { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTriggerHovering

Declaration
public bool IsTriggerHovering { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Joint

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

JointAnchorWorldPosition

Declaration
public override Vector3 JointAnchorWorldPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
Overrides
| Improve this Doc View Source

JointRotation

Declaration
public Quaternion JointRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

LineGrabAnchor

Declaration
public Vector3 LineGrabAnchor { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LineGrabHandVector

Declaration
protected Vector3 LineGrabHandVector { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

LineGrabVector

Declaration
protected Vector3 LineGrabVector { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

Palm

Declaration
public Transform Palm { get; }
Property Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

PosableGrabPoint

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

PoseLocalRotation

When a grab is initiated, this should be set to the hand models rotation relative to the grabbable object transform

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

PoserIndex

Declaration
public int PoserIndex { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PoseWorldPosition

Declaration
public Vector3 PoseWorldPosition { get; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

PoseWorldRotation

World Pose Rotation of the currently active grab point

Declaration
public Quaternion PoseWorldRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

RigidOverrides

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

StrengthHandler

Declaration
public HVRHandStrengthHandler StrengthHandler { get; set; }
Property Value
Type Description
HVRHandStrengthHandler
| Improve this Doc View Source

TempGrabPoint

Declaration
public GameObject TempGrabPoint { get; }
Property Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

TriggerGrabPoint

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

TriggerHoverTarget

Declaration
public HVRGrabbable TriggerHoverTarget { get; set; }
Property Value
Type Description
HVRGrabbable
| Improve this Doc View Source

TriggerPosableGrabPoint

Declaration
public HVRPosableGrabPoint TriggerPosableGrabPoint { get; }
Property Value
Type Description
HVRPosableGrabPoint

Methods

| Improve this Doc View Source

Awake()

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

BreakDistanceCooldown(Single)

Breakdistance check ignored for the next 'timeout' amount of time. Useful if you're teleporting the player around and need to ignore break check temporarily while the move resolves.

Declaration
public void BreakDistanceCooldown(float timeout = 0.25F)
Parameters
Type Name Description
System.Single timeout
| Improve this Doc View Source

CanGrab(HVRGrabbable)

Declaration
public override bool CanGrab(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

CanGrabFromSocket(HVRSocket)

Declaration
protected virtual bool CanGrabFromSocket(HVRSocket socket)
Parameters
Type Name Description
HVRSocket socket
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanHover(HVRGrabbable)

Declaration
public override bool CanHover(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

ChangeGrabPoint(HVRPosableGrabPoint, Single, HVRAxis)

Declaration
public void ChangeGrabPoint(HVRPosableGrabPoint grabPoint, float time, HVRAxis axis)
Parameters
Type Name Description
HVRPosableGrabPoint grabPoint
System.Single time
HVRAxis axis
| Improve this Doc View Source

CheckActivateGrabbable()

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

CheckBreakDistance()

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

CheckBreakDistanceReached(HVRGrabbable)

Declaration
protected virtual bool CheckBreakDistanceReached(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckGrab()

Declaration
protected override void CheckGrab()
Overrides
| Improve this Doc View Source

CheckHover()

Declaration
protected override bool CheckHover()
Returns
Type Description
System.Boolean
Overrides
| Improve this Doc View Source

CheckLineOfSight(HVRGrabbable)

Declaration
protected virtual bool CheckLineOfSight(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckSocketGrab()

Declaration
protected virtual bool CheckSocketGrab()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckSocketHover()

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

CheckSocketUnhover()

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

CheckSwapRelease(HVRGrabbable)

Declaration
protected override void CheckSwapRelease(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Overrides
| Improve this Doc View Source

CheckTriggerHover()

Declaration
protected virtual bool CheckTriggerHover()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckTriggerUnHover()

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

CheckUnHover()

Declaration
protected override void CheckUnHover()
Overrides
| Improve this Doc View Source

CleanupPull()

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

ClosestValidSocket()

Declaration
protected virtual HVRSocket ClosestValidSocket()
Returns
Type Description
HVRSocket
| Improve this Doc View Source

ComputeThrowVelocity(HVRGrabbable, out Vector3, Boolean)

Declaration
public Vector3 ComputeThrowVelocity(HVRGrabbable grabbable, out Vector3 angularVelocity, bool isThrowing = false)
Parameters
Type Name Description
HVRGrabbable grabbable
UnityEngine.Vector3 angularVelocity
System.Boolean isThrowing
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

DisableHandCollision(HVRGrabbable)

Declaration
public void DisableHandCollision(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

EnableHandCollision(HVRGrabbable)

Declaration
public void EnableHandCollision(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

FindClosestPoint(HVRGrabbable, out Boolean)

Declaration
protected virtual Vector3 FindClosestPoint(HVRGrabbable grabbable, out bool inside)
Parameters
Type Name Description
HVRGrabbable grabbable
System.Boolean inside
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

FixedUpdate()

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

ForceRelease()

Declaration
public override void ForceRelease()
Overrides
| Improve this Doc View Source

GetAverageAngularVelocity(Int32, Int32)

Declaration
public Vector3 GetAverageAngularVelocity(int frames, int start)
Parameters
Type Name Description
System.Int32 frames
System.Int32 start
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GetAverageVelocity(Int32, Int32)

Declaration
public Vector3 GetAverageVelocity(int frames, int start)
Parameters
Type Name Description
System.Int32 frames
System.Int32 start
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

Grab(HVRGrabbable)

Declaration
protected virtual void Grab(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

Grab(HVRGrabbable, HVRGrabTrigger, HVRPosableGrabPoint)

Will grab the provided object using the provided grab point, if the grab point isn't provided then the first valid one on the object will be used. If there are no grab points that are allowed to be grabbed by this hand you shouldn't use this method. If a grab point is found it will use the saved pose information to orient the object in the hand. If the CollisionHandler field on this hand is populated, it will do a post teleport sweep to try and prevent overlapping collisions due to the object being teleported. If grabTrigger is set to toggle or manual release, it will temporarily override the hand grabber / grabbables GrabTrigger while held. If you provide 'Active'then either the hand or the grabbable need their GrabTrigger set appropriately otherwise the object will just drop on the next frame.

Declaration
public virtual void Grab(HVRGrabbable grabbable, HVRGrabTrigger grabTrigger, HVRPosableGrabPoint grabPoint = null)
Parameters
Type Name Description
HVRGrabbable grabbable
HVRGrabTrigger grabTrigger
HVRPosableGrabPoint grabPoint
| Improve this Doc View Source

IsV1Closest(Vector3, Vector3, Vector3)

Declaration
public static bool IsV1Closest(Vector3 v, Vector3 v1, Vector3 v2)
Parameters
Type Name Description
UnityEngine.Vector3 v
UnityEngine.Vector3 v1
UnityEngine.Vector3 v2
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NetworkGrab(HVRGrabbable)

Declaration
public virtual void NetworkGrab(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

OnBeforeGrabbed(HVRGrabArgs)

Declaration
protected override void OnBeforeGrabbed(HVRGrabArgs args)
Parameters
Type Name Description
HVRGrabArgs args
Overrides
| Improve this Doc View Source

OnGrabbed(HVRGrabArgs)

Declaration
protected override void OnGrabbed(HVRGrabArgs args)
Parameters
Type Name Description
HVRGrabArgs args
Overrides
| Improve this Doc View Source

OnGrabbedHaptics()

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

OnHandAttached()

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

OnHoverEnter(HVRGrabbable)

Declaration
protected override void OnHoverEnter(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Overrides
| Improve this Doc View Source

OnHoverExit(HVRGrabbable)

Declaration
protected override void OnHoverExit(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Overrides
| Improve this Doc View Source

OnHoverHaptics()

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

OnReleased(HVRGrabbable)

Declaration
protected override void OnReleased(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Overrides
| Improve this Doc View Source

OnReleasedHaptics()

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

OnTriggerHoverEnter(HVRHandGrabber, HVRGrabbable)

Declaration
protected virtual void OnTriggerHoverEnter(HVRHandGrabber grabber, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRHandGrabber grabber
HVRGrabbable grabbable
| Improve this Doc View Source

OnTriggerHoverExit(HVRHandGrabber, HVRGrabbable)

Declaration
protected virtual void OnTriggerHoverExit(HVRHandGrabber grabber, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRHandGrabber grabber
HVRGrabbable grabbable
| Improve this Doc View Source

OrientGrabbable(HVRGrabbable, HVRPosableGrabPoint, Boolean, Boolean)

Immediately puts the grabbable object into pose position relative to the hand

Declaration
public void OrientGrabbable(HVRGrabbable grabbable, HVRPosableGrabPoint grabPoint, bool position = true, bool rotation = true)
Parameters
Type Name Description
HVRGrabbable grabbable
HVRPosableGrabPoint grabPoint
System.Boolean position
System.Boolean rotation
| Improve this Doc View Source

OverrideHandSettings(HVRJointSettings)

Declaration
public void OverrideHandSettings(HVRJointSettings settings)
Parameters
Type Name Description
HVRJointSettings settings
| Improve this Doc View Source

ResetAnimator()

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

ResetCloneAnimator()

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

ResetTrackedVelocities()

Declaration
protected void ResetTrackedVelocities()
| Improve this Doc View Source

SetAnimatorPose(HVRHandPoser, Boolean, Boolean)

Declaration
public void SetAnimatorPose(HVRHandPoser poser, bool poseHand = false, bool poseHandClone = false)
Parameters
Type Name Description
HVRHandPoser poser
System.Boolean poseHand
System.Boolean poseHandClone
| Improve this Doc View Source

SetJointAnchors(HVRGrabbable)

Declaration
public void SetJointAnchors(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

SetupGrab(HVRGrabbable)

Declaration
public void SetupGrab(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| Improve this Doc View Source

SetupPusher()

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

Start()

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

StartPull()

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

StartPushing()

Enables the push collider, disables existing hand colliders, and then grows the pusher collider to box size over 'PushoutTime', once complete it's disabled and the hand colliders are enabled again.

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

SwapGrabPoint(HVRPosableGrabPoint, Single, HVRAxis)

Declaration
protected virtual IEnumerator SwapGrabPoint(HVRPosableGrabPoint grabPoint, float time, HVRAxis axis)
Parameters
Type Name Description
HVRPosableGrabPoint grabPoint
System.Single time
HVRAxis axis
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

TryAutoGrab(HVRGrabbable, HVRPosableGrabPoint)

Declaration
public bool TryAutoGrab(HVRGrabbable grabbable, HVRPosableGrabPoint grabPoint)
Parameters
Type Name Description
HVRGrabbable grabbable
HVRPosableGrabPoint grabPoint
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update()

Declaration
protected override void Update()
Overrides
| Improve this Doc View Source

UpdateCollision(HVRGrabbable, Boolean)

Declaration
public void UpdateCollision(HVRGrabbable grabbable, bool enable)
Parameters
Type Name Description
HVRGrabbable grabbable
System.Boolean enable
| Improve this Doc View Source

UpdateGrabIndicator()

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

UpdateHolding()

Declaration
protected virtual bool UpdateHolding()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

UpdatePullGrabbable()

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

UpdatePushing()

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

UpdateTriggerGrabIndicator()

Declaration
protected virtual void UpdateTriggerGrabIndicator()

Extension Methods