Polygon is a subclass of CurvePolygon whose rings are defined by linear rings. More...

#include <Polygon.h>

Inheritance diagram for te::gm::Polygon:

Public Types
typedef void	ReturnType

typedef Visitor	VisitorType

Public Member Functions
virtual ReturnType	accept (VisitorType &guest) const=0
	It call the visit method from the guest object. More...

Initializer methods on geometric objects
Methods for initializing a geometric object.
	Polygon (std::size_t nRings, GeomType t, int srid=0, Envelope *mbr=0)
	It initializes the Geometry with the specified spatial reference system id and envelope. More...

	Polygon (const Polygon &rhs)
	Copy constructor. More...

virtual	~Polygon ()
	Virtual destructor. More...

virtual Polygon &	operator= (const Polygon &rhs)
	Assignment operator. More...

Re-Implementation from AbstractData
Methods re-Implementated from AbstractData.
virtual te::dt::AbstractData *	clone () const
	It clones the linestring. More...

CurvePolygon Specific Methods
Specific methods for a CurvePolygon.
Curve *	getExteriorRing () const
	It returns the exterior ring of this CurvePolygon. More...

std::size_t	getNumInteriorRings () const
	It returns the number of interior rings in this CurvePolygon. More...

std::size_t	getNumRings () const
	It returns the number of rings in this CurvePolygon. More...

void	setNumRings (std::size_t size)
	It sets the number of rings in this curve polygon. More...

Curve *	getInteriorRingN (std::size_t i) const
	It returns the n-th interior ring for this curve polygon as a curve. More...

Curve *	getRingN (std::size_t i) const
	It returns the n-th ring for this curve polygon as a curve. More...

Curve *	operator[] (std::size_t i) const
	It returns the n-th ring. More...

Curve *	operator[] (std::size_t i)
	It returns the n-th ring. More...

void	setRingN (std::size_t i, Curve *r)
	It sets the informed position ring to the new one. More...

void	removeRingN (std::size_t i)
	It removes the n-th ring in this CurvePolygon. More...

void	add (Curve *ring)
	It adds the ring to the curve polygon. More...

void	push_back (Curve *ring)
	It adds the curve to the curve polygon. More...

void	clear ()
	It deletes all the rings of the CurvePolygon and clear it. More...

std::vector< Curve * > &	getRings ()
	It returns the polygon rings. More...

const std::vector< Curve * > &	getRings () const
	It returns the polygon rings. More...

Surface Specific Methods
Specific methods for a Surface.
double	getArea () const
	It returns the area of this surface, as measured in the spatial reference system of this surface. More...

Point *	getCentroid () const
	It returns the mathematical centroid for this surface as a point. More...

Coord2D *	getCentroidCoord () const
	It returns the mathematical centroid for this surface as a coordinate. More...

Point *	getPointOnSurface () const
	It returns a point guaranteed to be on this surface. More...

Coord2D *	getCoordOnSurface () const
	It returns a coordinate guaranteed to be on this surface. More...

double	getPerimeter () const
	It returns the length of the boundary for the surface. More...

Re-Implmentation of methods from Geometry class
Re-Implmentation of basic methods from Geometry class.
Dimensionality	getDimension () const throw ()
	Surfaces are 2-dimensional objects. More...

Basic Geometry Methods
Basic methods on geometric objects.
int	getCoordinateDimension () const _NOEXCEPT_OP(true)
	It returns the number of measurements or axes needed to describe a position in a coordinate system. More...

GeomType	getGeomTypeId () const _NOEXCEPT_OP(true)
	It returns the geometry subclass type identifier. More...

virtual const std::string	get2DGeometryType () const _NOEXCEPT_OP(true)
	It returns the name of 2D geometry subclass. More...

virtual GeomType	get2DGeomTypeId () const _NOEXCEPT_OP(true)
	It returns the 2D geometry subclass type identifier. More...

int	getSRID () const _NOEXCEPT_OP(true)
	It returns the Spatial Reference System ID associated to this geometric object. More...

virtual void	transform (const int &srid) _NOEXCEPT_OP(false)
	It converts the coordinate values of the geometry to the new spatial reference system. More...

Geometry *	getEnvelope () const _NOEXCEPT_OP(true)
	It returns the minimum bounding rectangle (MBR) for the geometry. More...

const Envelope *	getMBR () const _NOEXCEPT_OP(true)
	It returns the minimum bounding rectangle for the geometry in an internal representation. More...

std::string	asText () const _NOEXCEPT_OP(true)
	It returns an string with the Well-Known Text Representation for the geometry. More...

char *	asBinary (std::size_t &size) const _NOEXCEPT_OP(false)
	It serializes the geometric object to a Well-known Binary Representation (WKB). More...

std::size_t	getWkbSize () const _NOEXCEPT_OP(true)
	It returns the size required by a WKB representation for this geometric object. More...

void	getWkb (char *wkb, te::common::MachineByteOrder byteOrder) const _NOEXCEPT_OP(false)
	It serializes the geometry to a WKB representation into the specified buffer. More...

virtual bool	isEmpty () const _NOEXCEPT_OP(false)
	It returns true if this geometric object is the empty Geometry. More...

