GEOS  3.9.1dev
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
geos::geom::Polygon Class Reference

Represents a linear polygon, which may include holes. More...

#include <geos.h>

Inheritance diagram for geos::geom::Polygon:
[legend]
Collaboration diagram for geos::geom::Polygon:
[legend]

Public Types

typedef std::vector< const Polygon * > ConstVect
 A vector of const Polygon pointers. More...
 
- Public Types inherited from geos::geom::Geometry
using ConstVect = std::vector< const Geometry * >
 A vector of const Geometry pointers. More...
 
using NonConstVect = std::vector< Geometry * >
 A vector of non-const Geometry pointers. More...
 
using Ptr = std::unique_ptr< Geometry >
 An unique_ptr of Geometry. More...
 

Public Member Functions

 ~Polygon () override=default
 
std::unique_ptr< Geometryclone () const override
 
std::unique_ptr< CoordinateSequencegetCoordinates () const override
 Returns this Geometry vertices. Caller takes ownership of the returned object. More...
 
size_t getNumPoints () const override
 Returns the count of this Geometrys vertices. More...
 
Dimension::DimensionType getDimension () const override
 Returns surface dimension (2) More...
 
uint8_t getCoordinateDimension () const override
 Returns coordinate dimension. More...
 
int getBoundaryDimension () const override
 Returns 1 (Polygon boundary is a MultiLineString) More...
 
std::unique_ptr< GeometrygetBoundary () const override
 Computes the boundary of this geometry. More...
 
bool isEmpty () const override
 Returns whether or not the set of points in this Geometry is empty. More...
 
const LinearRinggetExteriorRing () const
 Returns the exterior ring (shell) More...
 
size_t getNumInteriorRing () const
 Returns number of interior rings (hole) More...
 
const LinearRinggetInteriorRingN (std::size_t n) const
 Get nth interior ring (hole) More...
 
std::string getGeometryType () const override
 Return a string representation of this Geometry type. More...
 
GeometryTypeId getGeometryTypeId () const override
 Return an integer representation of this Geometry type. More...
 
bool equalsExact (const Geometry *other, double tolerance=0) const override
 Returns true iff the two Geometrys are of the same type and their vertices corresponding by index are equal up to a specified tolerance. More...
 
void apply_rw (const CoordinateFilter *filter) override
 
void apply_ro (CoordinateFilter *filter) const override
 
void apply_rw (GeometryFilter *filter) override
 
void apply_ro (GeometryFilter *filter) const override
 
void apply_rw (CoordinateSequenceFilter &filter) override
 
void apply_ro (CoordinateSequenceFilter &filter) const override
 
void apply_rw (GeometryComponentFilter *filter) override
 
void apply_ro (GeometryComponentFilter *filter) const override
 
std::unique_ptr< GeometryconvexHull () const override
 Returns the smallest convex Polygon that contains all the points in the Geometry. More...
 
void normalize () override
 
std::unique_ptr< Geometryreverse () const override
 Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one. More...
 
int compareToSameClass (const Geometry *p) const override
 
const CoordinategetCoordinate () const override
 Returns a vertex of this Geometry, or NULL if this is the empty geometry. More...
 
double getArea () const override
 Returns the area of this Geometry. More...
 
double getLength () const override
 Returns the perimeter of this Polygon More...
 
bool isRectangle () const override
 Polygon overrides to check for actual rectangle. More...
 
- Public Member Functions inherited from geos::geom::Geometry
virtual ~Geometry ()
 Destroy Geometry and all components. More...
 
const GeometryFactorygetFactory () const
 Gets the factory which contains the context in which this geometry was created. More...
 
void setUserData (void *newUserData)
 A simple scheme for applications to add their own custom data to a Geometry. An example use might be to add an object representing a Coordinate Reference System. More...
 
void * getUserData () const
 Gets the user data object for this geometry, if any. More...
 
virtual int getSRID () const
 Returns the ID of the Spatial Reference System used by the Geometry. More...
 
