Class HVRGrabbable

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRGrabbable
HVRPhysicsGrabbable
HVRArrowPassthrough
HVRChargingHandle
HVRSlide
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
Assembly: HurricaneVR.Framework.dll
Syntax
public class HVRGrabbable : MonoBehaviour

Fields

| Improve this Doc View Source

Activated

Declaration
public VRGrabberEvent Activated
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

AllowMultiplayerSwap

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

AutoApplyLayer

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

BreakDistance

Declaration
[Tooltip("Released if the grabbable exceeds this distance from the grabber.")]
public float BreakDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

BreakDistanceSource

Declaration
[Tooltip("The grabbed object will compare it's distance to this when checking BreakDistance release.")]
public BreakDistanceSource BreakDistanceSource
Field Value
Type Description
BreakDistanceSource
| Improve this Doc View Source

Collided

Declaration
public VRGrabbableEvent Collided
Field Value
Type Description
VRGrabbableEvent
| Improve this Doc View Source

CollisionDetection

Declaration
[Tooltip("Rigidbody CD will be set to this while held.")]
public CollisionDetectionMode CollisionDetection
Field Value
Type Description
UnityEngine.CollisionDetectionMode
| Improve this Doc View Source

CollisionParents

Declaration
[Tooltip("If assigned, Colliders will populate from these transforms, otherwise all children colliders of the object will be used (until another grabbable is found).")]
public List<Transform> CollisionParents
Field Value
Type Description
System.Collections.Generic.List<UnityEngine.Transform>
| Improve this Doc View Source

ConsiderGrabPointAngle

Declaration
[Tooltip("Should angle be compared when considering which grab point to choose, grab point should be close together")]
public bool ConsiderGrabPointAngle
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Deactivated

Declaration
public VRGrabberEvent Deactivated
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

Destroyed

Declaration
public VRGrabbableEvent Destroyed
Field Value
Type Description
VRGrabbableEvent
| Improve this Doc View Source

DisableHandCollision

Declaration
[Tooltip("If true, grabbing this object will disable hand collision while held")]
public bool DisableHandCollision
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DrawCenterOfMass

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

ExtraIgnoreCollisionParents

Declaration
[Tooltip("Additional transforms to ignore children colliders when grabbing, helpful for compound objects")]
public List<Transform> ExtraIgnoreCollisionParents
Field Value
Type Description
System.Collections.Generic.List<UnityEngine.Transform>
| Improve this Doc View Source

FinalJointMaxAngle

Declaration
[Tooltip("Must be below this angle delta from expected hand pose and current hand orientation to create the final joint.")]
public float FinalJointMaxAngle
Field Value
Type Description
System.Single
| Improve this Doc View Source

FinalJointTimeout

Declaration
[Tooltip("How long do we try pulling into position before using the final joint settings.")]
public float FinalJointTimeout
Field Value
Type Description
System.Single
| Improve this Doc View Source

ForceGrabbable

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

ForceGrabIndicator

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

ForcePullOverride

Declaration
[Tooltip("Override for when using Force Pull style distance grabbing. Does not apply to gravity glove style.")]
public HVRForcePullSettings ForcePullOverride
Field Value
Type Description
HVRForcePullSettings
| Improve this Doc View Source

Grabbed

Declaration
public VRGrabberEvent Grabbed
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

GrabBehaviour

Declaration
[Header("Grab Settings")]
[Tooltip("Define grab behaviour, HandGrabber Default, Pull object to hand, Hand goes to the object.")]
public GrabBehaviour GrabBehaviour
Field Value
Type Description
GrabBehaviour
| Improve this Doc View Source

Grabbers

Declaration
public List<HVRGrabberBase> Grabbers
Field Value
Type Description
System.Collections.Generic.List<HVRGrabberBase>
| Improve this Doc View Source

GrabColliders

Declaration
[Tooltip("If populated, only these colliders will be used by the grab detection system.")]
public Collider[] GrabColliders
Field Value
Type Description
UnityEngine.Collider[]
| Improve this Doc View Source

GrabControl

Declaration
public HVRGrabControls GrabControl
Field Value
Type Description
HVRGrabControls
| Improve this Doc View Source

GrabIndicator

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

GrabPoints

Declaration
public List<Transform> GrabPoints
Field Value
Type Description
System.Collections.Generic.List<UnityEngine.Transform>
| Improve this Doc View Source

GrabPointsMeta

