Show / Hide Table of Contents

Class HVRSocket

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRGrabberBase
HVRSocket
HVRShoulderSocket
HVRNockingPoint
HVRAutoDropMagazine
HVRMagazineSocket
HVRShotgunAmmoSocket
Inherited Members
HVRGrabberBase.BeforeGrabbed
HVRGrabberBase.Grabbed
HVRGrabberBase.Released
HVRGrabberBase.BeforeHoverEnter
HVRGrabberBase.HoverEnter
HVRGrabberBase.HoverExit
HVRGrabberBase.GrabBags
HVRGrabberBase.ControllerRotation
HVRGrabberBase.AllowHovering
HVRGrabberBase.AllowGrabbing
HVRGrabberBase.IsGrabbing
HVRGrabberBase.IsHovering
HVRGrabberBase.HoverTarget
HVRGrabberBase.GrabbedTarget
HVRGrabberBase.IsHandGrabber
HVRGrabberBase.Rigidbody
HVRGrabberBase._grabPoint
HVRGrabberBase.GrabPoint
HVRGrabberBase.JointAnchorWorldPosition
HVRGrabberBase.IsMine
HVRGrabberBase.PerformUpdate
HVRGrabberBase.PullingGrabbable
HVRGrabberBase.OnEnable()
HVRGrabberBase.OnDisable()
HVRGrabberBase.OnDestroy()
HVRGrabberBase.Awake()
HVRGrabberBase.FixedUpdate()
HVRGrabberBase.CheckRelease()
HVRGrabberBase.ForceRelease()
HVRGrabberBase.CheckSwapReleaseRequired(HVRGrabbable)
HVRGrabberBase.CheckSwapRelease(HVRGrabbable)
HVRGrabberBase.SwapRelease(HVRGrabbable)
HVRGrabberBase.ReleaseGrabbable(HVRGrabberBase, HVRGrabbable, Boolean, Boolean)
HVRGrabberBase.IsValidGrabbable(HVRGrabbable)
HVRGrabberBase.GetClosestGrabbable()
HVRGrabberBase.GetClosestGrabbable(Predicate<HVRGrabbable>)
HVRGrabberBase.TryGrab(HVRGrabbable, Boolean)
HVRGrabberBase.TryGrabNoEvents(HVRGrabbable, Boolean)
HVRGrabberBase.GrabGrabbable(HVRGrabberBase, HVRGrabbable, Boolean)
HVRGrabberBase.OnBeforeGrabbed(HVRGrabArgs)
HVRGrabberBase.OnAfterGrabbed(HVRGrabbable)
HVRGrabberBase.CheckUnHover()
HVRGrabberBase.ClosestValidHover(Boolean)
HVRGrabberBase.ClosestValidHover()
HVRGrabberBase.HoverGrabbable(HVRGrabberBase, HVRGrabbable)
HVRGrabberBase.UnhoverGrabbable(HVRGrabberBase, HVRGrabbable)
HVRGrabberBase.OnGrabbableDestroyed(HVRGrabbable)
HVRGrabberBase.CheckForLineOfSight(Vector3, HVRGrabbable, LayerMask, Single, Boolean)
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 HVRSocket : HVRGrabberBase

Fields

| Improve this Doc View Source

_appQuitting

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

_fixPositionRoutine

Declaration
protected Coroutine _fixPositionRoutine
Field Value
Type Description
UnityEngine.Coroutine
| Improve this Doc View Source

_hadRigidBody

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

_ignoreGrabSFX

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

_mass

Declaration
protected float _mass
Field Value
Type Description
System.Single
| Improve this Doc View Source

_modelBounds

Declaration
protected Bounds _modelBounds
Field Value
Type Description
UnityEngine.Bounds
| Improve this Doc View Source

_previousParent

Declaration
protected Transform _previousParent
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

_previousScale

Declaration
protected Vector3 _previousScale
Field Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

_timeoutGrabbable

Declaration
protected HVRGrabbable _timeoutGrabbable
Field Value
Type Description
HVRGrabbable
| Improve this Doc View Source

AudioGrabbedFallback

