Geometry collection. More...

#include <qgsgeometrycollectionv2.h>

Inheritance diagram for QgsGeometryCollectionV2:

Public Member Functions
	QgsGeometryCollectionV2 ()

	QgsGeometryCollectionV2 (const QgsGeometryCollectionV2 &c)

virtual	~QgsGeometryCollectionV2 ()

virtual bool	addGeometry (QgsAbstractGeometryV2 *g)
	Adds a geometry and takes ownership. More...

virtual double	area () const override
	Returns the area of the geometry. More...

QDomElement	asGML2 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override
	Returns a GML2 representation of the geometry. More...

QDomElement	asGML3 (QDomDocument &doc, int precision=17, const QString &ns="gml") const override
	Returns a GML3 representation of the geometry. More...

QString	asJSON (int precision=17) const override
	Returns a GeoJSON representation of the geometry. More...

unsigned char *	asWkb (int &binarySize) const override
	Returns a WKB representation of the geometry. More...

QString	asWkt (int precision=17) const override
	Returns a WKT representation of the geometry. More...

virtual QgsRectangle	calculateBoundingBox () const override
	Calculates the minimal bounding box for the geometry. More...

virtual void	clear () override
	Clears the geometry, ie reset it to a null geometry. More...

virtual QgsAbstractGeometryV2 *	clone () const override
	Clones the geometry by performing a deep copy. More...

virtual double	closestSegment (const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon) const override
	Searches for the closest segment of the geometry to a given point. More...

virtual void	coordinateSequence (QList< QList< QList< QgsPointV2 > > > &coord) const override
	Retrieves the sequence of geometries, rings and nodes. More...

virtual bool	deleteVertex (const QgsVertexId &position) override
	Deletes a vertex within the geometry. More...

virtual int	dimension () const override
	Returns the inherent dimension of the geometry. More...

virtual void	draw (QPainter &p) const override
	Draws the geometry using the specified QPainter. More...

bool	fromWkb (const unsigned char *wkb) override
	Sets the geometry from a WKB string. More...

virtual bool	fromWkt (const QString &wkt) override
	Sets the geometry from a WKT string. More...

const QgsAbstractGeometryV2 *	geometryN (int n) const
	Returns a const reference to a geometry from within the collection. More...

QgsAbstractGeometryV2 *	geometryN (int n)
	Returns a geometry from within the collection. More...

virtual QString	geometryType () const override
	Returns a unique string representing the geometry type. More...

bool	hasCurvedSegments () const override
	Returns true if the geometry contains curved segments. More...

virtual bool	insertVertex (const QgsVertexId &position, const QgsPointV2 &vertex) override
	Inserts a vertex into the geometry. More...

virtual double	length () const override
	Returns the length (or perimeter for area geometries) of the geometry. More...

virtual bool	moveVertex (const QgsVertexId &position, const QgsPointV2 &newPos) override
	Moves a vertex within the geometry. More...

bool	nextVertex (QgsVertexId &id, QgsPointV2 &vertex) const override
	Returns next vertex id and coordinates. More...

int	numGeometries () const
	Returns the number of geometries within the collection. More...

QgsGeometryCollectionV2 &	operator= (const QgsGeometryCollectionV2 &c)

virtual bool	removeGeometry (int nr)
	Removes a geometry from the collection. More...

QgsAbstractGeometryV2 *	segmentize () const override
	Returns a geometry without curves. More...

virtual void	transform (const QgsCoordinateTransform &ct) override
	Transforms the geometry using a coordinate transform. More...

void	transform (const QTransform &t) override
	Transforms the geometry using a QTransform object. More...

int	wkbSize () const override
	Returns the size of the WKB representation of the geometry. More...

Public Member Functions inherited from QgsAbstractGeometryV2
	QgsAbstractGeometryV2 ()

	QgsAbstractGeometryV2 (const QgsAbstractGeometryV2 &geom)

