UxrAvatarControllerEvent Class

Describes an event that maps an XR controller input to a hand pose. This allows to show different poses when certain buttons are pressed. It also allows to describe which poses need to be used when grabbing or pointing with the finger.

Inheritance Hierarchy

System.Object
  UltimateXR.Avatar.Controllers.UxrAvatarControllerEvent
Namespace: UltimateXR.Avatar.Controllers
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

[SerializableAttribute]
public class UxrAvatarControllerEvent


The UxrAvatarControllerEvent type exposes the following members.

Constructors

NameDescription
Public methodUxrAvatarControllerEvent

Properties

NameDescription
Public propertyButtons Gets or sets the button(s) that trigger the animation event.
Public propertyPoseBlendValue Gets or sets the pose blend value if the pose is Blend.
Public propertyPoseName Gets the hand pose name that should be used on the event.
Public propertyPoseNameOverride Gets or sets the pose name that will be used instead of the pose stored. If null, the pose will be used instead.
Public propertyTypeOfAnimation Gets the type of animation the event represents. This allows to keep track of certain key animations such as grabbing or pointing with the finger, that are used in the framework.

Methods

NameDescription
Public methodToString Returns a string that represents the current object. (Overrides Object.ToString().)

Extension Methods

NameDescription
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also

Reference

UltimateXR.Avatar.Controllers Namespace