Class HVRLever

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

HVRLever

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

Assembly: HurricaneVR.Framework.dll

Syntax

[RequireComponent(typeof(HVRGrabbable))]
[RequireComponent(typeof(HingeJoint))]
public class HVRLever : MonoBehaviour

Fields

| Improve this Doc View Source

AudioClip

Declaration

[Tooltip("SFX to play whenever the lever snaps")]
public AudioClip AudioClip

Field Value

Type	Description
UnityEngine.AudioClip

| Improve this Doc View Source

CurrentAngle

Declaration

public float CurrentAngle

Field Value

Type	Description
System.Single

| Improve this Doc View Source

CurrentStep

Declaration

public int CurrentStep

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

DiscardAngle

Declaration

[Header("Settings")]
[Tooltip("When the lever is released with Snap mode, should the grabbable handle snap to the RotationTarget")]
public bool DiscardAngle

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

HingeJoint

Declaration

protected HingeJoint HingeJoint

Field Value

Type	Description
UnityEngine.HingeJoint

| Improve this Doc View Source

LocalAxisStart

Declaration

[Tooltip("Vector of the starting 0 angle of the lever.")]
public Vector3 LocalAxisStart

Field Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

LocalRotationAxis

Declaration

public Vector3 LocalRotationAxis

Field Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

MaxAngle

Declaration

public float MaxAngle

Field Value

Type	Description
System.Single

| Improve this Doc View Source

MinAngle

Declaration

[Header("Debug")]
public float MinAngle

Field Value

Type	Description
System.Single

| Improve this Doc View Source

Moved

Declaration

public LeverMovedEvent Moved

Field Value

Type	Description
LeverMovedEvent

| Improve this Doc View Source

Offset

Declaration

[Tooltip("Angle offset the lever starts in relation to LocalAxisStart field")]
public float Offset

Field Value

Type	Description
System.Single

| Improve this Doc View Source

RotationTarget

Declaration

[Header("Transforms")]
[Tooltip("Target transform to rotate if the visual handle is not this object")]
public Transform RotationTarget

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

SnapTarget

Declaration

[Tooltip("Rotation Target snaps to the step angle size")]
public bool SnapTarget

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

Stepped

Declaration

public LeverSteppedEvent Stepped

Field Value

Type	Description
LeverSteppedEvent

| Improve this Doc View Source

Steps

Declaration

[Tooltip("Amount of steps the lever will click")]
public int Steps

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

StepSize

Declaration

public float StepSize

Field Value

Type	Description
System.Single

| Improve this Doc View Source

Tracker

Declaration

[Tooltip("Used to track the delta angle change, use with TrackerAxis.")]
public Transform Tracker

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

TrackerAxis

Declaration

[Tooltip("Choose an axis that isn't the same as the hinge axis")]
public Vector3 TrackerAxis

Field Value

Type	Description
UnityEngine.Vector3

Properties

| Improve this Doc View Source

Grabbable

Declaration

public HVRGrabbable Grabbable { get; }

Property Value

Type	Description
HVRGrabbable

| Improve this Doc View Source

PrimaryGrabber

Declaration

public HVRGrabberBase PrimaryGrabber { get; }

Property Value

Type	Description
HVRGrabberBase

| Improve this Doc View Source

Range

Declaration

public float Range { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Rigidbody

Declaration

public Rigidbody Rigidbody { get; }

Property Value

Type	Description
UnityEngine.Rigidbody

Methods

| Improve this Doc View Source

FixedUpdate()

Declaration

protected virtual void FixedUpdate()

| Improve this Doc View Source

OnAngleChanged(Single, Single, Single, Boolean)

Declaration

protected virtual void OnAngleChanged(float angle, float delta, float percent, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Single	angle
System.Single	delta
System.Single	percent
System.Boolean	raiseEvents

| Improve this Doc View Source

OnGrabbed(HVRGrabberBase, HVRGrabbable)

Declaration

protected void OnGrabbed(HVRGrabberBase grabber, HVRGrabbable hvrGrabbable)

Parameters

Type	Name	Description
HVRGrabberBase	grabber
HVRGrabbable	hvrGrabbable

| Improve this Doc View Source

OnReleased(HVRGrabberBase, HVRGrabbable)

Declaration

protected void OnReleased(HVRGrabberBase grabber, HVRGrabbable hvrGrabbable)

Parameters

Type	Name	Description
HVRGrabberBase	grabber
HVRGrabbable	hvrGrabbable

| Improve this Doc View Source

OnStepChanged(Int32, Boolean)

Declaration

protected virtual void OnStepChanged(int step, bool raiseEvents = true)

Parameters

Type	Name	Description
System.Int32	step
System.Boolean	raiseEvents

| Improve this Doc View Source

Start()

Declaration

protected void Start()

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)