mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
267 lines
9.6 KiB
ReStructuredText
267 lines
9.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ConeTwistJoint3D.xml.
|
|
|
|
.. _class_ConeTwistJoint3D:
|
|
|
|
ConeTwistJoint3D
|
|
================
|
|
|
|
**Inherits:** :ref:`Joint3D<class_Joint3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint. The twist axis is initiated as the X axis of the **ConeTwistJoint3D**. Once the physics bodies swing, the twist axis is calculated as the middle of the X axes of the joint in the local space of the two physics bodies. Useful for limbs like shoulders and hips, lamps hanging off a ceiling, etc.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`bias<class_ConeTwistJoint3D_property_bias>` | ``0.3`` |
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`relaxation<class_ConeTwistJoint3D_property_relaxation>` | ``1.0`` |
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`softness<class_ConeTwistJoint3D_property_softness>` | ``0.8`` |
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`swing_span<class_ConeTwistJoint3D_property_swing_span>` | ``0.785398`` |
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
| :ref:`float<class_float>` | :ref:`twist_span<class_ConeTwistJoint3D_property_twist_span>` | ``3.14159`` |
|
|
+---------------------------+---------------------------------------------------------------+--------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint3D_method_get_param>` **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const| |
|
|
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_param<class_ConeTwistJoint3D_method_set_param>` **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)** |
|
|
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_ConeTwistJoint3D_Param:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Param**:
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_SWING_SPAN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_SWING_SPAN** = ``0``
|
|
|
|
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
|
|
|
The swing span defines, how much rotation will not get corrected along the swing axis.
|
|
|
|
Could be defined as looseness in the **ConeTwistJoint3D**.
|
|
|
|
If below 0.05, this behavior is locked.
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_TWIST_SPAN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_TWIST_SPAN** = ``1``
|
|
|
|
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
|
|
|
Twist is locked if below 0.05.
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_BIAS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_BIAS** = ``2``
|
|
|
|
The speed with which the swing or twist will take place.
|
|
|
|
The higher, the faster.
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_SOFTNESS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_SOFTNESS** = ``3``
|
|
|
|
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_RELAXATION:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_RELAXATION** = ``4``
|
|
|
|
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
|
|
|
|
.. _class_ConeTwistJoint3D_constant_PARAM_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_ConeTwistJoint3D_Param>` **PARAM_MAX** = ``5``
|
|
|
|
Represents the size of the :ref:`Param<enum_ConeTwistJoint3D_Param>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ConeTwistJoint3D_property_bias:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **bias** = ``0.3``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
The speed with which the swing or twist will take place.
|
|
|
|
The higher, the faster.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ConeTwistJoint3D_property_relaxation:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **relaxation** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ConeTwistJoint3D_property_softness:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **softness** = ``0.8``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ConeTwistJoint3D_property_swing_span:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **swing_span** = ``0.785398``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
|
|
|
|
The swing span defines, how much rotation will not get corrected along the swing axis.
|
|
|
|
Could be defined as looseness in the **ConeTwistJoint3D**.
|
|
|
|
If below 0.05, this behavior is locked.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ConeTwistJoint3D_property_twist_span:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **twist_span** = ``3.14159``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
Twist is the rotation around the twist axis, this value defined how far the joint can twist.
|
|
|
|
Twist is locked if below 0.05.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ConeTwistJoint3D_method_get_param:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
|
|
|
|
Returns the value of the specified parameter.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ConeTwistJoint3D_method_set_param:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
|
|
|
|
Sets the value of the specified parameter.
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|