Scripting API

<<PageCurl Main Index PaletteKnifeTool>>
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

PaintBrush

Script Name: PaintBrush
Name: PaintBrush
Library: ToolPaint
Description: Apply paint to the target through a brush.
Status bar text: Paint Brush: Use to paint strokes on a raster layer
Tool tip text: Paint Brush
Undo text: Paint Brush
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Brush TipBrushTipParameter RepositoryBrush tip parametersNo
BrushBrushParameter RepositoryBrush settings.No
Primary MaterialPrimaryMaterialEnumeration (MaterialRef)The primary material for the tool action, foreground or background.NoForeground
Foreground MaterialForegroundMaterialParameter RepositoryThe foreground material.Yes
Background MaterialBackgroundMaterialParameter RepositoryThe background material.Yes
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