SFCGAL: SFCGAL::Geometry Class Reference

OGC/SFA based Geometry abstract class. More...

#include <Geometry.h>

Inheritance diagram for SFCGAL::Geometry:

Public Member Functions
	Geometry ()
	Default constructor. More...

	Geometry (const Geometry &)=default
	Copy constructor. More...

Geometry &	operator= (const Geometry &other)=default
	Copy assignemnt operator. More...

virtual	~Geometry ()=default
	Destructor. More...

virtual Geometry *	clone () const =0
	Get a deep copy of the geometry. More...

virtual std::string	geometryType () const =0
	[OGC/SFA]returns the geometry type More...

virtual GeometryType	geometryTypeId () const =0
	Returns a code corresponding to the type. More...

virtual int	dimension () const =0
	[OGC/SFA]Dimension of the Geometry ( 0 : punctual, 1 : curve, ...) More...

virtual int	coordinateDimension () const =0
	[OGC/SFA]returns the dimension of the coordinates More...

virtual bool	isEmpty () const =0
	[OGC/SFA]test if geometry is empty More...

virtual bool	is3D () const =0
	[OGC/SFA]test if geometry is 3d More...

virtual bool	isMeasured () const =0
	[OGC/SFA]test if geometry is measured (has an m) More...

void	forceValidityFlag (bool validity)
	Force the state of the validity flag. More...

bool	hasValidityFlag () const
	Returns the validity flag. More...

std::string	asText (const int &numDecimals=-1) const
	[OGC/SFA]returns the WKT string More...

Envelope	envelope () const
	[OGC/SFA]Returns a polygon representing the BBOX of the geometry More...

virtual std::unique_ptr< Geometry >	boundary () const
	[OGC/SFA]Returns the boundary of the geometry More...

double	distance (const Geometry &other) const
	Computes the distance to an other geometry. More...

double	distance3D (const Geometry &other) const
	Computes the 3D distance to an other geometry. More...

void	round (const long &scale=1)
	round the geometry with a corresponding scale factor More...

auto	almostEqual (const Geometry &, const double tolerance) const -> bool
	Equality operator. More...

virtual size_t	numGeometries () const
	[OGC/SFA]Gets the number of geometries in a collection of geometries More...

virtual const Geometry &	geometryN (size_t const &n) const
	[OGC/SFA]Returns the n-th geometry More...

virtual Geometry &	geometryN (size_t const &n)
	[OGC/SFA]Returns the n-th geometry More...

template<typename Derived >
bool	is () const
	Tests if geometry is of "Derived" type given as template parameter. More...

template<typename Derived >
const Derived &	as () const
	Downcast to a "Derived" class. More...

template<typename Derived >
Derived &	as ()
	Downcast to a "Derived" class. More...

virtual void	accept (GeometryVisitor &visitor)=0
	[visitor]dispatch visitor More...

virtual void	accept (ConstGeometryVisitor &visitor) const =0
	[visitor]dispatch visitor More...

template<class Archive >
void	serialize (Archive &, const unsigned int)
	Serializer. More...

Protected Attributes
bool	validityFlag_

Detailed Description

OGC/SFA based Geometry abstract class.

Constructor & Destructor Documentation

◆ Geometry() [1/2]

SFCGAL::Geometry::Geometry ( )

Default constructor.

◆ Geometry() [2/2]

SFCGAL::Geometry::Geometry ( const Geometry & )

default

Copy constructor.

◆ ~Geometry()

virtual SFCGAL::Geometry::~Geometry ( )

virtualdefault

Destructor.

Member Function Documentation

◆ almostEqual()

auto SFCGAL::Geometry::almostEqual	(	const Geometry &	other,
		const double	tolerance
	)		const -> bool

Equality operator.

Todo:: only compare coordinate points

Precondition: the two geometries must be valid

◆ as() [1/2]

template<typename Derived >

Derived & SFCGAL::Geometry::as ( )

inline

Downcast to a "Derived" class.

Warning: performs check if boost assertions are enabled

Precondition: The cast must be doable

◆ as() [2/2]

template<typename Derived >

const Derived & SFCGAL::Geometry::as ( ) const

inline

Downcast to a "Derived" class.

Warning: performs check if boost assertions are enabled

Precondition: The cast must be doable

◆ asText()

auto SFCGAL::Geometry::asText ( const int & numDecimals = -1 ) const

[OGC/SFA]returns the WKT string

Parameters

numDecimals extension specify fix precision output

◆ boundary()

auto SFCGAL::Geometry::boundary ( ) const

virtual

[OGC/SFA]Returns the boundary of the geometry

◆ clone()

virtual Geometry * SFCGAL::Geometry::clone ( ) const

pure virtual

Get a deep copy of the geometry.

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::MultiLineString, SFCGAL::MultiPoint, SFCGAL::MultiPolygon, SFCGAL::MultiSolid, SFCGAL::Point, SFCGAL::Polygon, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Triangle, and SFCGAL::TriangulatedSurface.

◆ coordinateDimension()

virtual int SFCGAL::Geometry::coordinateDimension ( ) const

pure virtual

[OGC/SFA]returns the dimension of the coordinates

Precondition: suppose no mix of 2D/3D coordinates

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::Point, SFCGAL::Polygon, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Triangle, and SFCGAL::TriangulatedSurface.

◆ dimension()

