This method allows you to define an area on a raster image and create a new image and mask image from that area.

[C++Builder]   [ bool = ]imagekitcontrolname->Effect->SelectImage(const TPoint * Points, const int Points_Size, short Red, short Green, short Blue)
[C++Builder]   [ bool = ]imagekitcontrolname->Effect->SelectImage(short Red, short Green, short Blue)
[Delphi]   [ Boolean = ]imagekitcontrolname.Effect.SelectImage(const Points: array of TPoint; Red, Green, Blue: Smallint)
[Delphi]   [ Boolean = ]imagekitcontrolname.Effect.SelectImage(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
Red The red component of the color painted outside the area selected. (from 0 to255)
Green The green component of the color painted outside the area selected. (from 0 to255)
Blue The blue component of the color painted outside the area selected. (from 0 to255)

Return Value

Returns True if successful, otherwise returns False.

Explanation

The SelectImage method allows you to select an area on a raster image and create a new image and mask image from this selected area.

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

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

  1. To use a mask image, set the SelectMode property to vikEffectMask. Set the mask image handle in the MaskImageHandle property
  2. To process the total image, set the SelectMode property to vikEffectAll.
  3. 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.
  4. 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. The color defined by the Red, Green, and Blue parameters wil be painted in the resulting image in the area that is outside the selected area. The resulting mask image will be a black and white, 1 bit color image where the selected area is white and the area outside of the select area is black.

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.

Note: To select a portion of an image, without creating a mask image, please use the CutRectImage method. This method is much faster than the SelectImage method.

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.

The ImageKit10 VCL is a product created by Newtone Corporation