mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
127 lines
4.4 KiB
ReStructuredText
127 lines
4.4 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PinJoint.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PinJoint:
|
|
|
|
PinJoint
|
|
========
|
|
|
|
**Inherits:** :ref:`Joint<class_Joint>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Pin joint for 3D shapes.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+---------------------------------------------------------------------------+-----+
|
|
| :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 |
|
|
+---------------------------+---------------------------------------------------------------------------+-----+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :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 **)** |
|
|
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_PinJoint_Param:
|
|
|
|
.. _class_PinJoint_constant_PARAM_BIAS:
|
|
|
|
.. _class_PinJoint_constant_PARAM_DAMPING:
|
|
|
|
.. _class_PinJoint_constant_PARAM_IMPULSE_CLAMP:
|
|
|
|
enum **Param**:
|
|
|
|
- **PARAM_BIAS** = **0** --- The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
|
|
|
|
- **PARAM_DAMPING** = **1** --- The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
|
|
|
|
- **PARAM_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Pin joint for 3D rigid bodies. It pins 2 bodies (rigid or static) together.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PinJoint_property_params/bias:
|
|
|
|
- :ref:`float<class_float>` **params/bias**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | 0.3 |
|
|
+-----------+------------------+
|
|
| *Setter* | set_param(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_param() |
|
|
+-----------+------------------+
|
|
|
|
The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
|
|
|
|
----
|
|
|
|
.. _class_PinJoint_property_params/damping:
|
|
|
|
- :ref:`float<class_float>` **params/damping**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | 1.0 |
|
|
+-----------+------------------+
|
|
| *Setter* | set_param(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_param() |
|
|
+-----------+------------------+
|
|
|
|
The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
|
|
|
|
----
|
|
|
|
.. _class_PinJoint_property_params/impulse_clamp:
|
|
|
|
- :ref:`float<class_float>` **params/impulse_clamp**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | 0.0 |
|
|
+-----------+------------------+
|
|
| *Setter* | set_param(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_param() |
|
|
+-----------+------------------+
|
|
|
|
If above 0, this value is the maximum value for an impulse that this Joint produces.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_PinJoint_method_get_param:
|
|
|
|
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint_Param>` param **)** const
|
|
|
|
----
|
|
|
|
.. _class_PinJoint_method_set_param:
|
|
|
|
- void **set_param** **(** :ref:`Param<enum_PinJoint_Param>` param, :ref:`float<class_float>` value **)**
|
|
|