Show / Hide Table of Contents

Class HVRForcePullSettings

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
HVRForcePullSettings
Inherited Members
UnityEngine.ScriptableObject.SetDirty()
UnityEngine.ScriptableObject.CreateInstance(System.String)
UnityEngine.ScriptableObject.CreateInstance(System.Type)
UnityEngine.ScriptableObject.CreateInstance<T>()
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.ScriptableObjects
Assembly: HurricaneVR.Framework.dll
Syntax
[CreateAssetMenu(menuName = "HurricaneVR/Force Pull Settings", fileName = "ForcePullSettings")]
public class HVRForcePullSettings : ScriptableObject

Fields

| Improve this Doc View Source

CounterGravityFactor

Amount of gravity force to counteract when pulling.

Declaration
[Tooltip("Amount of gravity force to counteract when pulling.")]
[Range(0.1F, 1F)]
public float CounterGravityFactor
Field Value
Type Description
System.Single
| Improve this Doc View Source

DampDistance

ActiveDampRate applies once the object is within this distance to the hand.

Declaration
[Tooltip("ActiveDampRate applies once the object is within this distance to the hand.")]
public float DampDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

DampSpeed

Object smooth lerps to the hand's velocity at this rate within DampDistance to the object.

Declaration
[FormerlySerializedAs("ActiveDampRate")]
[Tooltip("Object smooth lerps to the hand's velocity at this rate within DampDistance to the object")]
public float DampSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

DistanceThreshold

Distance to the hand when auto grab will occur for non dynamic posed grabs.

Declaration
[Tooltip("Distance to the hand when auto grab will occur for non dynamic posed grabs.")]
[Range(0.01F, 0.3F)]
public float DistanceThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

DynamicGrabThreshold

Distance to the hand when auto grab will occur for dynamic posed grabs.

Declaration
[Tooltip("Distance to the hand when auto grab will occur for dynamic posed grabs.")]
[Range(0.1F, 0.3F)]
public float DynamicGrabThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxAccelerationForce

Maximum acceleration force applied to get the object up to speed.

Declaration
[Tooltip("Maximum acceleration force applied to get the object up to speed.")]
public float MaxAccelerationForce
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxMissAngularSpeed

Angular Velocity is capped at this speed if released before grabbing

Declaration
[Tooltip("Max Angular Velocity after releasing this object and not grabbing it")]
public float MaxMissAngularSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxMissSpeed

Velocity is capped at this speed if released before grabbing

Declaration
[Tooltip("Velocity magnitude cap after releasing this object and not grabbing it")]
public float MaxMissSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

MaxSpeed

Max linear velocity the object will move toward your hand

Declaration
[FormerlySerializedAs("Speed")]
[Tooltip("Max linear velocity the object will move toward your hand")]
public float MaxSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

RotateOverDistance

Declaration
[Tooltip("Rotation Max Velocity is calculated based on Speed over this distance")]
[DrawIf("RotationStyle", ForceRotationStyle.RotateOverDistance, DrawIfAttribute.DisablingType.DontDraw)]
public float RotateOverDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

RotateTriggerDistance

Declaration
[Tooltip("'DistanceToHand' Trigger: Once distance from the hand to the object is below this value, the object will rotate into pose orientation.")]
[DrawIf("RotationTrigger", ForcePullRotationTrigger.DistanceToHand, DrawIfAttribute.DisablingType.DontDraw)]
public float RotateTriggerDistance
Field Value
Type Description
System.Single
| Improve this Doc View Source

RotateTriggerPercent

Declaration
[Tooltip("'PercentTraveled' Trigger: Start rotating after traveling this percentage of initial distance to the hand.")]
[DrawIf("RotationTrigger", ForcePullRotationTrigger.PercentTraveled, DrawIfAttribute.DisablingType.DontDraw)]
public float RotateTriggerPercent
Field Value
Type Description
System.Single
| Improve this Doc View Source

RotateTriggerTime

Declaration
[Tooltip("'TimeSinceStart' Trigger: Start rotating after pulling for this amount of time if TimeSinceStart mode")]
[DrawIf("RotationTrigger", ForcePullRotationTrigger.TimeSinceStart, DrawIfAttribute.DisablingType.DontDraw)]
public float RotateTriggerTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

RotationStyle

Declaration
[Header("Pose Rotation Style")]
public ForceRotationStyle RotationStyle
Field Value
Type Description
ForceRotationStyle
| Improve this Doc View Source

RotationTrigger

DistanceToHand: once within this range to the hand TimeSinceStart: after elapsed time since start of pull PercentTraveled: remaining distance / distance at time of grab

Declaration
[Header("Pose Rotation Trigger")]
[Tooltip("What causes the rotation to the pose rotation to start?")]
public ForcePullRotationTrigger RotationTrigger
Field Value
Type Description
ForcePullRotationTrigger
| Improve this Doc View Source

SlerpDamper

Declaration
public float SlerpDamper
Field Value
Type Description
System.Single
| Improve this Doc View Source

SlerpMaxForce

Declaration
public float SlerpMaxForce
Field Value
Type Description
System.Single
| Improve this Doc View Source

SlerpSpring

Declaration
[Header("Pose Rotation PD Controller")]
public float SlerpSpring
Field Value
Type Description
System.Single
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX