Class HVRForceGrabber

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

HVRGrabberBase

HVRForceGrabber

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.IsGrabActivated

HVRGrabberBase.IsHoldActive

HVRGrabberBase.IsHandGrabber

HVRGrabberBase.IsSocket

HVRGrabberBase.AllowSwap

HVRGrabberBase.Rigidbody

HVRGrabberBase._grabPoint

HVRGrabberBase.GrabPoint

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.CheckGrab()

HVRGrabberBase.TryGrab(HVRGrabbable, Boolean)

HVRGrabberBase.TryGrabNoEvents(HVRGrabbable, Boolean)

HVRGrabberBase.GrabGrabbable(HVRGrabberBase, HVRGrabbable, Boolean)

HVRGrabberBase.OnBeforeGrabbed(HVRGrabArgs)

HVRGrabberBase.OnAfterGrabbed(HVRGrabbable)

HVRGrabberBase.ClosestValidHover(Boolean)

HVRGrabberBase.ClosestValidHover()

HVRGrabberBase.CheckHover()

HVRGrabberBase.OnBeforeHover(HVRGrabbable)

HVRGrabberBase.OnAfterHover(HVRGrabbable)

HVRGrabberBase.HoverGrabbable(HVRGrabberBase, HVRGrabbable)

HVRGrabberBase.UnhoverGrabbable(HVRGrabberBase, HVRGrabbable)

HVRGrabberBase.OnReleased(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 HVRForceGrabber : HVRGrabberBase

Fields

AdditionalAutoGrabTime

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float AdditionalAutoGrabTime

Field Value

Type	Description
System.Single

AutoGrab

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public bool AutoGrab

Field Value

Type	Description
System.Boolean

AutoGrabDistance

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float AutoGrabDistance

Field Value

Type	Description
System.Single

FlickEndThreshold

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float FlickEndThreshold

Field Value

Type	Description
System.Single

FlickStartThreshold

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float FlickStartThreshold

Field Value

Type	Description
System.Single

ForcePullSettings

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.ForcePull, DrawIfAttribute.DisablingType.DontDraw)]
public HVRForcePullSettings ForcePullSettings

Field Value

Type	Description
HVRForcePullSettings

ForceTime

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float ForceTime

Field Value

Type	Description
System.Single

GrabIndicator

Declaration

public HVRGrabbableHoverBase GrabIndicator

Field Value

Type	Description
HVRGrabbableHoverBase

GrabPoser

Declaration

public HVRHandPoser GrabPoser

Field Value

Type	Description
HVRHandPoser

GrabStyle

Declaration

[Header("Settings")]
public HVRForceGrabMode GrabStyle

Field Value

Type	Description
HVRForceGrabMode

HandGrabber

Declaration

public HVRHandGrabber HandGrabber

Field Value

Type	Description
HVRHandGrabber

HoverPoser

Declaration

public HVRHandPoser HoverPoser

Field Value

Type	Description
HVRHandPoser

Laser

Declaration

[Header("Components")]
public HVRForceGrabberLaser Laser

Field Value

Type	Description
HVRForceGrabberLaser

MaximumVelocityAutoGrab

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float MaximumVelocityAutoGrab

Field Value

Type	Description
System.Single

MaximumVelocityPostCollision

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float MaximumVelocityPostCollision

Field Value

Type	Description
System.Single

MaxRayCastDistance

Declaration

[Tooltip("Max distance of the line of sight ray cast.")]
public float MaxRayCastDistance

Field Value

Type	Description
System.Single

QuickMoveResetThreshold

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float QuickMoveResetThreshold

Field Value

Type	Description
System.Single

QuickMoveThreshold

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float QuickMoveThreshold

Field Value

Type	Description
System.Single

RaycastLayermask

Declaration

[DrawIf("UseHandLayerMask", false, DrawIfAttribute.DisablingType.DontDraw)]
[Tooltip("Layer mask to determine line of sight to the grabbable.")]
public LayerMask RaycastLayermask

Field Value

Type	Description
UnityEngine.LayerMask

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

RequireLineOfSight

Declaration

