Public Member Functions | List of all members
Avoid::ReferencingPolygon Class Reference

A Polygon which just references its points from other Polygons. More...

#include <geomtypes.h>

Inheritance diagram for Avoid::ReferencingPolygon:
Avoid::PolygonInterface

Public Member Functions

void clear (void)
 Resets this to the empty polygon.
 
bool empty (void) const
 Returns true if this polygon is empty.
 
size_t size (void) const
 Returns the number of points in this polygon.
 
int id (void) const
 Returns the ID value associated with this polygon.
 
const Pointat (size_t index) const
 Returns a specific point in the polygon. More...
 
void getBoundingRect (double *minX, double *minY, double *maxX, double *maxY) const
 Returns the bounding rectangle that contains this polygon. More...
 
Polygon boundingRect (void) const
 Returns the bounding rectangle for this polygon. More...
 

Detailed Description

A Polygon which just references its points from other Polygons.

This type of Polygon is used to accurately represent cluster boundaries made up from the corner points of shapes.

Member Function Documentation

const Point & Avoid::ReferencingPolygon::at ( size_t  index) const
virtual

Returns a specific point in the polygon.

Parameters
[in]indexThe array index of the point to be returned.

Implements Avoid::PolygonInterface.

Polygon Avoid::PolygonInterface::boundingRect ( void  ) const
inherited

Returns the bounding rectangle for this polygon.

Returns
A new Rectangle representing the bounding box.
void Avoid::PolygonInterface::getBoundingRect ( double *  minX,
double *  minY,
double *  maxX,
double *  maxY 
) const
inherited

Returns the bounding rectangle that contains this polygon.

If a NULL pointer is passed for any of the arguments, then that value is ignored and not returned.

Parameters
[out]minXThe left hand side of the bounding box.
[out]minYThe top of the bounding box.
[out]maxXThe right hand side of the bounding box.
[out]maxYThe bottom of the bounding box.

The documentation for this class was generated from the following files: