Sculpt(Paint)

base classes — bpy_struct, Paint

class bpy.types.Sculpt(Paint)
constant_detail_resolution

Maximum edge length for dynamic topology sculpting (as divisor of Blender unit - higher value means smaller edge length) (in [0.0001, inf], default 3.0)

Type:

float

detail_percent

Maximum edge length for dynamic topology sculpting (in brush percentage) (in [0.5, 100], default 25.0)

Type:

float

detail_refine_method

In dynamic-topology mode, how to add or remove mesh detail (default 'SUBDIVIDE_COLLAPSE')

  • SUBDIVIDE Subdivide Edges – Subdivide long edges to add mesh detail where needed.

  • COLLAPSE Collapse Edges – Collapse short edges to remove mesh detail where possible.

  • SUBDIVIDE_COLLAPSE Subdivide Collapse – Both subdivide long edges and collapse short edges to refine mesh detail.

Type:

Literal[‘SUBDIVIDE’, ‘COLLAPSE’, ‘SUBDIVIDE_COLLAPSE’]

detail_size

Maximum edge length for dynamic topology sculpting (in pixels) (in [0.5, 40], default 12.0)

Type:

float

detail_type_method

In dynamic-topology mode, how mesh detail size is calculated (default 'RELATIVE')

  • RELATIVE Relative Detail – Mesh detail is relative to the brush size and detail size.

  • CONSTANT Constant Detail – Mesh detail is constant in world space according to detail size.

  • BRUSH Brush Detail – Mesh detail is relative to brush size.

  • MANUAL Manual Detail – Mesh detail does not change on each stroke, only when using Flood Fill.

Type:

Literal[‘RELATIVE’, ‘CONSTANT’, ‘BRUSH’, ‘MANUAL’]

gravity

Amount of gravity after each dab (in [0, 1], default 0.0)

Type:

float

gravity_object

Object whose Z axis defines orientation of gravity

Type:

Object

lock_x

Disallow changes to the X axis of vertices (default False)

Type:

bool

lock_y

Disallow changes to the Y axis of vertices (default False)

Type:

bool

lock_z

Disallow changes to the Z axis of vertices (default False)

Type:

bool

symmetrize_direction

Source and destination for symmetrize operator (default 'NEGATIVE_X')

Type:

Literal[Symmetrize Direction Items]

transform_mode

How the transformation is going to be applied to the target (default 'ALL_VERTICES')

  • ALL_VERTICES All Vertices – Applies the transformation to all vertices in the mesh.

  • RADIUS_ELASTIC Elastic – Applies the transformation simulating elasticity using the radius of the cursor.

Type:

Literal[‘ALL_VERTICES’, ‘RADIUS_ELASTIC’]

use_deform_only

Use only deformation modifiers (temporary disable all constructive modifiers except multi-resolution) (default False)

Type:

bool

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