QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Surface geometry type. More...
#include <qgssurface.h>
Public Member Functions | |
QgsRectangle | boundingBox () const override |
Returns the minimal bounding box for the geometry. More... | |
bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override |
Checks validity of the geometry, and returns true if the geometry is valid. More... | |
virtual QgsPolygon * | surfaceToPolygon () const =0 |
Gets a polygon representation of this surface. More... | |
Public Member Functions inherited from QgsAbstractGeometry | |
QgsAbstractGeometry ()=default | |
Constructor for QgsAbstractGeometry. More... | |
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. More... | |
virtual bool | addZValue (double zValue=0)=0 |
Adds a z-dimension to the geometry, initialized to a preset value. More... | |
virtual void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const =0 |
Returns the vertices adjacent to a specified vertex within a geometry. More... | |
virtual double | area () const |
Returns the planar, 2-dimensional area of the geometry. More... | |
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. More... | |
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. More... | |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. More... | |
virtual json | asJsonObject (int precision=17) const |
Returns a json object representation of the geometry. More... | |
virtual QString | asKml (int precision=17) const =0 |
Returns a KML representation of the geometry. More... | |
virtual QPainterPath | asQPainterPath () const =0 |
Returns the geometry represented as a QPainterPath. More... | |
virtual QByteArray | asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns a WKB representation of the geometry. More... | |
virtual QString | asWkt (int precision=17) const =0 |
Returns a WKT representation of the geometry. More... | |
virtual QgsAbstractGeometry * | boundary () const =0 |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More... | |
virtual QgsRectangle | boundingBox () const =0 |
Returns the minimal bounding box for the geometry. More... | |
virtual bool | boundingBoxIntersects (const QgsRectangle &rectangle) const SIP_HOLDGIL |
Returns true if the bounding box of this geometry intersects with a rectangle. More... | |
virtual QgsPoint | centroid () const |
Returns the centroid of the geometry. More... | |
virtual void | clear ()=0 |
Clears the geometry, ie reset it to a null geometry. More... | |
virtual QgsAbstractGeometry * | clone () const =0 |
Clones the geometry by performing a deep copy. More... | |
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. More... | |
virtual int | compareTo (const QgsAbstractGeometry *other) const |
Comparator for sorting of geometry. More... | |
const_part_iterator | const_parts_begin () const |
Returns STL-style iterator pointing to the const first part of the geometry. More... | |
const_part_iterator | const_parts_end () const |
Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. More... | |
virtual bool | convertTo (QgsWkbTypes::Type type) |
Converts the geometry to a specified type. More... | |
virtual QgsCoordinateSequence | coordinateSequence () const =0 |
Retrieves the sequence of geometries, rings and nodes. More... | |
virtual QgsAbstractGeometry * | createEmptyWithSameType () const =0 |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More... | |
virtual bool | deleteVertex (QgsVertexId position)=0 |
Deletes a vertex within the geometry. More... | |
virtual int | dimension () const =0 |
Returns the inherent dimension of the geometry. More... | |
virtual void | draw (QPainter &p) const =0 |
Draws the geometry using the specified QPainter. More... | |
virtual bool | dropMValue ()=0 |
Drops any measure values which exist in the geometry. More... | |
virtual bool | dropZValue ()=0 |
Drops any z-dimensions which exist in the geometry. More... | |
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. More... | |
virtual bool | fromWkb (QgsConstWkbPtr &wkb)=0 |
Sets the geometry from a WKB string. More... | |
virtual bool | fromWkt (const QString &wkt)=0 |
Sets the geometry from a WKT string. More... | |
virtual QString | geometryType () const =0 |
Returns a unique string representing the geometry type. More... | |
virtual bool | hasCurvedSegments () const |
Returns true if the geometry contains curved segments. More... | |
virtual bool | insertVertex (QgsVertexId position, const QgsPoint &vertex)=0 |
Inserts a vertex into the geometry. More... | |
bool | is3D () const SIP_HOLDGIL |
Returns true if the geometry is 3D and contains a z-value. More... | |
virtual bool | isEmpty () const |
Returns true if the geometry is empty. More... | |
bool | isMeasure () const SIP_HOLDGIL |
Returns true if the geometry contains m values. More... | |
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. More... | |
virtual double | length () const |
Returns the planar, 2-dimensional length of the geometry. More... | |
virtual bool | moveVertex (QgsVertexId position, const QgsPoint &newPos)=0 |
Moves a vertex within the geometry. More... | |
virtual int | nCoordinates () const |
Returns the number of nodes contained in the geometry. More... | |
virtual bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const =0 |
Returns next vertex id and coordinates. More... | |
virtual void | normalize ()=0 |
Reorganizes the geometry into a normalized form (or "canonical" form). More... | |
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. More... | |
QgsGeometryPartIterator | parts () |
Returns Java-style iterator for traversal of parts of the geometry. More... | |
QgsGeometryConstPartIterator | parts () const |
Returns Java-style iterator for traversal of parts of the geometry. More... | |
part_iterator | parts_begin () |
Returns STL-style iterator pointing to the first part of the geometry. More... | |
part_iterator | parts_end () |
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. More... | |
virtual double | perimeter () const |
Returns the planar, 2-dimensional perimeter of the geometry. More... | |
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. More... | |
virtual int | ringCount (int part=0) const =0 |
Returns the number of rings of which this geometry is built. More... | |
virtual QgsAbstractGeometry * | segmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const |
Returns a version of the geometry without curves. More... | |
virtual double | segmentLength (QgsVertexId startVertex) const =0 |
Returns the length of the segment of the geometry which begins at startVertex. More... | |
virtual const QgsAbstractGeometry * | simplifiedTypeRef () const SIP_HOLDGIL |
Returns a reference to the simplest lossless representation of this geometry, e.g. More... | |
virtual QgsAbstractGeometry * | snappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const =0 |
Makes a new geometry with all the points or vertices snapped to the closest point of the grid. More... | |
virtual void | swapXy ()=0 |
Swaps the x and y coordinates from the geometry. More... | |
virtual QgsAbstractGeometry * | toCurveType () const =0 |
Returns the geometry converted to the more generic curve type. More... | |
virtual void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) SIP_THROW(QgsCsException)=0 |
Transforms the geometry using a coordinate transform. More... | |
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. More... | |
virtual bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr)=0 |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. More... | |
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. More... | |
virtual double | vertexAngle (QgsVertexId vertex) const =0 |
Returns approximate angle at a vertex. More... | |
virtual QgsPoint | vertexAt (QgsVertexId id) const =0 |
Returns the point corresponding to a specified vertex id. More... | |
virtual int | vertexCount (int part=0, int ring=0) const =0 |
Returns the number of vertices of which this geometry is built. More... | |
virtual int | vertexNumberFromVertexId (QgsVertexId id) const =0 |
Returns the vertex number corresponding to a vertex id. More... | |
QgsVertexIterator | vertices () const |
Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. More... | |
vertex_iterator | vertices_begin () const |
Returns STL-style iterator pointing to the first vertex of the geometry. More... | |
vertex_iterator | vertices_end () const |
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More... | |
virtual int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns the length of the QByteArray returned by asWkb() More... | |
QgsWkbTypes::Type | wkbType () const SIP_HOLDGIL |
Returns the WKB type of the geometry. More... | |
QString | wktTypeStr () const |
Returns the WKT type string of the geometry. More... | |
Static Public Member Functions | |
static const QgsSurface * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsSurface. More... | |
Protected Member Functions | |
void | clearCache () const override |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. More... | |
Protected Member Functions inherited from QgsAbstractGeometry | |
virtual QgsRectangle | calculateBoundingBox () const |
Default calculator for the minimal bounding box for the geometry. More... | |
virtual int | childCount () const |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. More... | |
virtual QgsAbstractGeometry * | childGeometry (int index) const |
Returns pointer to child geometry (for geometries with child geometries - i.e. More... | |
virtual QgsPoint | childPoint (int index) const |
Returns point at index (for geometries without child geometries - i.e. More... | |
virtual void | clearCache () const |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. More... | |
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. More... | |
virtual bool | hasChildGeometries () const |
Returns whether the geometry has any child geometries (false for point / curve, true otherwise) More... | |
void | setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType) |
Updates the geometry type based on whether sub geometries contain z or m values. More... | |
int | sortIndex () const |
Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. More... | |
Protected Attributes | |
QgsRectangle | mBoundingBox |
bool | mHasCachedValidity = false |
QString | mValidityFailureReason |
Protected Attributes inherited from QgsAbstractGeometry | |
QgsWkbTypes::Type | mWkbType = QgsWkbTypes::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 } |
WKB export flags. More... | |
Surface geometry type.
Definition at line 33 of file qgssurface.h.
|
inlineoverridevirtual |
Returns the minimal bounding box for the geometry.
Implements QgsAbstractGeometry.
Definition at line 43 of file qgssurface.h.
|
inlinestatic |
Cast the geom to a QgsSurface.
Should be used by qgsgeometry_cast<QgsSurface *>( geometry ).
Definition at line 64 of file qgssurface.h.
|
overrideprotectedvirtual |
Clears any cached parameters associated with the geometry, e.g., bounding boxes.
Reimplemented from QgsAbstractGeometry.
Definition at line 43 of file qgssurface.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.
Definition at line 24 of file qgssurface.cpp.
|
pure virtual |
Gets a polygon representation of this surface.
Ownership is transferred to the caller.
Implemented in QgsCurvePolygon, QgsPolygon, and QgsTriangle.
|
mutableprotected |
Definition at line 81 of file qgssurface.h.
|
mutableprotected |
Definition at line 82 of file qgssurface.h.
|
mutableprotected |
Definition at line 83 of file qgssurface.h.