ILPoint Interface Reference

This interface represents a single point(LPoint object). More...

Inheritance diagram for ILPoint:

Public Member Functions
double	Collinear (ILPoint *point1, ILPoint *point2)
double	Distance (ILPoint *point)
double	DistanceWithRefLine (ILPoint *point, ILLine *refLine)
double	DotProduct (ILPoint *point)
void	Draw (LPVPointShape shape, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	FromSortable (ILSortable *sortable, LPVPositionMode posMode)
ILPoint *	MidPoint (ILPoint *point)
ILPoint *	Scale (double factorX, double factorY)
void	Set (double x, double y)
ILPoint *	Transform (ILTransform *tf)
ILPoint *	Translate (double offsetX, double offsetY)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Properties
double	X [get, set]
	The x-coordinate of the point.
double	Y [get, set]
	The y-coordinate of the point.

Detailed Description

This interface represents a single point(LPoint object).

Member Function Documentation

Collinear()

double Collinear	(	ILPoint *	point1,
		ILPoint *	point2
	)

Evaluate whether this and the two given points are collinear

Parameters

[in]	point1	The first input point
[in]	point2	The second input point

Return values

Return

the evaluation result, it's a value in (0, 1). For points on a perfect line, it's 1.

Distance()

double Distance

(

ILPoint *

point

)

Calculate the distance between this and the input point

Parameters

[in]

point

The input point

Return values

Return

the distance

DistanceWithRefLine()

double DistanceWithRefLine	(	ILPoint *	point,
		ILLine *	refLine
	)

Calculate the distance between this and the input point in direction of the reference line

Parameters

[in]	point	The input point
[in]	refLine	The input reference line

Return values

Return

the distance

DotProduct()

double DotProduct

(

ILPoint *

point

)

Calculate the dot-product of this and the input point

Parameters

[in]

point

The input point

Return values

Return

the dot-product result

Draw()

void Draw	(	LPVPointShape	shape,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw the point on HDC.

Parameters

[in]

shape

The shape of the point in drawing

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

FromSortable()

void FromSortable	(	ILSortable *	sortable,
		LPVPositionMode	posMode
	)

Set placement of the point from the input sortable object.

Parameters

[in]	sortable	The input sortable object
[in]	posMode	Specify which point is used as the object's position, usually the center.

MidPoint()

ILPoint* MidPoint

(

ILPoint *

point

)

Get the middle point of this and the input point

Parameters

[in]

point

The input point

Return values

Return

the middle point

Scale()

ILPoint* Scale	(	double	factorX,
		double	factorY
	)

Scale the point by the given factor and return a new point

Parameters

[in]	factorX	The scale factor of x-coordinate
[in]	factorY	The scale factor of y-coordinate

Return values

Return

the new point

Set()

void Set	(	double	x,
		double	y
	)

Set placement of the point

Parameters

[in]	x	The x-coordinate of the point
[in]	y	The y-coordinate of the point

Transform()

ILPoint* Transform

(

ILTransform *

tf

)

Transform the point via the given transformation and return a new point

Parameters

[in]

tf

The transformation.

Return values

Return

the new point

Translate()

ILPoint* Translate	(	double	offsetX,
		double	offsetY
	)

Translate the point by the given offset and return a new point

Parameters

[in]	offsetX	The x-coordinate of the offset
[in]	offsetY	The y-coordinate of the offset

Return values

Return

the new point