181 lines
6.2 KiB
ReStructuredText
181 lines
6.2 KiB
ReStructuredText
: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/PinJoint.xml.
|
|
|
|
.. _class_PinJoint:
|
|
|
|
PinJoint
|
|
========
|
|
|
|
**Inherits:** :ref:`Joint<class_Joint>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Pin joint for 3D PhysicsBodies.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together. See also :ref:`Generic6DOFJoint<class_Generic6DOFJoint>`.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+---------------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`params/bias<class_PinJoint_property_params/bias>` | ``0.3`` |
|
|
+---------------------------+---------------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`params/damping<class_PinJoint_property_params/damping>` | ``1.0`` |
|
|
+---------------------------+---------------------------------------------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint_property_params/impulse_clamp>` | ``0.0`` |
|
|
+---------------------------+---------------------------------------------------------------------------+---------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint_method_get_param>` **(** :ref:`Param<enum_PinJoint_Param>` param **)** |const| |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_param<class_PinJoint_method_set_param>` **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_PinJoint_Param:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Param**:
|
|
|
|
.. _class_PinJoint_constant_PARAM_BIAS:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_PinJoint_Param>` **PARAM_BIAS** = ``0``
|
|
|
|
The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
|
|
|
|
.. _class_PinJoint_constant_PARAM_DAMPING:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_PinJoint_Param>` **PARAM_DAMPING** = ``1``
|
|
|
|
The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
|
|
|
|
.. _class_PinJoint_constant_PARAM_IMPULSE_CLAMP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Param<enum_PinJoint_Param>` **PARAM_IMPULSE_CLAMP** = ``2``
|
|
|
|
If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PinJoint_property_params/bias:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **params/bias** = ``0.3``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_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_PinJoint_property_params/damping:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **params/damping** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_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_PinJoint_property_params/impulse_clamp:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **params/impulse_clamp** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_Param>` param **)** |const|
|
|
|
|
If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_PinJoint_method_get_param:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_Param>` param **)** |const|
|
|
|
|
Returns the value of the specified parameter.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_PinJoint_method_set_param:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_param** **(** :ref:`Param<enum_PinJoint_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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|