QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Abstract base class for all geometries. More...
#include <qgsabstractgeometry.h>
Classes | |
class | const_part_iterator |
The part_iterator class provides STL-style iterator for const references to geometry parts. More... | |
class | part_iterator |
The part_iterator class provides STL-style iterator for geometry parts. More... | |
class | vertex_iterator |
The vertex_iterator class provides STL-style iterator for vertices. More... | |
Public Types | |
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 |
Public Member Functions | |
QgsAbstractGeometry ()=default | |
QgsAbstractGeometry (const QgsAbstractGeometry &geom) | |
virtual | ~QgsAbstractGeometry ()=default |
virtual bool | addMValue (double mValue=0)=0 |
Adds a measure to the geometry, initialized to a preset value. | |
virtual bool | addZValue (double zValue=0)=0 |
Adds a z-dimension to the geometry, initialized to a preset value. | |
virtual void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const =0 |
Returns the vertices adjacent to a specified vertex within a geometry. | |
virtual double | area () const |
Returns the planar, 2-dimensional area of the geometry. | |
virtual QDomElement | asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0 |
Returns a GML2 representation of the geometry. | |
virtual QDomElement | asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0 |
Returns a GML3 representation of the geometry. | |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. | |
virtual json | asJsonObject (int precision=17) const |
Returns a json object representation of the geometry. | |
virtual QString | asKml (int precision=17) const =0 |
Returns a KML representation of the geometry. | |
virtual QPainterPath | asQPainterPath () const =0 |
Returns the geometry represented as a QPainterPath. | |
virtual QByteArray | asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns a WKB representation of the geometry. | |
virtual QString | asWkt (int precision=17) const =0 |
Returns a WKT representation of the geometry. | |
virtual QgsAbstractGeometry * | boundary () const =0 |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). | |
virtual QgsRectangle | boundingBox () const |
Returns the minimal bounding box for the geometry. | |
virtual QgsBox3D | boundingBox3D () const =0 |
Returns the 3D bounding box for the geometry. | |
virtual bool | boundingBoxIntersects (const QgsBox3D &box3d) const |
Returns true if the bounding box of this geometry intersects with a box3d. | |
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 void | clear ()=0 |
Clears the geometry, ie reset it to a null geometry. | |
virtual QgsAbstractGeometry * | clone () const =0 |
Clones the geometry by performing a deep copy. | |
virtual double | closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const =0 |
Searches for the closest segment of the geometry to a given point. | |
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. | |
virtual QgsCoordinateSequence | coordinateSequence () const =0 |
Retrieves the sequence of geometries, rings and nodes. | |
virtual QgsAbstractGeometry * | createEmptyWithSameType () const =0 |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. | |
virtual bool | deleteVertex (QgsVertexId position)=0 |
Deletes a vertex within the geometry. | |
virtual int | dimension () const =0 |
Returns the inherent dimension of the geometry. | |
virtual void | draw (QPainter &p) const =0 |
Draws the geometry using the specified QPainter. | |
virtual bool | dropMValue ()=0 |
Drops any measure values which exist in the geometry. | |
virtual bool | dropZValue ()=0 |
Drops any z-dimensions which exist in the geometry. | |
virtual void | filterVertices (const std::function< bool(const QgsPoint &) > &filter) |
Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. | |
virtual bool | fromWkb (QgsConstWkbPtr &wkb)=0 |
Sets the geometry from a WKB string. | |
virtual bool | fromWkt (const QString &wkt)=0 |
Sets the geometry from a WKT string. | |
virtual bool | fuzzyDistanceEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const =0 |
Performs fuzzy distance comparison between this geometry and other using an epsilon. | |
virtual bool | fuzzyEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const =0 |
Performs fuzzy comparison between this geometry and other using an epsilon. | |
virtual QString | geometryType () const =0 |
Returns a unique string representing the geometry type. | |
virtual bool | hasCurvedSegments () const |
Returns true if the geometry contains curved segments. | |
virtual bool | insertVertex (QgsVertexId position, const QgsPoint &vertex)=0 |
Inserts a vertex into the geometry. | |
bool | is3D () const |
Returns true if the geometry is 3D and contains a z-value. | |
virtual bool | isEmpty () const |
Returns true if the geometry is empty. | |
bool | isMeasure () const |
Returns true if the geometry contains m values. | |
virtual bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const =0 |
Checks validity of the geometry, and returns true if the geometry is valid. | |
virtual double | length () const |
Returns the planar, 2-dimensional length of the geometry. | |
virtual bool | moveVertex (QgsVertexId position, const QgsPoint &newPos)=0 |
Moves a vertex within the geometry. | |
virtual int | nCoordinates () const |
Returns the number of nodes contained in the geometry. | |
virtual bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const =0 |
Returns next vertex id and coordinates. | |
virtual void | normalize ()=0 |
Reorganizes the geometry into a normalized form (or "canonical" form). | |
virtual bool | operator!= (const QgsAbstractGeometry &other) const =0 |
QgsAbstractGeometry & | operator= (const QgsAbstractGeometry &geom) |
virtual bool | operator== (const QgsAbstractGeometry &other) const =0 |
virtual int | partCount () const =0 |
Returns count of parts contained in the geometry. | |
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. | |
virtual double | perimeter () const |
Returns the planar, 2-dimensional perimeter of the geometry. | |
virtual bool | removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false)=0 |
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry. | |
virtual int | ringCount (int part=0) const =0 |
Returns the number of rings of which this geometry is built. | |
virtual QgsAbstractGeometry * | segmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const |
Returns a version of the geometry without curves. | |
virtual double | segmentLength (QgsVertexId startVertex) const =0 |
Returns the length of the segment of the geometry which begins at startVertex. | |
virtual const QgsAbstractGeometry * | simplifiedTypeRef () const |
Returns a reference to the simplest lossless representation of this geometry, e.g. | |
virtual QgsAbstractGeometry * | simplifyByDistance (double tolerance) const =0 |
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm. | |
virtual QgsAbstractGeometry * | snappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0, bool removeRedundantPoints=false) const =0 |
Makes a new geometry with all the points or vertices snapped to the closest point of the grid. | |
virtual void | swapXy ()=0 |
Swaps the x and y coordinates from the geometry. | |
virtual QgsAbstractGeometry * | toCurveType () const =0 |
Returns the geometry converted to the more generic curve type. | |
virtual void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false)=0 |
Transforms the geometry using a coordinate transform. | |
virtual void | transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0)=0 |
Transforms the x and y components of the geometry using a QTransform object t. | |
virtual bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr)=0 |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. | |
virtual void | transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) |
Transforms the vertices from the geometry in place, applying the transform function to every vertex. | |
virtual double | vertexAngle (QgsVertexId vertex) const =0 |
Returns approximate angle at a vertex. | |
virtual QgsPoint | vertexAt (QgsVertexId id) const =0 |
Returns the point corresponding to a specified vertex id. | |
virtual int | vertexCount (int part=0, int ring=0) const =0 |
Returns the number of vertices of which this geometry is built. | |
virtual int | vertexNumberFromVertexId (QgsVertexId id) const =0 |
Returns the vertex number corresponding to a vertex id. | |
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. | |
virtual int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns the length of the QByteArray returned by asWkb() | |
Qgis::WkbType | wkbType () const |
Returns the WKB type of the geometry. | |
QString | wktTypeStr () const |
Returns the WKT type string of the geometry. | |
Protected Member Functions | |
virtual QgsRectangle | calculateBoundingBox () const |
Default calculator for the minimal bounding box for the geometry. | |
virtual QgsBox3D | calculateBoundingBox3D () const |
Calculates the minimal 3D bounding box for the geometry. | |
virtual int | childCount () const |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. | |
virtual QgsAbstractGeometry * | childGeometry (int index) const |
Returns pointer to child geometry (for geometries with child geometries - i.e. | |
virtual QgsPoint | childPoint (int index) const |
Returns point at index (for geometries without child geometries - i.e. | |
virtual void | clearCache () const |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. | |
virtual int | compareToSameClass (const QgsAbstractGeometry *other) const =0 |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. | |
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 | |
Qgis::WkbType | mWkbType = Qgis::WkbType::Unknown |
Friends | |
class | TestQgsGeometry |
Abstract base class for all geometries.
Definition at line 79 of file qgsabstractgeometry.h.
typedef QFlags< WkbFlag > QgsAbstractGeometry::WkbFlags |
Definition at line 308 of file qgsabstractgeometry.h.
Axis order for GML generation.
Enumerator | |
---|---|
XY | X comes before Y (or lon before lat) |
YX | Y comes before X (or lat before lon) |
Definition at line 138 of file qgsabstractgeometry.h.
Segmentation tolerance as maximum angle or maximum difference between approximation and circle.
Definition at line 120 of file qgsabstractgeometry.h.
WKB export flags.
Enumerator | |
---|---|
FlagExportTrianglesAsPolygons | Triangles should be exported as polygon geometries. |
FlagExportNanAsDoubleMin | Use -DOUBLE_MAX to represent NaN.
|
Definition at line 303 of file qgsabstractgeometry.h.
|
default |
|
virtualdefault |
QgsAbstractGeometry::QgsAbstractGeometry | ( | const QgsAbstractGeometry & | geom | ) |
Definition at line 27 of file qgsabstractgeometry.cpp.
|
pure virtual |
Adds a measure to the geometry, initialized to a preset value.
mValue | initial m-value for all nodes |
true
on success Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Adds a z-dimension to the geometry, initialized to a preset value.
zValue | initial z-value for all nodes |
true
on success Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Returns the vertices adjacent to a specified vertex within a geometry.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
|
virtual |
Returns the planar, 2-dimensional area of the geometry.
Reimplemented in QgsCurvePolygon, QgsGeometryCollection, and QgsPolyhedralSurface.
Definition at line 206 of file qgsabstractgeometry.cpp.
|
pure virtual |
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 |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
pure virtual |
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 |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
QString QgsAbstractGeometry::asJson | ( | int | precision = 17 | ) |
Returns a GeoJSON representation of the geometry as a QString.
precision | number of decimal places for coordinates |
Definition at line 226 of file qgsabstractgeometry.cpp.
|
virtual |
Returns a json object representation of the geometry.
Reimplemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, and QgsPolyhedralSurface.
Definition at line 231 of file qgsabstractgeometry.cpp.
|
pure virtual |
Returns a KML representation of the geometry.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
pure virtual |
Returns the geometry represented as a QPainterPath.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Returns a WKB representation of the geometry.
The optional flags argument specifies flags controlling WKB export behavior (since QGIS 3.14).
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPolygon, QgsPolyhedralSurface, and QgsPoint.
|
pure virtual |
Returns a WKT representation of the geometry.
precision | number of decimal places for coordinates |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolygon, and QgsPolyhedralSurface.
|
pure virtual |
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. Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsMultiCurve, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, and QgsTriangle.
|
virtual |
Returns the minimal bounding box for the geometry.
Definition at line 117 of file qgsabstractgeometry.cpp.
|
pure virtual |
Returns the 3D bounding box for the geometry.
Implemented in QgsCurve, QgsGeometryCollection, QgsPoint, and QgsSurface.
|
virtual |
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 in QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
Definition at line 430 of file qgsabstractgeometry.cpp.
|
virtual |
Returns true
if the bounding box of this geometry intersects with a rectangle.
Since this test only considers the bounding box of the geometry, is is very fast to calculate and handles invalid geometries.
Reimplemented in QgsLineString, and QgsPoint.
Definition at line 425 of file qgsabstractgeometry.cpp.
|
protectedvirtual |
Default calculator for the minimal bounding box for the geometry.
Derived classes should override this method if a more efficient bounding box calculation is available.
Definition at line 122 of file qgsabstractgeometry.cpp.
|
protectedvirtual |
Calculates the minimal 3D bounding box for the geometry.
Reimplemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, and QgsPolyhedralSurface.
Definition at line 127 of file qgsabstractgeometry.cpp.
|
virtual |
Returns the centroid of the geometry.
Reimplemented in QgsLineString.
Definition at line 236 of file qgsabstractgeometry.cpp.
|
inlineprotectedvirtual |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.
curve / point)
Reimplemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
Definition at line 1140 of file qgsabstractgeometry.h.
|
inlineprotectedvirtual |
Returns pointer to child geometry (for geometries with child geometries - i.e.
geom. collection / polygon)
Reimplemented in QgsCurvePolygon, QgsGeometryCollection, and QgsPolyhedralSurface.
Definition at line 1146 of file qgsabstractgeometry.h.
|
protectedvirtual |
Returns point at index (for geometries without child geometries - i.e.
curve / point)
Reimplemented in QgsCurve, and QgsPoint.
Definition at line 407 of file qgsabstractgeometry.cpp.
|
pure virtual |
Clears the geometry, ie reset it to a null geometry.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
protectedvirtual |
Clears any cached parameters associated with the geometry, e.g., bounding boxes.
Reimplemented in QgsCurve, QgsGeometryCollection, and QgsSurface.
Definition at line 176 of file qgsabstractgeometry.cpp.
|
pure virtual |
Clones the geometry by performing a deep copy.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, QgsTriangle, QgsTriangulatedSurface, and QgsCurve.
|
pure virtual |
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 |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
virtual |
Comparator for sorting of geometry.
Definition at line 42 of file qgsabstractgeometry.cpp.
|
protectedpure virtual |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsTriangulatedSurface, and QgsPolyhedralSurface.
|
inline |
Returns STL-style iterator pointing to the const first part of the geometry.
Definition at line 949 of file qgsabstractgeometry.h.
QgsAbstractGeometry::const_part_iterator QgsAbstractGeometry::const_parts_end | ( | ) | const |
Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry.
Definition at line 353 of file qgsabstractgeometry.cpp.
|
virtual |
Converts the geometry to a specified type.
true
if conversion was successful Reimplemented in QgsLineString, and QgsPoint.
Definition at line 291 of file qgsabstractgeometry.cpp.
|
pure virtual |
Retrieves the sequence of geometries, rings and nodes.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
pure virtual |
Deletes a vertex within the geometry.
position | vertex id for vertex to delete |
true
if delete was successful Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
pure virtual |
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.
Implemented in QgsPolyhedralSurface, QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, and QgsPoint.
|
pure virtual |
Draws the geometry using the specified QPainter.
p | destination QPainter |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Drops any measure values which exist in the geometry.
true
if m-values were present and have been removed Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Drops any z-dimensions which exist in the geometry.
true
if Z values were present and have been removed Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
virtual |
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 in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiPoint, QgsPoint, and QgsPolyhedralSurface.
Definition at line 327 of file qgsabstractgeometry.cpp.
|
pure virtual |
Sets the geometry from a WKB string.
After successful read the wkb argument will be at the position where the reading has stopped.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolygon, QgsPolyhedralSurface, QgsTriangulatedSurface, and QgsTriangle.
|
pure virtual |
Sets the geometry from a WKT string.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
pure virtual |
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).
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
pure virtual |
Returns a unique string representing the geometry type.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
protectedvirtual |
Returns whether the geometry has any child geometries (false
for point / curve, true
otherwise)
Definition at line 402 of file qgsabstractgeometry.cpp.
|
virtual |
Returns true
if the geometry contains curved segments.
Reimplemented in QgsPolyhedralSurface, QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, and QgsGeometryCollection.
Definition at line 420 of file qgsabstractgeometry.cpp.
|
pure virtual |
Inserts a vertex into the geometry.
position | vertex id for position of inserted vertex |
vertex | vertex to insert |
true
if insert was successful Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
inline |
Returns true
if the geometry is 3D and contains a z-value.
Definition at line 250 of file qgsabstractgeometry.h.
|
virtual |
Returns true
if the geometry is empty.
Reimplemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
Definition at line 413 of file qgsabstractgeometry.cpp.
|
inline |
Returns true
if the geometry contains m values.
Definition at line 259 of file qgsabstractgeometry.h.
|
pure virtual |
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 validImplemented in QgsCircularString, QgsCompoundCurve, QgsCurve, QgsGeometryCollection, QgsLineString, QgsMultiPoint, QgsPoint, QgsPolyhedralSurface, and QgsSurface.
|
virtual |
Returns the planar, 2-dimensional length of the geometry.
Reimplemented in QgsCircularString, QgsCompoundCurve, QgsGeometryCollection, and QgsLineString.
Definition at line 196 of file qgsabstractgeometry.cpp.
|
pure virtual |
Moves a vertex within the geometry.
position | vertex id for vertex to move |
newPos | new position of vertex |
true
if move was successful Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, and QgsTriangle.
|
virtual |
Returns the number of nodes contained in the geometry.
Reimplemented in QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiPoint, QgsPoint, and QgsPolyhedralSurface.
Definition at line 180 of file qgsabstractgeometry.cpp.
|
pure virtual |
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 Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
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.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
pure virtual |
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
QgsAbstractGeometry & QgsAbstractGeometry::operator= | ( | const QgsAbstractGeometry & | geom | ) |
Definition at line 32 of file qgsabstractgeometry.cpp.
|
pure virtual |
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, QgsPolyhedralSurface, QgsTriangle, and QgsTriangulatedSurface.
|
pure virtual |
Returns count of parts contained in the geometry.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPoint, and QgsPolyhedralSurface.
QgsGeometryPartIterator QgsAbstractGeometry::parts | ( | ) |
Returns Java-style iterator for traversal of parts of the geometry.
This iterator can safely be used to modify parts of the geometry.
Example
Definition at line 343 of file qgsabstractgeometry.cpp.
QgsGeometryConstPartIterator QgsAbstractGeometry::parts | ( | ) | const |
Returns Java-style iterator for traversal of parts of the geometry.
This iterator returns read-only references to parts and cannot be used to modify the parts.
Definition at line 348 of file qgsabstractgeometry.cpp.
|
inline |
Returns STL-style iterator pointing to the first part of the geometry.
Definition at line 880 of file qgsabstractgeometry.h.
QgsAbstractGeometry::part_iterator QgsAbstractGeometry::parts_end | ( | ) |
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.
Definition at line 337 of file qgsabstractgeometry.cpp.
|
virtual |
Returns the planar, 2-dimensional perimeter of the geometry.
Reimplemented in QgsCurvePolygon, QgsGeometryCollection, and QgsPolyhedralSurface.
Definition at line 201 of file qgsabstractgeometry.cpp.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Returns the number of rings of which this geometry is built.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPolyhedralSurface, and QgsPoint.
|
virtual |
Returns a version of the geometry without curves.
Caller takes ownership of the returned geometry.
tolerance | segmentation tolerance |
toleranceType | maximum segmentation angle or maximum difference between approximation and curve |
Reimplemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, and QgsPolyhedralSurface.
Definition at line 435 of file qgsabstractgeometry.cpp.
|
pure virtual |
Returns the length of the segment of the geometry which begins at startVertex.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiPoint, QgsPoint, and QgsPolyhedralSurface.
|
protected |
Updates the geometry type based on whether sub geometries contain z or m values.
Definition at line 75 of file qgsabstractgeometry.cpp.
|
virtual |
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 in QgsCompoundCurve, and QgsGeometryCollection.
Definition at line 322 of file qgsabstractgeometry.cpp.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
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) |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolyhedralSurface, and QgsTriangulatedSurface.
|
protected |
Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types.
Definition at line 364 of file qgsabstractgeometry.cpp.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Returns the geometry converted to the more generic curve type.
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsMultiCurve, QgsMultiLineString, QgsMultiPoint, QgsMultiPolygon, QgsMultiSurface, QgsPoint, QgsPolygon, QgsPolyhedralSurface, and QgsTriangle.
|
pure virtual |
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. |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
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.
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
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.Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
virtual |
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 in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
Definition at line 332 of file qgsabstractgeometry.cpp.
|
pure virtual |
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 |
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, and QgsPolyhedralSurface.
|
pure virtual |
Returns the point corresponding to a specified vertex id.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPolyhedralSurface, and QgsPoint.
|
pure virtual |
Returns the number of vertices of which this geometry is built.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsPolyhedralSurface, and QgsPoint.
|
pure virtual |
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.
Implemented in QgsCurve, QgsCurvePolygon, QgsGeometryCollection, QgsMultiPoint, QgsPoint, and QgsPolyhedralSurface.
QgsVertexIterator QgsAbstractGeometry::vertices | ( | ) | const |
Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings.
Example
Definition at line 359 of file qgsabstractgeometry.cpp.
|
inline |
Returns STL-style iterator pointing to the first vertex of the geometry.
Definition at line 1023 of file qgsabstractgeometry.h.
|
inline |
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry.
Definition at line 1035 of file qgsabstractgeometry.h.
|
pure virtual |
Returns the length of the QByteArray returned by asWkb()
The optional flags argument specifies flags controlling WKB export behavior
Implemented in QgsCircularString, QgsCompoundCurve, QgsCurvePolygon, QgsGeometryCollection, QgsLineString, QgsPoint, QgsPolygon, and QgsPolyhedralSurface.
|
inline |
Returns the WKB type of the geometry.
Definition at line 237 of file qgsabstractgeometry.h.
QString QgsAbstractGeometry::wktTypeStr | ( | ) | const |
Returns the WKT type string of the geometry.
Definition at line 211 of file qgsabstractgeometry.cpp.
|
friend |
Definition at line 1181 of file qgsabstractgeometry.h.
|
protected |
Definition at line 1155 of file qgsabstractgeometry.h.