GPencilSculptSettings(bpy_struct)

base class — bpy_struct

class bpy.types.GPencilSculptSettings(bpy_struct)

Properties for Grease Pencil stroke sculpting tool

affect_position

The brush affects the position of the point

Type:boolean, default False
affect_strength

The brush affects the color strength of the point

Type:boolean, default False
affect_thickness

The brush affects the thickness of the point

Type:boolean, default False
brush
Type:GPencilSculptBrush, (readonly)
lockaxis
  • GP_LOCKAXIS_NONE None.
  • GP_LOCKAXIS_X X, Project strokes to plane locked to X.
  • GP_LOCKAXIS_Y Y, Project strokes to plane locked to Y.
  • GP_LOCKAXIS_Z Z, Project strokes to plane locked to Z.
Type:enum in [‘GP_LOCKAXIS_NONE’, ‘GP_LOCKAXIS_X’, ‘GP_LOCKAXIS_Y’, ‘GP_LOCKAXIS_Z’], default ‘GP_LOCKAXIS_NONE’
selection_alpha

Alpha value for selected vertices

Type:float in [0, 1], default 0.0
tool
  • SMOOTH Smooth, Smooth stroke points.
  • THICKNESS Thickness, Adjust thickness of strokes.
  • STRENGTH Strength, Adjust color strength of 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.
  • RANDOMIZE Randomize, Introduce jitter/randomness into strokes.
  • CLONE Clone, Paste copies of the strokes stored on the clipboard.
Type:enum in [‘SMOOTH’, ‘THICKNESS’, ‘STRENGTH’, ‘GRAB’, ‘PUSH’, ‘TWIST’, ‘PINCH’, ‘RANDOMIZE’, ‘CLONE’], default ‘SMOOTH’
use_select_mask

Only sculpt selected stroke points

Type:boolean, default False

Inherited Properties

Inherited Functions

References