Class HVRGrabberBase

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRGrabberBase
HVRForceGrabber
HVRHandGrabber
HVRSocket
HVRSocketContainerGrabber
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 abstract class HVRGrabberBase : MonoBehaviour

Fields

| Improve this Doc View Source

_grabPoint

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

BeforeGrabbed

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

BeforeHoverEnter

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

GrabBags

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

Grabbed

Declaration
public VRGrabberEvent Grabbed
Field Value
Type Description
VRGrabberEvent
| 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

Released

Declaration
public VRGrabberEvent Released
Field Value
Type Description
VRGrabberEvent

Properties

| Improve this Doc View Source

AllowGrabbing

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

AllowHovering

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

AllowSwap

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

ControllerRotation

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

GrabbedTarget

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

GrabPoint

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

HoverTarget

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

IsGrabActivated

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

IsGrabbing

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

IsHandGrabber

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

IsHoldActive

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

IsHovering

Declaration
public bool IsHovering { 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

IsSocket

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

JointAnchorWorldPosition

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

PerformUpdate

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

PullingGrabbable

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

Rigidbody

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

Methods

| Improve this Doc View Source

Awake()

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

CanGrab(HVRGrabbable)

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

CanHover(HVRGrabbable)

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

CheckForLineOfSight(Vector3, HVRGrabbable, LayerMask, Single, Boolean)

Declaration
public bool CheckForLineOfSight(Vector3 rayOrigin, HVRGrabbable grabbable, LayerMask RaycastLayermask, float rayMaxDistance = 0.75F, bool useClosestPoint = true)
Parameters
Type Name Description
UnityEngine.Vector3 rayOrigin
HVRGrabbable grabbable
UnityEngine.LayerMask RaycastLayermask
System.Single rayMaxDistance
System.Boolean useClosestPoint
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckGrab()

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

CheckHover()

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

CheckRelease()

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

CheckSwapRelease(HVRGrabbable)

Will check if this object should be released from it's primary grabber and release it if so.

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

CheckSwapReleaseRequired(HVRGrabbable)

Returns true if this object should be released from it's existing grabber prior to be grabbed by another.

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

CheckUnHover()

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

ClosestValidHover()

Declaration
protected HVRGrabbable ClosestValidHover()
Returns
Type Description
HVRGrabbable
| Improve this Doc View Source

ClosestValidHover(Boolean)

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

FixedUpdate()

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

ForceRelease()

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

GetClosestGrabbable()

Returns the closest grabbable in the grabbable bag.

Declaration
public virtual HVRGrabbable GetClosestGrabbable()
Returns
Type Description
HVRGrabbable
| Improve this Doc View Source

GetClosestGrabbable(Predicate<HVRGrabbable>)

Returns the closest grabbable in the grabbable bag that satisfies canGrab delegate.

Declaration
public virtual HVRGrabbable GetClosestGrabbable(Predicate<HVRGrabbable> canGrab)
Parameters
Type Name Description
System.Predicate<HVRGrabbable> canGrab
Returns
Type Description
HVRGrabbable
| Improve this Doc View Source

GrabGrabbable(HVRGrabberBase, HVRGrabbable, Boolean)

Declaration
protected virtual void GrabGrabbable(HVRGrabberBase grabber, HVRGrabbable grabbable, bool raiseEvents = true)
Parameters
Type Name Description
HVRGrabberBase grabber
HVRGrabbable grabbable
System.Boolean raiseEvents
| Improve this Doc View Source

HoverGrabbable(HVRGrabberBase, HVRGrabbable)

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

IsValidGrabbable(HVRGrabbable)

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

OnAfterGrabbed(HVRGrabbable)

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

OnAfterHover(HVRGrabbable)

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

OnBeforeGrabbed(HVRGrabArgs)

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

OnBeforeHover(HVRGrabbable)

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

OnDestroy()

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

OnDisable()

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

OnEnable()

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

OnGrabbableDestroyed(HVRGrabbable)

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

OnGrabbed(HVRGrabArgs)

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

OnHoverEnter(HVRGrabbable)

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

OnHoverExit(HVRGrabbable)

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

OnReleased(HVRGrabbable)

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

ReleaseGrabbable(HVRGrabberBase, HVRGrabbable, Boolean, Boolean)

Executes the release sequence on the provided grabber and grabbable.

Declaration
public static void ReleaseGrabbable(HVRGrabberBase grabber, HVRGrabbable grabbable, bool raiseEvents = true, bool isHandSwap = false)
Parameters
Type Name Description
HVRGrabberBase grabber
HVRGrabbable grabbable
System.Boolean raiseEvents

If true the Released Unity events on the grabber and grabbable will execute.
System.Boolean isHandSwap
| Improve this Doc View Source

Start()

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

SwapRelease(HVRGrabbable)

Releases the grabbable from it's current grabber, this is prior to being grabbed by another grabber.

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

TryGrab(HVRGrabbable, Boolean)

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

TryGrabNoEvents(HVRGrabbable, Boolean)

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

UnhoverGrabbable(HVRGrabberBase, HVRGrabbable)

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

Update()

Declaration
protected virtual void Update()

Extension Methods