Class HVRCameraRig

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

HVRCameraRig

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

Assembly: HurricaneVR.Framework.dll

Syntax

public class HVRCameraRig : MonoBehaviour

Fields

| Improve this Doc View Source

AdjustedCameraHeight

Floor offset height adjusted by the Standing camera scale (if any).

Declaration

public float AdjustedCameraHeight

Field Value

Type	Description
System.Single

| Improve this Doc View Source

Camera

HMD transform used to detect HMD movement at start

Declaration

[Header("Required Transforms")]
public Transform Camera

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

CameraScale

Camera's parent transform used to scale the camera and tracked device transforms when in standing mode.

Declaration

public Transform CameraScale

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

CameraYOffset

Manually setting this will raise / lower the HMD

Declaration

[Header("Manual Camera Offsetting")]
[Tooltip("Manually modify the camera height if needed")]
public float CameraYOffset

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DebugCalibMode

None - no initial calibration HMDMoved - Calibrates the height after the HMD moves more than DebugCalibMovedThreshold . Immediately - Calibrates height immediately

Declaration

public HVRDebugCalibrate DebugCalibMode

Field Value

Type	Description
HVRDebugCalibrate

| Improve this Doc View Source

DebugCalibMovedThreshold

When DebugCalibMode is HMDMoved - how much the HMD needs to move at start to trigger the auto calibration

Declaration

public float DebugCalibMovedThreshold

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DebugKeyboardIncrement

Declaration

public float DebugKeyboardIncrement

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DebugKeyboardOffset

Declaration

[Header("Debug Height Offsets")]
[Tooltip("If true, use up and down arrow to change YOffset to help with testing.")]
public bool DebugKeyboardOffset

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

DebugKeyboardRecalibrate

If true the height can be calibrated using the RelicbrateKey

Declaration

public bool DebugKeyboardRecalibrate

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

EyeHeight

Used with height calibration to define the virtual player's HMD sight line.

Declaration

[FormerlySerializedAs("PlayerHeight")]
[Tooltip("Height of the virtual player")]
public float EyeHeight

Field Value

Type	Description
System.Single

| Improve this Doc View Source

FloorOffset

Camera rig child used to offset the Y height of the HMD.

Declaration

public Transform FloorOffset

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

HeightKey

Declaration

public const string HeightKey = "SaveHVRHeight"

Field Value

Type	Description
System.String

| Improve this Doc View Source

PlayerControllerYOffset

Set by the player controller to raise / lower the camera rig when performing a input driven crouch.

Declaration

[Header("For Debugging Display only")]
public float PlayerControllerYOffset

Field Value

Type	Description
System.Single

| Improve this Doc View Source

SaveCalibrationHeight

Declaration

[Header("Debug Height Calibration")]
[Tooltip("Calibration height is saved to player prefs when height is calibrated.")]
public bool SaveCalibrationHeight

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

SitStanding

Sitting - FloorOffset height is adjusted based on the difference between the HMD height and the EyeHeight. Standing - CameraScale is scaled based on the ratio of EyeHeight / HMD height. PlayerHeight - No offsetting or scaling performed.

Declaration

[Tooltip("Sitting or standing mode")]
public HVRSitStand SitStanding

Field Value

Type	Description
HVRSitStand

| Improve this Doc View Source

SittingOffset

Delta between the hmd height and the EyeHeight

Declaration

public float SittingOffset

Field Value

Type	Description
System.Single

Properties

| Improve this Doc View Source

IsMine

Set to false on player prefab clones if using multiplayer frameworks like PUN

Declaration

public bool IsMine { get; set; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

Calibrate()

Calibrates the height using the HMD height.

Declaration

public void Calibrate()

| Improve this Doc View Source

CalibrateFromSaved()

Declaration

protected virtual void CalibrateFromSaved()

| Improve this Doc View Source

CalibrateHeight(Single)

Calibrates the camera rig height.

Declaration

public virtual void CalibrateHeight(float height)

Parameters

Type	Name	Description
System.Single	height	Height to compare against - usually the HMD device height or a saved value from a prior calibration.

| Improve this Doc View Source

GetYOffset()

Returns the Y offset to apply to the camera rig.

Declaration

protected virtual float GetYOffset()

Returns

Type	Description
System.Single

| Improve this Doc View Source

SetSitStandMode(HVRSitStand)

Updates the height calibration mode and forces a height calibration that uses the HMD height.

Declaration

public void SetSitStandMode(HVRSitStand sitStand)

Parameters

Type	Name	Description
HVRSitStand	sitStand

| Improve this Doc View Source

Start()

Declaration

protected virtual void Start()

| Improve this Doc View Source

Update()

Declaration

protected virtual void 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)