|
| 1 | +<?xml version="1.0" encoding="UTF-8" ?> |
| 2 | +<class name="LimitAngularVelocityModifier3D" inherits="SkeletonModifier3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> |
| 3 | + <brief_description> |
| 4 | + Limit bone rotation angular velocity. |
| 5 | + </brief_description> |
| 6 | + <description> |
| 7 | + This modifier limits bone rotation angular velocity by comparing poses between previous and current frame. |
| 8 | + 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 [member exclude]. |
| 9 | + </description> |
| 10 | + <tutorials> |
| 11 | + </tutorials> |
| 12 | + <methods> |
| 13 | + <method name="clear_chains"> |
| 14 | + <return type="void" /> |
| 15 | + <description> |
| 16 | + Clear all chains. |
| 17 | + </description> |
| 18 | + </method> |
| 19 | + <method name="get_end_bone" qualifiers="const"> |
| 20 | + <return type="int" /> |
| 21 | + <param index="0" name="index" type="int" /> |
| 22 | + <description> |
| 23 | + Returns the end bone index of the bone chain. |
| 24 | + </description> |
| 25 | + </method> |
| 26 | + <method name="get_end_bone_name" qualifiers="const"> |
| 27 | + <return type="String" /> |
| 28 | + <param index="0" name="index" type="int" /> |
| 29 | + <description> |
| 30 | + Returns the end bone name of the bone chain. |
| 31 | + </description> |
| 32 | + </method> |
| 33 | + <method name="get_root_bone" qualifiers="const"> |
| 34 | + <return type="int" /> |
| 35 | + <param index="0" name="index" type="int" /> |
| 36 | + <description> |
| 37 | + Returns the root bone index of the bone chain. |
| 38 | + </description> |
| 39 | + </method> |
| 40 | + <method name="get_root_bone_name" qualifiers="const"> |
| 41 | + <return type="String" /> |
| 42 | + <param index="0" name="index" type="int" /> |
| 43 | + <description> |
| 44 | + Returns the root bone name of the bone chain. |
| 45 | + </description> |
| 46 | + </method> |
| 47 | + <method name="reset"> |
| 48 | + <return type="void" /> |
| 49 | + <description> |
| 50 | + 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. |
| 51 | + </description> |
| 52 | + </method> |
| 53 | + <method name="set_end_bone"> |
| 54 | + <return type="void" /> |
| 55 | + <param index="0" name="index" type="int" /> |
| 56 | + <param index="1" name="bone" type="int" /> |
| 57 | + <description> |
| 58 | + Sets the end bone index of the bone chain. |
| 59 | + </description> |
| 60 | + </method> |
| 61 | + <method name="set_end_bone_name"> |
| 62 | + <return type="void" /> |
| 63 | + <param index="0" name="index" type="int" /> |
| 64 | + <param index="1" name="bone_name" type="String" /> |
| 65 | + <description> |
| 66 | + Sets the end bone name of the bone chain. |
| 67 | + [b]Note:[/b] End bone must be the root bone or a child of the root bone. |
| 68 | + </description> |
| 69 | + </method> |
| 70 | + <method name="set_root_bone"> |
| 71 | + <return type="void" /> |
| 72 | + <param index="0" name="index" type="int" /> |
| 73 | + <param index="1" name="bone" type="int" /> |
| 74 | + <description> |
| 75 | + Sets the root bone index of the bone chain. |
| 76 | + </description> |
| 77 | + </method> |
| 78 | + <method name="set_root_bone_name"> |
| 79 | + <return type="void" /> |
| 80 | + <param index="0" name="index" type="int" /> |
| 81 | + <param index="1" name="bone_name" type="String" /> |
| 82 | + <description> |
| 83 | + Sets the root bone name of the bone chain. |
| 84 | + </description> |
| 85 | + </method> |
| 86 | + </methods> |
| 87 | + <members> |
| 88 | + <member name="chain_count" type="int" setter="set_chain_count" getter="get_chain_count" default="0"> |
| 89 | + The number of chains. |
| 90 | + </member> |
| 91 | + <member name="exclude" type="bool" setter="set_exclude" getter="is_exclude" default="false"> |
| 92 | + If [code]true[/code], the modifier processes bones not included in the bone list. |
| 93 | + If [code]false[/code], the bones processed by the modifier are equal to the bone list. |
| 94 | + </member> |
| 95 | + <member name="joint_count" type="int" setter="" getter="_get_joint_count" default="0"> |
| 96 | + The number of joints in the list which created by chains dynamically. |
| 97 | + </member> |
| 98 | + <member name="max_angular_velocity" type="float" setter="set_max_angular_velocity" getter="get_max_angular_velocity" default="6.2831855"> |
| 99 | + The maximum angular velocity per second. |
| 100 | + </member> |
| 101 | + </members> |
| 102 | +</class> |
0 commit comments