Ripple (ImageKit Control/ Effect Method)

This method produces a ripple like effect on a raster image.

[C++Builder] [ bool = ]imagekitcontrolname->Effect->Ripple(const TPoint * Points, const int Points_Size, double Amp, double Wavelen, double Phase, bool BackColor, bool Reflect, short Red, short Green, short Blue)

[C++Builder] [ bool = ]imagekitcontrolname->Effect->Ripple(double Amp, double Wavelen, double Phase, bool BackColor, bool Reflect, short Red, short Green, short Blue)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.Ripple(const Points: array of TPoint; Amp, Wavelen, Phase: Double; BackColor, Reflect: Boolean; Red, Green, Blue: Smallint)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.Ripple(Amp, Wavelen, Phase: Double; BackColor, Reflect: Boolean; Red, Green, Blue: Smallint)

Parameters

Name	Explanation
Points	An array of x and y coordinate values defining points of a polygonal area on the image. (in pixels) In C++Builder, the size of the Points array is given by Points_Size - 1
Amp	Sets the amplitude or height of the ripples. As this value increases the ripples become higher
Wavelen	Sets the wavelength or distance from the crest of one wave to the crest of the next wave. As this value increases there are few ripples produced
Phase	Sets the phase or shift in the wave cycle
BackColor	Sets whether empty spaces are filled with color from adjacent pixels or from the color set as a background color [False: spaces filled with background color, True: spaces filled with the color of the adjacent pixels]
Reflect	Causes a reflective effect from one ripple to the next. (Best used with small amplitudes) [False:No reflection, True: reflection]
Red	The red component of the background color (from 0 to 255)
Green	The green component of the background color (from 0 to 255)
Blue	The blue component of the background color (from 0 to 255)

Return Value

Returns True if successful, otherwise returns False.

Explanation

The Ripple method produces a ripple like effect on a raster image.

To execute the Ripple method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The Ripple method supports 8 bit grayscale, 16, 24, and 32 bit images.

Before executing the Ripple method, you must set the area on the image that will be affected. There are 4 ways to do this.

To use a mask image, set the SelectMode property to vikEffectMask. Set the mask image handle in the MaskImageHandle property
To process the total image, set the SelectMode property to vikEffectAll.
To process the polygonal area on the image, set the SelectMode property to vikEffectPolygon. Select the polygon by setting the appropriate coordinate values for the points of the polygon in the Points array. The number of points defining the polygon must be 3 or more.
To process an elliptical area on the image, set the SelectMode property to vikEffectEllipse. Select the ellipse by setting the appropriate values for the bounding rectangle in the RectLeft, RectTop, RectRight, and RectBottom properties

When the SelectMode property is set to vikEffectPolygon or vikEffectEllipse, the InOut property should be set. When the SelectMode property is set to values other than vikEffectPolygon, please set the Points parameter to a dummy array or to NULL.

When a 1, 4, or 8 bit image is processed, the SelectMode property must be set to process the total image (i.e. SelectMode= 1). If successful the resulting raster image data is set in the LayerNo property (the ImageHandle property or the Layer(LayerNo).ImageHandle property. If unsuccessful, 0 is returned.

When the Caption, Message, and ButtonName properties are blank, the progress dialog box will not be displayed. When the progress dialog box is displayed, the percentage that the processing has completed will be shown in the dialog box.

Differences from the ImageKit 7/8/9/10 ActiveX

The parameters x, y have been changed to type TPoint
In Delphi, it is not necessary to pass the size of the array of x, y points.