Click or drag to resize

AvatarRenderer Class

Provides references to the components that represent an avatar's head and hands at runtime. You must attach an implementation of this class to your custom avatar prefab, so that the SDK can correctly identify it's head and hands.
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDK.AvatarsAvatarRenderer
            ImmerseSDKDefaultAvatarRenderer

Namespace:  ImmerseSDK.Avatars
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
Syntax
C#
Copy
[HelpURLAttribute("https://immerse.readme.io/")]
public abstract class AvatarRenderer : UnityEngine.MonoBehaviour

The AvatarRenderer type exposes the following members.

Constructors
  NameDescription
Protected methodAvatarRenderer
Initializes a new instance of the AvatarRenderer class
Top
Properties
  NameDescription
Public propertyIndex
The index of this Avatar Renderer.
Public propertyVisualId
The unique Visual Id currently assigned to this avatar.
Top
Methods
  NameDescription
Public methodGetColorForVisualId
Returns a 32bit color value that you have associated with this avatar. The value returned here will be used by the Immerse SDK for things such as highlighting interactive objects and coloring the user's camera button in WebGL.
Public methodInit
Initialises this avatar renderer before it is accessed by the Immerse SDK.
Public methodSetVisualId
Sets the avatar renderer's Visual Id. The Visual Id is guaranteed to be unique and can be used as an index or seed value to determine the visual representation of this avatar instance.
Top
Fields
  NameDescription
Public fieldHandLeft
A reference to the avatar's left hand inside this prefab.
Public fieldHandRight
A reference to the avatar's right hand inside this prefab.
Public fieldHead
A reference to the avatar head inside this prefab.
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also