Declaration
public List<HVRPosableGrabPoint> GrabPointsMeta
Field Value
Type Description
System.Collections.Generic.List<HVRPosableGrabPoint>
| Improve this Doc View Source

GrabTrigger

Declaration
[DrawIf("OverrideGrabTrigger", true, DrawIfAttribute.DisablingType.DontDraw)]
public HVRGrabTrigger GrabTrigger
Field Value
Type Description
HVRGrabTrigger
| Improve this Doc View Source

HandFullReleased

Declaration
public VRHandGrabberEvent HandFullReleased
Field Value
Type Description
VRHandGrabberEvent
| Improve this Doc View Source

HandGrabbed

Declaration
public VRHandGrabberEvent HandGrabbed
Field Value
Type Description
VRHandGrabberEvent
| Improve this Doc View Source

HandGrabbedClip

Declaration
[Header("SFX")]
[Tooltip("SFX played when grabbed by a hand.")]
public AudioClip HandGrabbedClip
Field Value
Type Description
UnityEngine.AudioClip
| Improve this Doc View Source

HandGrabbers

Declaration
public List<HVRHandGrabber> HandGrabbers
Field Value
Type Description
System.Collections.Generic.List<HVRHandGrabber>
| Improve this Doc View Source

HandReleased

Declaration
public VRHandGrabberEvent HandReleased
Field Value
Type Description
VRHandGrabberEvent
| Improve this Doc View Source

HeldGrabPoints

Declaration
public readonly HashSet<Transform> HeldGrabPoints
Field Value
Type Description
System.Collections.Generic.HashSet<UnityEngine.Transform>
| Improve this Doc View Source

HoldType

Declaration
public HVRHoldType HoldType
Field Value
Type Description
HVRHoldType
| Improve this Doc View Source

HoverEnter

Declaration
public VRGrabberEvent HoverEnter
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

HoverExit

Declaration
public VRGrabberEvent HoverExit
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

JointOverride

Declaration
[Header("Configurable Joint Override")]
[Tooltip("If set it will override the default joint settings.")]
public HVRJointSettings JointOverride
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

LinkedGrabbables

Declaration
[Tooltip("Used to determine a two handed grab across grabbable objects")]
public List<HVRGrabbable> LinkedGrabbables
Field Value
Type Description
System.Collections.Generic.List<HVRGrabbable>
| Improve this Doc View Source

LinkStartingSocket

Declaration
[Tooltip("If true this grabbable will be auto grabbed by the StartingSocket whenever it's dropped.")]
public bool LinkStartingSocket
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

MasterGrabbable

Declaration
[Tooltip("Used by the HVRTeleportCollisionHandler component for post teleport grabbable movement, set this for compound grabbable objects if teleporting while holding thisis causing issues")]
public HVRGrabbable MasterGrabbable
Field Value
Type Description
HVRGrabbable
| Improve this Doc View Source

MaxDistanceBehaviour

Declaration
[Tooltip("Override to change how the hand behaves after reaching max distance from the controller")]
[DrawIf("OverrideMaxDistanceBehaviour", true, DrawIfAttribute.DisablingType.DontDraw)]
public MaxDistanceBehaviour MaxDistanceBehaviour
Field Value
Type Description
MaxDistanceBehaviour
| Improve this Doc View Source

OneHandJointSettings

Declaration
[Header("Hand Joint Overrides")]
[Tooltip("Applies the joint settings to the hand joint with one hand hold.")]
public HVRJointSettings OneHandJointSettings
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

OverlapTimeout

Declaration
[Tooltip("If not requiring overlap clearance, how long to wait to re-enable collision with the hand")]
public float OverlapTimeout
Field Value
Type Description
System.Single
| Improve this Doc View Source

OverrideGrabTrigger

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

OverrideMaxDistanceBehaviour

Declaration
[Tooltip("Enable override of max hand to controller distance reached behaviour")]
public bool OverrideMaxDistanceBehaviour
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PalmCenterOfMass

Declaration
[Header("Physics")]
[Tooltip("If true the hand palm will become the center of mass on grab, midpoint for 2 handed grabs")]
public bool PalmCenterOfMass
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ParentHandModel

Declaration
[Tooltip("Should the hand model parent to the grabbable once close enough? Required for posing.")]
public bool ParentHandModel
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PhysicsPoserFallback

Declaration
[Tooltip("If grab type is snap and a pose couldn't resolve, should we try dynamic grabbing.")]
public bool PhysicsPoserFallback
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PoseImmediately

