Parameters
| Name | Explanation |
|---|---|
| x | An array of x coordinate values defining points of a polygonal area on the image. (in pixels) *(see Note below) |
| y | An array of y coordinate values defining points of a polygonal area on the image. (in pixels) *(see Note below) |
| 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(0): spaces filled with background color,True(nonzero):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(0):No reflection, True(nonzero): 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) |
| * NOTE for retrieving array values: In Visual Basic / VB.NET, if the array is defined as Dim x(0 To 2), then the arguments are returned in x. In C#.NET the arguments are returned in ref x. |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The RippleVariant method produces a ripple like effect on a raster image.
This method is recommended when using scripting or other languages that require variant types or when using 64 bit builds in VB.NET or C#.
To execute the RippleVariant method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The RippleVariant method supports 8 bit grayscale, 16, 24, and 32 bit images.
Before executing the RippleVariant 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 0. Set the mask image handle in the MaskImageHandle property
- To process the total image, set the SelectMode property to 1
- To process the polygonal area on the image, set the SelectMode property to 2. Select the polygon by setting the appropriate coordinate values for the points of the polygon in two arrays, one array for the x coordinate values and one array for the y coordinate values. The pass these arrays to the x and y arguments of the RippleVariant method. 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 3. 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 values other than 2 (ikEffectPolygon), please set dummy arrays in the x and y parameters. The Red, Green and Blue parameters are enabled when the BackColor parameter is FALSE. When the SelectMode property is set to 2 or 3, the appropriate value must be set in the InOut property.
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.
Also see the Ripple method.