 | AvatarRendererHand Class |
Provides references to the components that represent an avatar's hand at runtime.
You must attach an implementation of this class to the root game object of your custom avatar hand, so that the SDK can correctly identify it's parts.
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.AvatarsAvatarRendererHand
ImmerseSDKDefaultAvatarHandRenderer
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.AvatarsAvatarRendererHand
ImmerseSDKDefaultAvatarHandRenderer
Namespace: ImmerseSDK.Avatars
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
[HelpURLAttribute("https://immerse.readme.io/")] public abstract class AvatarRendererHand : UnityEngine.MonoBehaviour
The AvatarRendererHand type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AvatarRendererHand | Initializes a new instance of the AvatarRendererHand class |
Methods| Name | Description | |
|---|---|---|
| HandleGripChanged |
Sets the hand's grip amount.
|
| HandlePoseChanged |
Displays the given pose on the hand.
|
 | Hide |
Hides the avatar's hand.
This is usually called when a tool or hardware controller model is shown.
|
| Show |
Shows the avatar's hand.
|
| Validate |
Validates the prefab to ensure it has been setup correctly.
|
| ValidateReference |
Validates that a component reference is not null
|
Fields| Name | Description | |
|---|---|---|
 | AttachPoint |
A transform that defines the position that engageable objects will be attached to when engaged by this hand.
|
| FingerCollider |
A small collider used to detect collisions with the avatar's index finger when the hand is pointing.
|
| HandCollider |
A capsule collider used to detect general collisions with the avatar's whole hand.
|
| MainRenderer |
The main renderer used to display this part of the avatar
|
| MenuCheckOrigin |
A transform that defines the origin position of the raycast that determines whether the hand should be in a menu pointing state or not.
The world position of this transform should closely match the position of the MenuPointerOrigin when the hand is in the pointing state.
Note that the raycast will follow the forward direction of the given transform.
|
| MenuPointerOrigin |
A transform that defines the origin position of the menu pointer laser beam.
In the SDK's default avatar, this point is located at the end of the index finger.
Note that the laser beam will follow the forward direction of the given transform.
|
| PalmMenuAttachPoint |
A transform that defines the position that the palm menu should appear in.
|
| WatchAttachPoint |
A transform that defines the position where the watch will be attached to this hand.
If you would like to display a strap for the watch, then place the strap inside this transform.
You can check the alignment by temporarily placing the Watch prefab inside this transform in the Unity editor.
The Watch prefab is located in your Unity project at: ImmerseSDK/Assets/Resources/ImmerseSDK/Prefabs/Avatar/Tools.
|
| WatchMenuAttachPoint |
A transform that defines the position that the watch menu should appear in.
|
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.) |
See Also