Scripting API

<<ReturnVectorObjectProperties

Ripple

Script Name:		Ripple
Name:		Ripple
Library:		CmdGeometry
Description:		Applies a ripple effect to the image or selection.
Status bar text:		Apply ripple effect to image
Tool tip text:		Ripple
Undo text:		Ripple

Parameter Repository:

Name	Script Name	Type	Description	Supports None	Default	Minimum	Maximum
Amplitude	Amplitude	Real	Amplitude of the ripples as a percentage	No	10.0	1.0	100.0
Horizontal Center	HorizontalCenter	Real	Horizontal center of the effect as a percentage	No	50.0	0.0	100.0
Vertical Center	VerticalCenter	Real	The vertical center of the effect as a percentage	No	50.0	0.0	100.0
Wavelength	Wavelength	Real	Wavelength of the ripples as a percentage	No	40.0	1.0	100.0
Edge Mode	EdgeMode	Enumeration (EdgeMode)	Determines how the areas outside of the effect will be filled in	No	Background
Background Color	BackgroundColor	Color	Color that will be used to fill in outside of the effect if the edge mode is Background	No	Red 0 Blue 0 Green 0	Red 0 Blue 0 Green 0	Red 255 Blue 255 Green 255
General Settings	GeneralSettings	Parameter Repository	Contains parameters that control the execution of the command.	No

Command Attributes:
IsExternal:	true
IsUndoable:	true
ProcessChanges:	true
FinalizeTransient:	true
ShowInEffectsBrowser:	true
This command is safe for execution in a processing thread.:	true
This command is safe for execution in a processing thread.:	true

Resource Attributes:
HasWinPlacement:	true
IsPreviewable:	true
IsProofable:	true
HelpID:	32914
DlgHasPresets:	true
DlgHasRandomize:	true
IsEditable:	true