GEOS 3.11.1
Public Member Functions | Protected Attributes | Friends | List of all members
geos::operation::polygonize::Polygonizer Class Reference

Polygonizes a set of Geometrys which contain linework that represents the edges of a planar graph. More...

#include <Polygonizer.h>

Public Member Functions

 Polygonizer (bool onlyPolygonal=false)
 Create a Polygonizer with the same GeometryFactory as the input Geometrys. More...
 
void add (std::vector< geom::Geometry * > *geomList)
 Add a collection of geometries to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used. More...
 
void add (std::vector< const geom::Geometry * > *geomList)
 Add a collection of geometries to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used. More...
 
void add (geom::Geometry *g)
 
void add (const geom::Geometry *g)
 
std::vector< std::unique_ptr< geom::Polygon > > getPolygons ()
 Gets the list of polygons formed by the polygonization. More...
 
const std::vector< const geom::LineString * > & getDangles ()
 Get the list of dangling lines found during polygonization. More...
 
bool hasDangles ()
 
const std::vector< const geom::LineString * > & getCutEdges ()
 Get the list of cut edges found during polygonization. More...
 
bool hasCutEdges ()
 
const std::vector< std::unique_ptr< geom::LineString > > & getInvalidRingLines ()
 Get the list of lines forming invalid rings found during polygonization. More...
 
bool hasInvalidRingLines ()
 
bool allInputsFormPolygons ()
 

Protected Attributes

std::unique_ptr< PolygonizeGraphgraph
 
std::vector< const geom::LineString * > dangles
 
std::vector< const geom::LineString * > cutEdges
 
std::vector< std::unique_ptr< geom::LineString > > invalidRingLines
 
std::vector< EdgeRing * > holeList
 
std::vector< EdgeRing * > shellList
 
std::vector< std::unique_ptr< geom::Polygon > > polyList
 

Friends

class Polygonizer::LineStringAdder
 

Detailed Description

Polygonizes a set of Geometrys which contain linework that represents the edges of a planar graph.

All types of Geometry are accepted as input; the constituent linework is extracted as the edges to be polygonized. The edges must be correctly noded; that is, they must only meet at their endpoints. Polygonization will accept incorrectly noded input but will not form polygons from non-noded edges, and reports them as errors.

The Polygonizer reports the follow kinds of errors:

Constructor & Destructor Documentation

◆ Polygonizer()

geos::operation::polygonize::Polygonizer::Polygonizer ( bool  onlyPolygonal = false)
explicit

Create a Polygonizer with the same GeometryFactory as the input Geometrys.

Parameters
onlyPolygonaltrue if only polygons which form a valid polygonal geometry should be extracted

Member Function Documentation

◆ add() [1/4]

void geos::operation::polygonize::Polygonizer::add ( const geom::Geometry g)

Add a geometry to the linework to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used

Parameters
ga Geometry with linework to be polygonized

◆ add() [2/4]

void geos::operation::polygonize::Polygonizer::add ( geom::Geometry g)

Add a geometry to the linework to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used

Parameters
ga Geometry with linework to be polygonized

◆ add() [3/4]

void geos::operation::polygonize::Polygonizer::add ( std::vector< const geom::Geometry * > *  geomList)

Add a collection of geometries to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used.

Parameters
geomLista list of Geometry with linework to be polygonized

◆ add() [4/4]

void geos::operation::polygonize::Polygonizer::add ( std::vector< geom::Geometry * > *  geomList)

Add a collection of geometries to be polygonized. May be called multiple times. Any dimension of Geometry may be added; the constituent linework will be extracted and used.

Parameters
geomLista list of Geometry with linework to be polygonized

◆ getCutEdges()

const std::vector< const geom::LineString * > & geos::operation::polygonize::Polygonizer::getCutEdges ( )

Get the list of cut edges found during polygonization.

Returns
a (possibly empty) collection of pointers to the input LineStrings which are cut edges.

◆ getDangles()

const std::vector< const geom::LineString * > & geos::operation::polygonize::Polygonizer::getDangles ( )

Get the list of dangling lines found during polygonization.

Returns
a (possibly empty) collection of pointers to the input LineStrings which are dangles.

◆ getInvalidRingLines()

const std::vector< std::unique_ptr< geom::LineString > > & geos::operation::polygonize::Polygonizer::getInvalidRingLines ( )

Get the list of lines forming invalid rings found during polygonization.

Returns
a (possibly empty) collection of pointers to the input LineStrings which form invalid rings

◆ getPolygons()

std::vector< std::unique_ptr< geom::Polygon > > geos::operation::polygonize::Polygonizer::getPolygons ( )

Gets the list of polygons formed by the polygonization.

Ownership of vector is transferred to caller, subsequent calls will return NULL.

Returns
a collection of Polygons

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