SoftBody

Inherits: MeshInstance < GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object

A soft mesh physics body.

Description

A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials.

Tutorials

Methods

void

add_collision_exception_with ( Node body )

Array

get_collision_exceptions ( )

bool

get_collision_layer_bit ( int bit ) const

bool

get_collision_mask_bit ( int bit ) const

Vector3

get_point_transform ( int point_index )

bool

is_point_pinned ( int point_index ) const

void

remove_collision_exception_with ( Node body )

void

set_collision_layer_bit ( int bit, bool value )

void

set_collision_mask_bit ( int bit, bool value )

void

set_point_pinned ( int point_index, bool pinned, NodePath attachment_path=NodePath("") )

Property Descriptions

  • float areaAngular_stiffness

Default

0.5

Setter

set_areaAngular_stiffness(value)

Getter

get_areaAngular_stiffness()


  • int collision_layer

Default

1

Setter

set_collision_layer(value)

Getter

get_collision_layer()

The physics layers this SoftBody is in.

Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.

A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See Collision layers and masks in the documentation for more information.


  • int collision_mask

Default

1

Setter

set_collision_mask(value)

Getter

get_collision_mask()

The physics layers this SoftBody scans for collisions. See Collision layers and masks in the documentation for more information.


  • float damping_coefficient

Default

0.01

Setter

set_damping_coefficient(value)

Getter

get_damping_coefficient()


Default

0.0

Setter

set_drag_coefficient(value)

Getter

get_drag_coefficient()


Default

0.5

Setter

set_linear_stiffness(value)

Getter

get_linear_stiffness()


Default

NodePath("")

Setter

set_parent_collision_ignore(value)

Getter

get_parent_collision_ignore()

NodePath to a CollisionObject this SoftBody should avoid clipping.


  • bool physics_enabled

Default

true

Setter

set_physics_enabled(value)

Getter

is_physics_enabled()

If true, the SoftBody is simulated in physics. Can be set to false to pause the physics simulation.


  • float pose_matching_coefficient

Default

0.0

Setter

set_pose_matching_coefficient(value)

Getter

get_pose_matching_coefficient()


  • float pressure_coefficient

Default

0.0

Setter

set_pressure_coefficient(value)

Getter

get_pressure_coefficient()


Default

true

Setter

set_ray_pickable(value)

Getter

is_ray_pickable()

If true, the SoftBody will respond to RayCasts.


  • int simulation_precision

Default

5

Setter

set_simulation_precision(value)

Getter

get_simulation_precision()

Increasing this value will improve the resulting simulation, but can affect performance. Use with care.


Default

1.0

Setter

set_total_mass(value)

Getter

get_total_mass()

The SoftBody's mass.


Default

0.5

Setter

set_volume_stiffness(value)

Getter

get_volume_stiffness()

Method Descriptions

  • void add_collision_exception_with ( Node body )

Adds a body to the list of bodies that this body can't collide with.


  • Array get_collision_exceptions ( )

Returns an array of nodes that were added as collision exceptions for this body.


  • bool get_collision_layer_bit ( int bit ) const

Returns an individual bit on the collision mask.


  • bool get_collision_mask_bit ( int bit ) const

Returns an individual bit on the collision mask.


Returns local translation of a vertex in the surface array.


  • bool is_point_pinned ( int point_index ) const

Returns true if vertex is set to pinned.


  • void remove_collision_exception_with ( Node body )

Removes a body from the list of bodies that this body can't collide with.


  • void set_collision_layer_bit ( int bit, bool value )

Sets individual bits on the layer mask. Use this if you only need to change one layer's value.


  • void set_collision_mask_bit ( int bit, bool value )

Sets individual bits on the collision mask. Use this if you only need to change one layer's value.


  • void set_point_pinned ( int point_index, bool pinned, NodePath attachment_path=NodePath("") )

Sets the pinned state of a surface vertex. When set to true, the optional attachment_path can define a Spatial the pinned vertex will be attached to.