Scripting API

<<CountImageColors Main Index CreateEllipseObject>>
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

CrayonTool

Script Name: CrayonTool
Name: CrayonTool
Library: ToolArt
Description: Apply crayon to the image.
Status bar text: Crayon Tool: Use to apply crayon strokes
Tool tip text: Crayon Tool
Undo text: Crayon
 
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
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