LimitAngularVelocityModifier3D
Limit bone rotation angular velocity.
Limit bone rotation angular velocity.
This modifier limits bone rotation angular velocity by comparing poses between previous and current frame.
You can add bone chains by specifying their root and end bones, then add the bones between them to a list. Modifier processes either that list or the bones excluding those in the list depending on the option LimitAngularVelocityModifier3D.Exclude.
Note: Most methods in this class take an index parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. settings/<index>/root_bone_name).
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
LimitAngularVelocityModifier3DConstructor
public LimitAngularVelocityModifier3D();Properties4
ChainCountProperty
public int ChainCount { get; set; }The number of chains.
ExcludeProperty
public bool Exclude { get; set; }If true, the modifier processes bones not included in the bone list.
If false, the bones processed by the modifier are equal to the bone list.
JointCountProperty
public int JointCount { get; }The number of joints in the list which created by chains dynamically.
MaxAngularVelocityProperty
public double MaxAngularVelocity { get; set; }The maximum angular velocity per second.
Methods16
ClearChainsvoid
public void ClearChains();Clear all chains.
GetChainCountint
public int GetChainCount();intGetEndBoneint
public int GetEndBone(int index);Returns the end bone index of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
intGetEndBoneNamestring
public string GetEndBoneName(int index);Returns the end bone name of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
stringGetMaxAngularVelocitydouble
public double GetMaxAngularVelocity();doubleGetRootBoneint
public int GetRootBone(int index);Returns the root bone index of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
intGetRootBoneNamestring
public string GetRootBoneName(int index);Returns the root bone name of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
stringIsExcludebool
public bool IsExclude();boolResetvoid
public void Reset();Sets the reference pose for angle comparison to the current pose with the influence of constraints removed. This function is automatically triggered when joints change or upon activation.
SetChainCountvoid
public void SetChainCount(int count);| Name | Type | Default |
|---|---|---|
count | int | — |
SetEndBonevoid
public void SetEndBone(int index, int bone);Sets the end bone index of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
bone | int | — |
SetEndBoneNamevoid
public void SetEndBoneName(int index, string boneName);Sets the end bone name of the bone chain. Note: End bone must be the root bone or a child of the root bone.
| Name | Type | Default |
|---|---|---|
index | int | — |
boneName | string | — |
SetExcludevoid
public void SetExclude(bool exclude);| Name | Type | Default |
|---|---|---|
exclude | bool | — |
SetMaxAngularVelocityvoid
public void SetMaxAngularVelocity(double angularVelocity);| Name | Type | Default |
|---|---|---|
angularVelocity | double | — |
SetRootBonevoid
public void SetRootBone(int index, int bone);Sets the root bone index of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
bone | int | — |
SetRootBoneNamevoid
public void SetRootBoneName(int index, string boneName);Sets the root bone name of the bone chain.
| Name | Type | Default |
|---|---|---|
index | int | — |
boneName | string | — |