virtual int SFCGAL::Geometry::dimension ( ) const

pure virtual

[OGC/SFA]Dimension of the Geometry ( 0 : punctual, 1 : curve, ...)

Warning: empty geometries provide the dimension corresponding to the object

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::Point, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Surface, and SFCGAL::TriangulatedSurface.

◆ distance()

auto SFCGAL::Geometry::distance ( const Geometry & other ) const

Computes the distance to an other geometry.

◆ distance3D()

auto SFCGAL::Geometry::distance3D ( const Geometry & other ) const

Computes the 3D distance to an other geometry.

◆ envelope()

auto SFCGAL::Geometry::envelope ( ) const

[OGC/SFA]Returns a polygon representing the BBOX of the geometry

Todo:: In order to adapt to 3D, would be better to define an "Envelope type", otherway would lead to Polygon and PolyhedralSurface

◆ forceValidityFlag()

void SFCGAL::Geometry::forceValidityFlag ( bool validity )

Force the state of the validity flag.

The validity flag allows to bypass validity checks If the flag is true, it means the geometry is considered valid If the flag is false, it means the validity state of the geometry is unknown The flag is only changed for this geometry and not the internal geometries.

See also: propagateValidityFlag

◆ geometryN() [1/2]

auto SFCGAL::Geometry::geometryN ( size_t const & n )

virtual

[OGC/SFA]Returns the n-th geometry

Warning: *this for Point, LineString, Polygon, Triangle

Reimplemented in SFCGAL::GeometryCollection, SFCGAL::PolyhedralSurface, and SFCGAL::TriangulatedSurface.

◆ geometryN() [2/2]

auto SFCGAL::Geometry::geometryN ( size_t const & n ) const

virtual

[OGC/SFA]Returns the n-th geometry

Warning: *this for Point, LineString, Polygon, Triangle

Reimplemented in SFCGAL::GeometryCollection, SFCGAL::PolyhedralSurface, and SFCGAL::TriangulatedSurface.

◆ geometryType()

virtual std::string SFCGAL::Geometry::geometryType ( ) const

pure virtual

[OGC/SFA]returns the geometry type

Warning: use CamelCase (LineString, not LINESTRING)

◆ geometryTypeId()

virtual GeometryType SFCGAL::Geometry::geometryTypeId ( ) const

pure virtual

Returns a code corresponding to the type.

Warning: not standard

◆ hasValidityFlag()

auto SFCGAL::Geometry::hasValidityFlag ( ) const

Returns the validity flag.

◆ is()

template<typename Derived >

bool SFCGAL::Geometry::is ( ) const

inline

Tests if geometry is of "Derived" type given as template parameter.

Warning: not optimized (slow with dynamic_cast)

◆ is3D()

virtual bool SFCGAL::Geometry::is3D ( ) const

pure virtual

[OGC/SFA]test if geometry is 3d

Precondition: suppose no mix of 2D/3D coordinates

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::Point, SFCGAL::Polygon, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Triangle, and SFCGAL::TriangulatedSurface.

◆ isEmpty()

virtual bool SFCGAL::Geometry::isEmpty ( ) const

pure virtual

[OGC/SFA]test if geometry is empty

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::Point, SFCGAL::Polygon, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Triangle, and SFCGAL::TriangulatedSurface.

◆ isMeasured()

virtual bool SFCGAL::Geometry::isMeasured ( ) const

pure virtual

[OGC/SFA]test if geometry is measured (has an m)

Precondition: suppose no mix of M/!M points

Implemented in SFCGAL::GeometryCollection, SFCGAL::LineString, SFCGAL::Point, SFCGAL::Polygon, SFCGAL::PolyhedralSurface, SFCGAL::Solid, SFCGAL::Triangle, and SFCGAL::TriangulatedSurface.

◆ numGeometries()

auto SFCGAL::Geometry::numGeometries ( ) const

virtual

[OGC/SFA]Gets the number of geometries in a collection of geometries

Warning: 1 for Point, LineString, Polygon, Triangle

Reimplemented in SFCGAL::GeometryCollection, SFCGAL::PolyhedralSurface, and SFCGAL::TriangulatedSurface.

◆ operator=()

Geometry & SFCGAL::Geometry::operator= ( const Geometry & other )

default

Copy assignemnt operator.

◆ round()

void SFCGAL::Geometry::round ( const long & scale = 1 )

round the geometry with a corresponding scale factor

Parameters

scale the scale factor (1 corresponds to the nearest integer, 1000 to a 0.001 tolerance)

Member Data Documentation

◆ validityFlag_

bool SFCGAL::Geometry::validityFlag_

protected

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Geometry() [1/2]

◆ Geometry() [2/2]

◆ ~Geometry()

Member Function Documentation

◆ almostEqual()

◆ as() [1/2]

◆ as() [2/2]

◆ asText()

◆ boundary()

◆ clone()

◆ coordinateDimension()

◆ dimension()

◆ distance()

◆ distance3D()

◆ envelope()

◆ forceValidityFlag()

◆ geometryN() [1/2]

◆ geometryN() [2/2]

◆ geometryType()

◆ geometryTypeId()

◆ hasValidityFlag()

◆ is()

◆ is3D()

◆ isEmpty()

◆ isMeasured()

◆ numGeometries()

◆ operator=()

◆ round()

Member Data Documentation

◆ validityFlag_