Show / Hide Table of Contents

Class VRAvatarHead

A concrete implementation of IVRAvatarHead, representing the head limb.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
VRAvatarLimb
VRAvatarHead
Implements
IVRAvatarHead
IVRAvatarLimb
Inherited Members
VRAvatarLimb.Avatar
VRAvatarLimb.LimbType
VRAvatarLimb.TrackedObject
VRAvatarLimb.Anchor
VRAvatarLimb.AttachedObjects
VRAvatarLimb.Events
VRAvatarLimb.IsActive
VRAvatarLimb.Transform
VRAvatarLimb.TrackingSettings
VRAvatarLimb.OnTransformParentChanged()
VRAvatarLimb.LateUpdate()
VRAvatarLimb.UpdateState()
VRAvatarLimb.SetActive(Boolean)
VRAvatarLimb.Attach(GameObject, AnchorAttachFlags)
VRAvatarLimb.Unattach(GameObject, Transform)
VRAvatarLimb.UnattachAll(Transform)
UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
UnityEngine.MonoBehaviour.CancelInvoke()
UnityEngine.MonoBehaviour.CancelInvoke(System.String)
UnityEngine.MonoBehaviour.IsInvoking(System.String)
UnityEngine.MonoBehaviour.IsInvoking()
UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
UnityEngine.MonoBehaviour.StartCoroutine(System.String)
UnityEngine.MonoBehaviour.StopCoroutine(System.String)
UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
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.GetComponent(System.String)
UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInChildren(System.Type)
UnityEngine.Component.GetComponentInChildren<T>()
UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
UnityEngine.Component.GetComponentsInChildren(System.Type)
UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
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)
UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
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.SendMessageOptions)
UnityEngine.Component.SendMessage(System.String, System.Object)
UnityEngine.Component.SendMessage(System.String)
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.Component.rigidbody
UnityEngine.Component.rigidbody2D
UnityEngine.Component.camera
UnityEngine.Component.light
UnityEngine.Component.animation
UnityEngine.Component.constantForce
UnityEngine.Component.renderer
UnityEngine.Component.audio
UnityEngine.Component.guiText
UnityEngine.Component.networkView
UnityEngine.Component.guiElement
UnityEngine.Component.guiTexture
UnityEngine.Component.collider
UnityEngine.Component.collider2D
UnityEngine.Component.hingeJoint
UnityEngine.Component.particleEmitter
UnityEngine.Component.particleSystem
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.FindObjectsOfTypeAll(System.Type)
UnityEngine.Object.ToString()
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.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectOfType(System.Type)
UnityEngine.Object.name
UnityEngine.Object.hideFlags
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Liminal.SDK.VR.Avatars
Assembly: Liminal.SDK.dll
Syntax
[DisallowMultipleComponent]
[AddComponentMenu("VR/Avatar/Head")]
public class VRAvatarHead : VRAvatarLimb, IVRAvatarHead, IVRAvatarLimb

Properties

| Improve this Doc View Source

ActiveEyeCamera

Gets the active eye camera. If UsePerEyeCameras is

true
, this will return LeftEyeCamera if active, otherwise it will return CenterEyeCamera. This value should be used if you need to reference the camera, but do not need a specific eye camera.

Declaration
public Camera ActiveEyeCamera { get; }
Property Value
Type Description
UnityEngine.Camera
| Improve this Doc View Source

CenterEyeCamera

Gets the center eye camera. This camera has UnityEngine.Camera.stereoTargetEye set to UnityEngine.StereoTargetEyeMask.Both.

Declaration
public Camera CenterEyeCamera { get; }
Property Value
Type Description
UnityEngine.Camera
| Improve this Doc View Source

DeviceComponent

Gets the IVRDeviceComponent the limb is assigned to.

Declaration
public override IVRDeviceComponent DeviceComponent { get; }
Property Value
Type Description
IVRDeviceComponent
Overrides
VRAvatarLimb.DeviceComponent
| Improve this Doc View Source

Headset

Gets the IVRHeadset attached to this limb.

Declaration
public IVRHeadset Headset { get; }
Property Value
Type Description
IVRHeadset
| Improve this Doc View Source

LeftEyeCamera

Gets the left eye camera. This camera has UnityEngine.Camera.stereoTargetEye set to UnityEngine.StereoTargetEyeMask.Left.

Declaration
public Camera LeftEyeCamera { get; }
Property Value
Type Description
UnityEngine.Camera
| Improve this Doc View Source

RightEyeCamera

Gets the right eye camera. This camera has UnityEngine.Camera.stereoTargetEye set to UnityEngine.StereoTargetEyeMask.Right.

Declaration
public Camera RightEyeCamera { get; }
Property Value
Type Description
UnityEngine.Camera
| Improve this Doc View Source

UsePerEyeCameras

Determines if the left/right eye cameras are used, or if center eye camera is used. If true, the left and right eye cameras are used and the center eye camera is disabled. If false, the center eye camera is used and the left/right eye cameras are disabled.

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

Methods

| Improve this Doc View Source

Awake()

Declaration
protected override void Awake()
Overrides
VRAvatarLimb.Awake()
| Improve this Doc View Source

OnDestroy()

Declaration
protected override void OnDestroy()
Overrides
VRAvatarLimb.OnDestroy()

Events

| Improve this Doc View Source

ActiveCameraChanged

Raised when the active camera is changed.

Declaration
public event ActiveCameraChangedEventHandler ActiveCameraChanged
Event Type
Type Description
ActiveCameraChangedEventHandler

Implements

IVRAvatarHead
IVRAvatarLimb

Extension Methods

VRAvatarExtensions.GetControllerVisual(IVRAvatarLimb)
VRAvatarExtensions.InstantiateControllerVisual(IVRAvatarLimb)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX