Class VRAvatarLimb

An abstract base class representing an avatar limb.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
VRAvatarLimb
VRAvatarHand
VRAvatarHead
Implements
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]
public abstract class VRAvatarLimb : MonoBehaviour, IVRAvatarLimb

Properties

| Improve this Doc View Source

Anchor

Gets the anchor transform for the limb.

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

AttachedObjects

Gets the list of GameObjects currently attached to the limb anchor.

Declaration
public List<GameObject> AttachedObjects { get; }
Property Value
Type Description
System.Collections.Generic.List<UnityEngine.GameObject>
| Improve this Doc View Source

Avatar

Gets the IVRAvatar the limb is attached to.

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

DeviceComponent

Gets the IVRDeviceComponent the limb is assigned to.

Declaration
public abstract IVRDeviceComponent DeviceComponent { get; }
Property Value
Type Description
IVRDeviceComponent
| Improve this Doc View Source

Events

Gets the limb events.

Declaration
public VRAvatarLimb.LimbEvents Events { get; }
Property Value
Type Description
VRAvatarLimb.LimbEvents
| Improve this Doc View Source

IsActive

Indicates if the limb is currently active.

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

LimbType

Gets the VRAvatarLimbType of this limb.

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

TrackedObject

Gets the tracked object assigned to the limb.

Declaration
public IVRTrackedObjectProxy TrackedObject { get; set; }
Property Value
Type Description
IVRTrackedObjectProxy
| Improve this Doc View Source

TrackingSettings

Gets or sets the tracking settings for the limb.

Declaration
public VRAvatarLimb.TrackedObjectSettings TrackingSettings { get; set; }
Property Value
Type Description
VRAvatarLimb.TrackedObjectSettings
| Improve this Doc View Source

Transform

Gets the transform for this limb.

Declaration
public Transform Transform { get; }
Property Value
Type Description
UnityEngine.Transform

Methods

| Improve this Doc View Source

Attach(GameObject, AnchorAttachFlags)

Attaches a UnityEngine.GameObject to the limb anchor.

Declaration
public void Attach(GameObject gameObject, AnchorAttachFlags flags = AnchorAttachFlags.ReparentToAnchor | AnchorAttachFlags.Default)
Parameters
Type Name Description
UnityEngine.GameObject gameObject

The UnityEngine.GameObject to attach to the limb anchor.
AnchorAttachFlags flags

Options for attaching the object to the limb anchor.
| Improve this Doc View Source

Awake()

Declaration
protected virtual void Awake()
| Improve this Doc View Source

LateUpdate()

Declaration
protected virtual void LateUpdate()
| Improve this Doc View Source

OnDestroy()

Declaration
protected virtual void OnDestroy()
| Improve this Doc View Source

OnTransformParentChanged()

Declaration
protected virtual void OnTransformParentChanged()
| Improve this Doc View Source

SetActive(Boolean)

Sets the active state for the limb.

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

The active state of the limb.
| Improve this Doc View Source

Unattach(GameObject, Transform)

Unattaches a UnityEngine.GameObject from the limb anchor and attaches to the specified parent. If no parent transform is supplied, the object will be reparented to the scene root.

Declaration
public bool Unattach(GameObject gameObject, Transform newParent = null)
Parameters
Type Name Description
UnityEngine.GameObject gameObject

The UnityEngine.GameObject to unattach.
UnityEngine.Transform newParent

The Transform to reparent the object to. Use null to reparent to the scene root.
Returns
Type Description
System.Boolean

A boolean indicating if the object was successfully unattached.
| Improve this Doc View Source

UnattachAll(Transform)

Unattaches all GameObjects from the limb and reparents them to newParent.

Declaration
public void UnattachAll(Transform newParent = null)
Parameters
Type Name Description
UnityEngine.Transform newParent

The transform to parent all current attachments to.
| Improve this Doc View Source

UpdateState()

[Internal use only] Updates the internal state of the limb. You should not call this from your own code.

Declaration
public void UpdateState()

Implements

Extension Methods