[Header("Line of Sight")]
[Tooltip("If true, ray cast from the RaycastOrigin need to hit objects in the trigger collider, otherwise they can't be grabbed.")]
public bool RequireLineOfSight

Field Value

Type	Description
System.Boolean

RequiresFlick

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public bool RequiresFlick

Field Value

Type	Description
System.Boolean

SFXGrab

Declaration

public AudioClip SFXGrab

Field Value

Type	Description
UnityEngine.AudioClip

SlowMo

Declaration

[Header("Debug")]
public bool SlowMo

Field Value

Type	Description
System.Boolean

TimeScale

Declaration

public float TimeScale

Field Value

Type	Description
System.Single

UseClosestPoint

Declaration

[Tooltip("If true uses collider closest point as ray cast target, if not uses collider bounds center")]
public bool UseClosestPoint

Field Value

Type	Description
System.Boolean

UseHandLayerMask

Declaration

[Tooltip("If true, uses RaycastLayermask field of the hand grabber for line of sight checks.")]
public bool UseHandLayerMask

Field Value

Type	Description
System.Boolean

YOffset

Declaration

[DrawIf("GrabStyle", HVRForceGrabMode.GravityGloves, DrawIfAttribute.DisablingType.DontDraw)]
public float YOffset

Field Value

Type	Description
System.Single

Properties

AngularVelocityMagnitude

Declaration

public float AngularVelocityMagnitude { get; }

Property Value

Type	Description
System.Single

HandSide

Declaration

public HVRHandSide HandSide { get; }

Property Value

Type	Description
HVRHandSide

Inputs

Declaration

public HVRPlayerInputs Inputs { get; }

Property Value

Type	Description
HVRPlayerInputs

IsAiming

Declaration

public bool IsAiming { get; }

Property Value

Type	Description
System.Boolean

IsForceGrabbing

Declaration

public bool IsForceGrabbing { get; }

Property Value

Type	Description
System.Boolean

JointAnchorWorldPosition

Declaration

public override Vector3 JointAnchorWorldPosition { get; }

Property Value

Type	Description
UnityEngine.Vector3

Overrides

HVRGrabberBase.JointAnchorWorldPosition

VelocityMagnitude

Declaration

public float VelocityMagnitude { get; }

Property Value

Type	Description
System.Single

Methods

CanGrab(HVRGrabbable)

Declaration

public override bool CanGrab(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Returns

Type	Description
System.Boolean

Overrides

HVRGrabberBase.CanGrab(HVRGrabbable)

CanHover(HVRGrabbable)

Declaration

public override bool CanHover(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Returns

Type	Description
System.Boolean

Overrides

HVRGrabberBase.CanHover(HVRGrabbable)

CheckUnHover()

Declaration

protected override void CheckUnHover()

Overrides

HVRGrabberBase.CheckUnHover()

ForcePull(HVRGrabbable)

Declaration

public IEnumerator ForcePull(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Returns

Type	Description
System.Collections.IEnumerator

GravityGloves(HVRGrabbable)

Declaration

public IEnumerator GravityGloves(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Returns

Type	Description
System.Collections.IEnumerator

OnGrabbed(HVRGrabArgs)

Declaration

protected override void OnGrabbed(HVRGrabArgs args)

Parameters

Type	Name	Description
HVRGrabArgs	args

Overrides

HVRGrabberBase.OnGrabbed(HVRGrabArgs)

OnGrabbedHaptics()

Declaration

protected virtual void OnGrabbedHaptics()

OnHoverEnter(HVRGrabbable)

Declaration

protected override void OnHoverEnter(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Overrides

HVRGrabberBase.OnHoverEnter(HVRGrabbable)

OnHoverExit(HVRGrabbable)

Declaration

protected override void OnHoverExit(HVRGrabbable grabbable)

Parameters

Type	Name	Description
HVRGrabbable	grabbable

Overrides

HVRGrabberBase.OnHoverExit(HVRGrabbable)

OnHoverHaptics()

Declaration

protected virtual void OnHoverHaptics()

Start()

Declaration

protected override void Start()

Overrides

HVRGrabberBase.Start()

Update()

Declaration

protected override void Update()

Overrides

HVRGrabberBase.Update()

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)