GeoTessCPP  2.1
Software to facilitate storage and retrieval of 3D information about the Earth.
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions | List of all members
geotess::GeoTessPolygon3D Class Reference

#include <GeoTessPolygon3D.h>

Inheritance diagram for geotess::GeoTessPolygon3D:
geotess::GeoTessPolygon

Public Member Functions

 GeoTessPolygon3D ()
 
 GeoTessPolygon3D (vector< double * > points, GeoTessHorizon *h_bottom, GeoTessHorizon *h_top)
 
 GeoTessPolygon3D (double *center, double radius, int nEdges, GeoTessHorizon *h_bottom, GeoTessHorizon *h_top)
 
 GeoTessPolygon3D (string filename)
 
 ~GeoTessPolygon3D ()
 
virtual string class_name ()
 
bool contains (const double *x, const double &radius, const int &layer, GeoTessProfile **profiles)
 
bool contains (const double *x, const int &layer)
 
bool contains (GeoTessPosition &position)
 
bool containsAll (vector< double * > &points, vector< double > &radii, vector< int > &layers, vector< GeoTessProfile ** > &profiles)
 
bool containsAny (vector< double * > &points, vector< double > &radii, vector< int > &layers, vector< GeoTessProfile ** > &profiles)
 
GeoTessHorizongetBottom ()
 
GeoTessHorizongetTop ()
 
virtual void write (const string &outputFileName)
 
- Public Member Functions inherited from geotess::GeoTessPolygon
 GeoTessPolygon ()
 
 GeoTessPolygon (vector< double * > &points)
 
 GeoTessPolygon (const double *center, double radius, int nEdges)
 
 GeoTessPolygon (string filename)
 
virtual ~GeoTessPolygon ()
 
void addReference ()
 
bool contains (const double *x)
 
bool containsAll (const vector< double * > &positions)
 
bool containsAny (const vector< double * > &points)
 
double getArea ()
 
double getAreaLarge ()
 
double getAreaSmall ()
 
const double * getPoint (int index)
 
void getPoints (vector< double * > &points, const bool &repeatFirstPoint)
 
void getPoints (vector< double * > &points, const bool &repeatFirstPoint, const double &maxSpacing)
 
int getRefCount ()
 
const double *const getReferencePoint ()
 
const void getReferencePoint (double *u)
 
bool getReferencePointIn ()
 
void invert ()
 
bool isNotReferenced ()
 
bool onBoundary (GeoTessGreatCircle &gcRef)
 
bool onBoundary (const double *x)
 
void removeReference ()
 
void setReferencePoint (const double *refPoint, const bool &inside)
 
void setReferencePoint (double lat, double lon, bool inside)
 
int size ()
 
string str (const bool &repeatFirstPoint, const bool &latFirst, const double &minLongitude=-180)
 

Additional Inherited Members

- Static Public Member Functions inherited from geotess::GeoTessPolygon
static double getTolerance ()
 
- Public Attributes inherited from geotess::GeoTessPolygon
void * attachment
 
- Protected Member Functions inherited from geotess::GeoTessPolygon
int edgeCrossings (GeoTessGreatCircle &gcRef)
 
void setup (vector< double * > &points)
 
- Protected Attributes inherited from geotess::GeoTessPolygon
vector< GeoTessGreatCircle * > edges
 
bool global
 
bool lonFirst
 
int refCount
 
bool referenceIn
 
double * referencePoint
 
- Static Protected Attributes inherited from geotess::GeoTessPolygon
static double TOLERANCE
 

Detailed Description

An ordered list of points on the surface of a unit sphere that define a closed polygon. Polygons have the ability to test whether or not an arbitrary test point on the sphere is inside or outside the polygon.

Besides the set of points that define the boundary of the polgon, a Polygon object has a single private instance of a reference point which is known to be either 'inside' or 'outside' the polygon. By default, the reference point is computed from the supplied boundary points in the following manner:

This method will work fine provided that polygons are 'smaller' than approximately a hemisphere. It is possible to override this behavior. The first method is to call the invert() method which simply reverses the value of whether the reference point is 'inside' or 'outside' the polygon. There are also methods that allow applications to specify both the position of the reference point and whether it is 'inside' or 'outside' the polygon.

A test point that is located very close to a polygon boundary point is deemed to be 'inside' the polygon. This means that if two adjacent, non-overlapping polygons share a boundary point, a test point near that boundary point will be deemed to be 'inside' both polygons. In this context two points are 'very close' if they are separated by less than 1e-7 radians or 5.7e-6 degrees. For a sphere with the radius of the Earth (6371 km), this corresponds to a linear distance of about 60 cm.

