QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Geometry collection. More...
#include <qgsgeometrycollection.h>
Public Member Functions | |
QgsGeometryCollection () | |
Constructor for an empty geometry collection. | |
QgsGeometryCollection (const QgsGeometryCollection &c) | |
~QgsGeometryCollection () override | |
virtual bool | addGeometries (const QVector< QgsAbstractGeometry * > &geometries) |
Adds a list of geometries to the collection, transferring ownership to the collection. | |
virtual bool | addGeometry (QgsAbstractGeometry *g) |
Adds a geometry and takes ownership. Returns true in case of success. | |
bool | addMValue (double mValue=0) override |
Adds a measure to the geometry, initialized to a preset value. | |
bool | addZValue (double zValue=0) override |
Adds a z-dimension to the geometry, initialized to a preset value. | |
void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override |
Returns the vertices adjacent to a specified vertex within a geometry. | |
double | area () const override |
Returns the planar, 2-dimensional area of the geometry. | |
QDomElement | asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML2 representation of the geometry. | |
QDomElement | asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML3 representation of the geometry. | |
json | asJsonObject (int precision=17) const override |
Returns a json object representation of the geometry. | |
QString | asKml (int precision=17) const override |
Returns a KML representation of the geometry. | |
QPainterPath | asQPainterPath () const override |
Returns the geometry represented as a QPainterPath. | |
QByteArray | asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
Returns a WKB representation of the geometry. | |
QString | asWkt (int precision=17) const override |
Returns a WKT representation of the geometry. | |
QgsAbstractGeometry * | boundary () const override |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). | |
QgsBox3D | boundingBox3D () const override |
Returns the 3D bounding box for the geometry. | |
bool | boundingBoxIntersects (const QgsBox3D &box3d) const override |
Returns true if the bounding box of this geometry intersects with a box3d. | |
void | clear () override |
Clears the geometry, ie reset it to a null geometry. | |
QgsGeometryCollection * | clone () const override |
Clones the geometry by performing a deep copy. | |
double | closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const override |
Searches for the closest segment of the geometry to a given point. | |
QgsCoordinateSequence | coordinateSequence () const override |
Retrieves the sequence of geometries, rings and nodes. | |
QgsGeometryCollection * | createEmptyWithSameType () const override |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. | |
bool | deleteVertex (QgsVertexId position) override |
Deletes a vertex within the geometry. | |
int | dimension () const override |
Returns the inherent dimension of the geometry. | |
void | draw (QPainter &p) const override |
Draws the geometry using the specified QPainter. | |
bool | dropMValue () override |
Drops any measure values which exist in the geometry. | |
bool | dropZValue () override |
Drops any z-dimensions which exist in the geometry. | |
QgsGeometryCollection * | extractPartsByType (Qgis::WkbType type, bool useFlatType=true) const |
Returns a new QgsGeometryCollection subclass which consists of the parts of this collection which match the specified WKB type. | |
void | filterVertices (const std::function< bool(const QgsPoint &) > &filter) override |
Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. | |
bool | fromWkb (QgsConstWkbPtr &wkb) override |
Sets the geometry from a WKB string. | |
bool | fromWkt (const QString &wkt) override |
Sets the geometry from a WKT string. | |
bool | fuzzyDistanceEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const override |
Performs fuzzy distance comparison between this geometry and other using an epsilon. | |
bool | fuzzyEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const override |
Performs fuzzy comparison between this geometry and other using an epsilon. | |
QgsAbstractGeometry * | geometryN (int n) |
Returns a geometry from within the collection. | |
const QgsAbstractGeometry * | geometryN (int n) const |
Returns a const reference to a geometry from within the collection. | |
QString | geometryType () const override |
Returns a unique string representing the geometry type. | |
bool | hasCurvedSegments () const override |
Returns true if the geometry contains curved segments. | |
virtual bool | insertGeometry (QgsAbstractGeometry *g, int index) |
Inserts a geometry before a specified index and takes ownership. | |
bool | insertVertex (QgsVertexId position, const QgsPoint &vertex) override |
Inserts a vertex into the geometry. | |
bool | isEmpty () const override |
Returns true if the geometry is empty. | |
bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override |
Checks validity of the geometry, and returns true if the geometry is valid. | |
double | length () const override |
Returns the planar, 2-dimensional length of the geometry. | |
bool | moveVertex (QgsVertexId position, const QgsPoint &newPos) override |
Moves a vertex within the geometry. | |
int | nCoordinates () const override |
Returns the number of nodes contained in the geometry. | |
bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const override |
Returns next vertex id and coordinates. | |
void | normalize () final |
Reorganizes the geometry into a normalized form (or "canonical" form). | |
int | numGeometries () const |
Returns the number of geometries within the collection. | |
bool | operator!= (const QgsAbstractGeometry &other) const override |
QgsGeometryCollection & | operator= (const QgsGeometryCollection &c) |
bool | operator== (const QgsAbstractGeometry &other) const override |
int | partCount () const override |
Returns count of parts contained in the geometry. | |
double | perimeter () const override |
Returns the planar, 2-dimensional perimeter of the geometry. | |
bool | removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false) override |
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry. | |
virtual bool | removeGeometry (int nr) |
Removes a geometry from the collection. | |
void | reserve (int size) |
Attempts to allocate memory for at least size geometries. | |
int | ringCount (int part=0) const override |
Returns the number of rings of which this geometry is built. | |
QgsAbstractGeometry * | segmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override |
Returns a geometry without curves. | |
double | segmentLength (QgsVertexId startVertex) const override |
Returns the length of the segment of the geometry which begins at startVertex. | |
const QgsAbstractGeometry * | simplifiedTypeRef () const override |
Returns a reference to the simplest lossless representation of this geometry, e.g. | |
virtual QgsGeometryCollection * | simplifyByDistance (double tolerance) const override |
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm. | |
QgsGeometryCollection * | snappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0, bool removeRedundantPoints=false) const override |
Makes a new geometry with all the points or vertices snapped to the closest point of the grid. | |
void | swapXy () override |
Swaps the x and y coordinates from the geometry. | |
QVector< QgsAbstractGeometry * > | takeGeometries () |
Removes all geometries from the collection, returning them and their ownership to the caller. | |
QgsGeometryCollection * | toCurveType () const override |
Returns the geometry converted to the more generic curve type. | |
void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) override |
Transforms the geometry using a coordinate transform. | |
void | transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0) override |
Transforms the x and y components of the geometry using a QTransform object t. | |
bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. | |
void | transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) override |
Transforms the vertices from the geometry in place, applying the transform function to every vertex. | |
double | vertexAngle (QgsVertexId vertex) const override |
Returns approximate angle at a vertex. | |
QgsPoint | vertexAt (QgsVertexId id) const override |
Returns the point corresponding to a specified vertex id. | |
int | vertexCount (int part=0, int ring=0) const override |
Returns the number of vertices of which this geometry is built. | |
int | vertexNumberFromVertexId (QgsVertexId id) const override |
Returns the vertex number corresponding to a vertex id. | |
int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
Returns the length of the QByteArray returned by asWkb() | |
Public Member Functions inherited from QgsAbstractGeometry | |
QgsAbstractGeometry ()=default | |
QgsAbstractGeometry (const QgsAbstractGeometry &geom) | |
virtual | ~QgsAbstractGeometry ()=default |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. | |
virtual QgsRectangle | boundingBox () const |
Returns the minimal bounding box for the geometry. | |
virtual bool | boundingBoxIntersects (const QgsRectangle &rectangle) const |
Returns true if the bounding box of this geometry intersects with a rectangle. | |
virtual QgsPoint | centroid () const |
Returns the centroid of the geometry. | |
virtual int | compareTo (const QgsAbstractGeometry *other) const |
Comparator for sorting of geometry. | |
const_part_iterator | const_parts_begin () const |
Returns STL-style iterator pointing to the const first part of the geometry. | |
const_part_iterator | const_parts_end () const |
Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. | |
virtual bool | convertTo (Qgis::WkbType type) |
Converts the geometry to a specified type. | |
bool | is3D () const |
Returns true if the geometry is 3D and contains a z-value. | |
bool | isMeasure () const |
Returns true if the geometry contains m values. | |
QgsAbstractGeometry & | operator= (const QgsAbstractGeometry &geom) |
QgsGeometryPartIterator | parts () |
Returns Java-style iterator for traversal of parts of the geometry. | |
QgsGeometryConstPartIterator | parts () const |
Returns Java-style iterator for traversal of parts of the geometry. | |
part_iterator | parts_begin () |
Returns STL-style iterator pointing to the first part of the geometry. | |
part_iterator | parts_end () |
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. | |
QgsVertexIterator | vertices () const |
Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. | |
vertex_iterator | vertices_begin () const |
Returns STL-style iterator pointing to the first vertex of the geometry. | |
vertex_iterator | vertices_end () const |
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. | |
Qgis::WkbType | wkbType () const |
Returns the WKB type of the geometry. | |
QString | wktTypeStr () const |
Returns the WKT type string of the geometry. | |
Static Public Member Functions | |
static const QgsGeometryCollection * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsGeometryCollection. | |
Protected Member Functions | |
QgsBox3D | calculateBoundingBox3D () const override |
Calculates the minimal 3D bounding box for the geometry. | |
int | childCount () const override |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. | |
QgsAbstractGeometry * | childGeometry (int index) const override |
Returns pointer to child geometry (for geometries with child geometries - i.e. | |
void | clearCache () const override |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. | |
int | compareToSameClass (const QgsAbstractGeometry *other) const final |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. | |
bool | fromCollectionWkt (const QString &wkt, const QVector< QgsAbstractGeometry * > &subtypes, const QString &defaultChildWkbType=QString()) |
Reads a collection from a WKT string. | |
virtual bool | wktOmitChildType () const |
Returns whether child type names are omitted from Wkt representations of the collection. | |
Protected Member Functions inherited from QgsAbstractGeometry | |
virtual QgsRectangle | calculateBoundingBox () const |
Default calculator for the minimal bounding box for the geometry. | |
virtual QgsPoint | childPoint (int index) const |
Returns point at index (for geometries without child geometries - i.e. | |
virtual bool | hasChildGeometries () const |
Returns whether the geometry has any child geometries (false for point / curve, true otherwise) | |
void | setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, Qgis::WkbType baseGeomType) |
Updates the geometry type based on whether sub geometries contain z or m values. | |
int | sortIndex () const |
Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. | |
Protected Attributes | |
QVector< QgsAbstractGeometry * > | mGeometries |
Protected Attributes inherited from QgsAbstractGeometry | |
Qgis::WkbType | mWkbType = Qgis::WkbType::Unknown |
Additional Inherited Members | |
Public Types inherited from QgsAbstractGeometry | |
enum | AxisOrder { XY = 0 , YX } |
Axis order for GML generation. More... | |
enum | SegmentationToleranceType { MaximumAngle = 0 , MaximumDifference } |
Segmentation tolerance as maximum angle or maximum difference between approximation and circle. More... | |
enum | WkbFlag { FlagExportTrianglesAsPolygons = 1 << 0 , FlagExportNanAsDoubleMin = 1 << 1 } |
WKB export flags. More... | |
typedef QFlags< WkbFlag > | WkbFlags |
Geometry collection.
Definition at line 36 of file qgsgeometrycollection.h.
QgsGeometryCollection::QgsGeometryCollection | ( | ) |
Constructor for an empty geometry collection.
Definition at line 36 of file qgsgeometrycollection.cpp.
QgsGeometryCollection::QgsGeometryCollection | ( | const QgsGeometryCollection & | c | ) |
Definition at line 41 of file qgsgeometrycollection.cpp.
|
override |
Definition at line 71 of file qgsgeometrycollection.cpp.
|
virtual |
Adds a list of geometries to the collection, transferring ownership to the collection.
Returns true
in case of success.
Reimplemented in QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiCurve, and QgsMultiSurface.
Definition at line 232 of file qgsgeometrycollection.cpp.
|
virtual |
Adds a geometry and takes ownership. Returns true
in case of success.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 220 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Adds a measure to the geometry, initialized to a preset value.
mValue | initial m-value for all nodes |
true
on success Implements QgsAbstractGeometry.
Definition at line 914 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Adds a z-dimension to the geometry, initialized to a preset value.
zValue | initial z-value for all nodes |
true
on success Implements QgsAbstractGeometry.
Definition at line 899 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the vertices adjacent to a specified vertex within a geometry.
Implements QgsAbstractGeometry.
Definition at line 129 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the planar, 2-dimensional area of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 684 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a GML2 representation of the geometry.
doc | DOM document |
precision | number of decimal places for coordinates |
ns | XML namespace |
axisOrder | Axis order for generated GML |
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 461 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a GML3 representation of the geometry.
doc | DOM document |
precision | number of decimal places for coordinates |
ns | XML namespace |
axisOrder | Axis order for generated GML |
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 473 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a json object representation of the geometry.
Reimplemented from QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 485 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a KML representation of the geometry.
Implements QgsAbstractGeometry.
Definition at line 499 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the geometry represented as a QPainterPath.
Implements QgsAbstractGeometry.
Definition at line 332 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a WKB representation of the geometry.
The optional flags argument specifies flags controlling WKB export behavior (since QGIS 3.14).
Implements QgsAbstractGeometry.
Definition at line 407 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a WKT representation of the geometry.
precision | number of decimal places for coordinates |
Implements QgsAbstractGeometry.
Definition at line 434 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
nullptr
for some geometry types. Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 124 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the 3D bounding box for the geometry.
Implements QgsAbstractGeometry.
Definition at line 512 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns true
if the bounding box of this geometry intersects with a box3d.
Since this test only considers the bounding box of the geometry, is is very fast to calculate and handles invalid geometries.
Reimplemented from QgsAbstractGeometry.
Definition at line 167 of file qgsgeometrycollection.cpp.
|
overrideprotectedvirtual |
Calculates the minimal 3D bounding box for the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 521 of file qgsgeometrycollection.cpp.
|
inlinestatic |
Cast the geom to a QgsGeometryCollection.
Should be used by qgsgeometry_cast<QgsGeometryCollection *>( geometry ).
Definition at line 335 of file qgsgeometrycollection.h.
|
overrideprotectedvirtual |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.
curve / point)
Reimplemented from QgsAbstractGeometry.
Definition at line 1114 of file qgsgeometrycollection.cpp.
|
overrideprotectedvirtual |
Returns pointer to child geometry (for geometries with child geometries - i.e.
geom. collection / polygon)
Reimplemented from QgsAbstractGeometry.
Definition at line 1119 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Clears the geometry, ie reset it to a null geometry.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 88 of file qgsgeometrycollection.cpp.
|
overrideprotectedvirtual |
Clears any cached parameters associated with the geometry, e.g., bounding boxes.
Reimplemented from QgsAbstractGeometry.
Definition at line 540 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Clones the geometry by performing a deep copy.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 83 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Searches for the closest segment of the geometry to a given point.
pt | specifies the point to find closest segment to |
segmentPt | storage for the closest point within the geometry |
vertexAfter | storage for the ID of the vertex at the end of the closest segment |
leftOf | indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) false if point is to right of segment) |
epsilon | epsilon for segment snapping |
Implements QgsAbstractGeometry.
Definition at line 579 of file qgsgeometrycollection.cpp.
|
finalprotectedvirtual |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.
Implements QgsAbstractGeometry.
Definition at line 1127 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Retrieves the sequence of geometries, rings and nodes.
Implements QgsAbstractGeometry.
Definition at line 548 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
To create it, the geometry is default constructed and then the WKB is changed.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 76 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Deletes a vertex within the geometry.
position | vertex id for vertex to delete |
true
if delete was successful Implements QgsAbstractGeometry.
Definition at line 645 of file qgsgeometrycollection.cpp.
|
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 QgsAbstractGeometry.
Definition at line 285 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Draws the geometry using the specified QPainter.
p | destination QPainter |
Implements QgsAbstractGeometry.
Definition at line 323 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Drops any measure values which exist in the geometry.
true
if m-values were present and have been removed Implements QgsAbstractGeometry.
Definition at line 944 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Drops any z-dimensions which exist in the geometry.
true
if Z values were present and have been removed Implements QgsAbstractGeometry.
Definition at line 930 of file qgsgeometrycollection.cpp.
QgsGeometryCollection * QgsGeometryCollection::extractPartsByType | ( | Qgis::WkbType | type, |
bool | useFlatType = true |
||
) | const |
Returns a new QgsGeometryCollection subclass which consists of the parts of this collection which match the specified WKB type.
For instance, if type is Qgis::WkbType::Polygon, then the returned object will be a QgsMultiPolygon object containing just the polygons from this collection.
If useFlatType is true
, then the WKB types of component geometries from this collection will be flattened prior to comparing with type. (I.e. the presence of Z / M dimensions will be ignored when comparing against type).
Definition at line 978 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Filters the vertices from the geometry in place, removing any which do not return true
for the filter function check.
Has no meaning when called on a single point geometry.
Depending on the filter used, this may result in an invalid geometry.
Reimplemented from QgsAbstractGeometry.
Reimplemented in QgsMultiPoint.
Definition at line 958 of file qgsgeometrycollection.cpp.
|
protected |
Reads a collection from a WKT string.
Definition at line 706 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Sets the geometry from a WKB string.
After successful read the wkb argument will be at the position where the reading has stopped.
Implements QgsAbstractGeometry.
Definition at line 344 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Sets the geometry from a WKT string.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 383 of file qgsgeometrycollection.cpp.
|
inlineoverridevirtual |
Performs fuzzy distance comparison between this geometry and other using an epsilon.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry. It focuses on the numerical differences or relationships between these values. On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values. This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).
Implements QgsAbstractGeometry.
Definition at line 110 of file qgsgeometrycollection.h.
|
inlineoverridevirtual |
Performs fuzzy comparison between this geometry and other using an epsilon.
The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
Implements QgsAbstractGeometry.
Definition at line 106 of file qgsgeometrycollection.h.
QgsAbstractGeometry * QgsGeometryCollection::geometryN | ( | int | n | ) |
Returns a geometry from within the collection.
n | index of geometry to return |
Definition at line 201 of file qgsgeometrycollection.cpp.
|
inline |
Returns a const reference to a geometry from within the collection.
n | index of geometry to return |
Definition at line 148 of file qgsgeometrycollection.h.
|
overridevirtual |
Returns a unique string representing the geometry type.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 300 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns true
if the geometry contains curved segments.
Reimplemented from QgsAbstractGeometry.
Definition at line 776 of file qgsgeometrycollection.cpp.
|
virtual |
Inserts a geometry before a specified index and takes ownership.
Returns true
in case of success.
g | geometry to insert. Ownership is transferred to the collection. |
index | position to insert geometry before |
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 239 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Inserts a vertex into the geometry.
position | vertex id for position of inserted vertex |
vertex | vertex to insert |
true
if insert was successful Implements QgsAbstractGeometry.
Definition at line 615 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns true
if the geometry is empty.
Reimplemented from QgsAbstractGeometry.
Definition at line 207 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Checks validity of the geometry, and returns true
if the geometry is valid.
error | will be set to the validity error message |
flags | indicates optional flags which control the type of validity checking performed (corresponding to Qgis::GeometryValidityFlags). |
true
if geometry is validImplements QgsAbstractGeometry.
Reimplemented in QgsMultiPoint.
Definition at line 880 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the planar, 2-dimensional length of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 673 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Moves a vertex within the geometry.
position | vertex id for vertex to move |
newPos | new position of vertex |
true
if move was successful Implements QgsAbstractGeometry.
Definition at line 630 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the number of nodes contained in the geometry.
Reimplemented from QgsAbstractGeometry.
Reimplemented in QgsMultiPoint.
Definition at line 566 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns next vertex id and coordinates.
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 |
false
if at end Implements QgsAbstractGeometry.
Definition at line 584 of file qgsgeometrycollection.cpp.
|
finalvirtual |
Reorganizes the geometry into a normalized form (or "canonical" form).
Polygon rings will be rearranged so that their starting vertex is the lower left and ring orientation follows the right hand rule, collections are ordered by geometry type, and other normalization techniques are applied. The resultant geometry will be geometrically equivalent to the original geometry.
Implements QgsAbstractGeometry.
Definition at line 273 of file qgsgeometrycollection.cpp.
|
inline |
Returns the number of geometries within the collection.
Definition at line 120 of file qgsgeometrycollection.h.
|
inlineoverridevirtual |
Implements QgsAbstractGeometry.
Definition at line 55 of file qgsgeometrycollection.h.
QgsGeometryCollection & QgsGeometryCollection::operator= | ( | const QgsGeometryCollection & | c | ) |
Definition at line 56 of file qgsgeometrycollection.cpp.
|
inlineoverridevirtual |
Implements QgsAbstractGeometry.
Definition at line 50 of file qgsgeometrycollection.h.
|
overridevirtual |
Returns count of parts contained in the geometry.
Implements QgsAbstractGeometry.
Definition at line 859 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the planar, 2-dimensional perimeter of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 695 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry.
The epsilon parameter specifies the tolerance for coordinates when determining that vertices are identical.
By default, z values are not considered when detecting duplicate nodes. E.g. two nodes with the same x and y coordinate but different z values will still be considered duplicate and one will be removed. If useZValues is true
, then the z values are also tested and nodes with the same x and y but different z will be maintained.
Note that duplicate nodes are not tested between different parts of a multipart geometry. E.g. a multipoint geometry with overlapping points will not be changed by this method.
The function will return true
if nodes were removed, or false
if no duplicate nodes were found.
Implements QgsAbstractGeometry.
Definition at line 114 of file qgsgeometrycollection.cpp.
|
virtual |
Removes a geometry from the collection.
nr | index of geometry to remove |
true
if removal was successful. Definition at line 253 of file qgsgeometrycollection.cpp.
void QgsGeometryCollection::reserve | ( | int | size | ) |
Attempts to allocate memory for at least size geometries.
If the number of geometries is known in advance, calling this function prior to adding geometries will prevent reallocations and memory fragmentation.
Definition at line 196 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the number of rings of which this geometry is built.
Implements QgsAbstractGeometry.
Definition at line 849 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a geometry without curves.
Caller takes ownership
tolerance | segmentation tolerance |
toleranceType | maximum segmentation angle or maximum difference between approximation and curve |
Reimplemented from QgsAbstractGeometry.
Definition at line 789 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the length of the segment of the geometry which begins at startVertex.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiPoint.
Definition at line 823 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns a reference to the simplest lossless representation of this geometry, e.g.
if the geometry is a multipart geometry type with a single member geometry, a reference to that part will be returned.
This method employs the following logic:
This method returns a reference only, and does not involve any geometry cloning.
Reimplemented from QgsAbstractGeometry.
Definition at line 1069 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.
The caller takes ownership of the returned geometry. Curved geometries will be segmentized prior to simplification.
If a simplified geometry cannot be calculated nullptr
will be returned.
The returned geometry may be invalid and contain self-intersecting rings.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 1077 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Makes a new geometry with all the points or vertices snapped to the closest point of the grid.
Ownership is transferred to the caller.
If the gridified geometry could not be calculated nullptr
will be returned. It may generate an invalid geometry (in some corner cases). It can also be thought as rounding the edges and it may be useful for removing errors.
Example:
In this case we use a 2D grid of 1x1 to gridify. In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).
hSpacing | Horizontal spacing of the grid (x axis). 0 to disable. |
vSpacing | Vertical spacing of the grid (y axis). 0 to disable. |
dSpacing | Depth spacing of the grid (z axis). 0 (default) to disable. |
mSpacing | Custom dimension spacing of the grid (m axis). 0 (default) to disable. |
removeRedundantPoints | if true , then points which are redundant (e.g. they represent mid points on a straight line segment) will be skipped (since QGIS 3.38) |
Implements QgsAbstractGeometry.
Definition at line 95 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Swaps the x and y coordinates from the geometry.
This can be used to repair geometries which have accidentally had their latitude and longitude coordinates reversed.
Implements QgsAbstractGeometry.
Definition at line 1048 of file qgsgeometrycollection.cpp.
QVector< QgsAbstractGeometry * > QgsGeometryCollection::takeGeometries | ( | ) |
Removes all geometries from the collection, returning them and their ownership to the caller.
Definition at line 265 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the geometry converted to the more generic curve type.
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, and QgsMultiSurface.
Definition at line 1058 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Transforms the geometry using a coordinate transform.
ct | coordinate transform |
d | transformation direction |
transformZ | set to true to also transform z coordinates. This requires that the z coordinates in the geometry represent height relative to the vertical datum of the source CRS (generally ellipsoidal heights) and are expressed in its vertical units (generally meters). If false , then z coordinates will not be changed by the transform. |
Implements QgsAbstractGeometry.
Definition at line 305 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Transforms the x and y components of the geometry using a QTransform object t.
Optionally, the geometry's z values can be scaled via zScale and translated via zTranslate. Similarly, m-values can be scaled via mScale and translated via mTranslate.
Implements QgsAbstractGeometry.
Definition at line 314 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Transforms the vertices from the geometry in place, using the specified geometry transformer object.
Depending on the transformer used, this may result in an invalid geometry.
The optional feedback argument can be used to cancel the transformation before it completes. If this is done, the geometry will be left in a semi-transformed state.
true
if the geometry was successfully transformed.Implements QgsAbstractGeometry.
Definition at line 1088 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Transforms the vertices from the geometry in place, applying the transform function to every vertex.
Depending on the transform used, this may result in an invalid geometry.
Transform functions are not permitted to alter the dimensionality of vertices. If a transform which adds (or removes) z/m values is desired, first call the corresponding addZValue() or addMValue() function to change the geometry's dimensionality and then transform.
Reimplemented from QgsAbstractGeometry.
Definition at line 968 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns approximate angle at a vertex.
This is usually the average angle between adjacent segments, and can be pictured as the orientation of a line following the curvature of the geometry at the specified vertex.
vertex | the vertex id |
Implements QgsAbstractGeometry.
Definition at line 807 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the point corresponding to a specified vertex id.
Implements QgsAbstractGeometry.
Definition at line 864 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the number of vertices of which this geometry is built.
Implements QgsAbstractGeometry.
Definition at line 839 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the vertex number corresponding to a vertex id.
The vertex numbers start at 0, so a return value of 0 corresponds to the first vertex.
Returns -1 if a corresponding vertex could not be found.
Implements QgsAbstractGeometry.
Reimplemented in QgsMultiPoint.
Definition at line 141 of file qgsgeometrycollection.cpp.
|
overridevirtual |
Returns the length of the QByteArray returned by asWkb()
The optional flags argument specifies flags controlling WKB export behavior
Implements QgsAbstractGeometry.
Definition at line 393 of file qgsgeometrycollection.cpp.
|
protectedvirtual |
Returns whether child type names are omitted from Wkt representations of the collection.
Reimplemented in QgsMultiLineString, QgsMultiPoint, and QgsMultiPolygon.
Definition at line 1109 of file qgsgeometrycollection.cpp.
|
protected |
Definition at line 432 of file qgsgeometrycollection.h.