This method creates a lens like effect on a raster image.

[C++Builder]   [ bool = ]imagekitcontrolname->Effect->Lens(const TPoint * Points, const int Points_Size, double Refract, bool BackColor, short Red, short Green, short Blue)
[C++Builder]   [ bool = ]imagekitcontrolname->Effect->Lens(double Refract, bool BackColor, short Red, short Green, short Blue)
[Delphi]   [ Boolean = ]imagekitcontrolname.Effect.Lens(const Points: array of TPoint; Refract: Double; BackColor: Boolean; Red, Green, Blue: Smallint)
[Delphi]   [ Boolean = ]imagekitcontrolname.Effect.Lens(Refract: Double; BackColor: Boolean; 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
Refract Sets the lens magnification (Greater than 1)
BackColor Sets whether or not the area outside of the lens effect is painted a particular color [True: the area is painted False: the area is not painted.]
Red Sets the red component of the color painted in the area outside the lens (from 0 to 255)
Green Sets the green component of the color painted in the area outside the lens (from 0 to 255)
Blue Sets the blue component of the color painted in the area outside the lens (from 0 to255)

Return Value

Returns True if successful, otherwise returns False.

Explanation

The Lens method produces a lens like effect on a raster image. To execute the Lens method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The Lens method supports 8-bit grayscale, 16, 24, and 32 bit images.

Before executing the Lens 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.

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.

The ImageKit10 VCL is a product created by Newtone Corporation