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

Type :float in [0, 10], default 0.0

bending_stiffness

Wrinkle coefficient (higher = less smaller but more big wrinkles)

Type :float in [0, 10000], default 0.0

bending_stiffness_max

Maximum bending stiffness value

Type :float in [0, 10000], default 0.0

collider_friction

Type :float in [0, 1], default 0.0

effector_weights

Type :EffectorWeights, (readonly)

goal_default

Default Goal (vertex target position) value, when no Vertex Group used

Type :float in [0, 1], default 0.0

goal_friction

Goal (vertex target position) friction

Type :float in [0, 50], default 0.0

goal_max

Goal maximum, vertex group weights are scaled to match this range

Type :float in [0, 1], default 0.0

goal_min

Goal minimum, vertex group weights are scaled to match this range

Type :float in [0, 1], default 0.0

goal_spring

Goal (vertex target position) spring stiffness

Type :float in [0, 0.999], default 0.0

gravity

Gravity or external force vector

Type :float array of 3 items in [-100, 100], default (0.0, 0.0, 0.0)

internal_friction

Type :float in [0, 1], default 0.0

mass

Mass of cloth material

Type :float in [0, 10], default 0.0

pin_stiffness

Pin (vertex target position) spring stiffness

Type :float in [0, 50], default 0.0

pre_roll

Simulation starts on this frame

Type :int in [0, 200], default 0

quality

Quality of the simulation in steps per frame (higher is better quality but slower)

Type :int in [4, 80], default 0

rest_shape_key

Shape key to use the rest spring lengths from

Type :ShapeKey

spring_damping

Damping of cloth velocity (higher = more smooth, less jiggling)

Type :float in [0, 50], default 0.0

structural_stiffness

Overall stiffness of structure

Type :float in [0, 10000], default 0.0

structural_stiffness_max

Maximum structural stiffness value

Type :float in [0, 10000], default 0.0

use_pin_cloth

Enable pinning of cloth vertices to other objects/positions

Type :boolean, default False

use_stiffness_scale

If enabled, stiffness can be scaled along a weight painted vertex group

Type :boolean, default False

vel_damping

Damp velocity to help cloth reach the resting position faster (1.0 = no damping, 0.0 = fully dampened)

Type :float in [0, 1], default 0.0

vertex_group_bending

Vertex group for fine control over bending stiffness

Type :string, default “”

vertex_group_mass

Vertex Group for pinning of vertices

Type :string, default “”

vertex_group_structural_stiffness

Vertex group for fine control over structural stiffness

Type :string, default “”

Inherited Properties

bpy_struct.id_data

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

ClothModifier.settings