libprop: Region Class Reference

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

# Region Class Reference

Define a generic region on the Earth. Can turn its defined region into a series of discrete points, and check if a given point is inside the region. More...

`#include <geom.h>`

Inheritance diagram for Region:

List of all members.

## Public Member Functions
virtual vector< Point * > | discrete (double resolution)=0
virtual bool | contains (Point *p)=0
virtual void | add (Point *p)=0

## Detailed Description

Define a generic region on the Earth. Can turn its defined region into a series of discrete points, and check if a given point is inside the region.

## Member Function Documentation

virtual vector<Point*> Region::discrete | ( | double | resolution | ) | `[pure virtual]`

Turn the defined region into a discrete set of points, using resolution to describe the level of detail.

Parameters:

  | resolution | Level of spacing (detail) between the discrete points to be created. Value in kilometers.

Returns:
  List of points that describe this region using the level of resolution requested

Implemented in RegionArea, and RegionLine.

virtual bool Region::contains | ( | Point * | p | ) | `[pure virtual]`

Check if this region contains the given point.

Parameters:

  | p | Point to check against

Returns:
  True if point is inside this region, false otherwise

Implemented in RegionArea, and RegionLine.

virtual void Region::add | ( | Point * | p | ) | `[pure virtual]`

Add the given Point to this Region, expanding the region as needed so that contains(p) returns true.

Parameters:

  | p | The point to include in this region

Implemented in RegionArea, and RegionLine.

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

- geom.h