2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "Generic6DOFJoint3D" inherits= "Joint3D" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2023-04-29 04:59:03 +08:00
A physics joint that allows for complex movement and rotation between two 3D physics bodies.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2023-04-29 04:59:03 +08:00
The [Generic6DOFJoint3D] (6 Degrees Of Freedom) joint allows for implementing custom types of joints by locking the rotation and translation of certain axes.
The first 3 DOF represent the linear motion of the physics bodies and the last 3 DOF represent the angular motion of the physics bodies. Each axis can be either locked, or limited.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2019-06-27 22:10:09 +08:00
<method name= "get_flag_x" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "get_flag_y" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "get_flag_z" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "bool" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "get_param_x" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "get_param_y" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "get_param_z" qualifiers= "const" >
2021-07-30 21:28:05 +08:00
<return type= "float" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_flag_x" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
<param index= "1" name= "value" type= "bool" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_flag_y" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
<param index= "1" name= "value" type= "bool" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_flag_z" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "flag" type= "int" enum= "Generic6DOFJoint3D.Flag" />
<param index= "1" name= "value" type= "bool" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_param_x" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
<param index= "1" name= "value" type= "float" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_param_y" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
<param index= "1" name= "value" type= "float" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
<method name= "set_param_z" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "param" type= "int" enum= "Generic6DOFJoint3D.Param" />
<param index= "1" name= "value" type= "float" />
2019-06-27 22:10:09 +08:00
<description >
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" default= "1.0" >
2019-06-22 07:04:47 +08:00
The amount of rotational damping across the X axis.
2017-10-14 18:19:03 +08:00
The lower, the longer an impulse from one side takes to travel to the other side.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], rotation across the X axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/erp" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.5" >
2019-06-22 07:04:47 +08:00
When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/force_limit" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum amount of force that can occur, when rotating around the X axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_x/lower_angle" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in negative direction to break loose and rotate around the X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/restitution" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The amount of rotational restitution across the X axis. The lower, the more restitution occurs.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_x/softness" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.5" >
2019-06-22 07:04:47 +08:00
The speed of all rotations across the X axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_x/upper_angle" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in positive direction to break loose and rotate around the X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" default= "1.0" >
2022-10-29 20:38:05 +08:00
The amount of rotational damping across the Y axis. The lower, the more damping occurs.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], rotation across the Y axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/erp" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.5" >
2019-06-22 07:04:47 +08:00
When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/force_limit" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum amount of force that can occur, when rotating around the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_y/lower_angle" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in negative direction to break loose and rotate around the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/restitution" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The amount of rotational restitution across the Y axis. The lower, the more restitution occurs.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_y/softness" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.5" >
2019-06-22 07:04:47 +08:00
The speed of all rotations across the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_y/upper_angle" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in positive direction to break loose and rotate around the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" default= "1.0" >
2022-10-29 20:38:05 +08:00
The amount of rotational damping across the Z axis. The lower, the more damping occurs.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], rotation across the Z axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/erp" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.5" >
2019-06-22 07:04:47 +08:00
When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/force_limit" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum amount of force that can occur, when rotating around the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_z/lower_angle" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in negative direction to break loose and rotate around the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/restitution" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The amount of rotational restitution across the Z axis. The lower, the more restitution occurs.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_limit_z/softness" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.5" >
2019-06-22 07:04:47 +08:00
The speed of all rotations across the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2022-08-22 17:30:48 +08:00
<member name= "angular_limit_z/upper_angle" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum rotation in positive direction to break loose and rotate around the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], a rotating motor at the X axis is enabled.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_x/force_limit" type= "float" setter= "set_param_x" getter= "get_param_x" default= "300.0" >
2019-06-22 07:04:47 +08:00
Maximum acceleration for the motor at the X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_x/target_velocity" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
Target speed for the motor at the X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], a rotating motor at the Y axis is enabled.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_y/force_limit" type= "float" setter= "set_param_y" getter= "get_param_y" default= "300.0" >
2019-06-22 07:04:47 +08:00
Maximum acceleration for the motor at the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_y/target_velocity" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
Target speed for the motor at the Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], a rotating motor at the Z axis is enabled.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_z/force_limit" type= "float" setter= "set_param_z" getter= "get_param_z" default= "300.0" >
2019-06-22 07:04:47 +08:00
Maximum acceleration for the motor at the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_motor_z/target_velocity" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
Target speed for the motor at the Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_x/equilibrium_point" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_x/stiffness" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_y/equilibrium_point" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_y/stiffness" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_z/equilibrium_point" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "angular_spring_z/stiffness" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" default= "1.0" >
2019-06-22 07:04:47 +08:00
The amount of damping that happens at the X motion.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], the linear motion across the X axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/lower_distance" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum difference between the pivot points' X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/restitution" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.5" >
2019-06-22 07:04:47 +08:00
The amount of restitution on the X axis movement. The lower, the more momentum gets lost.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/softness" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.7" >
2019-06-22 07:04:47 +08:00
A factor applied to the movement across the X axis. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_x/upper_distance" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum difference between the pivot points' X axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" default= "1.0" >
2019-06-22 07:04:47 +08:00
The amount of damping that happens at the Y motion.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], the linear motion across the Y axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/lower_distance" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum difference between the pivot points' Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/restitution" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.5" >
2019-06-22 07:04:47 +08:00
The amount of restitution on the Y axis movement. The lower, the more momentum gets lost.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/softness" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.7" >
2019-06-22 07:04:47 +08:00
A factor applied to the movement across the Y axis. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_y/upper_distance" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum difference between the pivot points' Y axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" default= "1.0" >
2019-06-22 07:04:47 +08:00
The amount of damping that happens at the Z motion.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "true" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], the linear motion across the Z axis is limited.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/lower_distance" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The minimum difference between the pivot points' Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/restitution" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.5" >
2019-06-22 07:04:47 +08:00
The amount of restitution on the Z axis movement. The lower, the more momentum gets lost.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/softness" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.7" >
2019-06-22 07:04:47 +08:00
A factor applied to the movement across the Z axis. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_limit_z/upper_distance" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum difference between the pivot points' Z axis.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_x/force_limit" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum force the linear motor can apply on the X axis while trying to reach the target velocity.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_x/target_velocity" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2019-06-22 07:04:47 +08:00
The speed that the linear motor will attempt to reach on the X axis.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_y/force_limit" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_y/target_velocity" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2019-06-22 07:04:47 +08:00
The speed that the linear motor will attempt to reach on the Y axis.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "false" >
2019-06-22 07:04:47 +08:00
If [code]true[/code], then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_z/force_limit" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_motor_z/target_velocity" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2019-06-22 07:04:47 +08:00
The speed that the linear motor will attempt to reach on the Z axis.
2018-03-16 20:07:52 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_x/damping" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_x/enabled" type= "bool" setter= "set_flag_x" getter= "get_flag_x" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_x/equilibrium_point" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_x/stiffness" type= "float" setter= "set_param_x" getter= "get_param_x" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_y/damping" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_y/enabled" type= "bool" setter= "set_flag_y" getter= "get_flag_y" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_y/equilibrium_point" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_y/stiffness" type= "float" setter= "set_param_y" getter= "get_param_y" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_z/damping" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_z/enabled" type= "bool" setter= "set_flag_z" getter= "get_flag_z" default= "false" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_z/equilibrium_point" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.0" >
2018-11-20 16:34:45 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "linear_spring_z/stiffness" type= "float" setter= "set_param_z" getter= "get_param_z" default= "0.01" >
2018-11-20 16:34:45 +08:00
</member>
2017-09-13 04:42:36 +08:00
</members>
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LOWER_LIMIT" value= "0" enum= "Param" >
2017-10-14 18:19:03 +08:00
The minimum difference between the pivot points' axes.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_UPPER_LIMIT" value= "1" enum= "Param" >
2017-10-14 18:19:03 +08:00
The maximum difference between the pivot points' axes.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_LIMIT_SOFTNESS" value= "2" enum= "Param" >
2019-06-22 07:04:47 +08:00
A factor applied to the movement across the axes. The lower, the slower the movement.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_RESTITUTION" value= "3" enum= "Param" >
2019-06-22 07:04:47 +08:00
The amount of restitution on the axes' movement. The lower, the more momentum gets lost.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PARAM_LINEAR_DAMPING" value= "4" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of damping that happens at the linear motion across the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-03-16 20:07:52 +08:00
<constant name= "PARAM_LINEAR_MOTOR_TARGET_VELOCITY" value= "5" enum= "Param" >
The velocity the linear motor will try to reach.
</constant>
<constant name= "PARAM_LINEAR_MOTOR_FORCE_LIMIT" value= "6" enum= "Param" >
The maximum force the linear motor will apply while trying to reach the velocity target.
</constant>
2020-05-02 19:48:00 +08:00
<constant name= "PARAM_LINEAR_SPRING_STIFFNESS" value= "7" enum= "Param" >
</constant>
<constant name= "PARAM_LINEAR_SPRING_DAMPING" value= "8" enum= "Param" >
</constant>
<constant name= "PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT" value= "9" enum= "Param" >
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_LOWER_LIMIT" value= "10" enum= "Param" >
2018-01-19 04:37:17 +08:00
The minimum rotation in negative direction to break loose and rotate around the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_UPPER_LIMIT" value= "11" enum= "Param" >
2018-01-19 04:37:17 +08:00
The minimum rotation in positive direction to break loose and rotate around the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_LIMIT_SOFTNESS" value= "12" enum= "Param" >
2017-10-14 18:19:03 +08:00
The speed of all rotations across the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_DAMPING" value= "13" enum= "Param" >
2022-10-29 20:38:05 +08:00
The amount of rotational damping across the axes. The lower, the more damping occurs.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_RESTITUTION" value= "14" enum= "Param" >
2017-10-14 18:19:03 +08:00
The amount of rotational restitution across the axes. The lower, the more restitution occurs.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_FORCE_LIMIT" value= "15" enum= "Param" >
2018-01-19 04:37:17 +08:00
The maximum amount of force that can occur, when rotating around the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_ERP" value= "16" enum= "Param" >
2017-10-14 18:19:03 +08:00
When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value= "17" enum= "Param" >
2017-10-14 18:19:03 +08:00
Target speed for the motor at the axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value= "18" enum= "Param" >
2017-10-14 18:19:03 +08:00
Maximum acceleration for the motor at the axes.
2017-09-13 04:42:36 +08:00
</constant>
2020-05-02 19:48:00 +08:00
<constant name= "PARAM_ANGULAR_SPRING_STIFFNESS" value= "19" enum= "Param" >
</constant>
<constant name= "PARAM_ANGULAR_SPRING_DAMPING" value= "20" enum= "Param" >
</constant>
<constant name= "PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT" value= "21" enum= "Param" >
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "PARAM_MAX" value= "22" enum= "Param" >
2019-06-27 17:10:53 +08:00
Represents the size of the [enum Param] enum.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "FLAG_ENABLE_LINEAR_LIMIT" value= "0" enum= "Flag" >
2019-06-22 07:04:47 +08:00
If enabled, linear motion is possible within the given limits.
2017-09-13 04:42:36 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "FLAG_ENABLE_ANGULAR_LIMIT" value= "1" enum= "Flag" >
2019-06-22 07:04:47 +08:00
If enabled, rotational motion is possible within the given limits.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "FLAG_ENABLE_LINEAR_SPRING" value= "3" enum= "Flag" >
</constant>
<constant name= "FLAG_ENABLE_ANGULAR_SPRING" value= "2" enum= "Flag" >
</constant>
<constant name= "FLAG_ENABLE_MOTOR" value= "4" enum= "Flag" >
2019-06-22 07:04:47 +08:00
If enabled, there is a rotational motor across these axes.
2017-09-13 04:42:36 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "FLAG_ENABLE_LINEAR_MOTOR" value= "5" enum= "Flag" >
2019-06-22 07:04:47 +08:00
If enabled, there is a linear motor across these axes.
2018-03-16 20:07:52 +08:00
</constant>
2018-11-20 16:34:45 +08:00
<constant name= "FLAG_MAX" value= "6" enum= "Flag" >
2019-06-27 17:10:53 +08:00
Represents the size of the [enum Flag] enum.
2017-09-13 04:42:36 +08:00
</constant>
</constants>
</class>