Declaration
[Tooltip("Fallback grabbed sfx to play if the socketable doesn't have one.")]
public AudioClip AudioGrabbedFallback
Field Value
Type Description
UnityEngine.AudioClip
| Improve this Doc View Source

AudioGrabbedOverride

Declaration
[Header("SFX")]
[Tooltip("Prioritized SFX to play for anything socketed")]
public AudioClip AudioGrabbedOverride
Field Value
Type Description
UnityEngine.AudioClip
| Improve this Doc View Source

AudioReleasedFallback

Declaration
[Tooltip("Fallback released sfx to play if the socketable doesn't have one.")]
public AudioClip AudioReleasedFallback
Field Value
Type Description
UnityEngine.AudioClip
| Improve this Doc View Source

AudioReleasedOverride

Declaration
[Tooltip("Prioritized SFX to play for anything released")]
public AudioClip AudioReleasedOverride
Field Value
Type Description
UnityEngine.AudioClip
| Improve this Doc View Source

AutoSpawnPrefab

Declaration
[Tooltip("If supplied, this object will be cloned when one is removed.")]
public GameObject AutoSpawnPrefab
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

CanGrabStabbingGrabbable

Declaration
[Tooltip("If the grabbable stabber is stabbing something, can this socket grab it ?")]
public bool CanGrabStabbingGrabbable
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CanRemoveGrabbable

Declaration
[Tooltip("If false then you can't remove the grabbable via hand grab.")]
public bool CanRemoveGrabbable
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CheckHandOverlap

Declaration
[Tooltip("If true the hand socket detector must have detected this socket to be placed as well.")]
public bool CheckHandOverlap
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DebugScale

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

DisableCollision

Declaration
[Tooltip("If false, the socketed object colliders remain active, only works for static or kinematic rb sockets.")]
public bool DisableCollision
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

DistanceSource

Declaration
[Header("Misc")]
[Tooltip("If supplied the hand will use this point when sorting distance to the closest socket instead of the socket position")]
public Transform DistanceSource
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

FilterCondition

Declaration
[Tooltip("If multiple filters are in use, must all be valid or just one?")]
public SocketCondition FilterCondition
Field Value
Type Description
SocketCondition
| Improve this Doc View Source

GrabbableMustBeHeld

Declaration
[Tooltip("If true item's must be placed with a hand grabber.")]
public bool GrabbableMustBeHeld
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

GrabControl

Declaration
[Header("Grab Settings")]
public HVRGrabControls GrabControl
Field Value
Type Description
HVRGrabControls
| Improve this Doc View Source

GrabDetectionType

Declaration
public HVRGrabDetection GrabDetectionType
Field Value
Type Description
HVRGrabDetection
| Improve this Doc View Source

GrabsFromHand

Declaration
[Tooltip("If true will snatch from a hand on hover.")]
public bool GrabsFromHand
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

GrabTimeout

Declaration
[Tooltip("If > 0 the last object released cannot be grabbed again until the timeout is reached")]
public float GrabTimeout
Field Value
Type Description
System.Single
| Improve this Doc View Source

HandGrabActions

Declaration
[Tooltip("Actions to apply when the socket is being hovered by a hand.")]
public HVRSocketHoverAction[] HandGrabActions
Field Value
Type Description
HVRSocketHoverAction[]
| Improve this Doc View Source

HoldType

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

HoverActions

Declaration
[Tooltip("Actions to apply when the socket is being hovered by a grabbable. Auto populates if empty")]
public HVRSocketHoverAction[] HoverActions
Field Value
Type Description
HVRSocketHoverAction[]
| Improve this Doc View Source

InstantHandPose

Declaration
[Tooltip("If true, the hand grabbing an object out of this will instantly bring the object to pose orientation.")]
public bool InstantHandPose
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ParentDisablesGrab

Declaration
[Tooltip("If parent grabbable is socketed, disable grabbing.")]
public bool ParentDisablesGrab
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ParentGrabbable

Declaration
[Tooltip("Parent grabbable used with ParentDisablesGrab.")]
public HVRGrabbable ParentGrabbable
Field Value
Type Description
HVRGrabbable
| Improve this Doc View Source

ReleasesOnHover

