Class DashboardOverlay

Namespace

OvrleUI

Assembly

OvrleUI.dll

Main class of Dashboard UI library.

public class DashboardOverlay : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

DashboardOverlay

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

OnDashboardClose

public UnityEvent OnDashboardClose

Field Value

UnityEvent

OnDashboardOpen

public UnityEvent OnDashboardOpen

Field Value

UnityEvent

dashboardCamera

[Header("Object Reference")]
public Camera dashboardCamera

Field Value

Camera

desktopCamera

public Camera desktopCamera

Field Value

Camera

eventSystem

To convert OpenVR events to Unity UI events with InputConverter.

public EventSystem eventSystem

Field Value

EventSystem

fallbackMiscSound

Fallback sound that plays when player clicks UI elements. If this is null, dashboard overlay automatically use SteamVR default sound. If system sound file is not found, this fallback sound used.

[SerializeField]
public AudioClip fallbackMiscSound

Field Value

AudioClip

fallbackNavigationSound

Fallback sound that plays when player clicks sidebar items. If this is null, dashboard overlay automatically use SteamVR default sound. If system sound file is not found, this fallback sound used.

[SerializeField]
public AudioClip fallbackNavigationSound

Field Value

AudioClip

isDashboardVisible

Dashboard is shown for player.

[HideInInspector]
public bool isDashboardVisible

Field Value

bool

miscSound

[HideInInspector]
public AudioSource miscSound

Field Value

AudioSource

navigationSound

[HideInInspector]
public AudioSource navigationSound

Field Value

AudioSource

showDashboardAtLaunch

Whether dashboard is shown at launch.

public bool showDashboardAtLaunch

Field Value

bool

showDesktopWindow

If true, dashboard overlay also displays on Unity player window and player can interact with mouse. Window size should be 16:9 aspect ratio to process dashboard event mouse position correctly.

public bool showDesktopWindow

Field Value

bool

vrSystem

When handleOvrLifecycle = true, you can use this variable to use OpenVR system methods.

[HideInInspector]
public CVRSystem vrSystem

Field Value

CVRSystem

Methods

Awake()

protected void Awake()

DashboardToScreenPoint(Vector2)

public static Vector2 DashboardToScreenPoint(Vector2 point)

Parameters

point Vector2

Returns

Vector2

HapticPulse()

public void HapticPulse()

HapticPulseStrong()

public void HapticPulseStrong()

HapticPulseWeak()

public void HapticPulseWeak()

ScreenToDashboardPoint(Vector2)

public static Vector2 ScreenToDashboardPoint(Vector2 point)

Parameters

point Vector2

Returns

Vector2

SetOverlayAlpha(float)

public void SetOverlayAlpha(float alpha)

Parameters

alpha float