ILPolyRegion Interface Reference

This interface expose APIs to create/modify a polygon region object. More...

Inheritance diagram for ILPolyRegion:

Public Member Functions
void	AddCtrl (double x, double y, int ctrlIndex)
int	CtrlCount ()
void	GetCtrl (int ctrlIndex, double *x, double *y)
void	RemoveCtrl (int ctrlIndex)
void	SetCtrl (double x, double y, int ctrlIndex)
void	SetPlacement (LArray< double > xs, LArray< double > ys)
Public Member Functions inherited from ILRegion
ILCompoundRegion *	Add (ILRegion *other)
void	Drag (LPVRoiHandle roiHandle, int x, int y, double zoomX, double zoomY, double panX, double panY)
void	Draw (HDC hdc, BOOL drawHandles, double zoomX, double zoomY, double panX, double panY)
void	EnableHandle (LPVRoiHandle roiHandle, BOOL enabled)
LPVRoiHandle	HitTest (int x, int y, double zoomX, double zoomY, double panX, double panY)
ILCompoundRegion *	Intersect (ILRegion *other)
ILCompoundRegion *	Invert ()
void	MapFromImage (double imagePointX, double imagePointY, double *regionPointX, double *regionPointY)
ILObject *	MapObjectFromImage (ILObject *imageObject)
ILObject *	MapObjectToImage (ILObject *regionObject)
void	MapToImage (double regionPointX, double regionPointY, double *imagePointX, double *imagePointY)
void	ReduceImage (ILImage *image, ILImage **newImage, ILImage **newMask)
ILRegion *	Rotate (double da)
ILRegion *	RotateAndTranslate (double x, double y, double newX, double newY, double da)
ILRegion *	Scale (double factorX, double factorY)
ILCompoundRegion *	Subtract (ILRegion *other)
ILImage *	ToMask (int w, int h)
ILRegion *	Translate (double offsetX, double offsetY)
ILCompoundRegion *	Union (ILRegion *other)
ILCompoundRegion *	XOR (ILRegion *other)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Additional Inherited Members
Properties inherited from ILRegion
LPVInterpolationMethod	InterpolationMethod [get, set]
	The interpolation method used in image reduction.
double	ReduceAngle [get, set]
	The angle of the reduced result. By default, it's 0. A non-zero value means we'll rotated the reduced result image by the angle clockwise. More...
double	ReduceScale [get, set]
	The scale of the reduced result. By default, it's 1. Change this value to scale the reduced result image. More...

Detailed Description

This interface expose APIs to create/modify a polygon region object.

To use this interface, you should create a LPolyRegion object.

Example Code

C++

ILPolyRegionPtr polyRoi = LPolyRegion::Create();
polyRoi->SetPlacement(20, 20, 100);

C#

LPolyRegion polyRoi = new LPolyRegion();
polyRoi.SetPlacement(20, 20, 100);

COM

ILPolyRegionPtr polyRoi = LPolyRegion::Create();
// or, ILPolyRegionPtr polyRoi(__uuidof(LPolyRegion)), for absence of built-in Create functions (before 2.2.0)
polyRoi->SetPlacement(20, 20, 100);

Member Function Documentation

AddCtrl()

void AddCtrl	(	double	x,
		double	y,
		int	ctrlIndex
	)

Add a control vertexes to the polygon region at provided position

Parameters

[in]	x	The x-coordinate of the new control vertex
[in]	y	The y-coordinate of the new control vertex
[in]	ctrlIndex	The index of the new control vertex, default to -1 means add at the end.

CtrlCount()

int CtrlCount

(

)

Get the count of control vertexes of the polygon region

GetCtrl()

void GetCtrl	(	int	ctrlIndex,
		double *	x,
		double *	y
	)

Get position of the polygon region's control vertexes with given index

Parameters

[in]	ctrlIndex	The index of the control vertex
[out]	x	Return the x-coordinate of the control vertex
[out]	y	Return the y-coordinate of the control vertex

RemoveCtrl()

void RemoveCtrl

(

int

ctrlIndex

)

Remove one of the polygon region's control vertexes with given index

Parameters

[in]

ctrlIndex

The index of the control vertex

SetCtrl()

void SetCtrl	(	double	x,
		double	y,
		int	ctrlIndex
	)

Modify a control vertexes of the polygon region to provided position

Parameters

[in]	x	The x-coordinate of the new position
[in]	y	The y-coordinate of the new position
[in]	ctrlIndex	The index of the new control vertex, default to -1 means add at the end.

SetPlacement()

void SetPlacement	(	LArray< double >	xs,
		LArray< double >	ys
	)

Modify the polygon region's placement by given vertexes.

Parameters

[in]	xs	The collection of x-coordinate of the vertexes.
[in]	ys	The collection of y-coordinate of the vertexes.