2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-01-25 07:50:56 +00:00
<class name= "Generic6DOFJoint" inherits= "Joint" category= "Core" version= "3.0-stable" >
2017-09-12 20:42:36 +00:00
<brief_description >
2017-10-14 10:19:03 +00:00
The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-10-14 10:19:03 +00:00
The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The amount of rotational damping across the x-axis.
The lower, the longer an impulse from one side takes to travel to the other side.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] rotation across the x-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/erp" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/force_limit" type= "float" setter= "set_param_x" getter= "get_param_x" >
2018-01-18 20:37:17 +00:00
The maximum amount of force that can occur, when rotating around x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/lower_angle" type= "float" setter= "_set_angular_lo_limit_x" getter= "_get_angular_lo_limit_x" >
2018-01-18 20:37:17 +00:00
The minimum rotation in negative direction to break loose and rotate around the x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/restitution" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The amount of rotational restitution across the x-axis. The lower, the more restitution occurs.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/softness" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The speed of all rotations across the x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_x/upper_angle" type= "float" setter= "_set_angular_hi_limit_x" getter= "_get_angular_hi_limit_x" >
2018-01-18 20:37:17 +00:00
The minimum rotation in positive direction to break loose and rotate around the x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The amount of rotational damping across the y-axis. The lower, the more dampening occurs.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] rotation across the y-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/erp" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/force_limit" type= "float" setter= "set_param_y" getter= "get_param_y" >
2018-01-18 20:37:17 +00:00
The maximum amount of force that can occur, when rotating around y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/lower_angle" type= "float" setter= "_set_angular_lo_limit_y" getter= "_get_angular_lo_limit_y" >
2018-01-18 20:37:17 +00:00
The minimum rotation in negative direction to break loose and rotate around the y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/restitution" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The amount of rotational restitution across the y-axis. The lower, the more restitution occurs.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/softness" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The speed of all rotations across the y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_y/upper_angle" type= "float" setter= "_set_angular_hi_limit_y" getter= "_get_angular_hi_limit_y" >
2018-01-18 20:37:17 +00:00
The minimum rotation in positive direction to break loose and rotate around the y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The amount of rotational damping across the z-axis. The lower, the more dampening occurs.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] rotation across the z-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/erp" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/force_limit" type= "float" setter= "set_param_z" getter= "get_param_z" >
2018-01-18 20:37:17 +00:00
The maximum amount of force that can occur, when rotating around z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/lower_angle" type= "float" setter= "_set_angular_lo_limit_z" getter= "_get_angular_lo_limit_z" >
2018-01-18 20:37:17 +00:00
The minimum rotation in negative direction to break loose and rotate around the z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/restitution" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The amount of rotational restitution across the z-axis. The lower, the more restitution occurs.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/softness" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The speed of all rotations across the z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_limit_z/upper_angle" type= "float" setter= "_set_angular_hi_limit_z" getter= "_get_angular_hi_limit_z" >
2018-01-18 20:37:17 +00:00
The minimum rotation in positive direction to break loose and rotate around the z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] a rotating motor at the x-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_x/force_limit" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor at the x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_x/target_velocity" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
Target speed for the motor at the x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] a rotating motor at the y-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_y/force_limit" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor at the y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_y/target_velocity" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
Target speed for the motor at the y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] a rotating motor at the z-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_z/force_limit" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor at the z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "angular_motor_z/target_velocity" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
Target speed for the motor at the z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The amount of damping that happens at the x-motion.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] the linear motion across the x-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/lower_distance" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The minimum difference between the pivot points' x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/restitution" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The amount of restitution on the x-axis movement The lower, the more momentum gets lost.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/softness" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
A factor applied to the movement across the x-axis The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_x/upper_distance" type= "float" setter= "set_param_x" getter= "get_param_x" >
2017-10-14 10:19:03 +00:00
The maximum difference between the pivot points' x-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The amount of damping that happens at the y-motion.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] the linear motion across the y-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/lower_distance" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The minimum difference between the pivot points' y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/restitution" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The amount of restitution on the y-axis movement The lower, the more momentum gets lost.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/softness" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
A factor applied to the movement across the y-axis The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_y/upper_distance" type= "float" setter= "set_param_y" getter= "get_param_y" >
2017-10-14 10:19:03 +00:00
The maximum difference between the pivot points' y-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The amount of damping that happens at the z-motion.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" >
2017-10-14 10:19:03 +00:00
If [code]true[/code] the linear motion across the z-axis is enabled.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/lower_distance" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The minimum difference between the pivot points' z-axis.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/restitution" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The amount of restitution on the z-axis movement The lower, the more momentum gets lost.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/softness" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
A factor applied to the movement across the z-axis The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "linear_limit_z/upper_distance" type= "float" setter= "set_param_z" getter= "get_param_z" >
2017-10-14 10:19:03 +00:00
The maximum difference between the pivot points' z-axis.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_LINEAR_LOWER_LIMIT" value= "0" enum= "Param" >
2017-10-14 10:19:03 +00:00
The minimum difference between the pivot points' axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_LINEAR_UPPER_LIMIT" value= "1" enum= "Param" >
2017-10-14 10:19:03 +00:00
The maximum difference between the pivot points' axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_LINEAR_LIMIT_SOFTNESS" value= "2" enum= "Param" >
2017-10-14 10:19:03 +00:00
A factor applied to the movement across the axes The lower, the slower the movement.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_LINEAR_RESTITUTION" value= "3" enum= "Param" >
2017-10-14 10:19:03 +00:00
The amount of restitution on the axes movement The lower, the more momentum gets lost.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_LINEAR_DAMPING" value= "4" enum= "Param" >
2017-10-14 10:19:03 +00:00
The amount of damping that happens at the linear motion across the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_LOWER_LIMIT" value= "5" enum= "Param" >
2018-01-18 20:37:17 +00:00
The minimum rotation in negative direction to break loose and rotate around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_UPPER_LIMIT" value= "6" enum= "Param" >
2018-01-18 20:37:17 +00:00
The minimum rotation in positive direction to break loose and rotate around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_LIMIT_SOFTNESS" value= "7" enum= "Param" >
2017-10-14 10:19:03 +00:00
The speed of all rotations across the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_DAMPING" value= "8" enum= "Param" >
2017-10-14 10:19:03 +00:00
The amount of rotational damping across the axes. The lower, the more dampening occurs.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_RESTITUTION" value= "9" enum= "Param" >
2017-10-14 10:19:03 +00:00
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_FORCE_LIMIT" value= "10" enum= "Param" >
2018-01-18 20:37:17 +00:00
The maximum amount of force that can occur, when rotating around the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_ERP" value= "11" enum= "Param" >
2017-10-14 10:19:03 +00:00
When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value= "12" enum= "Param" >
2017-10-14 10:19:03 +00:00
Target speed for the motor at the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value= "13" enum= "Param" >
2017-10-14 10:19:03 +00:00
Maximum acceleration for the motor at the axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "PARAM_MAX" value= "14" enum= "Param" >
2017-10-14 10:19:03 +00:00
End flag of PARAM_* constants, used internally.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_ENABLE_LINEAR_LIMIT" value= "0" enum= "Flag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is linear motion possible within the given limits.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_ENABLE_ANGULAR_LIMIT" value= "1" enum= "Flag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is rotational motion possible.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_ENABLE_MOTOR" value= "2" enum= "Flag" >
2017-10-14 10:19:03 +00:00
If [code]set[/code] there is a rotational motor across these axes.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_MAX" value= "3" enum= "Flag" >
2017-10-14 10:19:03 +00:00
End flag of FLAG_* constants, used internally.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>