UnifyColor (ImageKit Control/ Effect Method)

This method allows you to convert a range in colors in a raster image into one color. This method is useful when using transparent colors.

[C++Builder] [ bool = ]imagekitcontrolname->Effect->UnifyColor(const TPoint * Points, const int Points_Size, short Red, short Green, short Blue, short Error)

[C++Builder] [ bool = ]imagekitcontrolname->Effect->UnifyColor(short Red, short Green, short Blue, short Error)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.UnifyColor(const Points: array of TPoint; Red, Green, Blue, Error: Smallint)

[Delphi] [ Boolean = ]imagekitcontrolname.Effect.UnifyColor(Red, Green, Blue, Error: 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
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)

Return Value

Returns True if successful, otherwise returns False.

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 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.