virtual bool	isSimple () const _NOEXCEPT_OP(false)
	It returns true if this geometric object has no anomalous points, such as self intersection or self tangency. More...

virtual bool	isValid () const _NOEXCEPT_OP(false)
	It tells if the geometry is well formed. More...

bool	is3D () const _NOEXCEPT_OP(true)
	It returns true if this geometric object has z coordinate values. More...

bool	isMeasured () const _NOEXCEPT_OP(true)
	It returns true if this geometric object has m coordinate values. More...

bool	isCollection () const _NOEXCEPT_OP(true)
	It returns true if this geometric object is a collection. More...

virtual Geometry *	getBoundary () const _NOEXCEPT_OP(false)
	It returns the geometry boundary. More...

Spatial Relations
Methods for testing spatial relations between geometric objects. Please, see OGC specification for a in depth definition of each spatial operation.
virtual bool	equals (const Geometry *const rhs, const bool exact=false) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially equal to rhs geometry. More...

virtual bool	disjoint (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially disjoint from rhs geometry. More...

virtual bool	intersects (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially intersects rhs geometry. More...

virtual bool	touches (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially touches rhs geometry. More...

virtual bool	crosses (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially crosses rhs geometry. More...

virtual bool	within (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially within rhs geometry. More...

virtual bool	contains (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially contains rhs geometry. More...

virtual bool	overlaps (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially overlaps rhs geometry. More...

virtual bool	relate (const Geometry *const rhs, const std::string &matrix) const _NOEXCEPT_OP(false)
	It returns true if this geometry object is spatially related to rhs geometry according to the pattern expressed by the intersection matrix. More...

virtual std::string	relate (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns the spatial relation between this geometry object and the rhs geometry. More...

virtual bool	covers (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially covers the rhs geometry. More...

virtual bool	coveredBy (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object is spatially covered by rhs geometry. More...

virtual Geometry *	locateAlong (const double &mValue) const _NOEXCEPT_OP(false)
	It returns a derived GeometryCollection value according to the specified coordinate value. More...

virtual Geometry *	locateBetween (const double &mStart, const double &mEnd) const _NOEXCEPT_OP(false)
	It returns a derived geometry collection value according to the range of coordinate values inclusively. More...

Spatial Analysis
Methods that support spatial analysis.
virtual double	distance (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns the shortest distance between any two points in the two geometry objects. More...

virtual Geometry *	buffer (const double &distance) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	buffer (const double &distance, int quadrantSegments) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	buffer (const double &distance, int quadrantSegments, BufferCapStyle endCapStyle) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	convexHull () const _NOEXCEPT_OP(false)
	This method calculates the Convex Hull of a geometry. More...

virtual Geometry *	intersection (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set intersection with another geometry. More...

virtual Geometry *	Union (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set union with another geometry. More...

virtual Geometry *	difference (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set difference with another geometry. More...

virtual Geometry *	symDifference (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set symetric difference with another geometry. More...

virtual bool	dWithin (const Geometry *const rhs, const double &distance) const _NOEXCEPT_OP(false)
	It returns true if the geometries are within the specified distance. More...

Static Public Member Functions
Auxiliary Methods
Auxiliary Methods.
static GeomType	getGeomTypeId (const std::string &gtype)
	It returns the TerraLib geometry type id given a type string (the type string must be in capital letters). More...

static std::string	getGeomTypeString (const int &gId)
	It returns the TerraLib geometry type string given a type id. More...

static bool	isGeomType (const std::string &stype)
	It tells if the given string is a geometry data type. More...

static void	loadGeomTypeId ()
	It loads the internal MAP of geometry type names to geometry type ids. More...

Re-Implmentation of methods from Geometry class
Re-Implmentation of basic methods from Geometry class.
static const std::string	sm_typeName

virtual const std::string &	getGeometryType () const throw ()
	It returns the name of the instantiable subtype of Geometry of which this geometric object is an instantiable member. More...

Re-Implmentation of methods from Geometry class
Re-Implmentation of basic methods from Geometry class.
void	setSRID (int srid) throw ()
	It sets the Spatial Reference System ID of the geometry and all its parts if it is a GeometryCollection (or a Multi). More...

void	convert (te::srs::Converter *converter) override
	It converts the coordinate values of the geometry to the new spatial reference system. More...

void	computeMBR (bool cascade) const throw ()
	It computes the minimum bounding rectangle for the curve polygon. More...

std::size_t	getNPoints () const throw ()
	it returns the number of points (vertexes) in the geometry. More...

std::vector< Curve * >	m_rings
	An array with the ring list. More...

AbstractData Re-implementation
Methods re-implemneted from AbstractData.
int	getTypeCode () const
	It returns the data type code associated to the data value. More...

std::string	toString () const
	It returns the data value in a WKT representation. More...

GeomType	m_gType
	Internal geometry type. More...

int	m_srid
	The Spatial Reference System code associated to the Geometry. More...

Envelope *	m_mbr
	The geometry minimum bounding rectangle. More...

static std::map< std::string, GeomType >	sm_geomTypeMap
	A set of geometry type names (in UPPER CASE). More...

Detailed Description

Polygon is a subclass of CurvePolygon whose rings are defined by linear rings.

See also: Geometry, AbstractPoint, Point, PointM, PointZ, PointZM, PointKd, Curve, LineString, LinearRing, Line, CircularString, CompoundCurve, Surface, CurvePolygon, Triangle, PolyhedralSurface, TIN, GeometryCollection, MultiSurface, MultiCurve, MultiPoint, MultiLineString, MultiPolygon

Definition at line 50 of file Polygon.h.

Member Typedef Documentation

◆ ReturnType

typedef void te::common::BaseVisitable< Visitor , void >::ReturnType

inherited

Definition at line 58 of file BaseVisitable.h.

◆ VisitorType

typedef Visitor te::common::BaseVisitable< Visitor , void >::VisitorType

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

◆ Polygon() [1/2]

te::gm::Polygon::Polygon	(	std::size_t	nRings,
		GeomType	t,
		int	srid = `0`,
		Envelope *	mbr = `0`
	)

It initializes the Geometry with the specified spatial reference system id and envelope.

Parameters

nRings	The number of rings forming the polygon.
t	The internal type of the Geometry.
srid	The Spatial Reference System ID associated to the Geometry.
mbr	The minimum bounding rectangle of this geometry (i.e., its envelope). It may be a NULL value.

Note: The Geometry will take the ownership of the given mbr.

Warning: Set all nRing informed, otherwise you can not use methods like computeMBR().

◆ Polygon() [2/2]

te::gm::Polygon::Polygon ( const Polygon & rhs )

Copy constructor.

Parameters

rhs	The other geometry.

◆ ~Polygon()

virtual te::gm::Polygon::~Polygon ( )

virtual

Virtual destructor.

Member Function Documentation

◆ accept()

virtual ReturnType te::common::BaseVisitable< Visitor , void >::accept ( VisitorType & guest ) const

pure virtualinherited

It call the visit method from the guest object.

Parameters

guest The guest or visitor.

Returns: Any valid value define by the template type R.

◆ add()

void te::gm::CurvePolygon::add ( Curve * ring )

inherited

It adds the ring to the curve polygon.

Parameters

ring	The ring to be added.

Note: TerraLib extended method.

◆ asBinary()

char * te::gm::Geometry::asBinary ( std::size_t & size ) const

inherited

It serializes the geometric object to a Well-known Binary Representation (WKB).

Parameters

size	The size in bytes of the returned WKB.

Returns: The WKB representation for this object.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: The WKB will be on machine byte order.; The caller of this method will take the ownership of the returned wkb. You must use "delete [] pointer" in order to free the memory pointed by returned pointer.

◆ asText()

std::string te::gm::Geometry::asText ( ) const

inherited

It returns an string with the Well-Known Text Representation for the geometry.

Returns: The WKT for the Geometry.

◆ buffer() [1/3]

virtual Geometry * te::gm::Geometry::buffer ( const double & distance ) const

virtualinherited

This method calculates the buffer of a geometry.

Parameters

distance Distance value.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; Performed by GEOS.

◆ buffer() [2/3]

virtual Geometry * te::gm::Geometry::buffer	(	const double &	distance,
		int	quadrantSegments
	)		const

virtualinherited

This method calculates the buffer of a geometry.

Parameters

distance	Distance value.
quadrantSegments	A specified number of segments used to approximate the curves.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; TerraLib extended method.; Performed by GEOS.

◆ buffer() [3/3]

virtual Geometry * te::gm::Geometry::buffer	(	const double &	distance,
		int	quadrantSegments,
		BufferCapStyle	endCapStyle
	)		const

virtualinherited

This method calculates the buffer of a geometry.

As in GEOS, the quadrantSegments argument allows controlling the accuracy of the approximation by specifying the number of line segments used to represent a quadrant of a circle.

Parameters

distance	Distance value.
quadrantSegments	A specified number of segments used to approximate the curves.
endCapStyle	It specifies the shape used at the ends of linestrings.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned Geometry.; TerraLib extended method.; Performed by GEOS.

◆ clear()

void te::gm::CurvePolygon::clear ( )

inherited

It deletes all the rings of the CurvePolygon and clear it.

Note: TerraLib extended method.

◆ clone()

virtual te::dt::AbstractData * te::gm::Polygon::clone ( ) const

virtual

It clones the linestring.

Returns: A copy of the given linestring.

Note: The caller of this method will take the ownership of the returned linestring.; The cloned linestring will not have the MBR computed. This will save time when you are just cloning a geometry and don't intend to waste time computing the bounding box. If you have another suggestion, please, let me know.

Reimplemented from te::gm::CurvePolygon.

◆ computeMBR()

void te::gm::CurvePolygon::computeMBR	(	bool	cascade	)	const
throw	(
	)

virtualinherited

It computes the minimum bounding rectangle for the curve polygon.

Parameters

cascade If true, it will update the MBR of its parts.

Note: You can use this method in order to update the MBR of the curve polygon.; TerraLib extended method.

Implements te::gm::Geometry.

◆ contains()

virtual bool te::gm::Geometry::contains ( const Geometry *const rhs ) const

virtualinherited

It returns true if this geometry object spatially contains rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially contains the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ convert()

void te::gm::CurvePolygon::convert ( te::srs::Converter * converter )

overridevirtualinherited

It converts the coordinate values of the geometry to the new spatial reference system.

After calling this method the geometry will be associated to the new SRID.

Parameters

converter The converter containing all the information related to the new Spatial Reference System ID used to transform the coordinates of the geometry.

Exceptions

Exception It will throw an exception if it can not do the transformation.

Note: The geometry must be associated to a valid SRID before calling this method.; If the geometry already has an associated MBR, this method will automatically update it (i. e. automatically recompute it).

Implements te::gm::Geometry.

◆ convexHull()

virtual Geometry * te::gm::Geometry::convexHull ( ) const

virtualinherited

This method calculates the Convex Hull of a geometry.

Returns: A geometry representing the convex hull.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; Performed by GEOS.

Referenced by te::rp::GetTPConvexHullArea().

◆ coveredBy()

virtual bool te::gm::Geometry::coveredBy ( const Geometry *const rhs ) const

virtualinherited

It returns true if this geometry object is spatially covered by rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially covered by the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This is not the same as within. See Max Egenhofer paper on 9-intersection matrix.; Performed by GEOS.

◆ covers()

virtual bool te::gm::Geometry::covers ( const Geometry *const rhs ) const

virtualinherited

It returns true if this geometry object spatially covers the rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially covers the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This is not the same as contains. See Max Egenhofer paper on 9-intersection matrix.; Performed by GEOS.

◆ crosses()

virtual bool te::gm::Geometry::crosses ( const Geometry *const rhs ) const

virtualinherited

It returns true if the geometry object spatially crosses rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially crosses the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ difference()

virtual Geometry * te::gm::Geometry::difference ( const Geometry *const rhs ) const

virtualinherited

It returns a geometric object that represents the point set difference with another geometry.

Parameters

rhs	Another geometry whose difference with this geometry will be calculated.

Returns: A geometry representing the difference between the geometries.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

◆ disjoint()

virtual bool te::gm::Geometry::disjoint ( const Geometry *const rhs ) const

virtualinherited

It returns true if the geometry object is spatially disjoint from rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially disjoint from the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

Referenced by te::rst::PolygonIterator< T >::getBBOXIntersectionRanges().

◆ distance()

virtual double te::gm::Geometry::distance ( const Geometry *const rhs ) const

virtualinherited

It returns the shortest distance between any two points in the two geometry objects.

Parameters

rhs	The other geometry.

Returns: The shortest distance between any two points in the two geometries.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

◆ dWithin()

virtual bool te::gm::Geometry::dWithin	(	const Geometry *const	rhs,
		const double &	distance
	)		const

virtualinherited

It returns true if the geometries are within the specified distance.

Parameters

rhs	The other geometry whose symetric difference with this geometry will be calculated.
distance	The distance.

Returns: True if the geometries are within the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.; Performed by GEOS.

◆ equals()

virtual bool te::gm::Geometry::equals	(	const Geometry *const	rhs,
		const bool	exact = `false`
	)		const

virtualinherited

It returns true if the geometry object is spatially equal to rhs geometry.

Parameters

rhs	The another geometry to be compared.
exact	If true checks if this geometric object has the same vertexes in the same order of rhs geometry.

Returns: True if the geometry is spatially equal to the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise an exception will be thrown.

Note: Performed by GEOS.

◆ get2DGeometryType()

virtual const std::string te::gm::Geometry::get2DGeometryType ( ) const

virtualinherited

It returns the name of 2D geometry subclass.

The name of the 2D geometry subclass may be one of the following:

Returns: The name of the geometry subclass type ide.

◆ get2DGeomTypeId()

virtual GeomType te::gm::Geometry::get2DGeomTypeId ( ) const

virtualinherited

It returns the 2D geometry subclass type identifier.

GeometryType = 0
PointType = 1
LineStringType = 2
PolygonType = 3
MultiPointType = 4
MultiLineStringType = 5
MultiPolygonType = 6
GeometryCollectionType = 7
CircularStringType = 8
CompoundCurveType = 9
CurvePolygonType = 10
MultiSurfaceType = 12

Returns: The 2D geometry subclass type identifier

Note: Please, see GeomType enumeration for possible return values.; TerraLib extended method.

◆ getArea()

double te::gm::CurvePolygon::getArea ( ) const

virtualinherited

It returns the area of this surface, as measured in the spatial reference system of this surface.

Returns: The area of this surface.

Implements te::gm::Surface.

◆ getBoundary()

virtual Geometry * te::gm::Geometry::getBoundary ( ) const

virtualinherited

It returns the geometry boundary.

Returns: The geometry that makes the boundary of this geometry. The caller of this method will take the ownership of the returned geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

◆ getCentroid()

Point * te::gm::CurvePolygon::getCentroid ( ) const

virtualinherited

It returns the mathematical centroid for this surface as a point.

Returns: The mathematical centroid for this surface.

Note: The caller of this method will take the ownership of the returned point.; The result is not guaranteed to be on this Surface.

Implements te::gm::Surface.

◆ getCentroidCoord()

Coord2D * te::gm::CurvePolygon::getCentroidCoord ( ) const

virtualinherited

It returns the mathematical centroid for this surface as a coordinate.

Returns: The mathematical centroid for this surface.

Note: The caller of this method will take the ownership of the returned coordinate.; The result is not guaranteed to be on this Surface.; TerraLib extended method.

Implements te::gm::Surface.

◆ getCoordinateDimension()

int te::gm::Geometry::getCoordinateDimension ( ) const

inherited

It returns the number of measurements or axes needed to describe a position in a coordinate system.

It returns:

2 for a coordinate with x, y;
3 for a coordinate with x, y and z or x, y and m;
4 for a coordinate with x, y, z and m.

Returns: The number of measurements or axes needed to describe a position in a coordinate system.

Note: This is NOT the same as getDimension() method!

◆ getCoordOnSurface()

Coord2D * te::gm::CurvePolygon::getCoordOnSurface ( ) const

virtualinherited

It returns a coordinate guaranteed to be on this surface.

Returns: A point guaranteed to be on this surface.

Note: The caller of this method will take the ownership of the returned coordinate.; TerraLib extended method.

Implements te::gm::Surface.

◆ getDimension()

Dimensionality te::gm::Surface::getDimension	(	)	const
throw	(
	)

virtualinherited

Surfaces are 2-dimensional objects.

Returns: 2-dimensional.

Implements te::gm::Geometry.

◆ getEnvelope()

Geometry * te::gm::Geometry::getEnvelope ( ) const

inherited

It returns the minimum bounding rectangle (MBR) for the geometry.

As one can notice, the mbr is returned as a geometry, actually a polygon defined by the corner points of the bounding box [(MINX, MINY), (MAXX, MINY), (MAXX, MAXY), (MINX, MAXY), (MINX, MINY)].

Returns: The geometry envelope (or mbr).

Note: The caller of this method will take the ownership of the returned geometry.; If the MBR was not computed previously, it will compute it. Successive calls to this method will not compute the mbr anymore.

◆ getExteriorRing()

Curve * te::gm::CurvePolygon::getExteriorRing ( ) const

inherited

It returns the exterior ring of this CurvePolygon.

Returns: The exterior ring of this CurvePolygon.

Note: Don't call this method for a empty polygon.

◆ getGeometryType()

virtual const std::string & te::gm::Polygon::getGeometryType	(	)	const
throw	(
	)

virtual

It returns the name of the instantiable subtype of Geometry of which this geometric object is an instantiable member.

The name of the Geometry subtype for Polygons is: Polygon.

Returns: The name of the instantiable subtype of Geometry of which this geometric object is an instantiable member. In this case, it returns Polygon.

Reimplemented from te::gm::CurvePolygon.

◆ getGeomTypeId() [1/2]

GeomType te::gm::Geometry::getGeomTypeId ( ) const

inlineinherited

It returns the geometry subclass type identifier.

Returns: The geometry subclass type identifier

Note: Please, see GeomType enumeration for possible return values.; TerraLib extended method.

Definition at line 182 of file Geometry.h.

◆ getGeomTypeId() [2/2]

static GeomType te::gm::Geometry::getGeomTypeId ( const std::string & gtype )

staticinherited

It returns the TerraLib geometry type id given a type string (the type string must be in capital letters).

Parameters

gtype The geometry type name.

Returns: The geometry type id equivalent to the string name.

Note: If the type is unknow it returns UnknownGeometryType.

◆ getGeomTypeString()

static std::string te::gm::Geometry::getGeomTypeString ( const int & gId )

staticinherited

It returns the TerraLib geometry type string given a type id.

Parameters

gId	The geometry type id.

Returns: The geometry type string equivalent to the id.

Note: If the type is unknow it returns UNKNOWGEOMETRYTYPE.

◆ getInteriorRingN()

Curve * te::gm::CurvePolygon::getInteriorRingN ( std::size_t i ) const

inherited

It returns the n-th interior ring for this curve polygon as a curve.

Parameters

i	The ring index.

Note: The interior ring index start at 0.; It doesn't check the index range.

◆ getMBR()

const Envelope * te::gm::Geometry::getMBR ( ) const

inherited

It returns the minimum bounding rectangle for the geometry in an internal representation.

The mbr can be constructed when reading a geometry from a database or it can be computed internally. So, if the mbr is not already set it will compute it just when this method is called. Successive calls to this method will not compute the mbr anymore.

Returns: The envelope of this geometry (i.e., the minimum bounding rectangle).

Note: It is supposed to be faster and more useful than getting the box as a polygon geometry.; TerraLib extended method.

◆ getNPoints()

std::size_t te::gm::CurvePolygon::getNPoints	(	)	const
throw	(
	)

virtualinherited

it returns the number of points (vertexes) in the geometry.

Returns: The number of points (vertexes) in the geometry.

Note: TerraLib extended method.

Implements te::gm::Geometry.

◆ getNumInteriorRings()

std::size_t te::gm::CurvePolygon::getNumInteriorRings ( ) const

inherited

It returns the number of interior rings in this CurvePolygon.

Returns: The number of interior rings in this CurvePolygon.

◆ getNumRings()

std::size_t te::gm::CurvePolygon::getNumRings ( ) const

inlineinherited

It returns the number of rings in this CurvePolygon.

Returns: The number of rings in this CurvePolygon.

Note: TerraLib extended method.

Definition at line 153 of file CurvePolygon.h.

◆ getPerimeter()

double te::gm::CurvePolygon::getPerimeter ( ) const

virtualinherited

It returns the length of the boundary for the surface.

Returns: The length of the boundary for the surface.

Implements te::gm::Surface.

◆ getPointOnSurface()

Point * te::gm::CurvePolygon::getPointOnSurface ( ) const

virtualinherited

It returns a point guaranteed to be on this surface.

Returns: A point guaranteed to be on this surface.

Note: The caller of this method will take the ownership of the returned point.

Implements te::gm::Surface.

◆ getRingN()

Curve * te::gm::CurvePolygon::getRingN ( std::size_t i ) const

inlineinherited

It returns the n-th ring for this curve polygon as a curve.

Parameters

i	The ring index.

Returns: The n-th ring.

Note: The ring index start at 0.; It doesn't check the index range.; TerraLib extended method.

Definition at line 193 of file CurvePolygon.h.

◆ getRings() [1/2]

std::vector< Curve * > & te::gm::CurvePolygon::getRings ( )

inlineinherited

It returns the polygon rings.

Returns: A reference to the list of rings.

Warning: Don't use this method unless you know exactly what you're doing!

Note: TerraLib extended method.

Definition at line 294 of file CurvePolygon.h.

◆ getRings() [2/2]

const std::vector< Curve * > & te::gm::CurvePolygon::getRings ( ) const

inlineinherited

It returns the polygon rings.

Returns: A reference to the list of rings.

Warning: Don't use this method unless you know exactly what you're doing!

Note: TerraLib extended method.

Definition at line 305 of file CurvePolygon.h.

◆ getSRID()

int te::gm::Geometry::getSRID ( ) const

inlineinherited

It returns the Spatial Reference System ID associated to this geometric object.

This value can be used to identify the associated Spatial Reference System.

Returns: The Spatial Reference System ID associated to this geometric object.

Note: When not set this value will be -1.

Definition at line 242 of file Geometry.h.

Referenced by te::rst::PolygonIterator< T >::getScanLineIntersectionRanges(), te::rst::PolygonIterator< T >::initialize(), and te::rst::LineIterator< T >::LineIterator().

◆ getTypeCode()

int te::gm::Geometry::getTypeCode ( ) const

virtualinherited

It returns the data type code associated to the data value.

Returns: The data type code associated to the data value.

Implements te::dt::AbstractData.

◆ getWkb()

void te::gm::Geometry::getWkb	(	char *	wkb,
		te::common::MachineByteOrder	byteOrder
	)		const

inherited

It serializes the geometry to a WKB representation into the specified buffer.

The wkb parameter must have at least getWkbSize() in order to be used. Don't pass a NULL pointer or a buffer smaller than the size needed. Note that the WKB will be on the specified byte order.

Parameters

wkb	The buffer where the Geometry will be serialized.
byteOrder	The byte order used to store/serialize the geometry.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.

◆ getWkbSize()

std::size_t te::gm::Geometry::getWkbSize ( ) const

inherited

It returns the size required by a WKB representation for this geometric object.

This is the preferred method for creating a WKB. First of all, it gives you the possibility to use a pre-allocated buffer. So, this method can be used in conjunction with the getWkb method.

Returns: The size required by a WKB representation for the geometry object.

Note: TerraLib extended method.

◆ intersection()

virtual Geometry * te::gm::Geometry::intersection ( const Geometry *const rhs ) const

virtualinherited

It returns a geometric object that represents the point set intersection with another geometry.

Parameters

rhs	The other Geometry whose intersection with this Geometry will be calculated.

Returns: A Geometry representing the intersection with this Geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

Referenced by te::rst::LineIterator< T >::LineIterator().

◆ intersects()

virtual bool te::gm::Geometry::intersects ( const Geometry *const rhs ) const

virtualinherited

It returns true if the geometry object spatially intersects rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry intersects the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ is3D()

bool te::gm::Geometry::is3D ( ) const

inherited

It returns true if this geometric object has z coordinate values.

Returns: True if this geometric object has z coordinate values.

◆ isCollection()

bool te::gm::Geometry::isCollection ( ) const

inherited

It returns true if this geometric object is a collection.

Returns: True if this geometric object is a collection.

◆ isEmpty()

virtual bool te::gm::Geometry::isEmpty ( ) const

virtualinherited

It returns true if this geometric object is the empty Geometry.

If true, then this geometric object represents the empty point set for the coordinate space.

Returns: True if this geometric object is the empty Geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

Referenced by te::rst::LineIterator< T >::LineIterator().

◆ isGeomType()

static bool te::gm::Geometry::isGeomType ( const std::string & stype )

staticinherited

It tells if the given string is a geometry data type.

Parameters

stype The geometry type to be checked.

Returns: True if the given string corresponds to a geometry type.

◆ isMeasured()

bool te::gm::Geometry::isMeasured ( ) const

inherited

It returns true if this geometric object has m coordinate values.

Returns: True if this geometric object has m coordinate values.

◆ isSimple()

virtual bool te::gm::Geometry::isSimple ( ) const

virtualinherited

It returns true if this geometric object has no anomalous points, such as self intersection or self tangency.

See the ISO and OGC documentation for an explanation about specific conditions of each type of geometry to be considered not simple.

Returns: True if this geometric object has no anomalous geometric points.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

◆ isValid()

virtual bool te::gm::Geometry::isValid ( ) const

virtualinherited

It tells if the geometry is well formed.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.; Performed by GEOS.

◆ loadGeomTypeId()

static void te::gm::Geometry::loadGeomTypeId ( )

staticinherited

It loads the internal MAP of geometry type names to geometry type ids.

Warning: Ths method will be automatically called when geometry module is initialized!

◆ locateAlong()

virtual Geometry * te::gm::Geometry::locateAlong ( const double & mValue ) const

inlinevirtualinherited

It returns a derived GeometryCollection value according to the specified coordinate value.

Parameters

mValue The coordinate value.

Returns: A GeometryCollection value.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; This method only applies to Point and Line geometries, including homogeneu collections of points or lines. For polygons this will return a NULL value.

Definition at line 695 of file Geometry.h.

◆ locateBetween()

virtual Geometry * te::gm::Geometry::locateBetween	(	const double &	mStart,
		const double &	mEnd
	)		const

virtualinherited

It returns a derived geometry collection value according to the range of coordinate values inclusively.

Parameters

mStart	The initial coordinate value.
mEnd	The final coordinate value.

Returns: A GeometryCollection value.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: This method only applies to Point and Line geometries, including homogeneous collections of points or lines. For polygons this will return a NULL value.; The caller of this method will take the ownership of the returned Geometry.

Reimplemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::LineString, te::gm::MultiLineString, and te::gm::MultiPoint.

◆ operator=()

virtual Polygon & te::gm::Polygon::operator= ( const Polygon & rhs )

virtual

Assignment operator.

Parameters

rhs	The other geometry.

Returns: A reference for this.

◆ operator[]() [1/2]

Curve * te::gm::CurvePolygon::operator[] ( std::size_t i )

inlineinherited

It returns the n-th ring.

Parameters

i	The coordinate index.

Note: The ring index start at 0.

Returns: The n-th ring.

Definition at line 223 of file CurvePolygon.h.

◆ operator[]() [2/2]

Curve * te::gm::CurvePolygon::operator[] ( std::size_t i ) const

inlineinherited

It returns the n-th ring.

Parameters

i	The coordinate index.

Returns: The n-th ring.

Note: The ring index start at 0.

Definition at line 208 of file CurvePolygon.h.

◆ overlaps()

virtual bool te::gm::Geometry::overlaps ( const Geometry *const rhs ) const

virtualinherited

It returns true if this geometry object spatially overlaps rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially overlaps the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ push_back()

void te::gm::CurvePolygon::push_back ( Curve * ring )

inherited

It adds the curve to the curve polygon.

Parameters

ring	The ring to be added.

Note: TerraLib extended method.

◆ relate() [1/2]

virtual std::string te::gm::Geometry::relate ( const Geometry *const rhs ) const

virtualinherited

It returns the spatial relation between this geometry object and the rhs geometry.

Parameters

rhs	The another geometry to be compared.

Returns: A string where each byte is a intersection in the pattern intersection matrix of the relationship of the two objects.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This method will be handy when you don't know the spatial relation in advance.; Performed by GEOS.

◆ relate() [2/2]

virtual bool te::gm::Geometry::relate	(	const Geometry *const	rhs,
		const std::string &	matrix
	)		const

virtualinherited

It returns true if this geometry object is spatially related to rhs geometry according to the pattern expressed by the intersection matrix.

It does this by testing for intersections between the interior, boundary and exterior of the two geometric objects as specified by the values in the matrix.

Parameters

rhs	The other geometry to be compared.
matrix	The intersection matrix.

Returns: True if the geometry is spatially related to the other geometry according to the pattern expressed by the intersection matrix.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ removeRingN()

void te::gm::CurvePolygon::removeRingN ( std::size_t i )

inherited

It removes the n-th ring in this CurvePolygon.

Parameters

i	The index of the ring we want to remove.

Note: The ring index start at 0.; The memory pointed by ring will be released.; It doesn't check the index range.; TerraLib extended method.

◆ setNumRings()

void te::gm::CurvePolygon::setNumRings ( std::size_t size )

inherited

It sets the number of rings in this curve polygon.

If the new size is less than the old it will drop the geometries.

Parameters

size	The new number of rings for the curve polygon.

Note: TerraLib extended method.

◆ setRingN()

void te::gm::CurvePolygon::setRingN	(	std::size_t	i,
		Curve *	r
	)

inherited

It sets the informed position ring to the new one.

Parameters

i	The ring index.
r	The new ring to be placed in the informed position.

Note: The ring index start at 0.; If the informed position contains a ring, it will be released.; It doesn't check the index range.; TerraLib extended method.

◆ setSRID()

void te::gm::CurvePolygon::setSRID	(	int	srid	)
throw	(
	)

virtualinherited

It sets the Spatial Reference System ID of the geometry and all its parts if it is a GeometryCollection (or a Multi).

Parameters

srid	The Spatial Reference System ID to be associated to the geometric object.

Note: This method just set the srid, it doesn't perform conversions over coordinate values.; TerraLib extended method.

Implements te::gm::Geometry.

◆ symDifference()

virtual Geometry * te::gm::Geometry::symDifference ( const Geometry *const rhs ) const

virtualinherited

It returns a geometric object that represents the point set symetric difference with another geometry.

Parameters

rhs	The other geometry whose symetric difference with this geometry will be calculated.

Returns: A geometry representing the symetric difference with this geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

◆ toString()

std::string te::gm::Geometry::toString ( void ) const

inlinevirtualinherited

It returns the data value in a WKT representation.

Returns: The data value in a WKT representation.

Implements te::dt::AbstractData.

Definition at line 953 of file Geometry.h.

◆ touches()

virtual bool te::gm::Geometry::touches ( const Geometry *const rhs ) const

virtualinherited

It returns true if the geometry object spatially touches rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially touches the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

◆ transform()

virtual void te::gm::Geometry::transform ( const int & srid )

virtualinherited

It converts the coordinate values of the geometry to the new spatial reference system.

After calling this method the geometry will be associated to the new SRID.

Parameters

srid	The new Spatial Reference System ID used to transform the coordinates of the geometry.

Exceptions

Exception It will throw an exception if it can not do the transformation.

Note: The geometry must be associated to a valid SRID before calling this method.; If the geometry already has an associated MBR, this method will automatically update it (i. e. automatically recompute it).

◆ Union()

virtual Geometry * te::gm::Geometry::Union ( const Geometry *const rhs ) const

virtualinherited

It returns a geometric object that represents the point set union with another geometry.

Parameters

rhs	Another geometry whose union with this geometry will be calculated.

Returns: A geometry representing the union with this geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

◆ within()

virtual bool te::gm::Geometry::within ( const Geometry *const rhs ) const

virtualinherited

It returns true if the geometry object is spatially within rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially within the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

Member Data Documentation

◆ m_gType

GeomType te::gm::Geometry::m_gType

protectedinherited

Internal geometry type.

Definition at line 959 of file Geometry.h.

◆ m_mbr

Envelope* te::gm::Geometry::m_mbr

mutableprotectedinherited

The geometry minimum bounding rectangle.

Definition at line 961 of file Geometry.h.

◆ m_rings

std::vector<Curve*> te::gm::CurvePolygon::m_rings

privateinherited

An array with the ring list.

Definition at line 433 of file CurvePolygon.h.

◆ m_srid

int te::gm::Geometry::m_srid

protectedinherited

The Spatial Reference System code associated to the Geometry.

Definition at line 960 of file Geometry.h.

◆ sm_geomTypeMap

std::map<std::string, GeomType> te::gm::Geometry::sm_geomTypeMap

staticprotectedinherited

A set of geometry type names (in UPPER CASE).

Definition at line 963 of file Geometry.h.

◆ sm_typeName

const std::string te::gm::Polygon::sm_typeName

staticprivate

Definition at line 136 of file Polygon.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/geometry/Polygon.h

Public Types

Public Member Functions

Static Public Member Functions

Re-Implmentation of methods from Geometry class

Re-Implmentation of methods from Geometry class

AbstractData Re-implementation

Detailed Description

Member Typedef Documentation

◆ ReturnType

◆ VisitorType

Constructor & Destructor Documentation

◆ Polygon() [1/2]

◆ Polygon() [2/2]

◆ ~Polygon()

Member Function Documentation

◆ accept()

◆ add()

◆ asBinary()

◆ asText()

◆ buffer() [1/3]

◆ buffer() [2/3]

◆ buffer() [3/3]

◆ clear()

◆ clone()

◆ computeMBR()

◆ contains()

◆ convert()

◆ convexHull()

◆ coveredBy()

◆ covers()

◆ crosses()

◆ difference()

◆ disjoint()

◆ distance()

◆ dWithin()

◆ equals()

◆ get2DGeometryType()

◆ get2DGeomTypeId()

◆ getArea()

◆ getBoundary()

◆ getCentroid()

◆ getCentroidCoord()

◆ getCoordinateDimension()

◆ getCoordOnSurface()

◆ getDimension()

◆ getEnvelope()

◆ getExteriorRing()

◆ getGeometryType()

◆ getGeomTypeId() [1/2]

◆ getGeomTypeId() [2/2]

◆ getGeomTypeString()

◆ getInteriorRingN()

◆ getMBR()

◆ getNPoints()

◆ getNumInteriorRings()

◆ getNumRings()

◆ getPerimeter()

◆ getPointOnSurface()

◆ getRingN()

◆ getRings() [1/2]

◆ getRings() [2/2]

◆ getSRID()

◆ getTypeCode()

◆ getWkb()

◆ getWkbSize()

◆ intersection()

◆ intersects()

◆ is3D()

◆ isCollection()

◆ isEmpty()

◆ isGeomType()

◆ isMeasured()

◆ isSimple()

◆ isValid()

◆ loadGeomTypeId()

◆ locateAlong()

◆ locateBetween()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]