Class VRAvatar

A full, concrete implementation of IVRAvatar.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

VRAvatar

Implements

IVRAvatar

Inherited Members

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/Avatar Body")]
public class VRAvatar : MonoBehaviour, IVRAvatar

Properties

| Improve this Doc View Source

Active

Gets the current active IVRAvatar.

Declaration

public static IVRAvatar Active { get; }

Property Value

Type	Description
IVRAvatar

| Improve this Doc View Source

Auxiliaries

Gets the container for auxiliary systems.

Declaration

public Transform Auxiliaries { get; }

Property Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

Extensions

Gets the list of all extension assigned to the avatar.

Declaration

public IList<IVRAvatarExtension> Extensions { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IVRAvatarExtension>

| Improve this Doc View Source

Hands

Gets a list of all hand limbs.

Declaration

public IList<IVRAvatarHand> Hands { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IVRAvatarHand>

| Improve this Doc View Source

Head

Gets the Head limb.

Declaration

public IVRAvatarHead Head { get; }

Property Value

Type	Description
IVRAvatarHead

| Improve this Doc View Source

IsActive

Indicates if the avatar is currently active.

Declaration

public bool IsActive { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Limbs

Gets a list of all limbs.

Declaration

public IList<IVRAvatarLimb> Limbs { get; }

Property Value

Type	Description
System.Collections.Generic.IList<IVRAvatarLimb>

| Improve this Doc View Source

LookForward

Gets the forward looking direction vector for the avatar. This is a shortcut to the head's active eye camera forward.

Declaration

public Vector3 LookForward { get; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

LookRotation

Gets the looking rotation for the avatar. This is a shortcut to the head's active eye camera rotation.

Declaration

public Quaternion LookRotation { get; }

Property Value

Type	Description
UnityEngine.Quaternion

| Improve this Doc View Source

PrimaryHand

Gets the primary hand limb.

Declaration

public IVRAvatarHand PrimaryHand { get; }

Property Value

Type	Description
IVRAvatarHand

| Improve this Doc View Source

ScreenFader

Gets the screen fader for the avatar.

Declaration

public IScreenFader ScreenFader { get; }

Property Value

Type	Description
IScreenFader

| Improve this Doc View Source

SecondaryHand

Gets the secondary hand limb.

Declaration

public IVRAvatarHand SecondaryHand { get; }

Property Value

Type	Description
IVRAvatarHand

| Improve this Doc View Source

Transform

Gets the avatar's transform.

Declaration

public Transform Transform { get; }

Property Value

Type	Description
UnityEngine.Transform

Methods

| Improve this Doc View Source

GetExtension(Type)

Get the first extension of the specified type, or null if no extension exists of this type.

Declaration

public IVRAvatarExtension GetExtension(Type type)

Parameters

Type	Name	Description
System.Type	type	The type of the extension.

Returns

Type	Description
IVRAvatarExtension	The extension of the specified type, or null if no extension exists of this type.

| Improve this Doc View Source

GetExtension<TExtension>()

Get the first extension of the specified type, or null if no extension exists of this type.

Declaration

public TExtension GetExtension<TExtension>()
    where TExtension : IVRAvatarExtension

Returns

Type	Description
TExtension	The extension of the specified type, or null if no extension exists of this type.

Type Parameters

Name	Description
TExtension	The extension of the specified type.

| Improve this Doc View Source

GetExtensions(Type, IList<IVRAvatarExtension>)

Gets all extensions of the specified type and places them into the supplied list and returns the number of objects that were added to the list. The list is cleared before any objects are added.

Declaration

public int GetExtensions(Type type, IList<IVRAvatarExtension> list)

Parameters

Type	Name	Description
System.Type	type	The type of the extensions to add.
System.Collections.Generic.IList<IVRAvatarExtension>	list	The list to add the extensions to.

Returns

Type	Description
System.Int32	The number of objects that were added to the list.

| Improve this Doc View Source

GetExtensions<TExtension>(IList<TExtension>)

Gets all extensions of the specified type and places them into the supplied list and returns the number of objects that were added to the list. The list is cleared before any objects are added.

Declaration

public int GetExtensions<TExtension>(IList<TExtension> list)
    where TExtension : IVRAvatarExtension

Parameters

Type	Name	Description
System.Collections.Generic.IList<TExtension>	list	The list to add the extensions to.

Returns

Type	Description
System.Int32	The number of objects that were added to the list.

Type Parameters

Name	Description
TExtension	The type of the extensions to add.

| Improve this Doc View Source

GetLimb(VRAvatarLimbAlias)

Gets the limb for the specified VRAvatarLimbAlias alias.

Declaration

public IVRAvatarLimb GetLimb(VRAvatarLimbAlias alias)

Parameters

Type	Name	Description
VRAvatarLimbAlias	alias	The limb alias.

Returns

Type	Description
IVRAvatarLimb	The IVRAvatarLimb for the specified alias, or null if no limb is available for the supplied alias value.

| Improve this Doc View Source

GetLimb(VRAvatarLimbType)

Gets the first IVRAvatarLimb of the specified type attached to the avatar.

Declaration

public IVRAvatarLimb GetLimb(VRAvatarLimbType type)

Parameters

Type	Name	Description
VRAvatarLimbType	type	The VRAvatarLimbType of the limb to retrieve.

Returns

Type	Description
IVRAvatarLimb	The first IVRAvatarLimb of the specified type.

| Improve this Doc View Source

GetLimb(IVRDeviceComponent)

Gets the IVRAvatarLimb assigned to the specified IVRDeviceComponent.

Declaration

public IVRAvatarLimb GetLimb(IVRDeviceComponent deviceComponent)

Parameters

Type	Name	Description
IVRDeviceComponent	deviceComponent	The VR device component of the limb to retrieve.

Returns

Type	Description
IVRAvatarLimb	The IVRAvatarLimb assigned to the specified IVRDeviceComponent.

| Improve this Doc View Source

HasLimb(VRAvatarLimbType)

Indicates if the avatar has a IVRAvatarLimb of the specified VRAvatarLimbType type.

Declaration

public bool HasLimb(VRAvatarLimbType type)

Parameters

Type	Name	Description
VRAvatarLimbType	type	The VRAvatarLimbType of the limb to search for.

Returns

Type	Description
System.Boolean	A boolean indicating if the avatar has a IVRAvatarLimb of the specified VRAvatarLimbType type.

| Improve this Doc View Source

InitializeExtensions()

Initializes all avatar extensions.

Declaration

public void InitializeExtensions()

| Improve this Doc View Source

SetActive(Boolean)

Sets the active state for the avatar.

Declaration

public void SetActive(bool activeState)

Parameters

Type	Name	Description
System.Boolean	activeState	The active state to set.

| Improve this Doc View Source

SetHandsActiveState(Boolean)

Sets the active state for the hand limbs.

Declaration

public void SetHandsActiveState(bool activeState)

Parameters

Type	Name	Description
System.Boolean	activeState	The active state for the hand limbs.

| Improve this Doc View Source

SetLimbActiveState(VRAvatarLimbType, Boolean)

Sets the active state for all limbs of the specified VRAvatarLimbType.

Declaration

public void SetLimbActiveState(VRAvatarLimbType limbType, bool activeState)

Parameters

Type	Name	Description
VRAvatarLimbType	limbType	The VRAvatarLimbType.
System.Boolean	activeState	The active state for all limbs of the supplied type.

Events

| Improve this Doc View Source

AvatarChanged

Raised when the active avatar has changed.

Declaration

public static event VRAvatarEventHandler AvatarChanged

Event Type

Type	Description
VRAvatarEventHandler

Implements

IVRAvatar

Extension Methods

VRAvatarExtensions.GetLimb(IVRAvatar, PointerEventData)

VRAvatarExtensions.GetLimb(IVRAvatar, VRPointerEventData)

VRAvatarExtensions.GetHand(IVRAvatar, PointerEventData)

VRAvatarExtensions.GetHand(IVRAvatar, VRPointerEventData)

VRAvatarExtensions.GetHand(IVRAvatar, VRInputDeviceHand)

VRAvatarExtensions.GetHand(IVRAvatar, IVRDeviceComponent)

VRAvatarExtensions.CreateAuxiliaryObject(IVRAvatar, String, HideFlags)

VRAvatarExtensions.GetControllerVisual(IVRAvatar, PointerEventData)

VRAvatarExtensions.GetControllerVisual(IVRAvatar, VRPointerEventData)

VRAvatarExtensions.GetControllerVisual(IVRAvatar, VRInputDeviceHand)