Sculpt(Paint)#

base classes — bpy_struct, Paint

class bpy.types.Sculpt(Paint)#
automasking_boundary_edges_propagation_steps#

Distance where boundary edge automasking is going to protect vertices from the fully masked edge

Type:

int in [1, 20], default 1

automasking_cavity_blur_steps#

The number of times the cavity mask is blurred

Type:

int in [0, 25], default 0

automasking_cavity_curve#

Curve used for the sensitivity

Type:

CurveMapping, (readonly)

automasking_cavity_curve_op#

Curve used for the sensitivity

Type:

CurveMapping, (readonly)

automasking_cavity_factor#

The contrast of the cavity mask

Type:

float in [0, 5], default 1.0

automasking_start_normal_falloff#

Extend the angular range with a falloff gradient

Type:

float in [0.0001, 1], default 0.25

automasking_start_normal_limit#

The range of angles that will be affected

Type:

float in [0.0001, 3.14159], default 0.349066

automasking_view_normal_falloff#

Extend the angular range with a falloff gradient

Type:

float in [0.0001, 1], default 0.25

automasking_view_normal_limit#

The range of angles that will be affected

Type:

float in [0.0001, 3.14159], default 1.5708

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 3.0

detail_percent#

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

Type:

float in [0.5, 100], default 25.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 [0.5, 40], default 12.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 (0, 0, 0)

symmetrize_direction#

Source and destination for symmetrize operator

Type:

enum in Symmetrize Direction Items, default ‘NEGATIVE_X’

transform_mode#

How the transformation is going to be applied to the target

  • 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:

enum in [‘ALL_VERTICES’, ‘RADIUS_ELASTIC’], default ‘ALL_VERTICES’

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_cavity#

Do not affect vertices on peaks, based on the surface curvature

Type:

boolean, default False

use_automasking_cavity_inverted#

Do not affect vertices within crevices, based on the surface curvature

Type:

boolean, default False

use_automasking_custom_cavity_curve#

Use custom curve

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_start_normal#

Affect only vertices with a similar normal to where the stroke starts

Type:

boolean, default False

use_automasking_topology#

Affect only vertices connected to the active vertex under the brush

Type:

boolean, default False

use_automasking_view_normal#

Affect only vertices with a normal that faces the viewer

Type:

boolean, default False

use_automasking_view_occlusion#

Only affect vertices that are not occluded by other faces (Slower performance)

Type:

boolean, default False

use_deform_only#

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

Type:

boolean, default False

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

id (str) – 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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#

References#