virtual void setSRID (int newSRID)
 Sets the ID of the Spatial Reference System used by the Geometry. More...
 
const PrecisionModelgetPrecisionModel () const
 Get the PrecisionModel used to create this Geometry. More...
 
virtual bool isSimple () const
 Returns false if the Geometry not simple. More...
 
virtual std::size_t getNumGeometries () const
 
virtual const GeometrygetGeometryN (std::size_t) const
 Returns a pointer to the nth Geometry in this collection (or self if this is not a collection) More...
 
virtual bool isValid () const
 Tests the validity of this Geometry. More...
 
virtual bool isDimensionStrict (Dimension::DimensionType d) const
 Checks whether this Geometry consists only of components having dimension d. More...
 
bool isPuntal () const
 
bool isLineal () const
 
bool isPolygonal () const
 
bool isCollection () const
 
virtual std::unique_ptr< GeometrygetEnvelope () const
 Returns this Geometrys bounding box. More...
 
virtual const EnvelopegetEnvelopeInternal () const
 Returns the minimum and maximum x and y values in this Geometry, or a null Envelope if this Geometry is empty. More...
 
virtual bool disjoint (const Geometry *other) const
 
virtual bool touches (const Geometry *other) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is FT*******, F**T***** or F***T****. More...
 
virtual bool intersects (const Geometry *g) const
 Returns true if disjoint returns false. More...
 
virtual bool crosses (const Geometry *g) const
 
