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 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) |
| * 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 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.
- 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 SelectImage 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. The resulting mask image is set in the MaskImageHandle 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.
For scripting languages and other programs that require variant
types, please refer to the SelectImageVariant method.