QGIS API Documentation  2.12.0-Lyon
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsGeometryCollectionV2 Class Reference

Geometry collection. More...

#include <qgsgeometrycollectionv2.h>

Inheritance diagram for QgsGeometryCollectionV2:
Inheritance graph
[legend]

Public Member Functions

 QgsGeometryCollectionV2 ()
 
 QgsGeometryCollectionV2 (const QgsGeometryCollectionV2 &c)
 
virtual ~QgsGeometryCollectionV2 ()
 
virtual bool addGeometry (QgsAbstractGeometryV2 *g)
 Adds a geometry and takes ownership. More...
 
virtual bool addMValue (double mValue=0) override
 Adds a measure to the geometry, initialized to a preset value. More...
 
virtual bool addZValue (double zValue=0) override
 Adds a z-dimension to the geometry, initialized to a preset value. 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 QgsGeometryCollectionV2clone () 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 QgsAbstractGeometryV2geometryN (int n) const
 Returns a const reference to a geometry from within the collection. More...
 
QgsAbstractGeometryV2geometryN (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 insertGeometry (QgsAbstractGeometryV2 *g, int index)
 Inserts a geometry before a specified index and takes ownership. 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 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...
 
QgsGeometryCollectionV2operator= (const QgsGeometryCollectionV2 &c)
 
virtual int partCount () const override
 
virtual double perimeter () const override
 Returns the perimeter of the geometry. More...
 
virtual bool removeGeometry (int nr)
 Removes a geometry from the collection. More...
 
virtual int ringCount (int part=0) const override
 
QgsAbstractGeometryV2segmentize () const override
 Returns a geometry without curves. More...
 
virtual void transform (const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform) override
 Transforms the geometry using a coordinate transform. More...
 
void transform (const QTransform &t) override
 Transforms the geometry using a QTransform object. More...
 
double vertexAngle (const QgsVertexId &vertex) const override
 Returns approximate rotation angle for a vertex. More...
 
virtual QgsPointV2 vertexAt (const QgsVertexId &id) const override
 Returns the point corresponding to a specified vertex id. More...
 
virtual int vertexCount (int part=0, int ring=0) const override
 
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...
 
virtual QgsPointV2 centroid () const
 Returns the centroid of 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 QgsAbstractGeometryV2operator= (const QgsAbstractGeometryV2 &geom)
 
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...
 
virtual bool wktOmitChildType () const
 Returns whether child type names are omitted from Wkt representations of the collection. 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 29 of file qgsgeometrycollectionv2.h.

Constructor & Destructor Documentation

QgsGeometryCollectionV2::QgsGeometryCollectionV2 ( )

Definition at line 30 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2::QgsGeometryCollectionV2 ( const QgsGeometryCollectionV2 c)

Definition at line 35 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2::~QgsGeometryCollectionV2 ( )
virtual

Definition at line 60 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 100 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::addMValue ( double  mValue = 0)
overridevirtual

Adds a measure to the geometry, initialized to a preset value.

Parameters
mValueinitial m-value for all nodes
Returns
true on success
Note
added in QGIS 2.12
See also
addZValue

Implements QgsAbstractGeometryV2.

Definition at line 585 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::addZValue ( double  zValue = 0)
overridevirtual

Adds a z-dimension to the geometry, initialized to a preset value.

Parameters
zValueinitial z-value for all nodes
Returns
true on success
Note
added in QGIS 2.12
See also
addMValue

Implements QgsAbstractGeometryV2.

Definition at line 571 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::area ( ) const
overridevirtual

Returns the area of the geometry.

See also
length()
perimeter()

Reimplemented from QgsAbstractGeometryV2.

Definition at line 446 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
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
See also
asWkb
asWkt
asGML3
asJSON

Implements QgsAbstractGeometryV2.

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

Definition at line 281 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
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
See also
asWkb
asWkt
asGML2
asJSON

Implements QgsAbstractGeometryV2.

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

Definition at line 293 of file qgsgeometrycollectionv2.cpp.

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

Returns a GeoJSON representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See also
asWkb
asWkt
asGML2
asGML3

Implements QgsAbstractGeometryV2.

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

Definition at line 305 of file qgsgeometrycollectionv2.cpp.

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

Returns a WKB representation of the geometry.

Parameters
binarySizewill be set to the size of the returned WKB string
See also
wkbSize
asWkt
asGML2
asGML3
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 239 of file qgsgeometrycollectionv2.cpp.

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

Returns a WKT representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See also
asWkb
asGML2
asGML3
asJSON

Implements QgsAbstractGeometryV2.

Definition at line 261 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 320 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::clear ( )
overridevirtual

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

Implements QgsAbstractGeometryV2.

Definition at line 70 of file qgsgeometrycollectionv2.cpp.

QgsGeometryCollectionV2 * 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 65 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
ptSpecifies the point for search
segmentPtstorage for the closest point within the geometry
vertexAfterstorage for the id of the vertex after the closest segment
leftOfreturns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
epsilonepsilon for segment snapping
Returns
squared distance to closest segment

Implements QgsAbstractGeometryV2.

Definition at line 352 of file qgsgeometrycollectionv2.cpp.

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

Retrieves the sequence of geometries, rings and nodes.

Parameters
coorddestination for coordinate sequence.

Implements QgsAbstractGeometryV2.

Definition at line 336 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::deleteVertex ( const QgsVertexId position)
overridevirtual

Deletes a vertex within the geometry.

Parameters
positionvertex id for vertex to delete
Returns
true if delete was successful
See also
insertVertex
moveVertex

Implements QgsAbstractGeometryV2.

Definition at line 407 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 133 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::draw ( QPainter p) const
overridevirtual

Draws the geometry using the specified QPainter.

Parameters
pdestination QPainter

Implements QgsAbstractGeometryV2.

Definition at line 177 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 468 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 186 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 218 of file qgsgeometrycollectionv2.cpp.

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

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

Parameters
nindex of geometry to return

Definition at line 82 of file qgsgeometrycollectionv2.cpp.

QgsAbstractGeometryV2 * QgsGeometryCollectionV2::geometryN ( int  n)

Returns a geometry from within the collection.

Parameters
nindex of geometry to return

Definition at line 91 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 55 of file qgsgeometrycollectionv2.h.

bool QgsGeometryCollectionV2::hasCurvedSegments ( ) const
overridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometryV2.

Definition at line 525 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::insertGeometry ( QgsAbstractGeometryV2 g,
int  index 
)
virtual

Inserts a geometry before a specified index and takes ownership.

Returns true in case of success.

Parameters
ggeometry to insert. Ownership is transferred to the collection.
indexposition to insert geometry before

Definition at line 111 of file qgsgeometrycollectionv2.cpp.

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

Inserts a vertex into the geometry.

Parameters
positionvertex id for position of inserted vertex
vertexvertex to insert
Returns
true if insert was successful
See also
moveVertex
deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 377 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::length ( ) const
overridevirtual

Returns the length of the geometry.

See also
area()
perimeter()

Reimplemented from QgsAbstractGeometryV2.

Definition at line 435 of file qgsgeometrycollectionv2.cpp.

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

Moves a vertex within the geometry.

Parameters
positionvertex id for vertex to move
newPosnew position of vertex
Returns
true if move was successful
See also
insertVertex
deleteVertex

Implements QgsAbstractGeometryV2.

Definition at line 392 of file qgsgeometrycollectionv2.cpp.

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

Returns next vertex id and coordinates.

Parameters
idinitial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertexcontainer for found node
Returns
false if at end

Implements QgsAbstractGeometryV2.

Definition at line 357 of file qgsgeometrycollectionv2.cpp.

int QgsGeometryCollectionV2::numGeometries ( ) const

Returns the number of geometries within the collection.

Definition at line 77 of file qgsgeometrycollectionv2.cpp.

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

Definition at line 45 of file qgsgeometrycollectionv2.cpp.

virtual int QgsGeometryCollectionV2::partCount ( ) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 120 of file qgsgeometrycollectionv2.h.

double QgsGeometryCollectionV2::perimeter ( ) const
overridevirtual

Returns the perimeter of the geometry.

See also
area()
length()

Reimplemented from QgsAbstractGeometryV2.

Definition at line 457 of file qgsgeometrycollectionv2.cpp.

bool QgsGeometryCollectionV2::removeGeometry ( int  nr)
virtual

Removes a geometry from the collection.

Parameters
nrindex of geometry to remove
Returns
true if removal was successful.

Definition at line 122 of file qgsgeometrycollectionv2.cpp.

virtual int QgsGeometryCollectionV2::ringCount ( int  part = 0) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 119 of file qgsgeometrycollectionv2.h.

QgsAbstractGeometryV2 * QgsGeometryCollectionV2::segmentize ( ) const
overridevirtual

Returns a geometry without curves.

Caller takes ownership

Reimplemented from QgsAbstractGeometryV2.

Definition at line 538 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::transform ( const QgsCoordinateTransform ct,
QgsCoordinateTransform::TransformDirection  d = QgsCoordinateTransform::ForwardTransform 
)
overridevirtual

Transforms the geometry using a coordinate transform.

Parameters
ctcoordinate transform
dtransformation direction

Implements QgsAbstractGeometryV2.

Definition at line 148 of file qgsgeometrycollectionv2.cpp.

void QgsGeometryCollectionV2::transform ( const QTransform t)
overridevirtual

Transforms the geometry using a QTransform object.

Parameters
tQTransform transformation

Implements QgsAbstractGeometryV2.

Definition at line 157 of file qgsgeometrycollectionv2.cpp.

double QgsGeometryCollectionV2::vertexAngle ( const QgsVertexId vertex) const
overridevirtual

Returns approximate rotation angle for a vertex.

Usually average angle between adjacent segments.

Parameters
vertexthe vertex id
Returns
rotation in radians, clockwise from north

Implements QgsAbstractGeometryV2.

Definition at line 555 of file qgsgeometrycollectionv2.cpp.

virtual QgsPointV2 QgsGeometryCollectionV2::vertexAt ( const QgsVertexId id) const
inlineoverridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometryV2.

Definition at line 121 of file qgsgeometrycollectionv2.h.

virtual int QgsGeometryCollectionV2::vertexCount ( int  part = 0,
int  ring = 0 
) const
inlineoverridevirtual

Implements QgsAbstractGeometryV2.

Definition at line 118 of file qgsgeometrycollectionv2.h.

int QgsGeometryCollectionV2::wkbSize ( ) const
overridevirtual

Returns the size of the WKB representation of the geometry.

See also
asWkb

Implements QgsAbstractGeometryV2.

Definition at line 226 of file qgsgeometrycollectionv2.cpp.

virtual bool QgsGeometryCollectionV2::wktOmitChildType ( ) const
inlineprotectedvirtual

Returns whether child type names are omitted from Wkt representations of the collection.

Note
added in QGIS 2.12

Reimplemented in QgsMultiLineStringV2, QgsMultiPointV2, and QgsMultiPolygonV2.

Definition at line 132 of file qgsgeometrycollectionv2.h.

Member Data Documentation

QVector< QgsAbstractGeometryV2* > QgsGeometryCollectionV2::mGeometries
protected

Definition at line 127 of file qgsgeometrycollectionv2.h.


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