ClothSettings(bpy_struct)

base class — bpy_struct

class bpy.types.ClothSettings(bpy_struct)

Cloth simulation settings for an object

air_damping

Air has normally some thickness which slows falling things down (in [0, 10], default 1.0)

Type:

float

bending_damping

Amount of damping in bending behavior (in [0, 1000], default 0.5)

Type:

float

bending_model

Physical model for simulating bending forces (default 'ANGULAR')

  • ANGULAR Angular – Cloth model with angular bending springs.

  • LINEAR Linear – Cloth model with linear bending springs (legacy).

Type:

Literal[‘ANGULAR’, ‘LINEAR’]

bending_stiffness

How much the material resists bending (in [0, 10000], default 0.5)

Type:

float

bending_stiffness_max

Maximum bending stiffness value (in [0, 10000], default 0.5)

Type:

float

collider_friction

(in [0, 1], default 0.0)

Type:

float

compression_damping

Amount of damping in compression behavior (in [0, 50], default 5.0)

Type:

float

compression_stiffness

How much the material resists compression (in [0, 10000], default 15.0)

Type:

float

compression_stiffness_max

Maximum compression stiffness value (in [0, 10000], default 15.0)

Type:

float

density_strength

Influence of target density on the simulation (in [0, 1], default 0.0)

Type:

float

density_target

Maximum density of hair (in [0, 10000], default 0.0)

Type:

float

effector_weights

(readonly)

Type:

EffectorWeights

fluid_density

Density (kg/l) of the fluid contained inside the object, used to create a hydrostatic pressure gradient simulating the weight of the internal fluid, or buoyancy from the surrounding fluid if negative (in [-inf, inf], default 0.0)

Type:

float

goal_default

Default Goal (vertex target position) value, when no Vertex Group used (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 group weights are scaled to match this range (in [0, 1], default 1.0)

Type:

float

goal_min

Goal minimum, vertex group 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 1.0)

Type:

float

gravity

Gravity or external force vector (array of 3 items, in [-100, 100], default (0.0, 0.0, -9.81))

Type:

mathutils.Vector

internal_compression_stiffness

How much the material resists compression (in [0, 10000], default 15.0)

Type:

float

internal_compression_stiffness_max

Maximum compression stiffness value (in [0, 10000], default 15.0)

Type:

float

internal_friction

(in [0, 1], default 0.0)

Type:

float

internal_spring_max_diversion

How much the rays used to connect the internal points can diverge from the vertex normal (in [0, 0.785398], default 0.785398)

Type:

float

internal_spring_max_length

The maximum length an internal spring can have during creation. If the distance between internal points is greater than this, no internal spring will be created between these points. A length of zero means that there is no length limit. (in [0, 1000], default 0.0)

Type:

float

internal_spring_normal_check

Require the points the internal springs connect to have opposite normal directions (default True)

Type:

bool

internal_tension_stiffness

How much the material resists stretching (in [0, 10000], default 15.0)

Type:

float

internal_tension_stiffness_max

Maximum tension stiffness value (in [0, 10000], default 15.0)

Type:

float

mass

The mass of each vertex on the cloth material (in [0, inf], default 0.3)

Type:

float

pin_stiffness

Pin (vertex target position) spring stiffness (in [0, 50], default 1.0)

Type:

float

pressure_factor

Ambient pressure (kPa) that balances out between the inside and outside of the object when it has the target volume (in [0, 10000], default 1.0)

Type:

float

quality

Quality of the simulation in steps per frame (higher is better quality but slower) (in [1, inf], default 5)

Type:

int

rest_shape_key

Shape key to use the rest spring lengths from

Type:

ShapeKey

sewing_force_max

Maximum sewing force (in [0, 10000], default 0.0)

Type:

float

shear_damping

Amount of damping in shearing behavior (in [0, 50], default 5.0)

Type:

float

shear_stiffness

How much the material resists shearing (in [0, 10000], default 5.0)

Type:

float

shear_stiffness_max

Maximum shear scaling value (in [0, 10000], default 5.0)

Type:

float

shrink_max

Max amount to shrink cloth by (in [-inf, 1], default 0.0)

Type:

float

shrink_min

Factor by which to shrink cloth (in [-inf, 1], default 0.0)

Type:

float

target_volume

The mesh volume where the inner/outer pressure will be the same. If set to zero the change in volume will not affect pressure. (in [0, 10000], default 0.0)

Type:

float

tension_damping

Amount of damping in stretching behavior (in [0, 50], default 5.0)

Type:

float

tension_stiffness

How much the material resists stretching (in [0, 10000], default 15.0)

Type:

float

tension_stiffness_max

Maximum tension stiffness value (in [0, 10000], default 15.0)

Type:

float

time_scale

Cloth speed is multiplied by this value (in [0, inf], default 1.0)

Type:

float

uniform_pressure_force

The uniform pressure that is constantly applied to the mesh, in units of Pressure Scale. Can be negative. (in [-10000, 10000], default 0.0)

Type:

float

use_dynamic_mesh

Make simulation respect deformations in the base mesh (default False)

Type:

bool

use_internal_springs

Simulate an internal volume structure by creating springs connecting the opposite sides of the mesh (default False)

Type:

bool

use_pressure

Simulate pressure inside a closed cloth mesh (default False)

Type:

bool

use_pressure_volume

Use the Target Volume parameter as the initial volume, instead of calculating it from the mesh itself (default False)

Type:

bool

use_sewing_springs

Pulls loose edges together (default False)

Type:

bool

vertex_group_bending

Vertex group for fine control over bending stiffness (default “”, never None)

Type:

str

vertex_group_intern

Vertex group for fine control over the internal spring stiffness (default “”, never None)

Type:

str

vertex_group_mass

Vertex Group for pinning of vertices (default “”, never None)

Type:

str

vertex_group_pressure

Vertex Group for where to apply pressure. Zero weight means no pressure while a weight of one means full pressure. Faces with a vertex that has zero weight will be excluded from the volume calculation. (default “”, never None)

Type:

str

vertex_group_shear_stiffness

Vertex group for fine control over shear stiffness (default “”, never None)

Type:

str

vertex_group_shrink

Vertex Group for shrinking cloth (default “”, never None)

Type:

str

vertex_group_structural_stiffness

Vertex group for fine control over structural stiffness (default “”, never None)

Type:

str

voxel_cell_size

Size of the voxel grid cells for interaction effects (in [0.0001, 10000], default 0.1)

Type:

float

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