CPolygonUtils_interface.h File Reference

Interface for CPolygonUtils wrapper. More...

Go to the source code of this file.

Functions
IDRS_BOOL	CPolygonUtils_ContainsPoint (const CPolygon argPolygon, const IDRS_POINT *stPoint, idrs_exception *pargException)
	ContainsPoint tests if a polygon contains the given point or not.
IDRS_BOOL	CPolygonUtils_IsRectangle (const CPolygon argPolygon, idrs_exception *pargException)
	IsRectangle tests if a polygon is a rectangle or not.
IDRS_BOOL	CPolygonUtils_IntersectsRectangle (const CPolygon argPolygon, const IDRS_RECT *argRectangle, idrs_exception *pargException)
	IntersectsRectangle tests if a polygon intersects the given rectangle or not.
IDRS_BOOL	CPolygonUtils_IntersectsPolygon (const CPolygon argPolygon1, const CPolygon argPolygon2, idrs_exception *pargException)
	IntersectsPolygon tests if there's an intersection between the two given polygons.

Detailed Description

Interface for CPolygonUtils wrapper.

Function Documentation

CPolygonUtils_ContainsPoint()

IDRS_BOOL CPolygonUtils_ContainsPoint	(	const CPolygon	argPolygon,
		const IDRS_POINT *	stPoint,
		idrs_exception *	pargException
	)

ContainsPoint tests if a polygon contains the given point or not.

Parameters

argPolygon	The polygon to test.
stPoint	The point to test.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the point is in the polygon, otherwise IDRS_FALSE

CPolygonUtils_IntersectsPolygon()

IDRS_BOOL CPolygonUtils_IntersectsPolygon	(	const CPolygon	argPolygon1,
		const CPolygon	argPolygon2,
		idrs_exception *	pargException
	)

IntersectsPolygon tests if there's an intersection between the two given polygons.

Parameters

argPolygon1	The data of the first polygon to test.
argPolygon2	The data of the second polygon to test.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if an intersection exists, otherwise IDRS_FALSE

CPolygonUtils_IntersectsRectangle()

IDRS_BOOL CPolygonUtils_IntersectsRectangle	(	const CPolygon	argPolygon,
		const IDRS_RECT *	argRectangle,
		idrs_exception *	pargException
	)

IntersectsRectangle tests if a polygon intersects the given rectangle or not.

Parameters

argPolygon	The polygon to test.
argRectangle	The rectangle to test.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the provided polygon intersects the provided rectangle, otherwise IDRS_FALSE

CPolygonUtils_IsRectangle()

IDRS_BOOL CPolygonUtils_IsRectangle	(	const CPolygon	argPolygon,
		idrs_exception *	pargException
	)

IsRectangle tests if a polygon is a rectangle or not.

Parameters

argPolygon	The polygon to test.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the provided polygon is rectangle, otherwise IDRS_FALSE