virtual	~QgsAbstractGeometryV2 ()

QgsRectangle	boundingBox () const
	Returns the minimal bounding box for the geometry. More...

bool	is3D () const
	Returns true if the geometry is 3D and contains a z-value. More...

bool	isEmpty () const
	Returns true if the geometry is empty. More...

bool	isMeasure () const
	Returns true if the geometry contains m values. More...

int	nCoordinates () const
	Returns the number of nodes contained in the geometry. More...

virtual QgsAbstractGeometryV2 &	operator= (const QgsAbstractGeometryV2 &geom)

QgsPointV2	vertexAt (const QgsVertexId &id) const
	Returns the point corresponding to a specified vertex id. More...

QgsWKBTypes::Type	wkbType () const
	Returns the WKB type of the geometry. More...

QString	wktTypeStr () const
	Returns the WKT type string of the geometry. More...

Protected Member Functions
bool	fromCollectionWkt (const QString &wkt, const QList< QgsAbstractGeometryV2 * > &subtypes, const QString &defaultChildWkbType=QString())
	Reads a collection from a WKT string. More...

Protected Member Functions inherited from QgsAbstractGeometryV2
void	setZMTypeFromSubGeometry (const QgsAbstractGeometryV2 *subggeom, QgsWKBTypes::Type baseGeomType)
	Updates the geometry type based on whether sub geometries contain z or m values. More...

Protected Attributes
QVector< QgsAbstractGeometryV2 * >	mGeometries

Protected Attributes inherited from QgsAbstractGeometryV2
QgsRectangle	mBoundingBox

QgsWKBTypes::Type	mWkbType

Additional Inherited Members
Static Protected Member Functions inherited from QgsAbstractGeometryV2
static bool	readWkbHeader (QgsConstWkbPtr &wkbPtr, QgsWKBTypes::Type &wkbType, bool &endianSwap, QgsWKBTypes::Type expectedType)
	Reads a WKB header and tests its validity. More...

Detailed Description

Geometry collection.

Note: added in QGIS 2.10; this API is not considered stable and may change for 2.12

Definition at line 28 of file qgsgeometrycollectionv2.h.

Constructor & Destructor Documentation

QgsGeometryCollectionV2::QgsGeometryCollectionV2 ( )

Definition at line 27 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2::QgsGeometryCollectionV2 ( const QgsGeometryCollectionV2 & c )

Definition at line 32 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2::~QgsGeometryCollectionV2 ( )

virtual

Definition at line 57 of file qgsgeometrycollectionv2.cpp.

Member Function Documentation

bool QgsGeometryCollectionV2::addGeometry ( QgsAbstractGeometryV2 * g )

virtual

Adds a geometry and takes ownership.

Returns true in case of success.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 97 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::area ( ) const

overridevirtual

Returns the area of the geometry.

See Also: length

Reimplemented from QgsAbstractGeometryV2.

Definition at line 418 of file qgsgeometrycollectionv2.cpp.

QDomElement QgsGeometryCollectionV2::asGML2	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`
	)		const

overridevirtual

Returns a GML2 representation of the geometry.

Parameters

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace

See Also: asWkb; asWkt; asGML3; asJSON

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 267 of file qgsgeometrycollectionv2.cpp.

QDomElement QgsGeometryCollectionV2::asGML3	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`
	)		const

overridevirtual

Returns a GML3 representation of the geometry.

Parameters

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace

See Also: asWkb; asWkt; asGML2; asJSON

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 279 of file qgsgeometrycollectionv2.cpp.

QString QgsGeometryCollectionV2::asJSON ( int precision = 17 ) const

overridevirtual

Returns a GeoJSON representation of the geometry.

Parameters

precision number of decimal places for coordinates

See Also: asWkb; asWkt; asGML2; asGML3

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 291 of file qgsgeometrycollectionv2.cpp.

