Avatar Class

Encapsulates all Avatar functionality. Is abstract and have two concrete implementations: Local and Remote.

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.AvatarsAvatar
              ImmerseSDK.AvatarsAvatarLocal
              ImmerseSDK.AvatarsAvatarRemote

Namespace: ImmerseSDK.Avatars
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

Copy

[ScriptOrderAttribute(-30000)]
public abstract class Avatar : LoggingBehaviour, 
	IAvatar, IAvatarDataProvider, ISerialisationDataProvider, IAvatarDataConsumer, ISerialisationDataConsumer

The Avatar type exposes the following members.

Constructors

	Name	Description
	Avatar
	Avatar	Initializes a new instance of the Avatar class

Top

Properties

	Name	Description
	Color	This Avatar's color
	Controllers	Controllers associated with this Avatar
	Initialised	True if this object has been initialsed
	MaterialInstance	Instance of this Avatar's material. Loaded from "Avatars/AvatarVR_Material" resource
	Owner	User that owns this Avatar
	Position	Current position in world coordinates
	Root	Root of this avatar (the play area's center)
	Rotation	Current rotation in world coordinate system
	TrackedTransformCount	Number of tracked transforms that this Avatar is using
	Transforms	Important transforms for this Avatar

Top

Methods

	Name	Description
	AreAnyControllersEngaged	Returns true if any of the controllers are currently engaging with an object
	Find(UserID)	Returns the user avatar for the given user id
	FindT(UserID)	Returns the user avatar for the given user id, cast to the given type or interface
	FindLocal	Returns the local user avatar
	FindLocalT	Returns the local user avatar cast to the given type or interface
	GetBounds	Returns the bounds volume that represents this avatar's location in space
	GetController	Gets a reference to the controller object for the specified hand
	GetControllerSerialisation	Gets the controller serialisation implementation
	IsLocal	Returns true if the avatar is a local one
	OnDestroy	Unity component method
	SelectAvatarCameraTarget	Enable the avatar camera target
	SetLocation(Spawn)	Sets this avatar's location based on the specified Spawn point
	SetLocation(Vector3, NullableQuaternion, Boolean)	Moves the avatar's to the specified position and rotation in worldspace. If correctForPlaySpace is TRUE, then the Avatar's head will appear at the location specified. If correctForPlaySpace is FALSE, then the play space's center will appear at the location specified
	ShowTeleportTrail
	ToggleHeadVisibility	Toggle visibility of the head mesh

Top

Events

	Name	Description
	OnAvatarDestroyed	Fired when an Avatar is destroyed
	OnAvatarInstantiated	Fired when an Avatar is instantiated

Top

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)

Top

Reference

ImmerseSDK.Avatars Namespace