Parameters
| Name | Explanation |
|---|---|
| x | An array of x coordinate values defining points of a polygonal area on the image. (in pixels) * |
| y | An array of y coordinate values defining points of a polygonal area on the image. (in pixels) * |
| Points | The number of points defining the polygonal area on the image. |
| Red | The red component of the color to be unified (from 0 to 255) |
| Green | The green component of the color to be unified (from 0 to 255) |
| Blue | The blue component of the color to be unified (from 0 to 255) |
| Error | Sets the range of RGB values that will be unified (from 0 to 255) |
| * In Visual C++, pass the pointer to the first
element in the x and y arrays. In Visual Basic, the arguments are returned in the first elements of the arrays x(0) and Y(0). |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The UnifyColor method allows you to unify a range of
colors in a raster image. This is very useful when using
transparancy. The Red, Green, and Blue parameters define the
unified color. The Error parameter sets the range of
colors that will be unified into the single color. So, for
example, if you set the Red, Green and Blue parameter each to 128
and the Error parameter to 10, all colors ranging from
RGB(118,118,118) to RGB(138,138,138) will be changed to
RGB(128,128,128).
To execute the UnifyColor method, set the image handle of
the image in the ImageHandle property or the
Layer(LayerNo).ImageHandle
property. The UnifyColor method supports 8 bit grayscale,
16, 24, and 32 bit images.
Before executing the UnifyColor 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 UnifyColor 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.
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, please refer to the UnifyColorVariant method.