Interface IVRAvatar

Base interface for VRAvatar instances.

Namespace: Liminal.SDK.VR.Avatars
Assembly: Liminal.SDK.dll
Syntax
public interface IVRAvatar

Properties

| Improve this Doc View Source

Auxiliaries

Gets the container for auxiliary systems.

Declaration
Transform Auxiliaries { get; }
Property Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

Hands

Gets a list of all hand limbs.

Declaration
IList<IVRAvatarHand> Hands { get; }
Property Value
Type Description
System.Collections.Generic.IList<IVRAvatarHand>
| Improve this Doc View Source

Head

Gets the Head limb.

Declaration
IVRAvatarHead Head { get; }
Property Value
Type Description
IVRAvatarHead
| Improve this Doc View Source

IsActive

Indicates if the avatar is currently active.

Declaration
bool IsActive { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Limbs

Gets a list of all limbs.

Declaration
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
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
Quaternion LookRotation { get; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

PrimaryHand

Gets the primary hand limb.

Declaration
IVRAvatarHand PrimaryHand { get; }
Property Value
Type Description
IVRAvatarHand
| Improve this Doc View Source

ScreenFader

Gets the IScreenFader that controls the screen fades for this avatar.

Declaration
IScreenFader ScreenFader { get; }
Property Value
Type Description
IScreenFader
| Improve this Doc View Source

SecondaryHand

Gets the secondary hand limb.

Declaration
IVRAvatarHand SecondaryHand { get; }
Property Value
Type Description
IVRAvatarHand
| Improve this Doc View Source

Transform

Gets the avatar's transform.

Declaration
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
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
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 type of the extension.
| 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
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
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
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
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
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
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 the avatar extension components.

Declaration
void InitializeExtensions()
| Improve this Doc View Source

SetActive(Boolean)

Sets the active state for the avatar.

Declaration
void SetActive(bool activeState)
Parameters
Type Name Description
System.Boolean activeState

The active state for the avatar.
| Improve this Doc View Source

SetHandsActiveState(Boolean)

Sets the active state for the hand limbs.

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

Extension Methods