Sculpt(Paint)

base classes — bpy_struct, Paint

class bpy.types.Sculpt.Sculpt(Paint)
constant_detail_resolution

Maximum edge length for dynamic topology sculpting (as divisor of blender unit - higher value means smaller edge length)

Type

float in [0.0001, inf], default 0.0

detail_percent

Maximum edge length for dynamic topology sculpting (in brush percenage)

Type

float in [-inf, inf], default 0.0

detail_refine_method

In dynamic-topology mode, how to add or remove mesh detail

  • 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

enum in [‘SUBDIVIDE’, ‘COLLAPSE’, ‘SUBDIVIDE_COLLAPSE’], default ‘SUBDIVIDE’

detail_size

Maximum edge length for dynamic topology sculpting (in pixels)

Type

float in [-inf, inf], default 0.0

detail_type_method

In dynamic-topology mode, how mesh detail size is calculated

  • 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 radius.

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

Type

enum in [‘RELATIVE’, ‘CONSTANT’, ‘BRUSH’, ‘MANUAL’], default ‘RELATIVE’

gravity

Amount of gravity after each dab

Type

float in [0, 1], default 0.0

gravity_object

Object whose Z axis defines orientation of gravity

Type

Object

lock_x

Disallow changes to the X axis of vertices

Type

boolean, default False

lock_y

Disallow changes to the Y axis of vertices

Type

boolean, default False

lock_z

Disallow changes to the Z axis of vertices

Type

boolean, default False

radial_symmetry

Number of times to copy strokes across the surface

Type

int array of 3 items in [1, 64], default (1, 1, 1)

show_face_sets

Show Face Sets as overlay on object

Type

boolean, default False

show_mask

Show mask as overlay on object

Type

boolean, default False

symmetrize_direction

Source and destination for symmetrize operator

Type

enum in [‘NEGATIVE_X’, ‘POSITIVE_X’, ‘NEGATIVE_Y’, ‘POSITIVE_Y’, ‘NEGATIVE_Z’, ‘POSITIVE_Z’], default ‘NEGATIVE_X’

use_automasking_boundary_edges

Do not affect non manifold boundary edges

Type

boolean, default False

use_automasking_boundary_face_sets

Do not affect vertices that belong to a Face Set boundary

Type

boolean, default False

use_automasking_face_sets

Affect only vertices that share Face Sets with the active vertex

Type

boolean, default False

use_automasking_topology

Affect only vertices connected to the active vertex under the brush

Type

boolean, default False

use_deform_only

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

Type

boolean, default False

use_smooth_shading

Show faces in dynamic-topology mode with smooth shading rather than flat shaded

Type

boolean, default False

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

  • Paint.brush

  • Paint.tool_slots

  • Paint.palette

  • Paint.show_brush

  • Paint.show_brush_on_surface

  • Paint.show_low_resolution

  • Paint.use_sculpt_delay_updates

  • Paint.input_samples

  • Paint.use_symmetry_x

  • Paint.use_symmetry_y

  • Paint.use_symmetry_z

  • Paint.use_symmetry_feather

  • Paint.cavity_curve

  • Paint.use_cavity

  • Paint.tile_offset

  • Paint.tile_x

  • Paint.tile_y

  • Paint.tile_z

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • 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.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

  • Paint.bl_rna_get_subclass

  • Paint.bl_rna_get_subclass_py

References

  • ToolSettings.sculpt