Polygon implements reference counting. This means that when some other object obtains a reference to a Polygon object, it should increment the polygon's reference count. When it is done with the polygon it should decrement the polygon's reference count and delete the polygon if the reference count is equal to zero.

Author
sballar

Constructor & Destructor Documentation

geotess::GeoTessPolygon3D::~GeoTessPolygon3D ( )
geotess::GeoTessPolygon3D::GeoTessPolygon3D ( )
inline
geotess::GeoTessPolygon3D::GeoTessPolygon3D ( vector< double * >  points,
GeoTessHorizon h_bottom,
GeoTessHorizon h_top 
)
inline

Constructor that accepts a list of unit vectors that define the polygon. The polygon will be closed, i.e., if the first point and last point are not coincident then an edge will be created between them.

Parameters
pointsarray of unit vectors specifying the positions that define the polygon.
h_bottomHorizon object that defines the bottom of the Polygon3D.
h_topHorizon object that defines the top of the Polygon3D.
geotess::GeoTessPolygon3D::GeoTessPolygon3D ( double *  center,
double  radius,
int  nEdges,
GeoTessHorizon h_bottom,
GeoTessHorizon h_top 
)
inline

Constructor that builds a circular polygon of a specified horizontal radius centered on position center.

Parameters
centerunit vector of the position that defines the center of the circular Polygon.
radiusangular radius of the polygon, in radians.
nEdgesnumber of edges that define the polygon
h_bottomHorizon object that defines the bottom of the Polygon3D.
h_topHorizon object that defines the top of the Polygon3D.
geotess::GeoTessPolygon3D::GeoTessPolygon3D ( string  filename)

Constructor that reads a Polygon from a file.

Parameters
filenamethe name of the file containing the polygon information.

throws a GeoTessException if specified file is a kml or kmz file. GeoTessExplorer can translate kml/kmz files to a compatible ascii format.

Member Function Documentation

virtual string geotess::GeoTessPolygon3D::class_name ( )
inlinevirtual

Returns the class name.

Reimplemented from geotess::GeoTessPolygon.

bool geotess::GeoTessPolygon3D::contains ( const double *  x,
const double &  radius,
const int &  layer,
GeoTessProfile **  profiles 
)
inline

Returns true if this Polygon3D contains the specified position.

Parameters
xthe unit vector of the position
radiusthe radius of the position in km
layerthe index of the layer in which the position resides
profilesa 1D array of profiles at the specified position. The number of elements must be equal to the number of layers in the model with the first layer being the deepest (closest to the center of the Earth) and the last layer being the shallowest (farthest from the center of the Earth).
Returns
true if this Polygon3D contains the specified position.
bool geotess::GeoTessPolygon3D::contains ( const double *  x,
const int &  layer 
)
inline

Returns true if this Polygon3D contains the specified position.

Parameters
xthe unit vector of the position
layerthe index of the layer in which the position resides
Returns
true if this Polygon3D contains the specified position.
bool geotess::GeoTessPolygon3D::contains ( GeoTessPosition position)

Returns true if this Polygon3D contains the specified position.

Parameters
position
Returns
true if this Polygon3D contains the specified position.
bool geotess::GeoTessPolygon3D::containsAll ( vector< double * > &  points,
vector< double > &  radii,
vector< int > &  layers,
vector< GeoTessProfile ** > &  profiles 
)
inline

Returns true if this Polygon contains all of the supplied unit vectors

Parameters
pointsunit vectors of positions to be evaluated
radiithe radii of the positions to be evaluated. radii.size() and points.size() must be equal.
layersthe indexes of the layers in which the positions reside.
profilesthe array of Profiles at the current geographic position. profiles.size() must equal number of layers in the model.
Returns
true if this Polygon contains all of the supplied unit vectors
bool geotess::GeoTessPolygon3D::containsAny ( vector< double * > &  points,
vector< double > &  radii,
vector< int > &  layers,
vector< GeoTessProfile ** > &  profiles 
)
inline

Returns true if this Polygon contains any of the supplied unit vectors

Parameters
pointsunit vectors of positions to be evaluated
radiithe radii of the positions to be evaluated. radii.size() and points.size() must be equal.
layersthe indexes of the layers in which the positions reside.
profilesthe array of Profiles at the current geographic position. profiles.size() must equal number of layers in the model.
Returns
true if this Polygon contains any of the supplied unit vectors
GeoTessHorizon* geotess::GeoTessPolygon3D::getBottom ( )
inline

Retrieve a reference to the Horizon that defines the bottom of the active region.

GeoTessHorizon* geotess::GeoTessPolygon3D::getTop ( )
inline

Retrieve a reference to the Horizon that defines the top of the active region.

virtual void geotess::GeoTessPolygon3D::write ( const string &  outputFileName)
virtual

Reimplemented from geotess::GeoTessPolygon.


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