LimitAngularVelocityModifier3D
Inherits: SkeletonModifier3D < Spatial3D < Actor < Object
Limit bone rotation angular velocity.
Description
Section titled “Description”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 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).
Properties
Section titled “Properties”| Type | Name | Default |
|---|---|---|
| int | chain_count | 0 |
| bool | exclude | false |
| int | joint_count | 0 |
| float | max_angular_velocity | 6.2831855 |
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| void | clear_chains() |
| int | get_end_bone(index) |
| String | get_end_bone_name(index) |
| int | get_root_bone(index) |
| String | get_root_bone_name(index) |
| void | reset() |
| void | set_end_bone(index, bone) |
| void | set_end_bone_name(index, bone_name) |
| void | set_root_bone(index, bone) |
| void | set_root_bone_name(index, bone_name) |
Property descriptions
Section titled “Property descriptions”chain_count
Section titled “chain_count”int chain_count = 0
Setter/getter: set_chain_count(), get_chain_count()
The number of chains.
exclude
Section titled “exclude”bool exclude = false
Setter/getter: set_exclude(), is_exclude()
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.
joint_count
Section titled “joint_count”int joint_count = 0
Setter/getter: _get_joint_count()
The number of joints in the list which created by chains dynamically.
max_angular_velocity
Section titled “max_angular_velocity”float max_angular_velocity = 6.2831855
Setter/getter: set_max_angular_velocity(), get_max_angular_velocity()
The maximum angular velocity per second.
Method descriptions
Section titled “Method descriptions”clear_chains
Section titled “clear_chains”void clear_chains()
Clear all chains.
get_end_bone
Section titled “get_end_bone”int get_end_bone(index: int) const
Returns the end bone index of the bone chain.
get_end_bone_name
Section titled “get_end_bone_name”String get_end_bone_name(index: int) const
Returns the end bone name of the bone chain.
get_root_bone
Section titled “get_root_bone”int get_root_bone(index: int) const
Returns the root bone index of the bone chain.
get_root_bone_name
Section titled “get_root_bone_name”String get_root_bone_name(index: int) const
Returns the root bone name of the bone chain.
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.
set_end_bone
Section titled “set_end_bone”void set_end_bone(index: int, bone: int)
Sets the end bone index of the bone chain.
set_end_bone_name
Section titled “set_end_bone_name”void set_end_bone_name(index: int, bone_name: String)
Sets the end bone name of the bone chain.
Note: End bone must be the root bone or a child of the root bone.
set_root_bone
Section titled “set_root_bone”void set_root_bone(index: int, bone: int)
Sets the root bone index of the bone chain.
set_root_bone_name
Section titled “set_root_bone_name”void set_root_bone_name(index: int, bone_name: String)
Sets the root bone name of the bone chain.