unsigned char * QgsGeometryCollectionV2::asWkb ( int & binarySize ) const

overridevirtual

Returns a WKB representation of the geometry.

Parameters

binarySize will be set to the size of the returned WKB string

See Also: wkbSize; asWkt; asGML2; asGML3; asJSON

Implements QgsAbstractGeometryV2.

Definition at line 222 of file qgsgeometrycollectionv2.cpp.

QString QgsGeometryCollectionV2::asWkt ( int precision = 17 ) const

overridevirtual

Returns a WKT representation of the geometry.

Parameters

precision number of decimal places for coordinates

See Also: asWkb; asGML2; asGML3; asJSON

Implements QgsAbstractGeometryV2.

Definition at line 244 of file qgsgeometrycollectionv2.cpp.

QgsRectangle QgsGeometryCollectionV2::calculateBoundingBox ( ) const

overridevirtual

Calculates the minimal bounding box for the geometry.

Derived classes should override this method to return the correct bounding box.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 306 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::clear ( )

overridevirtual

Clears the geometry, ie reset it to a null geometry.

Implements QgsAbstractGeometryV2.

Definition at line 67 of file qgsgeometrycollectionv2.cpp.

QgsAbstractGeometryV2 * QgsGeometryCollectionV2::clone ( ) const

overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 62 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::closestSegment	(	const QgsPointV2 &	pt,
		QgsPointV2 &	segmentPt,
		QgsVertexId &	vertexAfter,
		bool *	leftOf,
		double	epsilon
	)		const

overridevirtual

Searches for the closest segment of the geometry to a given point.

Parameters

pt	Specifies the point for search
segmentPt	storage for the closest point within the geometry
vertexAfter	storage for the id of the vertex after the closest segment
leftOf	returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
epsilon	epsilon for segment snapping

Returns: squared distance to closest segment

Implements QgsAbstractGeometryV2.

Definition at line 338 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::coordinateSequence ( QList< QList< QList< QgsPointV2 > > > & coord ) const

overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Parameters

coord destination for coordinate sequence.

Implements QgsAbstractGeometryV2.

Definition at line 322 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::deleteVertex ( const QgsVertexId & position )

overridevirtual

Deletes a vertex within the geometry.

Parameters

position vertex id for vertex to delete

Returns: true if delete was successful

See Also: insertVertex; moveVertex

Implements QgsAbstractGeometryV2.

Definition at line 383 of file qgsgeometrycollectionv2.cpp.

int QgsGeometryCollectionV2::dimension ( ) const

overridevirtual

Returns the inherent dimension of the geometry.

For example, this is 0 for a point geometry, 1 for a linestring and 2 for a polygon.

Implements QgsAbstractGeometryV2.

Definition at line 118 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::draw ( QPainter & p ) const

overridevirtual

Draws the geometry using the specified QPainter.

Parameters

p	destination QPainter

Implements QgsAbstractGeometryV2.

Definition at line 162 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::fromCollectionWkt	(	const QString &	wkt,
		const QList< QgsAbstractGeometryV2 * > &	subtypes,
		const QString &	defaultChildWkbType = `QString()`
	)

protected

Reads a collection from a WKT string.

Definition at line 429 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::fromWkb ( const unsigned char * wkb )

overridevirtual

Sets the geometry from a WKB string.

See Also: fromWkt

Implements QgsAbstractGeometryV2.

Definition at line 171 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::fromWkt ( const QString & wkt )

overridevirtual

Sets the geometry from a WKT string.

See Also: fromWkb

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 203 of file qgsgeometrycollectionv2.cpp.

const QgsAbstractGeometryV2 * QgsGeometryCollectionV2::geometryN ( int n ) const

Returns a const reference to a geometry from within the collection.

Parameters

n	index of geometry to return

Definition at line 79 of file qgsgeometrycollectionv2.cpp.

QgsAbstractGeometryV2 * QgsGeometryCollectionV2::geometryN ( int n )

