GPencilSculptSettings(bpy_struct)

base class — bpy_struct

class bpy.types.GPencilSculptSettings(bpy_struct)

Properties for Grease Pencil stroke sculpting tool

brush
Type:GPencilSculptBrush, (readonly)
guide
Type:GPencilSculptGuide, (readonly)
intersection_threshold

Threshold for stroke intersections

Type:float in [0, 10], default 0.1
lock_axis
  • 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:enum in [‘VIEW’, ‘AXIS_Y’, ‘AXIS_X’, ‘AXIS_Z’, ‘CURSOR’], default ‘VIEW’
multiframe_falloff_curve

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

Type:CurveMapping, (readonly)
sculpt_tool
  • SMOOTH Smooth, Smooth stroke points.
  • THICKNESS Thickness, Adjust thickness of strokes.
  • STRENGTH Strength, Adjust color strength of strokes.
  • RANDOMIZE Randomize, Introduce jitter/randomness into strokes.
  • GRAB Grab, Translate the set of points initially within the brush circle.
  • PUSH Push, Move points out of the way, as if combing them.
  • TWIST Twist, Rotate points around the midpoint of the brush.
  • PINCH Pinch, Pull points towards the midpoint of the brush.
  • CLONE Clone, Paste copies of the strokes stored on the clipboard.
Type:enum in [‘SMOOTH’, ‘THICKNESS’, ‘STRENGTH’, ‘RANDOMIZE’, ‘GRAB’, ‘PUSH’, ‘TWIST’, ‘PINCH’, ‘CLONE’], default ‘SMOOTH’
thickness_primitive_curve

Custom curve to control primitive thickness

Type:CurveMapping, (readonly)
use_edit_position

The brush affects the position of the point

Type:boolean, default False
use_edit_strength

The brush affects the color strength of the point

Type:boolean, default False
use_edit_thickness

The brush affects the thickness of the point

Type:boolean, default False
use_edit_uv

The brush affects the UV rotation of the point

Type:boolean, default False
use_multiframe_falloff

Use falloff effect when edit in multiframe mode to compute brush effect by frame

Type:boolean, default False
use_select_mask

Only sculpt selected stroke points

Type:boolean, default False
use_thickness_curve

Use curve to define primitive stroke thickness

Type:boolean, default False
weight_tool

Tool for weight painting

  • WEIGHT Weight, Weight Paint for Vertex Groups.
Type:enum in [‘WEIGHT’], default ‘WEIGHT’
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

Inherited Functions

References