UxrBodyIKSettings Class
Stores parameters that drive Inverse Kinematics for full-body avatars.
Inheritance Hierarchy
System.Object
UltimateXR.Animation.IK.UxrBodyIKSettings
Namespace: UltimateXR.Animation.IK
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
[SerializableAttribute]
public class UxrBodyIKSettings
The UxrBodyIKSettings type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UxrBodyIKSettings |
Properties
| Name | Description | |
|---|---|---|
 | BodyPivotRotationSpeed | Gets the speed the body will turn around with. This is used to smooth out rotation. |
| ChestBend | Gets the amount the chest will bend when the head bends. |
| ChestTorsion | Gets the amount the chest will turn when the head turns. |
| EyesBaseHeight | Gets the height of the eyes starting from the avatar root Y. This is used to know where to place the avatar head knowing the camera will be positioned on the eyes. |
| EyesForwardOffset | Gets the forward offset of the eyes starting from the avatar root Z. This is used to know where to place the avatar head knowing the camera will be positioned on the eyes. |
| HeadFreeRangeBend | Gets the amount of degrees the head can bend before requiring rotation of other bones down the spine. |
| HeadFreeRangeTorsion | Gets the amount of degrees the head can turn before requiring rotation of other bones down the spine. |
| LockBodyPivot | Gets whether the avatar pivot will be kept in place so that it will only rotate around. |
| NeckBaseHeight | Gets the height of the base of the neck starting from the avatar root Y. This is used to create a dummy neck when the avatar is lacking a neck bone. |
| NeckForwardOffset | Gets the forward offset of the neck starting from the avatar root Z. This is used to create a dummy neck when the avatar is lacking a neck bone. |
| NeckHeadBalance | Gets a value in [0.0, 1.0] range that tells how rotation will be distributed between the head and the neck. 0.0 will fully use the neck and 1.0 will fully use the head. Values in between will distribute it among the two. |
| SpineBend | Gets the amount the spine will bend when the head bends. |
| SpineTorsion | Gets the amount the spine will turn when the head turns. |
| UpperChestBend | Gets the amount the upper chest will bend when the head bends. |
| UpperChestTorsion | Gets the amount the upper chest will turn when the head turns. |
Extension Methods
| Name | Description | |
|---|---|---|
 | ThrowIfNull | Throws an exception if the object is null. (Defined by ObjectExt.) |
Remarks
For now only half-body Inverse Kinematics is supported. Full-body will be implemented at some point.