DynamicPaintBrushSettings(bpy_struct)

base class — bpy_struct

class bpy.types.DynamicPaintBrushSettings(bpy_struct)

Brush settings

invert_proximity

Proximity falloff is applied inside the volume (default False)

Type:

bool

paint_alpha

Paint alpha (in [0, 1], default 0.0)

Type:

float

paint_color

Color of the paint (array of 3 items, in [0, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

paint_distance

Maximum distance from brush to mesh surface to affect paint (in [0, 500], default 0.0)

Type:

float

paint_ramp

Color ramp used to define proximity falloff (readonly)

Type:

ColorRamp

paint_source

(default 'VOLUME')

Type:

Literal[‘PARTICLE_SYSTEM’, ‘POINT’, ‘DISTANCE’, ‘VOLUME_DISTANCE’, ‘VOLUME’]

paint_wetness

Paint wetness, visible in wetmap (some effects only affect wet paint) (in [0, 1], default 0.0)

Type:

float

particle_system

The particle system to paint with

Type:

ParticleSystem

proximity_falloff

Proximity falloff type (default 'CONSTANT')

Type:

Literal[‘SMOOTH’, ‘CONSTANT’, ‘RAMP’]

ray_direction

Ray direction to use for projection (if brush object is located in that direction it’s painted) (default 'CANVAS')

Type:

Literal[‘CANVAS’, ‘BRUSH’, ‘Z_AXIS’]

smooth_radius

Smooth falloff added after solid radius (in [0, 10], default 0.0)

Type:

float

smudge_strength

Smudge effect strength (in [0, 1], default 0.0)

Type:

float

solid_radius

Radius that will be painted solid (in [0.01, 10], default 0.0)

Type:

float

use_absolute_alpha

Only increase alpha value if paint alpha is higher than existing (default False)

Type:

bool

use_negative_volume

Negate influence inside the volume (default False)

Type:

bool

use_paint_erase

Erase / remove paint instead of adding it (default False)

Type:

bool

use_particle_radius

Use radius from particle settings (default False)

Type:

bool

use_proximity_project

Brush is projected to canvas from defined direction within brush proximity (default False)

Type:

bool

use_proximity_ramp_alpha

Only read color ramp alpha (default False)

Type:

bool

use_smudge

Make this brush to smudge existing paint as it moves (default False)

Type:

bool

use_velocity_alpha

Multiply brush influence by velocity color ramp alpha (default False)

Type:

bool

use_velocity_color

Replace brush color by velocity color ramp (default False)

Type:

bool

use_velocity_depth

Multiply brush intersection depth (displace, waves) by velocity ramp alpha (default False)

Type:

bool

velocity_max

Velocity considered as maximum influence (Blender units per frame) (in [0.0001, 10], default 0.0)

Type:

float

velocity_ramp

Color ramp used to define brush velocity effect (readonly)

Type:

ColorRamp

wave_clamp

Maximum level of surface intersection used to influence waves (use 0.0 to disable) (in [0, 50], default 0.0)

Type:

float

wave_factor

Multiplier for wave influence of this brush (in [-2, 2], default 0.0)

Type:

float

wave_type

(default 'DEPTH')

Type:

Literal[‘CHANGE’, ‘DEPTH’, ‘FORCE’, ‘REFLECT’]

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