Declaration
[Tooltip("Releases the current grabbable if another valid one is in range")]
public bool ReleasesOnHover
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

ScaleGrabbable

Declaration
[Tooltip("Scales the grabbable down to fit based on Size and the model bounds.")]
public bool ScaleGrabbable
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Size

Declaration
[Tooltip("Grabbable scales down to this size along its longest extent.")]
public float Size
Field Value
Type Description
System.Single
| Improve this Doc View Source

SocketFilters

Declaration
[Header("Socketable Filtering")]
[Tooltip("Filters to filter out socketables.")]
public HVRSocketFilter[] SocketFilters
Field Value
Type Description
HVRSocketFilter[]
| Improve this Doc View Source

SpawnedPrefab

Declaration
[Tooltip("Fires when an AutoSpawnedPrefab is instantiated.")]
public SocketSpawnEvent SpawnedPrefab
Field Value
Type Description
SocketSpawnEvent

Properties

| Improve this Doc View Source

AllowSwap

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

CanAddGrabbable

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

CanInteract

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

IsGrabActivated

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

IsHoldActive

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

IsSocket

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

LinkedGrabbable

Declaration
public HVRGrabbable LinkedGrabbable { get; }
Property Value
Type Description
HVRGrabbable

Methods

| 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
HVRGrabberBase.CanGrab(HVRGrabbable)
| Improve this Doc View Source

CanGrabbableBeRemoved(HVRHandGrabber)

Declaration
public virtual bool CanGrabbableBeRemoved(HVRHandGrabber hand)
Parameters
Type Name Description
HVRHandGrabber hand
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanGrabEx(HVRGrabbable)

Bypass the held check for GrabsFromHand

