SoftBodySettings(bpy_struct)

base class — bpy_struct

class bpy.types.SoftBodySettings(bpy_struct)

Soft body simulation settings for an object

aero

Make edges ‘sail’ (in [0, 30000], default 0)

Type:

int

aerodynamics_type

Method of calculating aerodynamic interaction (default 'SIMPLE')

  • SIMPLE Simple – Edges receive a drag force from surrounding media.

  • LIFT_FORCE Lift Force – Edges receive a lift force when passing through surrounding media.

Type:

Literal[‘SIMPLE’, ‘LIFT_FORCE’]

ball_damp

Blending to inelastic collision (in [0.001, 1], default 0.0)

Type:

float

ball_size

Absolute ball size or factor if not manually adjusted (in [-10, 10], default 0.0)

Type:

float

ball_stiff

Ball inflating pressure (in [0.001, 100], default 0.0)

Type:

float

bend

Bending Stiffness (in [0, 10], default 0.0)

Type:

float

choke

‘Viscosity’ inside collision target (in [0, 100], default 0)

Type:

int

collision_collection

Limit colliders to this collection

Type:

Collection

collision_type

Choose Collision Type (default 'MANUAL')

  • MANUAL Manual – Manual adjust.

  • AVERAGE Average – Average Spring length * Ball Size.

  • MINIMAL Minimal – Minimal Spring length * Ball Size.

  • MAXIMAL Maximal – Maximal Spring length * Ball Size.

  • MINMAX AvMinMax – (Min+Max)/2 * Ball Size.

Type:

Literal[‘MANUAL’, ‘AVERAGE’, ‘MINIMAL’, ‘MAXIMAL’, ‘MINMAX’]

damping

Edge spring friction (in [0, 50], default 0.0)

Type:

float

effector_weights

(readonly)

Type:

EffectorWeights

error_threshold

The Runge-Kutta ODE solver error limit, low value gives more precision, high values speed (in [0.001, 10], default 0.0)

Type:

float

friction

General media friction for point movements (in [0, 50], default 0.0)

Type:

float

fuzzy

Fuzziness while on collision, high values make collision handling faster but less stable (in [1, 100], default 0)

Type:

int

goal_default

Default Goal (vertex target position) value (in [0, 1], default 0.0)

Type:

float

goal_friction

Goal (vertex target position) friction (in [0, 50], default 0.0)

Type:

float

goal_max

Goal maximum, vertex weights are scaled to match this range (in [0, 1], default 0.0)

Type:

float

goal_min

Goal minimum, vertex weights are scaled to match this range (in [0, 1], default 0.0)

Type:

float

goal_spring

Goal (vertex target position) spring stiffness (in [0, 0.999], default 0.0)

Type:

float

gravity

Apply gravitation to point movement (in [-10, 10], default 0.0)

Type:

float

location_mass_center

Location of center of mass (array of 3 items, in [-inf, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Vector

mass

General Mass value (in [0, 50000], default 0.0)

Type:

float

plastic

Permanent deform (in [0, 100], default 0)

Type:

int

pull

Edge spring stiffness when longer than rest length (in [0, 0.999], default 0.0)

Type:

float

push

Edge spring stiffness when shorter than rest length (in [0, 0.999], default 0.0)

Type:

float

rotation_estimate

Estimated rotation matrix (multi-dimensional array of 3 * 3 items, in [-inf, inf], default ((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0)))

Type:

mathutils.Matrix

scale_estimate

Estimated scale matrix (multi-dimensional array of 3 * 3 items, in [-inf, inf], default ((0.0, 0.0, 0.0), (0.0, 0.0, 0.0), (0.0, 0.0, 0.0)))

Type:

mathutils.Matrix

shear

Shear Stiffness (in [0, 1], default 0.0)

Type:

float

speed

Tweak timing for physics to control frequency and speed (in [0.01, 100], default 0.0)

Type:

float

spring_length

Alter spring length to shrink/blow up (unit %) 0 to disable (in [0, 200], default 0)

Type:

int

step_max

Maximal # solver steps/frame (in [0, 30000], default 0)

Type:

int

step_min

Minimal # solver steps/frame (in [0, 30000], default 0)

Type:

int

use_auto_step

Use velocities for automagic step sizes (default False)

Type:

bool

use_diagnose

Turn on SB diagnose console prints (default False)

Type:

bool

use_edge_collision

Edges collide too (default False)

Type:

bool

use_edges

Use Edges as springs (default False)

Type:

bool

use_estimate_matrix

Store the estimated transforms in the soft body settings (default False)

Type:

bool

use_face_collision

Faces collide too, can be very slow (default False)

Type:

bool

use_goal

Define forces for vertices to stick to animated position (default False)

Type:

bool

use_self_collision

Enable naive vertex ball self collision (default False)

Type:

bool

use_stiff_quads

Add diagonal springs on 4-gons (default False)

Type:

bool

vertex_group_goal

Control point weight values (default “”, never None)

Type:

str

vertex_group_mass

Control point mass values (default “”, never None)

Type:

str

vertex_group_spring

Control point spring strength values (default “”, never None)

Type:

str

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References