:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Generic6DOFJoint.xml. .. _class_Generic6DOFJoint: Generic6DOFJoint ================ **Inherits:** :ref:`Joint` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` The generic 6-degrees-of-freedom joint can implement a variety of joint types by locking certain axes' rotation or translation. .. rst-class:: classref-introduction-group 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. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_limit_x/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/erp` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/lower_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/restitution` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/softness` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_x/upper_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_limit_y/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/erp` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/lower_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/restitution` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/softness` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_y/upper_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_limit_z/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/erp` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/lower_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/restitution` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/softness` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_limit_z/upper_angle` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_motor_x/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_x/force_limit` | ``300.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_x/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_motor_y/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_y/force_limit` | ``300.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_y/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_motor_z/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_z/force_limit` | ``300.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_motor_z/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_x/damping` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_spring_x/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_x/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_x/stiffness` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_y/damping` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_spring_y/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_y/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_y/stiffness` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_z/damping` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`angular_spring_z/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_z/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`angular_spring_z/stiffness` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_x/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_limit_x/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_x/lower_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_x/restitution` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_x/softness` | ``0.7`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_x/upper_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_y/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_limit_y/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_y/lower_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_y/restitution` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_y/softness` | ``0.7`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_y/upper_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_z/damping` | ``1.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_limit_z/enabled` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_z/lower_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_z/restitution` | ``0.5`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_z/softness` | ``0.7`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_limit_z/upper_distance` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_motor_x/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_x/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_x/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_motor_y/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_y/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_y/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_motor_z/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_z/force_limit` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_motor_z/target_velocity` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_x/damping` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_spring_x/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_x/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_x/stiffness` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_y/damping` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_spring_y/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_y/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_y/stiffness` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_z/damping` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`linear_spring_z/enabled` | ``false`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_z/equilibrium_point` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`linear_spring_z/stiffness` | ``0.01`` | +---------------------------+---------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag_x` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag_y` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag_z` **(** :ref:`Flag` flag **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_x` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_y` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_z` **(** :ref:`Param` param **)** |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag_x` **(** :ref:`Flag` flag, :ref:`bool` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag_y` **(** :ref:`Flag` flag, :ref:`bool` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag_z` **(** :ref:`Flag` flag, :ref:`bool` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_x` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_y` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_z` **(** :ref:`Param` param, :ref:`float` value **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Generic6DOFJoint_Param: .. rst-class:: classref-enumeration enum **Param**: .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LOWER_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LOWER_LIMIT** = ``0`` The minimum difference between the pivot points' axes. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_UPPER_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_UPPER_LIMIT** = ``1`` The maximum difference between the pivot points' axes. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_LIMIT_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_LIMIT_SOFTNESS** = ``2`` A factor applied to the movement across the axes. The lower, the slower the movement. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_RESTITUTION** = ``3`` The amount of restitution on the axes' movement. The lower, the more momentum gets lost. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_DAMPING** = ``4`` The amount of damping that happens at the linear motion across the axes. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_TARGET_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_MOTOR_TARGET_VELOCITY** = ``5`` The velocity the linear motor will try to reach. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_MOTOR_FORCE_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_MOTOR_FORCE_LIMIT** = ``6`` The maximum force the linear motor will apply while trying to reach the velocity target. .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_STIFFNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_SPRING_STIFFNESS** = ``7`` .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_SPRING_DAMPING** = ``8`` .. _class_Generic6DOFJoint_constant_PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT** = ``9`` .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LOWER_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LOWER_LIMIT** = ``10`` The minimum rotation in negative direction to break loose and rotate around the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_UPPER_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_UPPER_LIMIT** = ``11`` The minimum rotation in positive direction to break loose and rotate around the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_LIMIT_SOFTNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_LIMIT_SOFTNESS** = ``12`` The speed of all rotations across the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_DAMPING** = ``13`` The amount of rotational damping across the axes. The lower, the more dampening occurs. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_RESTITUTION: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_RESTITUTION** = ``14`` The amount of rotational restitution across the axes. The lower, the more restitution occurs. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_FORCE_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_FORCE_LIMIT** = ``15`` The maximum amount of force that can occur, when rotating around the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_ERP: .. rst-class:: classref-enumeration-constant :ref:`Param` **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. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_TARGET_VELOCITY: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = ``17`` Target speed for the motor at the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_MOTOR_FORCE_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = ``18`` Maximum acceleration for the motor at the axes. .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_STIFFNESS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_SPRING_STIFFNESS** = ``19`` .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_SPRING_DAMPING** = ``20`` .. _class_Generic6DOFJoint_constant_PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT** = ``21`` .. _class_Generic6DOFJoint_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_MAX** = ``22`` Represents the size of the :ref:`Param` enum. .. rst-class:: classref-item-separator ---- .. _enum_Generic6DOFJoint_Flag: .. rst-class:: classref-enumeration enum **Flag**: .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_LINEAR_LIMIT** = ``0`` If enabled, linear motion is possible within the given limits. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_LIMIT: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_ANGULAR_LIMIT** = ``1`` If enabled, rotational motion is possible within the given limits. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_SPRING: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_LINEAR_SPRING** = ``3`` .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_ANGULAR_SPRING: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_ANGULAR_SPRING** = ``2`` .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_MOTOR: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_MOTOR** = ``4`` If enabled, there is a rotational motor across these axes. .. _class_Generic6DOFJoint_constant_FLAG_ENABLE_LINEAR_MOTOR: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_ENABLE_LINEAR_MOTOR** = ``5`` If enabled, there is a linear motor across these axes. .. _class_Generic6DOFJoint_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`Flag` **FLAG_MAX** = ``6`` Represents the size of the :ref:`Flag` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Generic6DOFJoint_property_angular_limit_x/damping: .. rst-class:: classref-property :ref:`float` **angular_limit_x/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| 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. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/enabled: .. rst-class:: classref-property :ref:`bool` **angular_limit_x/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| If ``true``, rotation across the X axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/erp: .. rst-class:: classref-property :ref:`float` **angular_limit_x/erp** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| When rotating across the X axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/force_limit: .. rst-class:: classref-property :ref:`float` **angular_limit_x/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The maximum amount of force that can occur, when rotating around the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/lower_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_x/lower_angle** = ``0.0`` The minimum rotation in negative direction to break loose and rotate around the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/restitution: .. rst-class:: classref-property :ref:`float` **angular_limit_x/restitution** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The amount of rotational restitution across the X axis. The lower, the more restitution occurs. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/softness: .. rst-class:: classref-property :ref:`float` **angular_limit_x/softness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The speed of all rotations across the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_x/upper_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_x/upper_angle** = ``0.0`` The minimum rotation in positive direction to break loose and rotate around the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/damping: .. rst-class:: classref-property :ref:`float` **angular_limit_y/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The amount of rotational damping across the Y axis. The lower, the more dampening occurs. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/enabled: .. rst-class:: classref-property :ref:`bool` **angular_limit_y/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| If ``true``, rotation across the Y axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/erp: .. rst-class:: classref-property :ref:`float` **angular_limit_y/erp** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| When rotating across the Y axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/force_limit: .. rst-class:: classref-property :ref:`float` **angular_limit_y/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The maximum amount of force that can occur, when rotating around the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/lower_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_y/lower_angle** = ``0.0`` The minimum rotation in negative direction to break loose and rotate around the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/restitution: .. rst-class:: classref-property :ref:`float` **angular_limit_y/restitution** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The amount of rotational restitution across the Y axis. The lower, the more restitution occurs. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/softness: .. rst-class:: classref-property :ref:`float` **angular_limit_y/softness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The speed of all rotations across the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_y/upper_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_y/upper_angle** = ``0.0`` The minimum rotation in positive direction to break loose and rotate around the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/damping: .. rst-class:: classref-property :ref:`float` **angular_limit_z/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The amount of rotational damping across the Z axis. The lower, the more dampening occurs. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/enabled: .. rst-class:: classref-property :ref:`bool` **angular_limit_z/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| If ``true``, rotation across the Z axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/erp: .. rst-class:: classref-property :ref:`float` **angular_limit_z/erp** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| When rotating across the Z axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/force_limit: .. rst-class:: classref-property :ref:`float` **angular_limit_z/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The maximum amount of force that can occur, when rotating around the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/lower_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_z/lower_angle** = ``0.0`` The minimum rotation in negative direction to break loose and rotate around the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/restitution: .. rst-class:: classref-property :ref:`float` **angular_limit_z/restitution** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The amount of rotational restitution across the Z axis. The lower, the more restitution occurs. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/softness: .. rst-class:: classref-property :ref:`float` **angular_limit_z/softness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The speed of all rotations across the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_limit_z/upper_angle: .. rst-class:: classref-property :ref:`float` **angular_limit_z/upper_angle** = ``0.0`` The minimum rotation in positive direction to break loose and rotate around the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_x/enabled: .. rst-class:: classref-property :ref:`bool` **angular_motor_x/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| If ``true``, a rotating motor at the X axis is enabled. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_x/force_limit: .. rst-class:: classref-property :ref:`float` **angular_motor_x/force_limit** = ``300.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| Maximum acceleration for the motor at the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_x/target_velocity: .. rst-class:: classref-property :ref:`float` **angular_motor_x/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| Target speed for the motor at the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_y/enabled: .. rst-class:: classref-property :ref:`bool` **angular_motor_y/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| If ``true``, a rotating motor at the Y axis is enabled. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_y/force_limit: .. rst-class:: classref-property :ref:`float` **angular_motor_y/force_limit** = ``300.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| Maximum acceleration for the motor at the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_y/target_velocity: .. rst-class:: classref-property :ref:`float` **angular_motor_y/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| Target speed for the motor at the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_z/enabled: .. rst-class:: classref-property :ref:`bool` **angular_motor_z/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| If ``true``, a rotating motor at the Z axis is enabled. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_z/force_limit: .. rst-class:: classref-property :ref:`float` **angular_motor_z/force_limit** = ``300.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| Maximum acceleration for the motor at the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_motor_z/target_velocity: .. rst-class:: classref-property :ref:`float` **angular_motor_z/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| Target speed for the motor at the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_x/damping: .. rst-class:: classref-property :ref:`float` **angular_spring_x/damping** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_x/enabled: .. rst-class:: classref-property :ref:`bool` **angular_spring_x/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_x/equilibrium_point: .. rst-class:: classref-property :ref:`float` **angular_spring_x/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_x/stiffness: .. rst-class:: classref-property :ref:`float` **angular_spring_x/stiffness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_y/damping: .. rst-class:: classref-property :ref:`float` **angular_spring_y/damping** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_y/enabled: .. rst-class:: classref-property :ref:`bool` **angular_spring_y/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_y/equilibrium_point: .. rst-class:: classref-property :ref:`float` **angular_spring_y/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_y/stiffness: .. rst-class:: classref-property :ref:`float` **angular_spring_y/stiffness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_z/damping: .. rst-class:: classref-property :ref:`float` **angular_spring_z/damping** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_z/enabled: .. rst-class:: classref-property :ref:`bool` **angular_spring_z/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_z/equilibrium_point: .. rst-class:: classref-property :ref:`float` **angular_spring_z/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_angular_spring_z/stiffness: .. rst-class:: classref-property :ref:`float` **angular_spring_z/stiffness** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/damping: .. rst-class:: classref-property :ref:`float` **linear_limit_x/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The amount of damping that happens at the X motion. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/enabled: .. rst-class:: classref-property :ref:`bool` **linear_limit_x/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| If ``true``, the linear motion across the X axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/lower_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_x/lower_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The minimum difference between the pivot points' X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/restitution: .. rst-class:: classref-property :ref:`float` **linear_limit_x/restitution** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The amount of restitution on the X axis movement. The lower, the more momentum gets lost. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/softness: .. rst-class:: classref-property :ref:`float` **linear_limit_x/softness** = ``0.7`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| A factor applied to the movement across the X axis. The lower, the slower the movement. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_x/upper_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_x/upper_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The maximum difference between the pivot points' X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/damping: .. rst-class:: classref-property :ref:`float` **linear_limit_y/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The amount of damping that happens at the Y motion. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/enabled: .. rst-class:: classref-property :ref:`bool` **linear_limit_y/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| If ``true``, the linear motion across the Y axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/lower_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_y/lower_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The minimum difference between the pivot points' Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/restitution: .. rst-class:: classref-property :ref:`float` **linear_limit_y/restitution** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The amount of restitution on the Y axis movement. The lower, the more momentum gets lost. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/softness: .. rst-class:: classref-property :ref:`float` **linear_limit_y/softness** = ``0.7`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| A factor applied to the movement across the Y axis. The lower, the slower the movement. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_y/upper_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_y/upper_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The maximum difference between the pivot points' Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/damping: .. rst-class:: classref-property :ref:`float` **linear_limit_z/damping** = ``1.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The amount of damping that happens at the Z motion. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/enabled: .. rst-class:: classref-property :ref:`bool` **linear_limit_z/enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| If ``true``, the linear motion across the Z axis is limited. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/lower_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_z/lower_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The minimum difference between the pivot points' Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/restitution: .. rst-class:: classref-property :ref:`float` **linear_limit_z/restitution** = ``0.5`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The amount of restitution on the Z axis movement. The lower, the more momentum gets lost. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/softness: .. rst-class:: classref-property :ref:`float` **linear_limit_z/softness** = ``0.7`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| A factor applied to the movement across the Z axis. The lower, the slower the movement. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_limit_z/upper_distance: .. rst-class:: classref-property :ref:`float` **linear_limit_z/upper_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The maximum difference between the pivot points' Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_x/enabled: .. rst-class:: classref-property :ref:`bool` **linear_motor_x/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| 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. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_x/force_limit: .. rst-class:: classref-property :ref:`float` **linear_motor_x/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The maximum force the linear motor can apply on the X axis while trying to reach the target velocity. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_x/target_velocity: .. rst-class:: classref-property :ref:`float` **linear_motor_x/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| The speed that the linear motor will attempt to reach on the X axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_y/enabled: .. rst-class:: classref-property :ref:`bool` **linear_motor_y/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| 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. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_y/force_limit: .. rst-class:: classref-property :ref:`float` **linear_motor_y/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The maximum force the linear motor can apply on the Y axis while trying to reach the target velocity. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_y/target_velocity: .. rst-class:: classref-property :ref:`float` **linear_motor_y/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| The speed that the linear motor will attempt to reach on the Y axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_z/enabled: .. rst-class:: classref-property :ref:`bool` **linear_motor_z/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| 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. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_z/force_limit: .. rst-class:: classref-property :ref:`float` **linear_motor_z/force_limit** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The maximum force the linear motor can apply on the Z axis while trying to reach the target velocity. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_motor_z/target_velocity: .. rst-class:: classref-property :ref:`float` **linear_motor_z/target_velocity** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| The speed that the linear motor will attempt to reach on the Z axis. .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_x/damping: .. rst-class:: classref-property :ref:`float` **linear_spring_x/damping** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_x/enabled: .. rst-class:: classref-property :ref:`bool` **linear_spring_x/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_x/equilibrium_point: .. rst-class:: classref-property :ref:`float` **linear_spring_x/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_x/stiffness: .. rst-class:: classref-property :ref:`float` **linear_spring_x/stiffness** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_y/damping: .. rst-class:: classref-property :ref:`float` **linear_spring_y/damping** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_y/enabled: .. rst-class:: classref-property :ref:`bool` **linear_spring_y/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_y/equilibrium_point: .. rst-class:: classref-property :ref:`float` **linear_spring_y/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_y/stiffness: .. rst-class:: classref-property :ref:`float` **linear_spring_y/stiffness** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_z/damping: .. rst-class:: classref-property :ref:`float` **linear_spring_z/damping** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_z/enabled: .. rst-class:: classref-property :ref:`bool` **linear_spring_z/enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_z/equilibrium_point: .. rst-class:: classref-property :ref:`float` **linear_spring_z/equilibrium_point** = ``0.0`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_property_linear_spring_z/stiffness: .. rst-class:: classref-property :ref:`float` **linear_spring_z/stiffness** = ``0.01`` .. rst-class:: classref-property-setget - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Generic6DOFJoint_method_get_flag_x: .. rst-class:: classref-method :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_get_flag_y: .. rst-class:: classref-method :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_get_flag_z: .. rst-class:: classref-method :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_get_param_x: .. rst-class:: classref-method :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_get_param_y: .. rst-class:: classref-method :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_get_param_z: .. rst-class:: classref-method :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_flag_x: .. rst-class:: classref-method void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_flag_y: .. rst-class:: classref-method void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_flag_z: .. rst-class:: classref-method void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_param_x: .. rst-class:: classref-method void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_param_y: .. rst-class:: classref-method void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Generic6DOFJoint_method_set_param_z: .. rst-class:: classref-method void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`