This method creates a wave like effect on a raster image.
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) |
| Points | The number of points defining the polygonal area on the image. |
| Direction | Sets the direction of the waves (0: horizontal, 1: vertical) |
| WaveType | Sets the type of wave (0:sin wave, 1: sawtooth) |
| Period | Sets the length of the wave (more than 0) |
| Amp | Sets the size of the wave (more than 0) |
| Phase | Sets the phase or shift in the wave cycle.(from 0.0 to 1.0) |
| Edges | Sets the type of edge(0: background color, 1:adjoining pixel color, 2 wrap around) |
| Red | Sets the red component of the background color (from 0 to 255) |
| Green | Sets the green component of the background color (from 0 to 255) |
| Blue | Sets the blue component of the background color (from 0 to 255) |
| * NOTE for retrieving array values: In Visual Basic, if the array is defined as Dim x(0 To 2) As Long, then the arguments are returned in x(0). In Visual C++, pass the pointer to the first element in the array. In VB.NET, the arguments are returned in x(0). In C#.NET, the arguments are returned in x[0]. |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The Waves method creates a wave like effect on a raster image.
To execute the Waves method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The Waves method supports 8 bit grayscale, 16, 24, and 32 bit images.
Before executing the Waves 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 Waves 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 and set the Points parameter to 0. The Red, Green, and Blue parameters become enabled when the Edges parameter is 0. 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.
For scripting languages and other programs that require variant types, or when using VB.NET or C#.NET in 64 bit builds, please refer to the WavesVariant method.