2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2020-01-26 15:01:49 +00:00
|
|
|
<class name="ConeTwistJoint" inherits="Joint" version="3.2">
|
2017-09-12 20:42:36 +00:00
|
|
|
<brief_description>
|
2018-03-30 23:11:14 +00:00
|
|
|
A twist joint between two 3D bodies.
|
2017-09-12 20:42:36 +00:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-10-14 10:19:03 +00:00
|
|
|
The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint].
|
2019-06-21 23:04:47 +00:00
|
|
|
The twist axis is initiated as the X axis of the [Joint].
|
2017-10-14 10:19:03 +00:00
|
|
|
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<methods>
|
2019-06-27 14:10:09 +00:00
|
|
|
<method name="get_param" qualifiers="const">
|
|
|
|
<return type="float">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="set_param">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="param" type="int" enum="ConeTwistJoint.Param">
|
|
|
|
</argument>
|
|
|
|
<argument index="1" name="value" type="float">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
2017-09-12 20:42:36 +00:00
|
|
|
</methods>
|
|
|
|
<members>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="bias" type="float" setter="set_param" getter="get_param" default="0.3">
|
2017-10-14 10:19:03 +00:00
|
|
|
The speed with which the swing or twist will take place.
|
|
|
|
The higher, the faster.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="relaxation" type="float" setter="set_param" getter="get_param" default="1.0">
|
2017-10-14 10:19:03 +00:00
|
|
|
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="softness" type="float" setter="set_param" getter="get_param" default="0.8">
|
2017-10-14 10:19:03 +00:00
|
|
|
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span" default="45.0">
|
2017-10-14 10:19:03 +00:00
|
|
|
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
2019-06-27 09:10:53 +00:00
|
|
|
The swing span defines, how much rotation will not get corrected along the swing axis.
|
2019-03-29 22:37:35 +00:00
|
|
|
Could be defined as looseness in the [ConeTwistJoint].
|
2019-06-29 13:24:23 +00:00
|
|
|
If below 0.05, this behavior is locked.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2019-06-29 10:38:01 +00:00
|
|
|
<member name="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span" default="180.0">
|
2017-10-14 10:19:03 +00:00
|
|
|
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
|
|
|
Twist is locked if below 0.05.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<constants>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_SWING_SPAN" value="0" enum="Param">
|
2017-10-14 10:19:03 +00:00
|
|
|
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
2019-06-27 09:10:53 +00:00
|
|
|
The swing span defines, how much rotation will not get corrected along the swing axis.
|
2019-03-29 22:37:35 +00:00
|
|
|
Could be defined as looseness in the [ConeTwistJoint].
|
2019-06-29 13:24:23 +00:00
|
|
|
If below 0.05, this behavior is locked.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_TWIST_SPAN" value="1" enum="Param">
|
2017-10-14 10:19:03 +00:00
|
|
|
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
|
|
|
Twist is locked if below 0.05.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_BIAS" value="2" enum="Param">
|
2017-10-14 10:19:03 +00:00
|
|
|
The speed with which the swing or twist will take place.
|
|
|
|
The higher, the faster.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_SOFTNESS" value="3" enum="Param">
|
2017-10-14 10:19:03 +00:00
|
|
|
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_RELAXATION" value="4" enum="Param">
|
2017-10-14 10:19:03 +00:00
|
|
|
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
2017-11-24 22:16:30 +00:00
|
|
|
<constant name="PARAM_MAX" value="5" enum="Param">
|
2019-06-27 09:10:53 +00:00
|
|
|
Represents the size of the [enum Param] enum.
|
2017-09-12 20:42:36 +00:00
|
|
|
</constant>
|
|
|
|
</constants>
|
|
|
|
</class>
|