Declaration
[FormerlySerializedAs("ParentHandModelImmediately")]
[Tooltip("Should the hand model pose immediately to this upon grabbing.")]
public bool PoseImmediately
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PoseType

Declaration
[FormerlySerializedAs("GrabType")]
public PoseType PoseType
Field Value
Type Description
PoseType
| Improve this Doc View Source

PullingSettingsOverride

Declaration
[Tooltip("Uses this to pull the object to the hand, overrides default settings")]
public HVRJointSettings PullingSettingsOverride
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

Released

Declaration
public VRGrabberEvent Released
Field Value
Type Description
VRGrabberEvent
| Improve this Doc View Source

ReleasedAngularConversionFactor

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

ReleasedAngularFactor

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

ReleasedVelocityFactor

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

RemainsKinematic

Declaration
[Tooltip("If true the object remains kinematic")]
public bool RemainsKinematic
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RequireLineOfSight

Declaration
[Tooltip("Does this grabbable require line of sight to the hand grabber to be grabbed?")]
public bool RequireLineOfSight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RequireOverlapClearance

Declaration
[Tooltip("If true the hand must not overlap this any longer to re-enable collision")]
public bool RequireOverlapClearance
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Rigidbody

Declaration
[Header("Misc")]
[Tooltip("RB for hand jointing, majority of grabbables should be on the rigidbody, only assign this for compound objects with secondary grabbables")]
public Rigidbody Rigidbody
Field Value
Type Description
UnityEngine.Rigidbody
| Improve this Doc View Source

ShowBoundingBox

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

ShowForceGrabIndicator

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

ShowGrabIndicator

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

ShowTriggerGrabIndicator

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

Socketed

Declaration
public VRSocketEvent Socketed
Field Value
Type Description
VRSocketEvent
| Improve this Doc View Source

SocketGrabPoints

Declaration
[Tooltip("If provided only these grab points will be considered when an object is removed from a socket, otherwise the closest grab point will be used.")]
public HVRPosableGrabPoint[] SocketGrabPoints
Field Value
Type Description
HVRPosableGrabPoint[]
| Improve this Doc View Source

Stabbable

Declaration
public HVRStabbable Stabbable
Field Value
Type Description
HVRStabbable
| Improve this Doc View Source

Stabbers

Declaration
public List<HVRStabber> Stabbers
Field Value
Type Description
System.Collections.Generic.List<HVRStabber>
| Improve this Doc View Source

StartingSocket

Declaration
[Header("Sockets")]
[Tooltip("Socket that this grabbable will start in.")]
public HVRSocket StartingSocket
Field Value
Type Description
HVRSocket
| Improve this Doc View Source

Stationary

Declaration
[Tooltip("If true the object is static or attached to something else and shouldn't be pulled and rotated to the hand")]
public bool Stationary
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

TrackingType

Declaration
public HVRGrabTracking TrackingType
Field Value
Type Description
HVRGrabTracking
| Improve this Doc View Source

TwoHandJointSettings

Declaration
[Tooltip("Applies the joint settings to the hand joint with two hand hold.")]
public HVRJointSettings TwoHandJointSettings
Field Value
Type Description
HVRJointSettings
| Improve this Doc View Source

UnSocketed

Declaration
public VRSocketEvent UnSocketed
Field Value
Type Description
VRSocketEvent
| Improve this Doc View Source

UseColliderClosestPoint

Declaration
[Tooltip("Let the grab system know if it can use collider closest point for line of sight and distance checking for grab detection")]
public bool UseColliderClosestPoint
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

AdditionalIgnoreColliders

Declaration
public List<Collider> AdditionalIgnoreColliders { get; }
Property Value
Type Description
System.Collections.Generic.List<UnityEngine.Collider>
| Improve this Doc View Source

BeingDestroyed

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

CanBeGrabbed

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

Colliders

Used to line of sight checks when grabbing, as well as disabling collision between the hand and the this object while grabbing.

Declaration
public List<Collider> Colliders { get; }
Property Value
Type Description
System.Collections.Generic.List<UnityEngine.Collider>
| Improve this Doc View Source

DropOnRequiredReleased

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

ElapsedSinceReleased

