Class HVRController

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRController
HVRXRInputController
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.Shared
Assembly: HurricaneVR.Framework.dll
Syntax
public abstract class HVRController : MonoBehaviour

Fields

| Improve this Doc View Source

AngularVelocity

Declaration
public Vector3 AngularVelocity
Field Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

AngularVelocityMagnitude

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

FingerCurls

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

Grip

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

GripButton

Supplied by SteamVR, OpenXR, or OVR input bindings

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

GripButtonState

Declaration
public HVRButtonState GripButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

GripForce

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

IndexCurl

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

JoystickAxis

Declaration
public Vector2 JoystickAxis
Field Value
Type Description
UnityEngine.Vector2
| Improve this Doc View Source

JoystickButtonState

Declaration
public HVRButtonState JoystickButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

JoystickClicked

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

JoystickTouch

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

JoystickTouchState

Declaration
public HVRButtonState JoystickTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

LeftFingerCurls

Declaration
public static float[] LeftFingerCurls
Field Value
Type Description
System.Single[]
| Improve this Doc View Source

MenuButton

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

MenuButtonState

Declaration
public HVRButtonState MenuButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

MiddleCurl

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

PinkyCurl

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

PrimaryButton

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

PrimaryButtonState

Declaration
public HVRButtonState PrimaryButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

PrimaryTouch

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

PrimaryTouchButtonState

Declaration
public HVRButtonState PrimaryTouchButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

RecentVelocities

Declaration
public readonly CircularBuffer<float> RecentVelocities
Field Value
Type Description
CircularBuffer<System.Single>
| Improve this Doc View Source

RightFingerCurls

Declaration
public static float[] RightFingerCurls
Field Value
Type Description
System.Single[]
| Improve this Doc View Source

RingCurl

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

SecondaryButton

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

SecondaryButtonState

Declaration
public HVRButtonState SecondaryButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

SecondaryTouch

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

SecondaryTouchButtonState

Declaration
public HVRButtonState SecondaryTouchButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

ThumbCurl

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

ThumbNearTouch

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

ThumbNearTouchState

Declaration
public HVRButtonState ThumbNearTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

ThumbTouch

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

ThumbTouchState

Declaration
public HVRButtonState ThumbTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackpadAxis

Declaration
public Vector2 TrackpadAxis
Field Value
Type Description
UnityEngine.Vector2
| Improve this Doc View Source

TrackpadButtonState

Declaration
public HVRButtonState TrackpadButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackPadClicked

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

TrackPadDown

Declaration
public HVRButtonState TrackPadDown
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackPadLeft

Declaration
public HVRButtonState TrackPadLeft
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackPadRight

Declaration
public HVRButtonState TrackPadRight
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackPadTouch

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

TrackPadTouchState

Declaration
public HVRButtonState TrackPadTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TrackPadUp

Declaration
public HVRButtonState TrackPadUp
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

Trigger

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

TriggerButton

Suppplied by SteamVR, OpenXR, or OVR input bindings

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

TriggerButtonState

Declaration
public HVRButtonState TriggerButtonState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TriggerNearTouch

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

TriggerNearTouchState

Declaration
public HVRButtonState TriggerNearTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

TriggerTouch

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

TriggerTouchState

Declaration
public HVRButtonState TriggerTouchState
Field Value
Type Description
HVRButtonState
| Improve this Doc View Source

Velocity

Declaration
public Vector3 Velocity
Field Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

VelocityMagnitude

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

XRNode

Declaration
public XRNode XRNode
Field Value
Type Description
UnityEngine.XR.XRNode

Properties

| Improve this Doc View Source

ControllerType

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

Device

Declaration
public InputDevice Device { get; }
Property Value
Type Description
UnityEngine.XR.InputDevice
| Improve this Doc View Source

FingerSettings

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

InputMap

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

IsActive

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

Knuckles

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

Side

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

ThumbstickDeadZone

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

Vive

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

WMR

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

Methods

| Improve this Doc View Source

AfterInputUpdate()

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

Awake()

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

CheckButtonState(HVRButtons, ref HVRButtonState)

Declaration
protected virtual void CheckButtonState(HVRButtons button, ref HVRButtonState buttonState)
Parameters
Type Name Description
HVRButtons button
HVRButtonState buttonState
| Improve this Doc View Source

GetAverageVelocity(Single)

Declaration
public float GetAverageVelocity(float seconds)
Parameters
Type Name Description
System.Single seconds
Returns
Type Description
System.Single
| Improve this Doc View Source

GetButtonState(HVRHandSide, HVRButtons)

Declaration
public static HVRButtonState GetButtonState(HVRHandSide side, HVRButtons button)
Parameters
Type Name Description
HVRHandSide side
HVRButtons button
Returns
Type Description
HVRButtonState
| Improve this Doc View Source

GetIsGripPressed()

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

GetIsTriggerPressed()

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

ResetButton(ref HVRButtonState)

Declaration
protected void ResetButton(ref HVRButtonState buttonState)
Parameters
Type Name Description
HVRButtonState buttonState
| Improve this Doc View Source

ResetTrackedVelocities()

Declaration
protected void ResetTrackedVelocities()
| Improve this Doc View Source

SetButtonState(HVRButtons, ref HVRButtonState, Boolean)

Declaration
protected void SetButtonState(HVRButtons button, ref HVRButtonState buttonState, bool pressed)
Parameters
Type Name Description
HVRButtons button
HVRButtonState buttonState
System.Boolean pressed
| Improve this Doc View Source

SetButtonState(HVRHandSide, HVRButtons, HVRButtonState)

Declaration
public static void SetButtonState(HVRHandSide side, HVRButtons button, HVRButtonState state)
Parameters
Type Name Description
HVRHandSide side
HVRButtons button
HVRButtonState state
| Improve this Doc View Source

Start()

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

UpdateFingerCurls()

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

UpdateInput()

Declaration
protected abstract void UpdateInput()
| Improve this Doc View Source

Vibrate(HapticData)

Declaration
public virtual void Vibrate(HapticData haptics)
Parameters
Type Name Description
HapticData haptics
| Improve this Doc View Source

Vibrate(Single, Single, Single)

Sends a haptic impulse to the controller.

Declaration
public virtual void Vibrate(float amplitude, float duration = 1F, float frequency = 1F)
Parameters
Type Name Description
System.Single amplitude

The normalized (0.0 to 1.0) amplitude value of the haptic impulse to play on the device.
System.Single duration

The duration in seconds that the haptic impulse will play. Only supported on Oculus.
System.Single frequency

Extension Methods