Package bpy :: Module types :: Class Brush
[hide private]
[frames] | no frames]

Class Brush


The Brush Object

Brush datablock for storing brush settings for painting and sculpting.

References

Instance Methods [hide private]
 
animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)
AnimData
animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)
ID
copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)
Instance Variables [hide private]
Texture active_texture
Active texture slot being displayed.
int in [0, 17] active_texture_index
Index of active texture slot.
enum blend
Brush blending mode.
Image clone_image
Image for clone tool.
float array of 2 items in [-inf, inf] clone_offset
Clone Offset
float in [0, 1] clone_opacity
Opacity of clone image display.
float array of 3 items in [-inf, inf] color
Color
CurveMapping (readonly) curve
Editable falloff curve.
enum direction
Mapping type to use for this image in the game engine.
boolean fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)
float in [0, 1] jitter
Jitter the position of the brush while painting.
Library (readonly) library
Library file the datablock is linked from. (Inherited from bpy.types.ID)
string name
Unique datablock ID name. (Inherited from bpy.types.ID)
float in [0.01, 1] rate
Number of paints per second for Airbrush.
enum sculpt_tool
Sculpt Tool in...
int in [1, 200] size
Diameter of the brush.
float in [0.5, 0.99] smooth_stroke_factor
Higher values give a smoother stroke.
int in [10, 200] smooth_stroke_radius
Minimum distance from last point before stroke continues.
float in [1, 100] spacing
Spacing between brush stamps.
float in [0, 1] strength
The amount of pressure on the brush.
boolean tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)
Collection of BrushTextureSlot (readonly) textures
Texture slots defining the mapping and influence of textures.
boolean use_airbrush
Keep applying paint effect while holding mouse (spray).
boolean use_anchor
Keep the brush anchored to the initial location.
boolean use_jitter_pressure
Enable tablet pressure sensitivity for jitter.
boolean use_persistent
Sculpts on a persistent layer of the mesh.
boolean use_rake
Rotate the brush texture to match the stroke direction.
boolean use_size_pressure
Enable tablet pressure sensitivity for size.
boolean use_smooth_stroke
Brush lags behind mouse and follows a smoother path.
boolean use_space
Limit brush application to the distance specified by spacing.
boolean use_spacing_pressure
Enable tablet pressure sensitivity for spacing.
boolean use_strength_pressure
Enable tablet pressure sensitivity for strength.
boolean use_wrap
Enable torus wrapping while painting.
int (readonly) in [0, 32767] users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)
Instance Variable Details [hide private]

blend

Brush blending mode. in...
  • MIX
  • ADD
  • SUB
  • MUL
  • LIGHTEN
  • DARKEN
  • ERASE_ALPHA
  • ADD_ALPHA
Type:
enum

direction

Mapping type to use for this image in the game engine. in...
  • ADD
  • SUBTRACT
Type:
enum

sculpt_tool

Sculpt Tool in...
  • DRAW
  • SMOOTH
  • PINCH
  • INFLATE
  • GRAB
  • LAYER
  • FLATTEN
  • CLAY
Type:
enum