Declaration
public float ElapsedSinceReleased { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ForceTwoHandSettings

If true will force use the two hand settings regardless of the number of hand grabbers holding

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

GrabberCount

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

GrabRequiredIfReleased

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

HasConcaveColliders

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

IsBeingForcedGrabbed

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

IsBeingHeld

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

IsClimbable

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

IsHandGrabbed

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

IsJointGrab

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

IsLeftHandGrabbed

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

IsMine

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

IsRightHandGrabbed

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

IsSocketed

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

IsStabbed

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

IsStabbing

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

LeftHandGrabber

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

LinkedSocket

The socket this grabbable will return to when it's released.

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

ModelBounds

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

OriginalCollisionMode

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

PrimaryGrabber

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

RequiredGrabbable

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

RequiredGrabbableComponent

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

RequiresGrabbable

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

RightHandGrabber

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

Socket

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

Socketable

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

SocketHoverer

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

Triggers

Used for line of sight checks when grabbing.

Declaration
public List<Collider> Triggers { get; }
Property Value
Type Description
System.Collections.Generic.List<UnityEngine.Collider>
| Improve this Doc View Source

WasGravity

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

WasKinematic

Declaration
public bool WasKinematic { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

AnyGrabberNotMine()

Used for networked games, to determine if any grabber holding this object is not ours

Declaration
public bool AnyGrabberNotMine()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

AnyLinkedHandHeld()

Returns true if any linked grabbable is held by a hand

Declaration
public bool AnyLinkedHandHeld()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Awake()

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

DisableCollision()

Disables all non trigger colliders

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

EnableCollision()

Enables all non trigger colliders

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

FindColliders(Transform, List<Collider>, List<Collider>)

Recursively finds colliders and triggers, ignores children that are grabbables.

Declaration
protected virtual void FindColliders(Transform parent, List<Collider> colliders, List<Collider> triggers)
Parameters
Type Name Description
UnityEngine.Transform parent
System.Collections.Generic.List<UnityEngine.Collider> colliders
System.Collections.Generic.List<UnityEngine.Collider> triggers
| Improve this Doc View Source

FixedUpdate()

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

ForceRelease()

Forces any held grabbers to release this grabbable.

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

GetAverageAngularVelocity(Int32, Int32)

Gets the average angular velocity of the grabbable for N frames into the past starting at start frames into the past.

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, Boolean, Int32)

Gets the average velocity of the grabbable for N frames into the past starting at start frames into the past.

Declaration
public Vector3 GetAverageVelocity(int frames, int start, bool takePeak = false, int nPeak = 3)
Parameters
Type Name Description
System.Int32 frames
System.Int32 start
System.Boolean takePeak
System.Int32 nPeak
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GetDistanceToGrabber(Vector3)

Gets the distance between this grabbable and the provided grabber

Declaration
public virtual float GetDistanceToGrabber(Vector3 point)
Parameters
Type Name Description
UnityEngine.Vector3 point
Returns
Type Description
System.Single
| Improve this Doc View Source

GetGrabPoint(HVRHandGrabber, GrabpointFilter)

Declaration
public HVRPosableGrabPoint GetGrabPoint(HVRHandGrabber hand, GrabpointFilter filter)
Parameters
Type Name Description
HVRHandGrabber hand
GrabpointFilter filter
Returns
Type Description
HVRPosableGrabPoint
| Improve this Doc View Source

GetSquareDistanceToGrabber(Vector3)

Gets the Squared Distance between this grabbable and the provided grabber

Declaration
public virtual float GetSquareDistanceToGrabber(Vector3 point)
Parameters
Type Name Description
UnityEngine.Vector3 point
Returns
Type Description
System.Single
| Improve this Doc View Source

GrabPointValid(HVRHandGrabber, HVRPosableGrabPoint, GrabpointFilter)

Declaration
protected virtual bool GrabPointValid(HVRHandGrabber hand, HVRPosableGrabPoint grabPoint, GrabpointFilter filter)
Parameters
Type Name Description
HVRHandGrabber hand
HVRPosableGrabPoint grabPoint
GrabpointFilter filter
Returns
Type Description
System.Boolean
| Improve this Doc View Source

HasCollider(Collider)

Declaration
public virtual bool HasCollider(Collider c)
Parameters
Type Name Description
UnityEngine.Collider c
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IgnoreCollision(HVRGrabbable, Boolean)

Ignores collision with another grabbable

Declaration
public void IgnoreCollision(HVRGrabbable other, bool ignore = true)
Parameters
Type Name Description
HVRGrabbable other
System.Boolean ignore
| Improve this Doc View Source

IgnoreCollision(Collider, Boolean)

Declaration
public void IgnoreCollision(Collider other, bool ignore = true)
Parameters
Type Name Description
UnityEngine.Collider other
System.Boolean ignore
| Improve this Doc View Source

InternalOnActivate(HVRGrabberBase)

When the grabbable is activated, such as when the trigger is pulled by the held hand grabber

Declaration
protected virtual void InternalOnActivate(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

InternalOnDeactivate(HVRGrabberBase)

When the grabbable is deactivated, such as when the trigger is released by the held hand grabber

Declaration
protected virtual void InternalOnDeactivate(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

InternalOnHoverExit(HVRGrabberBase)

Declaration
protected virtual void InternalOnHoverExit(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

IsIgnoreCollider(Collider)

Declaration
public bool IsIgnoreCollider(Collider col)
Parameters
Type Name Description
UnityEngine.Collider col
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LoadGrabPoints()

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

OnActivate(HVRGrabberBase)

When the grabbable is activated, such as when the trigger is pulled by the held hand grabber

Declaration
protected virtual void OnActivate(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnAfterHandGrabberAdded(HVRHandGrabber)

Called after a hand grabs this and is added to the HandGrabbers field.

Declaration
protected virtual void OnAfterHandGrabberAdded(HVRHandGrabber handGrabber)
Parameters
Type Name Description
HVRHandGrabber handGrabber
| Improve this Doc View Source

OnAfterHandGrabberRemoved(HVRHandGrabber)

Declaration
protected virtual void OnAfterHandGrabberRemoved(HVRHandGrabber handGrabber)
Parameters
Type Name Description
HVRHandGrabber handGrabber
| Improve this Doc View Source

OnBeforeGrabbed(HVRGrabberBase)

Fired before the OnGrabbed method

Declaration
protected virtual void OnBeforeGrabbed(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnBeforeHandGrabberRemoved(HVRHandGrabber)

Called before a hand grabber is removed from the HandGrabbers field.

Declaration
protected virtual void OnBeforeHandGrabberRemoved(HVRHandGrabber handGrabber)
Parameters
Type Name Description
HVRHandGrabber handGrabber
| Improve this Doc View Source

OnCollisionEnter(Collision)

Declaration
protected virtual void OnCollisionEnter(Collision other)
Parameters
Type Name Description
UnityEngine.Collision other
| Improve this Doc View Source

OnDeactivate(HVRGrabberBase)

When the grabbable is deactivated, such as when the trigger is released by the held hand grabber

Declaration
protected virtual void OnDeactivate(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnGrabbed(HVRGrabberBase)

Fired upon a successful grab

Declaration
protected virtual void OnGrabbed(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnGrabCanceled(HVRGrabberBase)

Fired if the grabber decided to cancel the grab

Declaration
protected virtual void OnGrabCanceled(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnHoverEnter(HVRGrabberBase)

Fired when a grabber is hovering this, most likely with their trigger collider

Declaration
protected virtual void OnHoverEnter(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnHoverExit(HVRGrabberBase)

Fired when a grabber is not longer hovering this, most likely with their trigger collider

Declaration
protected virtual void OnHoverExit(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

OnReleased(HVRGrabberBase)

Fired after the grabber released this

Declaration
protected virtual void OnReleased(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

PopulateGrabPoints()

Loads grab points from the object with HVRGrabPoints component, if not found it we look for the first child object named "GrabPoints"

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

ProcessFixedUpdate()

Called at the end of the unity FixedUpdate Method;

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

ProcessUpdate()

Called at the end of the unity Update method.

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

RemoveJoint(HVRGrabberBase)

Destroys and cleanups reference to the configurable joint attached to this grabber

Declaration
public void RemoveJoint(HVRGrabberBase grabber)
Parameters
Type Name Description
HVRGrabberBase grabber
| Improve this Doc View Source

ResetRigidBody()

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

ResetToNonTrigger()

Sets all non trigger colliders back to non trigger

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

SetAllToTrigger()

Sets all colliders to trigger

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

SetupColliders()

Locates colliders that are used for line of sight checking and for collision disabling with the grabbing hand when held.

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

Start()

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

Update()

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

UpdateHandSettings()

If provided, will update the hand joint settings depending on one or two handed grabs

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

UpdateIgnoreColliders()

Declaration
public void UpdateIgnoreColliders()

Extension Methods