:github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the Generic6DOFJoint.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_Generic6DOFJoint: Generic6DOFJoint ================ **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. Properties ---------- +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_limit_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/erp` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/lower_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_x/upper_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_limit_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/erp` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/lower_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_y/upper_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_limit_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/erp` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/lower_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_limit_z/upper_angle` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_motor_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_x/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_x/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_motor_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_y/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_y/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_motor_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_z/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_motor_z/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_x/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_spring_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_x/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_y/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_spring_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_y/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_z/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`angular_spring_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`angular_spring_z/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_x/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_limit_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_x/lower_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_x/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_x/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_x/upper_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_y/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_limit_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_y/lower_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_y/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_y/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_y/upper_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_z/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_limit_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_z/lower_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_z/restitution` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_z/softness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_limit_z/upper_distance` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_motor_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_x/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_x/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_motor_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_y/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_y/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_motor_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_z/force_limit` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_motor_z/target_velocity` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_x/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_spring_x/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_x/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_y/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_spring_y/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_y/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_z/damping` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`linear_spring_z/enabled` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`linear_spring_z/stiffness` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`precision` | +---------------------------+---------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_Generic6DOFJoint_Param: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LOWER_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_UPPER_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_RESTITUTION: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_DAMPING: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_TARGET_VELOCITY: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_FORCE_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LOWER_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_UPPER_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_DAMPING: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_RESTITUTION: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_FORCE_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_ERP: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_TARGET_VELOCITY: .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_FORCE_LIMIT: .. _class_Generic6DOFJoint_constant_PARAM_MAX: enum **Param**: - **PARAM_LINEAR_LOWER_LIMIT** = **0** --- The minimum difference between the pivot points' axes. - **PARAM_LINEAR_UPPER_LIMIT** = **1** --- The maximum difference between the pivot points' axes. - **PARAM_LINEAR_LIMIT_SOFTNESS** = **2** --- A factor applied to the movement across the axes The lower, the slower the movement. - **PARAM_LINEAR_RESTITUTION** = **3** --- The amount of restitution on the axes movement The lower, the more momentum gets lost. - **PARAM_LINEAR_DAMPING** = **4** --- The amount of damping that happens at the linear motion across the axes. - **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = **5** --- The velocity the linear motor will try to reach. - **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = **6** --- The maximum force the linear motor will apply while trying to reach the velocity target. - **PARAM_ANGULAR_LOWER_LIMIT** = **10** --- The minimum rotation in negative direction to break loose and rotate around the axes. - **PARAM_ANGULAR_UPPER_LIMIT** = **11** --- The minimum rotation in positive direction to break loose and rotate around the axes. - **PARAM_ANGULAR_LIMIT_SOFTNESS** = **12** --- The speed of all rotations across the axes. - **PARAM_ANGULAR_DAMPING** = **13** --- The amount of rotational damping across the axes. The lower, the more dampening occurs. - **PARAM_ANGULAR_RESTITUTION** = **14** --- The amount of rotational restitution across the axes. The lower, the more restitution occurs. - **PARAM_ANGULAR_FORCE_LIMIT** = **15** --- The maximum amount of force that can occur, when rotating around the axes. - **PARAM_ANGULAR_ERP** = **16** --- When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. - **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **17** --- Target speed for the motor at the axes. - **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **18** --- Maximum acceleration for the motor at the axes. - **PARAM_MAX** = **22** --- Represents the size of the :ref:`Param` enum. ---- .. _enum_Generic6DOFJoint_Flag: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_LIMIT: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_SPRING: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_SPRING: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_MOTOR: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_MOTOR: .. _class_Generic6DOFJoint_constant_FLAG_MAX: enum **Flag**: - **FLAG_ENABLE_LINEAR_LIMIT** = **0** --- If ``set`` there is linear motion possible within the given limits. - **FLAG_ENABLE_ANGULAR_LIMIT** = **1** --- If ``set`` there is rotational motion possible. - **FLAG_ENABLE_LINEAR_SPRING** = **3** - **FLAG_ENABLE_ANGULAR_SPRING** = **2** - **FLAG_ENABLE_MOTOR** = **4** --- If ``set`` there is a rotational motor across these axes. - **FLAG_ENABLE_LINEAR_MOTOR** = **5** - **FLAG_MAX** = **6** --- Represents the size of the :ref:`Flag` enum. Description ----------- 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. Property Descriptions --------------------- .. _class_Generic6DOFJoint_property_angular_limit_x/damping: - :ref:`float` **angular_limit_x/damping** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ 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. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/enabled: - :ref:`bool` **angular_limit_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ If ``true``, rotation across the x-axis is limited. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/erp: - :ref:`float` **angular_limit_x/erp** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/force_limit: - :ref:`float` **angular_limit_x/force_limit** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The maximum amount of force that can occur, when rotating around x-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle: - :ref:`float` **angular_limit_x/lower_angle** The minimum rotation in negative direction to break loose and rotate around the x-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/restitution: - :ref:`float` **angular_limit_x/restitution** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/softness: - :ref:`float` **angular_limit_x/softness** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The speed of all rotations across the x-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle: - :ref:`float` **angular_limit_x/upper_angle** The minimum rotation in positive direction to break loose and rotate around the x-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/damping: - :ref:`float` **angular_limit_y/damping** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The amount of rotational damping across the y-axis. The lower, the more dampening occurs. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/enabled: - :ref:`bool` **angular_limit_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ If ``true``, rotation across the y-axis is limited. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/erp: - :ref:`float` **angular_limit_y/erp** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/force_limit: - :ref:`float` **angular_limit_y/force_limit** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The maximum amount of force that can occur, when rotating around y-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle: - :ref:`float` **angular_limit_y/lower_angle** The minimum rotation in negative direction to break loose and rotate around the y-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/restitution: - :ref:`float` **angular_limit_y/restitution** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/softness: - :ref:`float` **angular_limit_y/softness** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The speed of all rotations across the y-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle: - :ref:`float` **angular_limit_y/upper_angle** The minimum rotation in positive direction to break loose and rotate around the y-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/damping: - :ref:`float` **angular_limit_z/damping** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The amount of rotational damping across the z-axis. The lower, the more dampening occurs. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/enabled: - :ref:`bool` **angular_limit_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ If ``true``, rotation across the z-axis is limited. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/erp: - :ref:`float` **angular_limit_z/erp** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/force_limit: - :ref:`float` **angular_limit_z/force_limit** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The maximum amount of force that can occur, when rotating around z-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle: - :ref:`float` **angular_limit_z/lower_angle** The minimum rotation in negative direction to break loose and rotate around the z-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/restitution: - :ref:`float` **angular_limit_z/restitution** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/softness: - :ref:`float` **angular_limit_z/softness** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The speed of all rotations across the z-axis. ---- .. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle: - :ref:`float` **angular_limit_z/upper_angle** The minimum rotation in positive direction to break loose and rotate around the z-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_x/enabled: - :ref:`bool` **angular_motor_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ If ``true``, a rotating motor at the x-axis is enabled. ---- .. _class_Generic6DOFJoint_property_angular_motor_x/force_limit: - :ref:`float` **angular_motor_x/force_limit** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ Maximum acceleration for the motor at the x-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity: - :ref:`float` **angular_motor_x/target_velocity** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ Target speed for the motor at the x-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_y/enabled: - :ref:`bool` **angular_motor_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ If ``true``, a rotating motor at the y-axis is enabled. ---- .. _class_Generic6DOFJoint_property_angular_motor_y/force_limit: - :ref:`float` **angular_motor_y/force_limit** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ Maximum acceleration for the motor at the y-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity: - :ref:`float` **angular_motor_y/target_velocity** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ Target speed for the motor at the y-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_z/enabled: - :ref:`bool` **angular_motor_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ If ``true``, a rotating motor at the z-axis is enabled. ---- .. _class_Generic6DOFJoint_property_angular_motor_z/force_limit: - :ref:`float` **angular_motor_z/force_limit** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ Maximum acceleration for the motor at the z-axis. ---- .. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity: - :ref:`float` **angular_motor_z/target_velocity** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ Target speed for the motor at the z-axis. ---- .. _class_Generic6DOFJoint_property_angular_spring_x/damping: - :ref:`float` **angular_spring_x/damping** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_x/enabled: - :ref:`bool` **angular_spring_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point: - :ref:`float` **angular_spring_x/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness: - :ref:`float` **angular_spring_x/stiffness** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_y/damping: - :ref:`float` **angular_spring_y/damping** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_y/enabled: - :ref:`bool` **angular_spring_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point: - :ref:`float` **angular_spring_y/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness: - :ref:`float` **angular_spring_y/stiffness** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_z/damping: - :ref:`float` **angular_spring_z/damping** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_z/enabled: - :ref:`bool` **angular_spring_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point: - :ref:`float` **angular_spring_z/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness: - :ref:`float` **angular_spring_z/stiffness** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_limit_x/damping: - :ref:`float` **linear_limit_x/damping** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The amount of damping that happens at the x-motion. ---- .. _class_Generic6DOFJoint_property_linear_limit_x/enabled: - :ref:`bool` **linear_limit_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ If ``true``, the linear motion across the x-axis is limited. ---- .. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance: - :ref:`float` **linear_limit_x/lower_distance** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The minimum difference between the pivot points' x-axis. ---- .. _class_Generic6DOFJoint_property_linear_limit_x/restitution: - :ref:`float` **linear_limit_x/restitution** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The amount of restitution on the x-axis movement The lower, the more momentum gets lost. ---- .. _class_Generic6DOFJoint_property_linear_limit_x/softness: - :ref:`float` **linear_limit_x/softness** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ A factor applied to the movement across the x-axis The lower, the slower the movement. ---- .. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance: - :ref:`float` **linear_limit_x/upper_distance** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The maximum difference between the pivot points' x-axis. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/damping: - :ref:`float` **linear_limit_y/damping** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The amount of damping that happens at the y-motion. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/enabled: - :ref:`bool` **linear_limit_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ If ``true``, the linear motion across the y-axis is limited. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance: - :ref:`float` **linear_limit_y/lower_distance** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The minimum difference between the pivot points' y-axis. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/restitution: - :ref:`float` **linear_limit_y/restitution** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The amount of restitution on the y-axis movement The lower, the more momentum gets lost. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/softness: - :ref:`float` **linear_limit_y/softness** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ A factor applied to the movement across the y-axis The lower, the slower the movement. ---- .. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance: - :ref:`float` **linear_limit_y/upper_distance** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The maximum difference between the pivot points' y-axis. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/damping: - :ref:`float` **linear_limit_z/damping** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The amount of damping that happens at the z-motion. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/enabled: - :ref:`bool` **linear_limit_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ If ``true``, the linear motion across the z-axis is limited. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance: - :ref:`float` **linear_limit_z/lower_distance** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The minimum difference between the pivot points' z-axis. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/restitution: - :ref:`float` **linear_limit_z/restitution** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The amount of restitution on the z-axis movement The lower, the more momentum gets lost. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/softness: - :ref:`float` **linear_limit_z/softness** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ A factor applied to the movement across the z-axis The lower, the slower the movement. ---- .. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance: - :ref:`float` **linear_limit_z/upper_distance** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The maximum difference between the pivot points' z-axis. ---- .. _class_Generic6DOFJoint_property_linear_motor_x/enabled: - :ref:`bool` **linear_motor_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ If ``true``, then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. ---- .. _class_Generic6DOFJoint_property_linear_motor_x/force_limit: - :ref:`float` **linear_motor_x/force_limit** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The maximum force the linear motor can apply on the x-axis while trying to reach the target velocity. ---- .. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity: - :ref:`float` **linear_motor_x/target_velocity** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ The speed that the linear motor will attempt to reach on the x-axis. ---- .. _class_Generic6DOFJoint_property_linear_motor_y/enabled: - :ref:`bool` **linear_motor_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ If ``true``, then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. ---- .. _class_Generic6DOFJoint_property_linear_motor_y/force_limit: - :ref:`float` **linear_motor_y/force_limit** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The maximum force the linear motor can apply on the y-axis while trying to reach the target velocity. ---- .. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity: - :ref:`float` **linear_motor_y/target_velocity** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ The speed that the linear motor will attempt to reach on the y-axis. ---- .. _class_Generic6DOFJoint_property_linear_motor_z/enabled: - :ref:`bool` **linear_motor_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ If ``true``, then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. ---- .. _class_Generic6DOFJoint_property_linear_motor_z/force_limit: - :ref:`float` **linear_motor_z/force_limit** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The maximum force the linear motor can apply on the z-axis while trying to reach the target velocity. ---- .. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity: - :ref:`float` **linear_motor_z/target_velocity** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ The speed that the linear motor will attempt to reach on the z-axis. ---- .. _class_Generic6DOFJoint_property_linear_spring_x/damping: - :ref:`float` **linear_spring_x/damping** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_x/enabled: - :ref:`bool` **linear_spring_x/enabled** +----------+-------------------+ | *Setter* | set_flag_x(value) | +----------+-------------------+ | *Getter* | get_flag_x() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point: - :ref:`float` **linear_spring_x/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness: - :ref:`float` **linear_spring_x/stiffness** +----------+--------------------+ | *Setter* | set_param_x(value) | +----------+--------------------+ | *Getter* | get_param_x() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_y/damping: - :ref:`float` **linear_spring_y/damping** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_y/enabled: - :ref:`bool` **linear_spring_y/enabled** +----------+-------------------+ | *Setter* | set_flag_y(value) | +----------+-------------------+ | *Getter* | get_flag_y() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point: - :ref:`float` **linear_spring_y/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness: - :ref:`float` **linear_spring_y/stiffness** +----------+--------------------+ | *Setter* | set_param_y(value) | +----------+--------------------+ | *Getter* | get_param_y() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_z/damping: - :ref:`float` **linear_spring_z/damping** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_z/enabled: - :ref:`bool` **linear_spring_z/enabled** +----------+-------------------+ | *Setter* | set_flag_z(value) | +----------+-------------------+ | *Getter* | get_flag_z() | +----------+-------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point: - :ref:`float` **linear_spring_z/equilibrium_point** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness: - :ref:`float` **linear_spring_z/stiffness** +----------+--------------------+ | *Setter* | set_param_z(value) | +----------+--------------------+ | *Getter* | get_param_z() | +----------+--------------------+ ---- .. _class_Generic6DOFJoint_property_precision: - :ref:`int` **precision** +----------+----------------------+ | *Setter* | set_precision(value) | +----------+----------------------+ | *Getter* | get_precision() | +----------+----------------------+