Methods

Functions
long	Execute ()
	Execute method which executes the filter.
long	GetFilterArea (double *x0, double *y0, double *x1, double *y1, double *x2, double *y2)
	This function returns the coordinates of the filter area.
long	LoadFilter (BSTR Filename)
	This function loads a filter file with the specified filename.
long	LoadFilterByDialog ()
	This function show a common file dialogue box to let you enter or browse the filename of the FLT file.
long	SetFilterArea (double x0, double y0, double x1, double y1, double x2, double y2)
	This function sets a filter area all in one.

Detailed Description

Function Documentation

long Execute

(

)

Execute method which executes the filter.

Returns

In case of an error this method returns zero. On success it returns something else than zero.

Supported platforms:

Win32

long GetFilterArea	(	double *	x0,
		double *	y0,
		double *	x1,
		double *	y1,
		double *	x2,
		double *	y2
	)

This function returns the coordinates of the filter area.

Attention

As alternative, this values can be read separately using the properties X0, X1, X2, Y0, Y1, and Y2.

Parameters

[out]	x0	X-coordinate of point 0.
[out]	y0	Y-coordinate of point 0.
[out]	x1	X-coordinate of point 1.
[out]	y1	Y-coordinate of point 1.
[out]	x2	X-coordinate of point 2.
[out]	y2	Y-coordinate of point 2.

Returns

0 on success.

Supported platforms:

Win32

long LoadFilter

(

BSTR

Filename

)

This function loads a filter file with the specified filename.

Parameters

[in]

Filename

Filename of the filter file to be loaded.

Returns

In case of an error this method returns zero. On success it returns something else than zero.

Supported platforms:

Win32

long LoadFilterByDialog

(

)

This function show a common file dialogue box to let you enter or browse the filename of the FLT file.

After pressing OK the file gets loaded.

Returns

In case of an error this method returns zero. On success it returns something else than zero.

Supported platforms:

Win32

long SetFilterArea	(	double	x0,
		double	y0,
		double	x1,
		double	y1,
		double	x2,
		double	y2
	)

This function sets a filter area all in one.

Attention

As alternative, this values can be set separately using the properties X0, X1, X2, Y0, Y1, and Y2.

Parameters

[in]	x0	X-coordinate of point 0.
[in]	y0	Y-coordinate of point 0.
[in]	x1	X-coordinate of point 1.
[in]	y1	Y-coordinate of point 1.
[in]	x2	X-coordinate of point 2.
[in]	y2	Y-coordinate of point 2.

Returns

0 on success.

Supported platforms:

Win32