GPencilSculptSettings(bpy_struct)

base class — bpy_struct

class bpy.types.GPencilSculptSettings(bpy_struct)

General properties for Grease Pencil stroke sculpting tools

guide

(readonly)

Type:

GPencilSculptGuide

intersection_threshold

Threshold for stroke intersections (in [0, 10], default 0.1)

Type:

float

lock_axis

(default 'VIEW')

  • VIEW View – Align strokes to current view plane.

  • AXIS_Y Front (X-Z) – Project strokes to plane locked to Y.

  • AXIS_X Side (Y-Z) – Project strokes to plane locked to X.

  • AXIS_Z Top (X-Y) – Project strokes to plane locked to Z.

  • CURSOR Cursor – Align strokes to current 3D cursor orientation.

Type:

Literal[‘VIEW’, ‘AXIS_Y’, ‘AXIS_X’, ‘AXIS_Z’, ‘CURSOR’]

multiframe_falloff_curve

Custom curve to control falloff of brush effect by Grease Pencil frames (readonly)

Type:

CurveMapping

thickness_primitive_curve

Custom curve to control primitive thickness (readonly)

Type:

CurveMapping

use_automasking_layer_active

Affect only the Active Layer (default False)

Type:

bool

use_automasking_layer_stroke

Affect only strokes below the cursor (default False)

Type:

bool

use_automasking_material_active

Affect only the Active Material (default False)

Type:

bool

use_automasking_material_stroke

Affect only strokes below the cursor (default False)

Type:

bool

use_automasking_stroke

Affect only strokes below the cursor (default False)

Type:

bool

use_multiframe_falloff

Use falloff effect when edit in multiframe mode to compute brush effect by frame (default False)

Type:

bool

use_scale_thickness

Scale the stroke thickness when transforming strokes (default False)

Type:

bool

use_thickness_curve

Use curve to define primitive stroke thickness (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