summaryrefslogtreecommitdiff
path: root/doc/classes/Generic6DOFJoint.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Generic6DOFJoint.xml')
-rw-r--r--doc/classes/Generic6DOFJoint.xml148
1 files changed, 20 insertions, 128 deletions
diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml
index 202e461652..e44ae867d4 100644
--- a/doc/classes/Generic6DOFJoint.xml
+++ b/doc/classes/Generic6DOFJoint.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-alpha">
+<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0-beta">
<brief_description>
The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.
</brief_description>
@@ -11,114 +11,6 @@
<demos>
</demos>
<methods>
- <method name="get_flag_x" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <description>
- </description>
- </method>
- <method name="get_flag_y" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <description>
- </description>
- </method>
- <method name="get_flag_z" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <description>
- </description>
- </method>
- <method name="get_param_x" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <description>
- </description>
- </method>
- <method name="get_param_y" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <description>
- </description>
- </method>
- <method name="get_param_z" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_flag_x">
- <return type="void">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <argument index="1" name="value" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_flag_y">
- <return type="void">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <argument index="1" name="value" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_flag_z">
- <return type="void">
- </return>
- <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag">
- </argument>
- <argument index="1" name="value" type="bool">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_param_x">
- <return type="void">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <argument index="1" name="value" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_param_y">
- <return type="void">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <argument index="1" name="value" type="float">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_param_z">
- <return type="void">
- </return>
- <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param">
- </argument>
- <argument index="1" name="value" type="float">
- </argument>
- <description>
- </description>
- </method>
</methods>
<members>
<member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x">
@@ -277,61 +169,61 @@
</member>
</members>
<constants>
- <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0">
+ <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0" enum="Param">
The minimum difference between the pivot points' axes.
</constant>
- <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1">
+ <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1" enum="Param">
The maximum difference between the pivot points' axes.
</constant>
- <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2">
+ <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2" enum="Param">
A factor applied to the movement across the axes The lower, the slower the movement.
</constant>
- <constant name="PARAM_LINEAR_RESTITUTION" value="3">
+ <constant name="PARAM_LINEAR_RESTITUTION" value="3" enum="Param">
The amount of restitution on the axes movement The lower, the more momentum gets lost.
</constant>
- <constant name="PARAM_LINEAR_DAMPING" value="4">
+ <constant name="PARAM_LINEAR_DAMPING" value="4" enum="Param">
The amount of damping that happens at the linear motion across the axes.
</constant>
- <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5">
+ <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5" enum="Param">
The minimum rotation in negative direction to break loose and rotate arround the axes.
</constant>
- <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6">
+ <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6" enum="Param">
The minimum rotation in positive direction to break loose and rotate arround the axes.
</constant>
- <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7">
+ <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7" enum="Param">
The speed of all rotations across the axes.
</constant>
- <constant name="PARAM_ANGULAR_DAMPING" value="8">
+ <constant name="PARAM_ANGULAR_DAMPING" value="8" enum="Param">
The amount of rotational damping across the axes. The lower, the more dampening occurs.
</constant>
- <constant name="PARAM_ANGULAR_RESTITUTION" value="9">
+ <constant name="PARAM_ANGULAR_RESTITUTION" value="9" enum="Param">
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
</constant>
- <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10">
+ <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10" enum="Param">
The maximum amount of force that can occur, when rotating arround the axes.
</constant>
- <constant name="PARAM_ANGULAR_ERP" value="11">
+ <constant name="PARAM_ANGULAR_ERP" value="11" enum="Param">
When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
</constant>
- <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12">
+ <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12" enum="Param">
Target speed for the motor at the axes.
</constant>
- <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13">
+ <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13" enum="Param">
Maximum acceleration for the motor at the axes.
</constant>
- <constant name="PARAM_MAX" value="14">
+ <constant name="PARAM_MAX" value="14" enum="Param">
End flag of PARAM_* constants, used internally.
</constant>
- <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0">
+ <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag">
If [code]set[/code] there is linear motion possible within the given limits.
</constant>
- <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1">
+ <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1" enum="Flag">
If [code]set[/code] there is rotational motion possible.
</constant>
- <constant name="FLAG_ENABLE_MOTOR" value="2">
+ <constant name="FLAG_ENABLE_MOTOR" value="2" enum="Flag">
If [code]set[/code] there is a rotational motor across these axes.
</constant>
- <constant name="FLAG_MAX" value="3">
+ <constant name="FLAG_MAX" value="3" enum="Flag">
End flag of FLAG_* constants, used internally.
</constant>
</constants>
generated by cgit v1.2.3 (git 2.25.1) at 2025-03-02 07:59:51 +0000