Scripting API

<<WarpingBrush Main Index Wave>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

WatercolorBrushTool

Script Name: WatercolorBrushTool
Name: WatercolorBrushTool
Library: ToolArt
Description: Apply watercolor to the target.
Status bar text: Watercolor Brush: Use to apply watercolor strokes.
Tool tip text: Watercolor Brush
Undo text: Watercolor Brush
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
SizeSizeIntegerThe brush size in pixels, 3..200No3513000
ShapeShapeEnumeration (ArtMediaBrushShape)The brush shape, circular or rectangularNoElliptical
ThicknessThicknessIntegerBrush thickness or aspect ration, 0..100%.No1001100
RotationRotationIntegerThe brush rotation angle when pathing is set to fixed.No00359
HeadTrackingHeadTrackingEnumeration (ArtMediaBrushRotation)How the brush head tracks the path, fixed angle or rotate along stroke path.NoRotateAlongPath
MouseButtonButtonEnumeration (MouseButton)The mouse button used for the stroke, primary or secondary.NoPrimary
MaterialMaterialParameter RepositoryThe stroke material. May be the captured foreground or background depending upon other parameters.Yes
TraceTraceEnumeration (Boolean)When true, the tool ignores the specified material and samples material from the image on the first impression of the stroke. When false, the specified material is used.NoFalse
TabletStrokeTabletStrokeEnumeration (Boolean)When true, indicates stroke recorded from tablet. False indicates source was mouse.NoTrue
HeadLoadHeadLoadIntegerPercentage of media head is loaded with at start of stroke.No1000100
ViscosityViscosityIntegerRate at which media is applied, and, thus, duration of stroke before media runs out.No501100
BristleFirmnessBristleFirmnessIntegerAmount of splay in the brush bristles. This value controls how the stroke widens based upon pressure and how the stroke penetrates the surface.No501100
BristleSizeBristleSizeIntegerThe brush bristle size. This value adjusts how the media is applied to the surface.No501100
HeadCleaningMethodHeadCleaningMethodEnumeration (ArtMediaBrushCleaning)Controls whether the brush head is automatically cleaned of paint after a stroke or user will manually clean the brush.NoAutomaticClean
StrokeStrokeListThe path of the brush stroke.No0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
Has Random Seed: true
DisallowNullMaterial: true
UsesCachedMaterials: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes:
DlgHasPresets: true
DlgHasRandomize: true