Declaration
protected virtual bool CanGrabEx(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
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
HVRGrabberBase.CanHover(HVRGrabbable)
| Improve this Doc View Source

CheckAutoSpawn()

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

CheckGrab()

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

CheckHover()

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

CleanupRigidBody(HVRGrabbable)

Declaration
protected virtual void CleanupRigidBody(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
| 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

GetPositionOffset(HVRGrabbable)

Declaration
protected virtual Vector3 GetPositionOffset(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GetRotationOffset(HVRGrabbable)

Declaration
protected virtual Quaternion GetRotationOffset(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
UnityEngine.Quaternion
| 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

GetTargetPosition(HVRGrabbable)

Declaration
protected virtual Vector3 GetTargetPosition(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

GetTargetRotation(HVRGrabbable)

Declaration
protected virtual Quaternion GetTargetRotation(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

GrabTimeoutRoutine(HVRGrabbable)

Declaration
protected virtual IEnumerator GrabTimeoutRoutine(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

HandleRigidBodyGrab(HVRGrabbable)

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

IsValid(HVRGrabbable)

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

OnAfterHover(HVRGrabbable)

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

OnBeforeHover(HVRGrabbable)

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

OnGrabbableParented(HVRGrabbable)

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

OnGrabbed(HVRGrabArgs)

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

OnHandGrabberEntered()

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

OnHandGrabberExited()

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

OnHoverEnter(HVRGrabbable)

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

OnHoverExit(HVRGrabbable)

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

OnHoverGrabbableReleased(HVRGrabberBase, HVRGrabbable)

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

OnReleased(HVRGrabbable)

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

PlaySFX(AudioClip)

Declaration
protected virtual void PlaySFX(AudioClip clip)
Parameters
Type Name Description
UnityEngine.AudioClip clip
| Improve this Doc View Source

PlaySocketedSFX(HVRSocketable)

Declaration
protected virtual void PlaySocketedSFX(HVRSocketable socketable)
Parameters
Type Name Description
HVRSocketable socketable
| Improve this Doc View Source

PlayUnsocketedSFX(HVRGrabbable)

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

PositionGrabbable(HVRGrabbable)

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

RotateGrabbable(HVRGrabbable)

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

Start()

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

TryGrab(HVRGrabbable, Boolean, Boolean)

Declaration
public virtual bool TryGrab(HVRGrabbable grabbable, bool force = false, bool ignoreGrabSound = false)
Parameters
Type Name Description
HVRGrabbable grabbable
System.Boolean force
System.Boolean ignoreGrabSound
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update()

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

UpdateScale(HVRGrabbable)

Declaration
protected virtual void UpdateScale(HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabbable grabbable

Extension Methods

HVRUtilities.GetRelativeValues(Component, Transform, out Vector3, out Quaternion)
HVRUtilities.GetRelativeValues(Component, Component, out Vector3, out Quaternion)
HVRUtilities.GetRelativeRotation(Component, Quaternion)
VRUtilities.GetRigidbody(MonoBehaviour)
VRUtilities.GetCopyOf<T>(Component, T)
CoroutineExtensions.ExecuteNextUpdate(MonoBehaviour, Action)
CoroutineExtensions.ExecuteAfterSeconds(MonoBehaviour, Action, Single)
CoroutineExtensions.ExecuteAfterSecondsUnscaled(MonoBehaviour, Action, Single)
CoroutineExtensions.ExecuteAfterFixedUpdate(MonoBehaviour, Action)
CoroutineExtensions.ExecuteAfterFixedUpdates(MonoBehaviour, Action, Int32)
  • Improve this Doc
  • View Source
In This Article
  • Fields
    • _appQuitting
    • _fixPositionRoutine
    • _hadRigidBody
    • _ignoreGrabSFX
    • _mass
    • _modelBounds
    • _previousParent
    • _previousScale
    • _timeoutGrabbable
    • AudioGrabbedFallback
    • AudioGrabbedOverride
    • AudioReleasedFallback
    • AudioReleasedOverride
    • AutoSpawnPrefab
    • CanGrabStabbingGrabbable
    • CanRemoveGrabbable
    • CheckHandOverlap
    • DebugScale
    • DisableCollision
    • DistanceSource
    • FilterCondition
    • GrabbableMustBeHeld
    • GrabControl
    • GrabDetectionType
    • GrabsFromHand
    • GrabTimeout
    • HandGrabActions
    • HoldType
    • HoverActions
    • InstantHandPose
    • ParentDisablesGrab
    • ParentGrabbable
    • ReleasesOnHover
    • ScaleGrabbable
    • Size
    • SocketFilters
    • SpawnedPrefab
  • Properties
    • AllowSwap
    • CanAddGrabbable
    • CanInteract
    • IsGrabActivated
    • IsHoldActive
    • IsSocket
    • LinkedGrabbable
  • Methods
    • CanGrab(HVRGrabbable)
    • CanGrabbableBeRemoved(HVRHandGrabber)
    • CanGrabEx(HVRGrabbable)
    • CanHover(HVRGrabbable)
    • CheckAutoSpawn()
    • CheckGrab()
    • CheckHover()
    • CleanupRigidBody(HVRGrabbable)
    • GetDistanceToGrabber(Vector3)
    • GetPositionOffset(HVRGrabbable)
    • GetRotationOffset(HVRGrabbable)
    • GetSquareDistanceToGrabber(Vector3)
    • GetTargetPosition(HVRGrabbable)
    • GetTargetRotation(HVRGrabbable)
    • GrabTimeoutRoutine(HVRGrabbable)
    • HandleRigidBodyGrab(HVRGrabbable)
    • IsValid(HVRGrabbable)
    • OnAfterHover(HVRGrabbable)
    • OnBeforeHover(HVRGrabbable)
    • OnGrabbableParented(HVRGrabbable)
    • OnGrabbed(HVRGrabArgs)
    • OnHandGrabberEntered()
    • OnHandGrabberExited()
    • OnHoverEnter(HVRGrabbable)
    • OnHoverExit(HVRGrabbable)
    • OnHoverGrabbableReleased(HVRGrabberBase, HVRGrabbable)
    • OnReleased(HVRGrabbable)
    • PlaySFX(AudioClip)
    • PlaySocketedSFX(HVRSocketable)
    • PlayUnsocketedSFX(HVRGrabbable)
    • PositionGrabbable(HVRGrabbable)
    • RotateGrabbable(HVRGrabbable)
    • Start()
    • TryGrab(HVRGrabbable, Boolean, Boolean)
    • Update()
    • UpdateScale(HVRGrabbable)
  • Extension Methods
Back to top Generated by DocFX