godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
classes/class_pinjoint3d.rst
View File

@@ -14,113 +14,164 @@ PinJoint3D
Pin joint for 3D PhysicsBodies.
.. rst-class:: classref-introduction-group
Description
-----------
Pin joint for 3D rigid bodies. It pins 2 bodies (dynamic or static) together. See also :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/bias<class_PinJoint3D_property_params/bias>` | ``0.3`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/damping<class_PinJoint3D_property_params/damping>` | ``1.0`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint3D_property_params/impulse_clamp>` | ``0.0`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/bias<class_PinJoint3D_property_params/bias>` | ``0.3`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/damping<class_PinJoint3D_property_params/damping>` | ``1.0`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint3D_property_params/impulse_clamp>` | ``0.0`` |
+---------------------------+-----------------------------------------------------------------------------+---------+
.. rst-class:: classref-reftable-group
Methods
-------
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint3D_method_get_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const| |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_PinJoint3D_method_set_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint3D_method_get_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const| |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_PinJoint3D_method_set_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_PinJoint3D_Param:
.. _class_PinJoint3D_constant_PARAM_BIAS:
.. _class_PinJoint3D_constant_PARAM_DAMPING:
.. _class_PinJoint3D_constant_PARAM_IMPULSE_CLAMP:
.. rst-class:: classref-enumeration
enum **Param**:
- **PARAM_BIAS** = **0** --- The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
.. _class_PinJoint3D_constant_PARAM_BIAS:
- **PARAM_DAMPING** = **1** --- The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
.. rst-class:: classref-enumeration-constant
- **PARAM_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint3D produces.
:ref:`Param<enum_PinJoint3D_Param>` **PARAM_BIAS** = ``0``
The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
.. _class_PinJoint3D_constant_PARAM_DAMPING:
.. rst-class:: classref-enumeration-constant
:ref:`Param<enum_PinJoint3D_Param>` **PARAM_DAMPING** = ``1``
The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
.. _class_PinJoint3D_constant_PARAM_IMPULSE_CLAMP:
.. rst-class:: classref-enumeration-constant
:ref:`Param<enum_PinJoint3D_Param>` **PARAM_IMPULSE_CLAMP** = ``2``
If above 0, this value is the maximum value for an impulse that this Joint3D produces.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_PinJoint3D_property_params/bias:
- :ref:`float<class_float>` **params/bias**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``0.3`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
:ref:`float<class_float>` **params/bias** = ``0.3``
.. rst-class:: classref-property-setget
- void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
.. rst-class:: classref-item-separator
----
.. _class_PinJoint3D_property_params/damping:
- :ref:`float<class_float>` **params/damping**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``1.0`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
:ref:`float<class_float>` **params/damping** = ``1.0``
.. rst-class:: classref-property-setget
- void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
.. rst-class:: classref-item-separator
----
.. _class_PinJoint3D_property_params/impulse_clamp:
- :ref:`float<class_float>` **params/impulse_clamp**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``0.0`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
:ref:`float<class_float>` **params/impulse_clamp** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
If above 0, this value is the maximum value for an impulse that this Joint3D produces.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_PinJoint3D_method_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
.. rst-class:: classref-method
:ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
Returns the value of the specified parameter.
.. rst-class:: classref-item-separator
----
.. _class_PinJoint3D_method_set_param:
- void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
.. rst-class:: classref-method
void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
Sets the value of the specified parameter.