virtual bool within (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*F**F***. More...
 
virtual bool contains (const Geometry *g) const
 Returns true if other.within(this) returns true. More...
 
virtual bool overlaps (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*T***T** (for two points or two surfaces) 1*T***T** (for two curves). More...
 
bool relate (const Geometry *g, const std::string &intersectionPattern) const
 Returns true if the elements in the DE-9IM intersection matrix for the two Geometrys match the elements in intersectionPattern. More...
 
bool relate (const Geometry &g, const std::string &intersectionPattern) const
 
std::unique_ptr< IntersectionMatrixrelate (const Geometry *g) const
 Returns the DE-9IM intersection matrix for the two Geometrys. More...
 
std::unique_ptr< IntersectionMatrixrelate (const Geometry &g) const
 
virtual bool equals (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*F**FFF*. More...
 
bool covers (const Geometry *g) const
 Returns true if this geometry covers the specified geometry. More...
 
bool coveredBy (const Geometry *g) const
 Tests whether this geometry is covered by the specified geometry. More...
 
virtual std::string toString () const
 Returns the Well-known Text representation of this Geometry. More...
 
virtual std::string toText () const
 
std::unique_ptr< Geometrybuffer (double distance) const
 
std::unique_ptr< Geometrybuffer (double distance, int quadrantSegments) const
 Returns a buffer region around this Geometry having the given width and with a specified number of segments used to approximate curves. More...
 
std::unique_ptr< Geometrybuffer (double distance, int quadrantSegments, int endCapStyle) const
 Computes a buffer area around this geometry having the given width and with a specified accuracy of approximation for circular arcs, and using a specified end cap style. More...
 
std::unique_ptr< Geometryintersection (const Geometry *other) const
 Returns a Geometry representing the points shared by this Geometry and other. More...
 
std::unique_ptr< GeometryUnion (const Geometry *other) const
 Returns a Geometry representing all the points in this Geometry and other. More...
 
Ptr Union () const
 Computes the union of all the elements of this geometry. Heterogeneous GeometryCollections are fully supported. More...
 
std::unique_ptr< Geometrydifference (const Geometry *other) const
 Returns a Geometry representing the points making up this Geometry that do not make up other. More...
 
std::unique_ptr< GeometrysymDifference (const Geometry *other) const
 Returns a set combining the points in this Geometry not in other, and the points in other not in this Geometry. More...
 
template<class T >
void applyComponentFilter (T &f) const
 Apply a filter to each component of this geometry. The filter is expected to provide a .filter(const Geometry*) method. More...
 
virtual int compareTo (const Geometry *geom) const
 Comparator for sorting geometry. More...
 
virtual double distance (const Geometry *g) const
 Returns the minimum distance between this Geometry and the Geometry g. More...
 
virtual bool isWithinDistance (const Geometry *geom, double cDistance) const
 Tests whether the distance from this Geometry to another is less than or equal to a specified value. More...
 
virtual std::unique_ptr< PointgetCentroid () const
 Computes the centroid of this Geometry. More...
 
virtual bool getCentroid (Coordinate &ret) const
 Computes the centroid of this Geometry as a Coordinate. More...
 
std::unique_ptr< PointgetInteriorPoint () const
 Computes an interior point of this Geometry. More...
 
virtual void geometryChanged ()
 Notifies this Geometry that its Coordinates have been changed by an external party (using a CoordinateFilter, for example). More...
 
void geometryChangedAction ()
 Notifies this Geometry that its Coordinates have been changed by an external party. More...
 

Protected Member Functions

 Polygon (const Polygon &p)
 
 Polygon (LinearRing *newShell, std::vector< LinearRing * > *newHoles, const GeometryFactory *newFactory)
 
 Polygon (std::unique_ptr< LinearRing > &&newShell, const GeometryFactory &newFactory)
 
 Polygon (std::unique_ptr< LinearRing > &&newShell, std::vector< std::unique_ptr< LinearRing >> &&newHoles, const GeometryFactory &newFactory)
 
Envelope::Ptr computeEnvelopeInternal () const override
 
int getSortIndex () const override
 
- Protected Member Functions inherited from geos::geom::Geometry
virtual bool isEquivalentClass (const Geometry *other) const
 Returns whether the two Geometrys are equal, from the point of view of the equalsExact method. More...
 
int compare (std::vector< Coordinate > a, std::vector< Coordinate > b) const
 
int compare (std::vector< Geometry * > a, std::vector< Geometry * > b) const
 
int compare (const std::vector< std::unique_ptr< Geometry >> &a, const std::vector< std::unique_ptr< Geometry >> &b) const
 
bool equal (const Coordinate &a, const Coordinate &b, double tolerance) const
 
 Geometry (const Geometry &geom)
 
 Geometry (const GeometryFactory *factory)
 Construct a geometry with the given GeometryFactory. More...
 

Protected Attributes

std::unique_ptr< LinearRingshell
 
std::vector< std::unique_ptr< LinearRing > > holes
 
- Protected Attributes inherited from geos::geom::Geometry
std::unique_ptr< Envelopeenvelope
 The bounding box of this Geometry. More...
 
int SRID
 

Private Member Functions

void normalize (LinearRing *ring, bool clockwise)
 

Friends

class GeometryFactory
 

Additional Inherited Members

- Static Protected Member Functions inherited from geos::geom::Geometry
template<typename T >
static bool hasNonEmptyElements (const std::vector< T > *geometries)
 Returns true if the array contains any non-empty Geometrys. More...
 
static bool hasNullElements (const CoordinateSequence *list)
 Returns true if the CoordinateSequence contains any null elements. More...
 
template<typename T >
static bool hasNullElements (const std::vector< T > *geometries)
 Returns true if the vector contains any null elements. More...
 
static void checkNotGeometryCollection (const Geometry *g)
 
template<typename T >
static std::vector< std::unique_ptr< Geometry > > toGeometryArray (std::vector< std::unique_ptr< T >> &&v)
 

Detailed Description

Represents a linear polygon, which may include holes.

The shell and holes of the polygon are represented by LinearRings. In a valid polygon, holes may touch the shell or other holes at a single point. However, no sequence of touching holes may split the polygon into two pieces. The orientation of the rings in the polygon does not matter.

The shell and holes must conform to the assertions specified in the OpenGIS Simple Features Specification for SQL .

Definition at line 64 of file Polygon.h.

Member Typedef Documentation

typedef std::vector<const Polygon*> geos::geom::Polygon::ConstVect

A vector of const Polygon pointers.

Definition at line 71 of file Polygon.h.

Constructor & Destructor Documentation

geos::geom::Polygon::~Polygon ( )
overridedefault
geos::geom::Polygon::Polygon ( const Polygon p)
protected
geos::geom::Polygon::Polygon ( LinearRing newShell,
std::vector< LinearRing * > *  newHoles,
const GeometryFactory newFactory 
)
protected

Constructs a Polygon with the given exterior and interior boundaries.

Parameters
newShellthe outer boundary of the new Polygon, or null or an empty LinearRing if the empty geometry is to be created.
newHolesthe LinearRings defining the inner boundaries of the new Polygon, or null or empty LinearRing if the empty geometry is to be created.
newFactorythe GeometryFactory used to create this geometry

Polygon will take ownership of Shell and Holes LinearRings

geos::geom::Polygon::Polygon ( std::unique_ptr< LinearRing > &&  newShell,
const GeometryFactory newFactory 
)
protected
geos::geom::Polygon::Polygon ( std::unique_ptr< LinearRing > &&  newShell,
std::vector< std::unique_ptr< LinearRing >> &&  newHoles,
const GeometryFactory newFactory 
)
protected

Member Function Documentation

void geos::geom::Polygon::apply_ro ( CoordinateFilter filter) const
overridevirtual

Implements geos::geom::Geometry.

void geos::geom::Polygon::apply_ro ( GeometryFilter filter) const
overridevirtual

Reimplemented from geos::geom::Geometry.

void geos::geom::Polygon::apply_ro ( CoordinateSequenceFilter filter) const
overridevirtual

Performs a read-only operation on the coordinates in this Geometry's CoordinateSequences.

Parameters
filterthe filter to apply

Implements geos::geom::Geometry.

void geos::geom::Polygon::apply_ro ( GeometryComponentFilter filter) const
overridevirtual

Reimplemented from geos::geom::Geometry.

void geos::geom::Polygon::apply_rw ( const CoordinateFilter filter)
overridevirtual

Implements geos::geom::Geometry.

void geos::geom::Polygon::apply_rw ( GeometryFilter filter)
overridevirtual

Reimplemented from geos::geom::Geometry.

void geos::geom::Polygon::apply_rw ( CoordinateSequenceFilter filter)
overridevirtual

Performs an operation on the coordinates in this Geometry's CoordinateSequences. If the filter reports that a coordinate value has been changed, geometryChanged will be called automatically.

Parameters
filterthe filter to apply

Implements geos::geom::Geometry.

void geos::geom::Polygon::apply_rw ( GeometryComponentFilter filter)
overridevirtual

Reimplemented from geos::geom::Geometry.

std::unique_ptr<Geometry> geos::geom::Polygon::clone ( ) const
inlineoverridevirtual

Creates and returns a full copy of this Polygon object. (including all coordinates contained by it).

Returns
a clone of this instance

Implements geos::geom::Geometry.

Definition at line 82 of file Polygon.h.

int geos::geom::Polygon::compareToSameClass ( const Geometry p) const
overridevirtual

Implements geos::geom::Geometry.

Envelope::Ptr geos::geom::Polygon::computeEnvelopeInternal ( ) const
overrideprotectedvirtual

Implements geos::geom::Geometry.

std::unique_ptr<Geometry> geos::geom::Polygon::convexHull ( ) const
overridevirtual

Returns the smallest convex Polygon that contains all the points in the Geometry.

Reimplemented from geos::geom::Geometry.

bool geos::geom::Polygon::equalsExact ( const Geometry other,
double  tolerance = 0 
) const
overridevirtual

Returns true iff the two Geometrys are of the same type and their vertices corresponding by index are equal up to a specified tolerance.

Implements geos::geom::Geometry.

double geos::geom::Polygon::getArea ( ) const
overridevirtual

Returns the area of this Geometry.

Reimplemented from geos::geom::Geometry.

std::unique_ptr<Geometry> geos::geom::Polygon::getBoundary ( ) const
overridevirtual

Computes the boundary of this geometry.

Returns
a lineal geometry (which may be empty)
See also
Geometry::getBoundary

Implements geos::geom::Geometry.

int geos::geom::Polygon::getBoundaryDimension ( ) const
overridevirtual

Returns 1 (Polygon boundary is a MultiLineString)

Implements geos::geom::Geometry.

const Coordinate* geos::geom::Polygon::getCoordinate ( ) const
overridevirtual

Returns a vertex of this Geometry, or NULL if this is the empty geometry.

Implements geos::geom::Geometry.

uint8_t geos::geom::Polygon::getCoordinateDimension ( ) const
overridevirtual

Returns coordinate dimension.

Implements geos::geom::Geometry.

std::unique_ptr<CoordinateSequence> geos::geom::Polygon::getCoordinates ( ) const
overridevirtual

Returns this Geometry vertices. Caller takes ownership of the returned object.

Implements geos::geom::Geometry.

Dimension::DimensionType geos::geom::Polygon::getDimension ( ) const
overridevirtual

Returns surface dimension (2)

Implements geos::geom::Geometry.

const LinearRing* geos::geom::Polygon::getExteriorRing ( ) const

Returns the exterior ring (shell)

std::string geos::geom::Polygon::getGeometryType ( ) const
overridevirtual

Return a string representation of this Geometry type.

Implements geos::geom::Geometry.

GeometryTypeId geos::geom::Polygon::getGeometryTypeId ( ) const
overridevirtual

Return an integer representation of this Geometry type.

Implements geos::geom::Geometry.

const LinearRing* geos::geom::Polygon::getInteriorRingN ( std::size_t  n) const

Get nth interior ring (hole)

double geos::geom::Polygon::getLength ( ) const
overridevirtual

Returns the perimeter of this Polygon

Reimplemented from geos::geom::Geometry.

size_t geos::geom::Polygon::getNumInteriorRing ( ) const

Returns number of interior rings (hole)

size_t geos::geom::Polygon::getNumPoints ( ) const
overridevirtual

Returns the count of this Geometrys vertices.

Implements geos::geom::Geometry.

int geos::geom::Polygon::getSortIndex ( ) const
inlineoverrideprotectedvirtual

Implements geos::geom::Geometry.

Definition at line 188 of file Polygon.h.

References geos::geom::SORTINDEX_POLYGON.

bool geos::geom::Polygon::isEmpty ( ) const
overridevirtual

Returns whether or not the set of points in this Geometry is empty.

Implements geos::geom::Geometry.

bool geos::geom::Polygon::isRectangle ( ) const
overridevirtual

Polygon overrides to check for actual rectangle.

Reimplemented from geos::geom::Geometry.

void geos::geom::Polygon::normalize ( )
overridevirtual

Reorganizes this Geometry into normal form (or canonical form). Starting point of rings is lower left, collections are ordered by geometry type, etc.

Implements geos::geom::Geometry.

void geos::geom::Polygon::normalize ( LinearRing ring,
bool  clockwise 
)
private
std::unique_ptr<Geometry> geos::geom::Polygon::reverse ( ) const
overridevirtual

Computes a new geometry which has all component coordinate sequences in reverse order (opposite orientation) to this one.

Returns
a reversed geometry

Implements geos::geom::Geometry.

Friends And Related Function Documentation

friend class GeometryFactory
friend

Definition at line 68 of file Polygon.h.

Member Data Documentation

std::vector<std::unique_ptr<LinearRing> > geos::geom::Polygon::holes
protected

Definition at line 183 of file Polygon.h.

std::unique_ptr<LinearRing> geos::geom::Polygon::shell
protected

Definition at line 181 of file Polygon.h.


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