: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` **<** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`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. Additionally, **SoftBody3D** is subject to wind forces defined in :ref:`Area3D` (see :ref:`Area3D.wind_source_path`, :ref:`Area3D.wind_force_magnitude`, and :ref:`Area3D.wind_attenuation_factor`). \ **Note:** It's recommended to use Jolt Physics when using **SoftBody3D** instead of the default GodotPhysics3D, as Jolt Physics' soft body implementation is faster and more reliable. You can switch the physics engine using the :ref:`ProjectSettings.physics/3d/physics_engine` project setting. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`SoftBody <../tutorials/physics/soft_body>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`collision_layer` | ``1`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`damping_coefficient` | ``0.01`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`DisableMode` | :ref:`disable_mode` | ``0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`drag_coefficient` | ``0.0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`linear_stiffness` | ``0.5`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`NodePath` | :ref:`parent_collision_ignore` | ``NodePath("")`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`pressure_coefficient` | ``0.0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`ray_pickable` | ``true`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`shrinking_factor` | ``0.0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`simulation_precision` | ``5`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`total_mass` | ``1.0`` | +-------------------------------------------------+-----------------------------------------------------------------------------------+------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_central_force`\ (\ force\: :ref:`Vector3`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_central_impulse`\ (\ impulse\: :ref:`Vector3`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_force`\ (\ point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_impulse`\ (\ point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`PhysicsBody3D`\] | :ref:`get_collision_exceptions`\ (\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_value`\ (\ layer_number\: :ref:`int`\ ) |const| | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_value`\ (\ layer_number\: :ref:`int`\ ) |const| | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_physics_rid`\ (\ ) |const| | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_point_transform`\ (\ point_index\: :ref:`int`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_point_pinned`\ (\ point_index\: :ref:`int`\ ) |const| | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_collision_exception_with`\ (\ body\: :ref:`Node`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_collision_layer_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_collision_mask_value`\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_point_pinned`\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath(""), insert_at\: :ref:`int` = -1\ ) | +------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SoftBody3D_DisableMode: .. rst-class:: classref-enumeration enum **DisableMode**: :ref:`🔗` .. _class_SoftBody3D_constant_DISABLE_MODE_REMOVE: .. rst-class:: classref-enumeration-constant :ref:`DisableMode` **DISABLE_MODE_REMOVE** = ``0`` When :ref:`Node.process_mode` is set to :ref:`Node.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` is processed again. .. _class_SoftBody3D_constant_DISABLE_MODE_KEEP_ACTIVE: .. rst-class:: classref-enumeration-constant :ref:`DisableMode` **DISABLE_MODE_KEEP_ACTIVE** = ``1`` When :ref:`Node.process_mode` is set to :ref:`Node.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` **collision_layer** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collision_layer**\ (\ value\: :ref:`int`\ ) - :ref:`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`. \ **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` **collision_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_collision_mask**\ (\ value\: :ref:`int`\ ) - :ref:`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`. \ **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` **damping_coefficient** = ``0.01`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_damping_coefficient**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_damping_coefficient**\ (\ ) The body's damping coefficient. Higher values will slow down the body more noticeably when forces are applied. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_disable_mode: .. rst-class:: classref-property :ref:`DisableMode` **disable_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_disable_mode**\ (\ value\: :ref:`DisableMode`\ ) - :ref:`DisableMode` **get_disable_mode**\ (\ ) Defines the behavior in physics when :ref:`Node.process_mode` is set to :ref:`Node.PROCESS_MODE_DISABLED`. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_drag_coefficient: .. rst-class:: classref-property :ref:`float` **drag_coefficient** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_drag_coefficient**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_drag_coefficient**\ (\ ) The body's drag coefficient. Higher values increase this body's air resistance. \ **Note:** This value is currently unused by Godot's default physics implementation. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_linear_stiffness: .. rst-class:: classref-property :ref:`float` **linear_stiffness** = ``0.5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_linear_stiffness**\ (\ value\: :ref:`float`\ ) - :ref:`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` **parent_collision_ignore** = ``NodePath("")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_parent_collision_ignore**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_parent_collision_ignore**\ (\ ) :ref:`NodePath` to a :ref:`CollisionObject3D` this SoftBody3D should avoid clipping. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_pressure_coefficient: .. rst-class:: classref-property :ref:`float` **pressure_coefficient** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pressure_coefficient**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_pressure_coefficient**\ (\ ) The pressure coefficient of this soft body. Simulate pressure build-up from inside this body. Higher values increase the strength of this effect. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_ray_pickable: .. rst-class:: classref-property :ref:`bool` **ray_pickable** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ray_pickable**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_ray_pickable**\ (\ ) If ``true``, the **SoftBody3D** will respond to :ref:`RayCast3D`\ s. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_shrinking_factor: .. rst-class:: classref-property :ref:`float` **shrinking_factor** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shrinking_factor**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_shrinking_factor**\ (\ ) Scales the rest lengths of **SoftBody3D**'s edge constraints. Positive values shrink the mesh, while negative values expand it. For example, a value of ``0.1`` shortens the edges of the mesh by 10%, while ``-0.1`` expands the edges by 10%. \ **Note:** :ref:`shrinking_factor` is best used on surface meshes with pinned points. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_property_simulation_precision: .. rst-class:: classref-property :ref:`int` **simulation_precision** = ``5`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_simulation_precision**\ (\ value\: :ref:`int`\ ) - :ref:`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` **total_mass** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_total_mass**\ (\ value\: :ref:`float`\ ) - :ref:`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**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_apply_central_force: .. rst-class:: classref-method |void| **apply_central_force**\ (\ force\: :ref:`Vector3`\ ) :ref:`🔗` Distributes and applies a force to all points. A force is time dependent and meant to be applied every physics update. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_apply_central_impulse: .. rst-class:: classref-method |void| **apply_central_impulse**\ (\ impulse\: :ref:`Vector3`\ ) :ref:`🔗` Distributes and applies an impulse to all points. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_apply_force: .. rst-class:: classref-method |void| **apply_force**\ (\ point_index\: :ref:`int`, force\: :ref:`Vector3`\ ) :ref:`🔗` Applies a force to a point. A force is time dependent and meant to be applied every physics update. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_apply_impulse: .. rst-class:: classref-method |void| **apply_impulse**\ (\ point_index\: :ref:`int`, impulse\: :ref:`Vector3`\ ) :ref:`🔗` Applies an impulse to a point. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_get_collision_exceptions: .. rst-class:: classref-method :ref:`Array`\[:ref:`PhysicsBody3D`\] **get_collision_exceptions**\ (\ ) :ref:`🔗` 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` **get_collision_layer_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`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` **get_collision_mask_value**\ (\ layer_number\: :ref:`int`\ ) |const| :ref:`🔗` Returns whether or not the specified layer of the :ref:`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` **get_physics_rid**\ (\ ) |const| :ref:`🔗` Returns the internal :ref:`RID` used by the :ref:`PhysicsServer3D` for this body. .. rst-class:: classref-item-separator ---- .. _class_SoftBody3D_method_get_point_transform: .. rst-class:: classref-method :ref:`Vector3` **get_point_transform**\ (\ point_index\: :ref:`int`\ ) :ref:`🔗` 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` **is_point_pinned**\ (\ point_index\: :ref:`int`\ ) |const| :ref:`🔗` 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**\ (\ body\: :ref:`Node`\ ) :ref:`🔗` 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**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`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**\ (\ layer_number\: :ref:`int`, value\: :ref:`bool`\ ) :ref:`🔗` Based on ``value``, enables or disables the specified layer in the :ref:`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**\ (\ point_index\: :ref:`int`, pinned\: :ref:`bool`, attachment_path\: :ref:`NodePath` = NodePath(""), insert_at\: :ref:`int` = -1\ ) :ref:`🔗` Sets the pinned state of a surface vertex. When set to ``true``, the optional ``attachment_path`` can define a :ref:`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.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`