Scripting API

<<Warp Main Index WatercolorBrushTool>>
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

WarpingBrush

Script Name: WarpingBrush
Name: WarpingBrush
Library: ToolWarp
Description: Applies warping effects with a brush.
Status bar text: Warp Brush: Use to warp areas of an image
Tool tip text: Warp Brush
Undo text: Warp Brush
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Load deformation mapLoadDeformationMapEnumeration (Boolean)Loads currently selected deformation mapNoFalse
Save deformation mapSaveDeformationMapEnumeration (Boolean)Saves current deformation mapNoFalse
Change qualityQualityChangeEnumeration (Boolean)Changes warp drawing qualityNoFalse
Change backgroundBackgroundChangeEnumeration (Boolean)Redraw warping with new background colorNoFalse
Change edge modeEdgeChangeEnumeration (Boolean)Redraw warping with a new edge modeNoFalse
Final applyFinalApplyEnumeration (Boolean)Applies warping brush with the maximum qualityNoFalse
Warping Brush ModesModeEnumeration (WarpingBrushMode)Describes one of eight Warping Brush modesNoPush
Parameters Locked.ParametersLockedEnumeration (Boolean)Shares parameters between modesNoFalse
Lock Mode.LockModeEnumeration (WarpingBrushMode)Sets brush parameters lockedNoPush
Push Mode SizePushSizeIntegerSets push brush radiusNo3241000
Push Mode HardnessPushHardnessPercentSets push warping brush hardnessNo0
Push Mode StrengthPushStrengthIntegerSets push warp strengthNo1001100
Expand Mode SizeExpandSizeIntegerSets expand brush radiusNo3241000
Expand Mode HardnessExpandHardnessPercentSets brush hardnessNo0
Expand Mode StrengthExpandStrengthIntegerSet warp strengthNo1001100
Expand Mode StepExpandStepIntegerSets expand stroke stepNo251100
Contract Mode SizeContractSizeIntegerSets contract warp brush radiusNo3241000
Contract Mode HardnessContractHardnessPercentSets contract brush hardnessNo0
Contract Mode StrengthContractStrengthIntegerSets contract warp strengthNo1001100
Contract Mode StepContractStepIntegerSets right twirl stroke stepNo251100
RightTwirl Mode SizeRightTwirlSizeIntegerSets right twirl brush radiusNo3241000
RightTwirl Mode HardnessRightTwirlHardnessPercentSets right twirl brush hardnessNo0
RightTwirl Mode StrengthRightTwirlStrengthIntegerSets warp strengthNo1001100
RightTwirl Mode StepRightTwirlStepIntegerSets right twirl stroke stepNo251100
LeftTwirl Mode SizeLeftTwirlSizeIntegerSets left twirl brush radiusNo3241000
LeftTwirl Mode HardnessLeftTwirlHardnessPercentSets left twirl brush hardnessNo0
LeftTwirl Mode StrengthLeftTwirlStrengthIntegerSets left twirl warp strengthNo1001100
LeftTwirl Mode StepLeftTwirlStepIntegerSets left twirl stroke stepNo251100
Noise Mode SizeNoiseSizeIntegerSets noise brush radiusNo3241000
Noise Mode HardnessNoiseHardnessPercentSets noise warp brush hardnessNo0
Noise Mode StrengthNoiseStrengthIntegerSets warp strength for noise modeNo1001100
Noise Mode StepNoiseStepIntegerSets noise stroke stepNo251100
Noise Mode NoiseNoiseNoisePercentSets noise parameterNo1
IronOut Mode SizeIronOutSizeIntegerSet ironout brush radiusNo3241000
IronOut Mode HardnessIronOutHardnessPercentSets ironout brush hardnessNo0
IronOut Mode StrengthIronOutStrengthIntegerSets ironout warp strengthNo1001100
Unwarp Mode SizeUnwarpSizeIntegerSets unwarp brush radiusNo3241000
Unwarp Mode HardnessUnwarpHardnessPercentSets unwarp brush hardness.No0
Unwarp Mode StrengthUnwarpStrengthIntegerSets unwarp warp strengthNo1001100
Unwarp Mode StepUnwarpStepIntegerSets unwarp stroke stepNo251100
Noise Seed.NoiseSeedIntegerWarping seed for a Noise modeNo1099999
Erase modeEraseModeEnumeration (Boolean)Sets warping brush into erase mode. Accessed from right mouse buttonNoFalse
Reverse modeReverseModeEnumeration (Boolean)Sets warping brush into reverse mode. The same as you warp with ALT key down.NoFalse
Edge ModeEdgeModeEnumeration (WarpingBrushEdgeMode)Sets warping edge modeNoBackground
Deformation map categoryLoadDeformationMapCategoryStringSpecifies deformation map categoryYes
Deformation map pathLoadDeformationMapPathStringSets deformation map pathYes
Deformation map pathSaveDeformationMapPathStringSets deformation map pathYes
Replace current deformationLoadAndReplaceCurrentEnumeration (Boolean)Replaces current deformation map on loadNoFalse
MappingModeMapingModeIntegerSets warping mapping modeNo006
Draft master qualityDraftMasterQualityEnumeration (WarpingBrushDraftQuality)Sets draft mode master deformation map qualityNoMedium
Draft Drawing QualityDraftDrawingQualityEnumeration (WarpingBrushDraftQuality)Sets draft mode drawing deformation map qualityNoMedium
Final Apply QualityFinalApplyQualityEnumeration (WarpingBrushFinalApplyQuality)Final apply mode deformation map qualityNoUse
PathPathListSets path of the brush strokeNo0
Fill materialFillParameter RepositorySets background material for the warping brushYes
Stroke material StrokeParameter RepositorySets foreground material for the warping brushYes
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes:
DlgHasPresets: true