| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106 |
- :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>` |
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`params/damping<class_PinJoint_property_params/damping>` |
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint_property_params/impulse_clamp>` |
- +---------------------------+---------------------------------------------------------------------------+
- 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**
- +----------+------------------+
- | *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**
- +----------+------------------+
- | *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**
- +----------+------------------+
- | *Setter* | set_param(value) |
- +----------+------------------+
- | *Getter* | get_param() |
- +----------+------------------+
- If above 0, this value is the maximum value for an impulse that this Joint produces.
|
