Brush Operators

bpy.ops.brush.active_index_set(mode="", index=0)

Set active sculpt/paint brush from it’s number

Parameters:

• mode (string, (optional)) – mode, Paint mode to set brush for
• index (int in [-inf, inf], (optional)) – number, Brush number

File :

startup/bl_operators/wm.py:164

bpy.ops.brush.add()

Add brush by mode type

bpy.ops.brush.curve_preset(shape='SMOOTH')

Set brush shape

Parameters:shape (enum in [‘SHARP’, ‘SMOOTH’, ‘MAX’, ‘LINE’, ‘ROUND’, ‘ROOT’], (optional)) – Mode

bpy.ops.brush.image_tool_set(tool='DRAW')

Set the image tool

Parameters:tool (enum in [‘DRAW’, ‘SOFTEN’, ‘SMEAR’, ‘CLONE’], (optional)) – Tool

bpy.ops.brush.reset()

Return brush to defaults based on current tool

bpy.ops.brush.scale_size(scalar=1.0)

Change brush size by a scalar

Parameters:scalar (float in [0, 2], (optional)) – Scalar, Factor to scale brush size by

bpy.ops.brush.sculpt_tool_set(tool='BLOB')

Set the sculpt tool

Parameters:tool (enum in [‘BLOB’, ‘CLAY’, ‘CREASE’, ‘DRAW’, ‘FILL’, ‘FLATTEN’, ‘GRAB’, ‘INFLATE’, ‘LAYER’, ‘NUDGE’, ‘PINCH’, ‘ROTATE’, ‘SCRAPE’, ‘SMOOTH’, ‘SNAKE_HOOK’, ‘THUMB’], (optional)) – Tool

bpy.ops.brush.uv_sculpt_tool_set(tool='PINCH')

Set the uv sculpt tool

Parameters:tool (enum in [‘PINCH’, ‘RELAX’, ‘GRAB’], (optional)) –

Tool

• PINCH Pinch, Pinch UVs.
• RELAX Relax, Relax UVs.
• GRAB Grab, Grab UVs.

bpy.ops.brush.vertex_tool_set(tool='MIX')

Set the vertex paint tool

Parameters:tool (enum in [‘MIX’, ‘ADD’, ‘SUB’, ‘MUL’, ‘BLUR’, ‘LIGHTEN’, ‘DARKEN’], (optional)) –

Tool

• MIX Mix, Use mix blending mode while painting.
• ADD Add, Use add blending mode while painting.
• SUB Subtract, Use subtract blending mode while painting.
• MUL Multiply, Use multiply blending mode while painting.
• BLUR Blur, Blur the color with surrounding values.
• LIGHTEN Lighten, Use lighten blending mode while painting.
• DARKEN Darken, Use darken blending mode while painting.

bpy.ops.brush.weight_tool_set(tool='MIX')

Set the weight paint tool

Parameters:tool (enum in [‘MIX’, ‘ADD’, ‘SUB’, ‘MUL’, ‘BLUR’, ‘LIGHTEN’, ‘DARKEN’], (optional)) –

Tool

• MIX Mix, Use mix blending mode while painting.
• ADD Add, Use add blending mode while painting.
• SUB Subtract, Use subtract blending mode while painting.
• MUL Multiply, Use multiply blending mode while painting.
• BLUR Blur, Blur the color with surrounding values.
• LIGHTEN Lighten, Use lighten blending mode while painting.
• DARKEN Darken, Use darken blending mode while painting.