Returns a geometry from within the collection.

Parameters

n	index of geometry to return

Definition at line 88 of file qgsgeometrycollectionv2.cpp.

virtual QString QgsGeometryCollectionV2::geometryType ( ) const

inlineoverridevirtual

Returns a unique string representing the geometry type.

See Also: wkbType; wktTypeStr

Implements QgsAbstractGeometryV2.

Reimplemented in QgsMultiCurveV2, QgsMultiLineStringV2, QgsMultiPointV2, QgsMultiPolygonV2, and QgsMultiSurfaceV2.

Definition at line 54 of file qgsgeometrycollectionv2.h.

bool QgsGeometryCollectionV2::hasCurvedSegments ( ) const

overridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 469 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::insertVertex	(	const QgsVertexId &	position,
		const QgsPointV2 &	vertex
	)

overridevirtual

Inserts a vertex into the geometry.

Parameters

position	vertex id for position of inserted vertex
vertex	vertex to insert

Returns: true if insert was successful

See Also: moveVertex; deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 363 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::length ( ) const

overridevirtual

Returns the length (or perimeter for area geometries) of the geometry.

See Also: area

Reimplemented from QgsAbstractGeometryV2.

Definition at line 407 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::moveVertex	(	const QgsVertexId &	position,
		const QgsPointV2 &	newPos
	)

overridevirtual

Moves a vertex within the geometry.

Parameters

position	vertex id for vertex to move
newPos	new position of vertex

Returns: true if move was successful

See Also: insertVertex; deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 373 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::nextVertex	(	QgsVertexId &	id,
		QgsPointV2 &	vertex
	)		const

overridevirtual

Returns next vertex id and coordinates.

Parameters

id	initial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertex	container for found node

Returns: false if at end

Implements QgsAbstractGeometryV2.

Definition at line 343 of file qgsgeometrycollectionv2.cpp.

int QgsGeometryCollectionV2::numGeometries ( ) const

Returns the number of geometries within the collection.

Definition at line 74 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2 & QgsGeometryCollectionV2::operator= ( const QgsGeometryCollectionV2 & c )

Definition at line 42 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::removeGeometry ( int nr )

virtual

Removes a geometry from the collection.

Parameters

nr	index of geometry to remove

Returns: true if removal was successful.

Definition at line 108 of file qgsgeometrycollectionv2.cpp.

QgsAbstractGeometryV2 * QgsGeometryCollectionV2::segmentize ( ) const

overridevirtual

Returns a geometry without curves.

Caller takes ownership

Reimplemented from QgsAbstractGeometryV2.

Definition at line 482 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::transform ( const QgsCoordinateTransform & ct )

overridevirtual

Transforms the geometry using a coordinate transform.

Parameters

ct	coordinate transform

Implements QgsAbstractGeometryV2.

Definition at line 133 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::transform ( const QTransform & t )

overridevirtual

Transforms the geometry using a QTransform object.

Parameters

t	QTransform transformation

Implements QgsAbstractGeometryV2.

Definition at line 142 of file qgsgeometrycollectionv2.cpp.

int QgsGeometryCollectionV2::wkbSize ( ) const

overridevirtual

Returns the size of the WKB representation of the geometry.

See Also: asWkb

Implements QgsAbstractGeometryV2.

Definition at line 209 of file qgsgeometrycollectionv2.cpp.

Member Data Documentation

QVector< QgsAbstractGeometryV2* > QgsGeometryCollectionV2::mGeometries

protected

Definition at line 102 of file qgsgeometrycollectionv2.h.

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

/tmp/buildd/qgis-2.10.1+git20150822+dd4475c+20trusty/src/core/geometry/qgsgeometrycollectionv2.h
/tmp/buildd/qgis-2.10.1+git20150822+dd4475c+20trusty/src/core/geometry/qgsgeometrycollectionv2.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation