Parameters
| Name | Explanation |
|---|---|
| x | An array of x coordinate values defining points of a polygonal area on the image. (in pixels) * (see Note below) |
| y | An array of y coordinate values defining points of a polygonal area on the image. (in pixels) * (see Note below) |
| Mode | Sets the type of blur (0: Linear, 1: Radial, 2: Zoom) |
| Length | Sets the length of the blur (from 0 to 255) |
| Angle | Sets the angle of the blur (in degrees from 0 to 360) |
| * NOTE for retrieving array values: In Visual Basic / VB.NET, if the array is defined as Dim x(0 To 2), then the arguments are returned in x. In C#.NET the arguments are returned in ref x. |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The MotionBlurVariant method creates a motion blur effect on a raster image.
This method is recommended when using scripting or other languages that require variant types or when using 64 bit builds in VB.NET or C#.
The Mode parameter determines the type of motion blur:
Mode=0 (Linear blur)
This motion blur simulates the image shifting. The Length parameter
sets the magnitude of the shift. The Angle parameter determines the
direction of the shift. The major directions of the Angle parameter
are as follows: Angle= 0 -> a shift to the left; Angle= 90
-> a shift down; Angle= 180 -> ashift to the right; Angle=
270-> a shift up.
Mode=1 (Radial blur)
This motion blur simulates the image spinning by the number of
degrees set in the Angle parameter. The Length parameter is
ineffective.
Mode=2 (Zoom blur)
This motion blur simulates the image zooming in by the length set
in the Length parameter. The Angle parameter is ineffective.
To execute the MotionBlurVariant method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The MotionBlurVariant method supports 8 bit grayscale, 16, 24, and 32 bit images.
Before executing the MotionBlurVariant 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 MotionBlurVariant 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.
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.
Also see the MotionBlur method.