mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
478 lines
23 KiB
ReStructuredText
478 lines
23 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/SoftBody3D.xml.
|
|
|
|
.. _class_SoftBody3D:
|
|
|
|
SoftBody3D
|
|
==========
|
|
|
|
**Inherits:** :ref:`MeshInstance3D<class_MeshInstance3D>` **<** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
A deformable 3D physics mesh.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A deformable 3D physics mesh. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials.
|
|
|
|
\ **Note:** There are many known bugs in **SoftBody3D**. Therefore, it's not recommended to use them for things that can affect gameplay (such as trampolines).
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`SoftBody <../tutorials/physics/soft_body>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`int<class_int>` | :ref:`collision_layer<class_SoftBody3D_property_collision_layer>` | ``1`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`int<class_int>` | :ref:`collision_mask<class_SoftBody3D_property_collision_mask>` | ``1`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`float<class_float>` | :ref:`damping_coefficient<class_SoftBody3D_property_damping_coefficient>` | ``0.01`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`DisableMode<enum_SoftBody3D_DisableMode>` | :ref:`disable_mode<class_SoftBody3D_property_disable_mode>` | ``0`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`float<class_float>` | :ref:`drag_coefficient<class_SoftBody3D_property_drag_coefficient>` | ``0.0`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`float<class_float>` | :ref:`linear_stiffness<class_SoftBody3D_property_linear_stiffness>` | ``0.5`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`NodePath<class_NodePath>` | :ref:`parent_collision_ignore<class_SoftBody3D_property_parent_collision_ignore>` | ``NodePath("")`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`float<class_float>` | :ref:`pressure_coefficient<class_SoftBody3D_property_pressure_coefficient>` | ``0.0`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`ray_pickable<class_SoftBody3D_property_ray_pickable>` | ``true`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`int<class_int>` | :ref:`simulation_precision<class_SoftBody3D_property_simulation_precision>` | ``5`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
| :ref:`float<class_float>` | :ref:`total_mass<class_SoftBody3D_property_total_mass>` | ``1.0`` |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_collision_exception_with<class_SoftBody3D_method_add_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PhysicsBody3D[]<class_PhysicsBody3D>` | :ref:`get_collision_exceptions<class_SoftBody3D_method_get_collision_exceptions>` **(** **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_value<class_SoftBody3D_method_get_collision_layer_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_value<class_SoftBody3D_method_get_collision_mask_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`RID<class_RID>` | :ref:`get_physics_rid<class_SoftBody3D_method_get_physics_rid>` **(** **)** |const| |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`get_point_transform<class_SoftBody3D_method_get_point_transform>` **(** :ref:`int<class_int>` point_index **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_point_pinned<class_SoftBody3D_method_is_point_pinned>` **(** :ref:`int<class_int>` point_index **)** |const| |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_collision_exception_with<class_SoftBody3D_method_remove_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_collision_layer_value<class_SoftBody3D_method_set_collision_layer_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_collision_mask_value<class_SoftBody3D_method_set_collision_mask_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_point_pinned<class_SoftBody3D_method_set_point_pinned>` **(** :ref:`int<class_int>` point_index, :ref:`bool<class_bool>` pinned, :ref:`NodePath<class_NodePath>` attachment_path=NodePath("") **)** |
|
|
+---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_SoftBody3D_DisableMode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **DisableMode**:
|
|
|
|
.. _class_SoftBody3D_constant_DISABLE_MODE_REMOVE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`DisableMode<enum_SoftBody3D_DisableMode>` **DISABLE_MODE_REMOVE** = ``0``
|
|
|
|
When :ref:`Node.process_mode<class_Node_property_process_mode>` is set to :ref:`Node.PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`, remove from the physics simulation to stop all physics interactions with this **SoftBody3D**.
|
|
|
|
Automatically re-added to the physics simulation when the :ref:`Node<class_Node>` is processed again.
|
|
|
|
.. _class_SoftBody3D_constant_DISABLE_MODE_KEEP_ACTIVE:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`DisableMode<enum_SoftBody3D_DisableMode>` **DISABLE_MODE_KEEP_ACTIVE** = ``1``
|
|
|
|
When :ref:`Node.process_mode<class_Node_property_process_mode>` is set to :ref:`Node.PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`, do not affect the physics simulation.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_SoftBody3D_property_collision_layer:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **collision_layer** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_collision_layer** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_collision_layer** **(** **)**
|
|
|
|
The physics layers this SoftBody3D **is in**. Collision objects can exist in one or more of 32 different layers. See also :ref:`collision_mask<class_SoftBody3D_property_collision_mask>`.
|
|
|
|
\ **Note:** Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_collision_mask:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **collision_mask** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_collision_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_collision_mask** **(** **)**
|
|
|
|
The physics layers this SoftBody3D **scans**. Collision objects can scan one or more of 32 different layers. See also :ref:`collision_layer<class_SoftBody3D_property_collision_layer>`.
|
|
|
|
\ **Note:** Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_damping_coefficient:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **damping_coefficient** = ``0.01``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_damping_coefficient** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_damping_coefficient** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_disable_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`DisableMode<enum_SoftBody3D_DisableMode>` **disable_mode** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_disable_mode** **(** :ref:`DisableMode<enum_SoftBody3D_DisableMode>` value **)**
|
|
- :ref:`DisableMode<enum_SoftBody3D_DisableMode>` **get_disable_mode** **(** **)**
|
|
|
|
Defines the behavior in physics when :ref:`Node.process_mode<class_Node_property_process_mode>` is set to :ref:`Node.PROCESS_MODE_DISABLED<class_Node_constant_PROCESS_MODE_DISABLED>`. See :ref:`DisableMode<enum_SoftBody3D_DisableMode>` for more details about the different modes.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_drag_coefficient:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **drag_coefficient** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_drag_coefficient** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_drag_coefficient** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_linear_stiffness:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **linear_stiffness** = ``0.5``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_linear_stiffness** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_linear_stiffness** **(** **)**
|
|
|
|
Higher values will result in a stiffer body, while lower values will increase the body's ability to bend. The value can be between ``0.0`` and ``1.0`` (inclusive).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_parent_collision_ignore:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`NodePath<class_NodePath>` **parent_collision_ignore** = ``NodePath("")``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_parent_collision_ignore** **(** :ref:`NodePath<class_NodePath>` value **)**
|
|
- :ref:`NodePath<class_NodePath>` **get_parent_collision_ignore** **(** **)**
|
|
|
|
:ref:`NodePath<class_NodePath>` to a :ref:`CollisionObject3D<class_CollisionObject3D>` this SoftBody3D should avoid clipping.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_pressure_coefficient:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **pressure_coefficient** = ``0.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_pressure_coefficient** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_pressure_coefficient** **(** **)**
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_ray_pickable:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **ray_pickable** = ``true``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)**
|
|
|
|
If ``true``, the **SoftBody3D** will respond to :ref:`RayCast3D<class_RayCast3D>`\ s.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_simulation_precision:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **simulation_precision** = ``5``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_simulation_precision** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_simulation_precision** **(** **)**
|
|
|
|
Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_property_total_mass:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **total_mass** = ``1.0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_total_mass** **(** :ref:`float<class_float>` value **)**
|
|
- :ref:`float<class_float>` **get_total_mass** **(** **)**
|
|
|
|
The SoftBody3D's mass.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_SoftBody3D_method_add_collision_exception_with:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **add_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
|
|
|
|
Adds a body to the list of bodies that this body can't collide with.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_get_collision_exceptions:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`PhysicsBody3D[]<class_PhysicsBody3D>` **get_collision_exceptions** **(** **)**
|
|
|
|
Returns an array of nodes that were added as collision exceptions for this body.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_get_collision_layer_value:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **get_collision_layer_value** **(** :ref:`int<class_int>` layer_number **)** |const|
|
|
|
|
Returns whether or not the specified layer of the :ref:`collision_layer<class_SoftBody3D_property_collision_layer>` is enabled, given a ``layer_number`` between 1 and 32.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_get_collision_mask_value:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **get_collision_mask_value** **(** :ref:`int<class_int>` layer_number **)** |const|
|
|
|
|
Returns whether or not the specified layer of the :ref:`collision_mask<class_SoftBody3D_property_collision_mask>` is enabled, given a ``layer_number`` between 1 and 32.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_get_physics_rid:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`RID<class_RID>` **get_physics_rid** **(** **)** |const|
|
|
|
|
.. container:: contribute
|
|
|
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_get_point_transform:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Vector3<class_Vector3>` **get_point_transform** **(** :ref:`int<class_int>` point_index **)**
|
|
|
|
Returns local translation of a vertex in the surface array.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_is_point_pinned:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_point_pinned** **(** :ref:`int<class_int>` point_index **)** |const|
|
|
|
|
Returns ``true`` if vertex is set to pinned.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_remove_collision_exception_with:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **remove_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
|
|
|
|
Removes a body from the list of bodies that this body can't collide with.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_set_collision_layer_value:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_collision_layer_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**
|
|
|
|
Based on ``value``, enables or disables the specified layer in the :ref:`collision_layer<class_SoftBody3D_property_collision_layer>`, given a ``layer_number`` between 1 and 32.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_set_collision_mask_value:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_collision_mask_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**
|
|
|
|
Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask<class_SoftBody3D_property_collision_mask>`, given a ``layer_number`` between 1 and 32.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_SoftBody3D_method_set_point_pinned:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_point_pinned** **(** :ref:`int<class_int>` point_index, :ref:`bool<class_bool>` pinned, :ref:`NodePath<class_NodePath>` attachment_path=NodePath("") **)**
|
|
|
|
Sets the pinned state of a surface vertex. When set to ``true``, the optional ``attachment_path`` can define a :ref:`Node3D<class_Node3D>` the pinned vertex will be attached to.
|
|
|
|
.. |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.)`
|