QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsPolyhedralSurface Class Reference

Polyhedral surface geometry type. More...

#include <qgspolyhedralsurface.h>

Inheritance diagram for QgsPolyhedralSurface:
Inheritance graph
[legend]

Public Member Functions

 QgsPolyhedralSurface ()
 
 QgsPolyhedralSurface (const QgsMultiPolygon *multiPolygon)
 Creates a polyhedral surface from a multiPolygon.
 
 QgsPolyhedralSurface (const QgsPolyhedralSurface &p)
 
 ~QgsPolyhedralSurface () override
 
bool addMValue (double mValue=0) override
 Adds a measure to the geometry, initialized to a preset value.
 
virtual void addPatch (QgsPolygon *patch)
 Adds a patch to the geometry, transferring ownership to the polyhedral surface.
 
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.
 
QgsAbstractGeometryboundary () const override
 Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of 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.
 
QgsPolyhedralSurfaceclone () 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.
 
QgsPolyhedralSurfacecreateEmptyWithSameType () 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 final
 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.
 
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.
 
QString geometryType () const override
 Returns a unique string representing the geometry type.
 
bool hasCurvedSegments () const final
 Returns true if the geometry contains curved segments.
 
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.
 
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 () override
 Reorganizes the geometry into a normalized form (or "canonical" form).
 
int numPatches () const
 Returns the number of patches contained with the polyhedral surface.
 
bool operator!= (const QgsAbstractGeometry &other) const override
 
QgsPolyhedralSurfaceoperator= (const QgsPolyhedralSurface &p)
 
bool operator== (const QgsAbstractGeometry &other) const override
 
int partCount () const override
 Returns count of parts contained in the geometry.
 
QgsPolygonpatchN (int i)
 Retrieves a patch from the polyhedral surface.
 
const QgsPolygonpatchN (int i) const
 Retrieves a patch from the polyhedral surface.
 
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.
 
bool removePatch (int patchIndex)
 Removes a patch from the polyhedral surface.
 
int ringCount (int part=0) const override
 Returns the number of rings of which this geometry is built.
 
QgsAbstractGeometrysegmentize (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.
 
virtual void setPatches (const QVector< QgsPolygon * > &patches)
 Sets all patches, transferring ownership to the polyhedral surface.
 
QgsPolyhedralSurfacesimplifyByDistance (double tolerance) const override
 Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.
 
QgsPolyhedralSurfacesnappedToGrid (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.
 
QgsMultiSurfacetoCurveType () const override
 Returns the geometry converted to the more generic curve type.
 
QgsMultiPolygontoMultiPolygon () const
 Converts a polyhedral surface to a multipolygon.
 
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 rotation angle for 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 QgsSurface
QgsBox3D boundingBox3D () const override
 Returns the 3D bounding box for the geometry.
 
bool isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override
 Checks validity of the geometry, and returns true if the geometry is valid.
 
- 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.
 
virtual double length () const
 Returns the planar, 2-dimensional length of the geometry.
 
QgsAbstractGeometryoperator= (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.
 
virtual const QgsAbstractGeometrysimplifiedTypeRef () const
 Returns a reference to the simplest lossless representation of this geometry, e.g.
 
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 QgsPolyhedralSurfacecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsPolyhedralSurface.
 
- Static Public Member Functions inherited from QgsSurface
static const QgsSurfacecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsSurface.
 

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.
 
QgsAbstractGeometrychildGeometry (int index) const override
 Returns pointer to child geometry (for geometries with child geometries - i.e.
 
int compareToSameClass (const QgsAbstractGeometry *other) const override
 Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.
 
- Protected Member Functions inherited from QgsSurface
void clearCache () const override
 Clears any cached parameters associated with the geometry, e.g., bounding boxes.
 
- 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< QgsPolygon * > mPatches
 
- Protected Attributes inherited from QgsSurface
QgsBox3D mBoundingBox
 
bool mHasCachedValidity = false
 
QString mValidityFailureReason
 
- 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< WkbFlagWkbFlags
 

Detailed Description

Polyhedral surface geometry type.

A polyhedral surface is a collection of polygons which share common boundary segments.

Since
QGIS 3.40

Definition at line 37 of file qgspolyhedralsurface.h.

Constructor & Destructor Documentation

◆ QgsPolyhedralSurface() [1/3]

QgsPolyhedralSurface::QgsPolyhedralSurface ( )

Definition at line 38 of file qgspolyhedralsurface.cpp.

◆ QgsPolyhedralSurface() [2/3]

QgsPolyhedralSurface::QgsPolyhedralSurface ( const QgsPolyhedralSurface p)

Definition at line 81 of file qgspolyhedralsurface.cpp.

◆ QgsPolyhedralSurface() [3/3]

QgsPolyhedralSurface::QgsPolyhedralSurface ( const QgsMultiPolygon multiPolygon)

Creates a polyhedral surface from a multiPolygon.

Definition at line 43 of file qgspolyhedralsurface.cpp.

◆ ~QgsPolyhedralSurface()

QgsPolyhedralSurface::~QgsPolyhedralSurface ( )
override

Definition at line 59 of file qgspolyhedralsurface.cpp.

Member Function Documentation

◆ addMValue()

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

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

Parameters
mValueinitial m-value for all nodes
Returns
true on success
See also
dropMValue()
addZValue()

Implements QgsAbstractGeometry.

Definition at line 839 of file qgspolyhedralsurface.cpp.

◆ addPatch()

void QgsPolyhedralSurface::addPatch ( QgsPolygon patch)
virtual

Adds a patch to the geometry, transferring ownership to the polyhedral surface.

Reimplemented in QgsTriangulatedSurface.

Definition at line 505 of file qgspolyhedralsurface.cpp.

◆ addZValue()

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

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

Parameters
zValueinitial z-value for all nodes
Returns
true on success
See also
dropZValue()
addMValue()

Implements QgsAbstractGeometry.

Definition at line 822 of file qgspolyhedralsurface.cpp.

◆ adjacentVertices()

void QgsPolyhedralSurface::adjacentVertices ( QgsVertexId  vertex,
QgsVertexId previousVertex,
QgsVertexId nextVertex 
) const
overridevirtual

Returns the vertices adjacent to a specified vertex within a geometry.

Implements QgsAbstractGeometry.

Definition at line 679 of file qgspolyhedralsurface.cpp.

◆ area()

double QgsPolyhedralSurface::area ( ) const
overridevirtual

Returns the planar, 2-dimensional area of the geometry.

Warning
QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the area returned by this method is calculated using strictly Cartesian mathematics. In contrast, the QgsDistanceArea class exposes methods for calculating the areas of geometries using geodesic calculations which account for the curvature of the Earth (or any other celestial body).
See also
length()
perimeter()

Reimplemented from QgsAbstractGeometry.

Definition at line 352 of file qgspolyhedralsurface.cpp.

◆ asGml2()

QDomElement QgsPolyhedralSurface::asGml2 ( QDomDocument &  doc,
int  precision = 17,
const QString &  ns = "gml",
QgsAbstractGeometry::AxisOrder  axisOrder = QgsAbstractGeometry::AxisOrder::XY 
) const
overridevirtual

Returns a GML2 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
axisOrderAxis order for generated GML
See also
asWkb()
asWkt()
asGml3()
asJson()

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 280 of file qgspolyhedralsurface.cpp.

◆ asGml3()

QDomElement QgsPolyhedralSurface::asGml3 ( QDomDocument &  doc,
int  precision = 17,
const QString &  ns = "gml",
QgsAbstractGeometry::AxisOrder  axisOrder = QgsAbstractGeometry::AxisOrder::XY 
) const
overridevirtual

Returns a GML3 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
axisOrderAxis order for generated GML
See also
asWkb()
asWkt()
asGml2()
asJson()

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 286 of file qgspolyhedralsurface.cpp.

◆ asJsonObject()

json QgsPolyhedralSurface::asJsonObject ( int  precision = 17) const
overridevirtual

Returns a json object representation of the geometry.

See also
asWkb()
asWkt()
asGml2()
asGml3()
asJson()
Note
not available in Python bindings
Since
QGIS 3.10

Reimplemented from QgsAbstractGeometry.

Definition at line 307 of file qgspolyhedralsurface.cpp.

◆ asKml()

QString QgsPolyhedralSurface::asKml ( int  precision = 17) const
overridevirtual

Returns a KML representation of the geometry.

Since
QGIS 3.12

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 315 of file qgspolyhedralsurface.cpp.

◆ asQPainterPath()

QPainterPath QgsPolyhedralSurface::asQPainterPath ( ) const
overridevirtual

Returns the geometry represented as a QPainterPath.

Warning
not all geometry subclasses can be represented by a QPainterPath, e.g. points and multipoint geometries will return an empty path.
Since
QGIS 3.16

Implements QgsAbstractGeometry.

Definition at line 542 of file qgspolyhedralsurface.cpp.

◆ asWkb()

QByteArray QgsPolyhedralSurface::asWkb ( QgsAbstractGeometry::WkbFlags  flags = QgsAbstractGeometry::WkbFlags()) const
overridevirtual

Returns a WKB representation of the geometry.

The optional flags argument specifies flags controlling WKB export behavior (since QGIS 3.14).

See also
asWkt
asGml2
asGml3
asJson()

Implements QgsAbstractGeometry.

Definition at line 237 of file qgspolyhedralsurface.cpp.

◆ asWkt()

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

Returns a WKT representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See also
asWkb()
asGml2()
asGml3()
asJson()

Implements QgsAbstractGeometry.

Definition at line 252 of file qgspolyhedralsurface.cpp.

◆ boundary()

QgsAbstractGeometry * QgsPolyhedralSurface::boundary ( ) const
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.

Returns
boundary for geometry. May be nullptr for some geometry types.

Implements QgsAbstractGeometry.

Definition at line 376 of file qgspolyhedralsurface.cpp.

◆ boundingBoxIntersects()

bool QgsPolyhedralSurface::boundingBoxIntersects ( const QgsBox3D box3d) const
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.

Since
QGIS 3.34

Reimplemented from QgsAbstractGeometry.

Definition at line 465 of file qgspolyhedralsurface.cpp.

◆ calculateBoundingBox3D()

QgsBox3D QgsPolyhedralSurface::calculateBoundingBox3D ( ) const
overrideprotectedvirtual

Calculates the minimal 3D bounding box for the geometry.

See also
calculateBoundingBox()
Since
QGIS 3.34

Reimplemented from QgsAbstractGeometry.

Definition at line 211 of file qgspolyhedralsurface.cpp.

◆ cast()

static const QgsPolyhedralSurface * QgsPolyhedralSurface::cast ( const QgsAbstractGeometry geom)
inlinestatic

Cast the geom to a QgsPolyhedralSurface.

Should be used by qgsgeometry_cast<QgsPolyhedralSurface *>( geometry ).

Note
Not available in Python. Objects will be automatically be converted to the appropriate target type.

Definition at line 309 of file qgspolyhedralsurface.h.

◆ childCount()

int QgsPolyhedralSurface::childCount ( ) const
overrideprotectedvirtual

Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.

curve / point)

Note
used for vertex_iterator implementation

Reimplemented from QgsAbstractGeometry.

Definition at line 960 of file qgspolyhedralsurface.cpp.

◆ childGeometry()

QgsAbstractGeometry * QgsPolyhedralSurface::childGeometry ( int  index) const
overrideprotectedvirtual

Returns pointer to child geometry (for geometries with child geometries - i.e.

geom. collection / polygon)

Note
used for vertex_iterator implementation

Reimplemented from QgsAbstractGeometry.

Definition at line 965 of file qgspolyhedralsurface.cpp.

◆ clear()

void QgsPolyhedralSurface::clear ( )
overridevirtual

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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 119 of file qgspolyhedralsurface.cpp.

◆ clone()

QgsPolyhedralSurface * QgsPolyhedralSurface::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 114 of file qgspolyhedralsurface.cpp.

◆ closestSegment()

double QgsPolyhedralSurface::closestSegment ( const QgsPoint pt,
QgsPoint segmentPt,
QgsVertexId vertexAfter,
int *  leftOf = nullptr,
double  epsilon = 4 *std::numeric_limits< double >::epsilon() 
) const
overridevirtual

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

Parameters
ptspecifies the point to find closest segment to
segmentPtstorage for the closest point within the geometry
vertexAfterstorage for the ID of the vertex at the end of the closest segment
leftOfindicates 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)
epsilonepsilon for segment snapping
Returns
squared distance to closest segment or negative value on error

Implements QgsAbstractGeometry.

Definition at line 642 of file qgspolyhedralsurface.cpp.

◆ compareToSameClass()

int QgsPolyhedralSurface::compareToSameClass ( const QgsAbstractGeometry other) const
overrideprotectedvirtual

Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.

Note
The actual logic for the sorting is an internal detail only and is subject to change between QGIS versions. The result should only be used for direct comparison of geometries and not stored for later use.
Since
QGIS 3.20

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 970 of file qgspolyhedralsurface.cpp.

◆ coordinateSequence()

QgsCoordinateSequence QgsPolyhedralSurface::coordinateSequence ( ) const
overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Returns
coordinate sequence

Implements QgsAbstractGeometry.

Definition at line 584 of file qgspolyhedralsurface.cpp.

◆ createEmptyWithSameType()

QgsPolyhedralSurface * QgsPolyhedralSurface::createEmptyWithSameType ( ) const
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.

See also
clone()

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 64 of file qgspolyhedralsurface.cpp.

◆ deleteVertex()

bool QgsPolyhedralSurface::deleteVertex ( QgsVertexId  position)
overridevirtual

Deletes a vertex within the geometry.

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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 727 of file qgspolyhedralsurface.cpp.

◆ dimension()

int QgsPolyhedralSurface::dimension ( ) const
finalvirtual

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 76 of file qgspolyhedralsurface.cpp.

◆ draw()

void QgsPolyhedralSurface::draw ( QPainter &  p) const
overridevirtual

Draws the geometry using the specified QPainter.

Parameters
pdestination QPainter

Implements QgsAbstractGeometry.

Definition at line 555 of file qgspolyhedralsurface.cpp.

◆ dropMValue()

bool QgsPolyhedralSurface::dropMValue ( )
overridevirtual

Drops any measure values which exist in the geometry.

Returns
true if m-values were present and have been removed
See also
addMValue()
dropZValue()

Implements QgsAbstractGeometry.

Definition at line 872 of file qgspolyhedralsurface.cpp.

◆ dropZValue()

bool QgsPolyhedralSurface::dropZValue ( )
overridevirtual

Drops any z-dimensions which exist in the geometry.

Returns
true if Z values were present and have been removed
See also
addZValue()
dropMValue()

Implements QgsAbstractGeometry.

Definition at line 856 of file qgspolyhedralsurface.cpp.

◆ filterVertices()

void QgsPolyhedralSurface::filterVertices ( const std::function< bool(const QgsPoint &) > &  filter)
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.

Note
Not available in Python bindings
Since
QGIS 3.2

Reimplemented from QgsAbstractGeometry.

Definition at line 940 of file qgspolyhedralsurface.cpp.

◆ fromWkb()

bool QgsPolyhedralSurface::fromWkb ( QgsConstWkbPtr wkb)
overridevirtual

Sets the geometry from a WKB string.

After successful read the wkb argument will be at the position where the reading has stopped.

See also
fromWkt

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 128 of file qgspolyhedralsurface.cpp.

◆ fromWkt()

bool QgsPolyhedralSurface::fromWkt ( const QString &  wkt)
overridevirtual

Sets the geometry from a WKT string.

See also
fromWkb

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 167 of file qgspolyhedralsurface.cpp.

◆ fuzzyDistanceEqual()

bool QgsPolyhedralSurface::fuzzyDistanceEqual ( const QgsAbstractGeometry other,
double  epsilon = 1e-8 
) const
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).

See also
fuzzyEqual
QgsGeometryUtilsBase::fuzzyEqual
Since
QGIS 3.36

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 95 of file qgspolyhedralsurface.h.

◆ fuzzyEqual()

bool QgsPolyhedralSurface::fuzzyEqual ( const QgsAbstractGeometry other,
double  epsilon = 1e-8 
) const
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.

See also
fuzzyDistanceEqual
QgsGeometryUtilsBase::fuzzyDistanceEqual
Since
QGIS 3.36

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 91 of file qgspolyhedralsurface.h.

◆ geometryType()

QString QgsPolyhedralSurface::geometryType ( ) const
overridevirtual

Returns a unique string representing the geometry type.

See also
wkbType
wktTypeStr

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 71 of file qgspolyhedralsurface.cpp.

◆ hasCurvedSegments()

bool QgsPolyhedralSurface::hasCurvedSegments ( ) const
finalvirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometry.

Definition at line 749 of file qgspolyhedralsurface.cpp.

◆ insertVertex()

bool QgsPolyhedralSurface::insertVertex ( QgsVertexId  position,
const QgsPoint vertex 
)
overridevirtual

Inserts a vertex into the geometry.

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

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 693 of file qgspolyhedralsurface.cpp.

◆ isEmpty()

bool QgsPolyhedralSurface::isEmpty ( ) const
overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 637 of file qgspolyhedralsurface.cpp.

◆ isValid()

bool QgsPolyhedralSurface::isValid ( QString &  error,
Qgis::GeometryValidityFlags  flags = Qgis::GeometryValidityFlags() 
) const
overridevirtual

Checks validity of the geometry, and returns true if the geometry is valid.

Parameters
errorwill be set to the validity error message
flagsindicates optional flags which control the type of validity checking performed (corresponding to Qgis::GeometryValidityFlags).
Returns
true if geometry is valid
Since
QGIS 3.8

Implements QgsAbstractGeometry.

Definition at line 999 of file qgspolyhedralsurface.cpp.

◆ moveVertex()

bool QgsPolyhedralSurface::moveVertex ( QgsVertexId  position,
const QgsPoint newPos 
)
overridevirtual

Moves a vertex within the geometry.

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

Implements QgsAbstractGeometry.

Definition at line 710 of file qgspolyhedralsurface.cpp.

◆ nCoordinates()

int QgsPolyhedralSurface::nCoordinates ( ) const
overridevirtual

Returns the number of nodes contained in the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 600 of file qgspolyhedralsurface.cpp.

◆ nextVertex()

bool QgsPolyhedralSurface::nextVertex ( QgsVertexId id,
QgsPoint vertex 
) const
overridevirtual

Returns next vertex id and coordinates.

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

Implements QgsAbstractGeometry.

Definition at line 648 of file qgspolyhedralsurface.cpp.

◆ normalize()

void QgsPolyhedralSurface::normalize ( )
overridevirtual

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.

Since
QGIS 3.20

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 321 of file qgspolyhedralsurface.cpp.

◆ numPatches()

int QgsPolyhedralSurface::numPatches ( ) const
inline

Returns the number of patches contained with the polyhedral surface.

See also
patchN()

Definition at line 145 of file qgspolyhedralsurface.h.

◆ operator!=()

bool QgsPolyhedralSurface::operator!= ( const QgsAbstractGeometry other) const
inlineoverridevirtual

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 105 of file qgspolyhedralsurface.h.

◆ operator=()

QgsPolyhedralSurface & QgsPolyhedralSurface::operator= ( const QgsPolyhedralSurface p)

Definition at line 99 of file qgspolyhedralsurface.cpp.

◆ operator==()

bool QgsPolyhedralSurface::operator== ( const QgsAbstractGeometry other) const
inlineoverridevirtual

Implements QgsAbstractGeometry.

Reimplemented in QgsTriangulatedSurface.

Definition at line 100 of file qgspolyhedralsurface.h.

◆ partCount()

int QgsPolyhedralSurface::partCount ( ) const
overridevirtual

Returns count of parts contained in the geometry.

See also
vertexCount
ringCount

Implements QgsAbstractGeometry.

Definition at line 798 of file qgspolyhedralsurface.cpp.

◆ patchN() [1/2]

QgsPolygon * QgsPolyhedralSurface::patchN ( int  i)
inline

Retrieves a patch from the polyhedral surface.

The first patch has index 0.

See also
numPatches()

Definition at line 171 of file qgspolyhedralsurface.h.

◆ patchN() [2/2]

const QgsPolygon * QgsPolyhedralSurface::patchN ( int  i) const
inline

Retrieves a patch from the polyhedral surface.

The first patch has index 0.

See also
numPatches()

Definition at line 157 of file qgspolyhedralsurface.h.

◆ perimeter()

double QgsPolyhedralSurface::perimeter ( ) const
overridevirtual

Returns the planar, 2-dimensional perimeter of the geometry.

Warning
QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the perimeter returned by this method is calculated using strictly Cartesian mathematics. In contrast, the QgsDistanceArea class exposes methods for calculating the perimeters of geometries using geodesic calculations which account for the curvature of the Earth (or any other celestial body).
See also
area()
length()

Reimplemented from QgsAbstractGeometry.

Definition at line 364 of file qgspolyhedralsurface.cpp.

◆ removeDuplicateNodes()

bool QgsPolyhedralSurface::removeDuplicateNodes ( double  epsilon = 4 *std::numeric_limits< double >::epsilon(),
bool  useZValues = false 
)
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 451 of file qgspolyhedralsurface.cpp.

◆ removePatch()

bool QgsPolyhedralSurface::removePatch ( int  patchIndex)

Removes a patch from the polyhedral surface.

The first patch has index 0. The corresponding patch is removed from the polyhedral surface and deleted. If a patch was successfully removed the function will return true.

Definition at line 530 of file qgspolyhedralsurface.cpp.

◆ ringCount()

int QgsPolyhedralSurface::ringCount ( int  part = 0) const
overridevirtual

Returns the number of rings of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 790 of file qgspolyhedralsurface.cpp.

◆ segmentize()

QgsAbstractGeometry * QgsPolyhedralSurface::segmentize ( double  tolerance = M_PI_2 / 90,
SegmentationToleranceType  toleranceType = MaximumAngle 
) const
overridevirtual

Returns a geometry without curves.

Caller takes ownership

Parameters
tolerancesegmentation tolerance
toleranceTypemaximum segmentation angle or maximum difference between approximation and curve

Reimplemented from QgsAbstractGeometry.

Definition at line 754 of file qgspolyhedralsurface.cpp.

◆ segmentLength()

double QgsPolyhedralSurface::segmentLength ( QgsVertexId  startVertex) const
overridevirtual

Returns the length of the segment of the geometry which begins at startVertex.

Warning
QgsAbstractGeometry objects are inherently Cartesian/planar geometries, and the lengths returned by this method are calculated using strictly Cartesian mathematics.

Implements QgsAbstractGeometry.

Definition at line 811 of file qgspolyhedralsurface.cpp.

◆ setPatches()

void QgsPolyhedralSurface::setPatches ( const QVector< QgsPolygon * > &  patches)
virtual

Sets all patches, transferring ownership to the polyhedral surface.

Definition at line 492 of file qgspolyhedralsurface.cpp.

◆ simplifyByDistance()

QgsPolyhedralSurface * QgsPolyhedralSurface::simplifyByDistance ( double  tolerance) const
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.

Since
QGIS 3.38

Implements QgsAbstractGeometry.

Definition at line 437 of file qgspolyhedralsurface.cpp.

◆ snappedToGrid()

QgsPolyhedralSurface * QgsPolyhedralSurface::snappedToGrid ( double  hSpacing,
double  vSpacing,
double  dSpacing = 0,
double  mSpacing = 0,
bool  removeRedundantPoints = false 
) const
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:

geometry.snappedToGrid(1, 1)

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).

Parameters
hSpacingHorizontal spacing of the grid (x axis). 0 to disable.
vSpacingVertical spacing of the grid (y axis). 0 to disable.
dSpacingDepth spacing of the grid (z axis). 0 (default) to disable.
mSpacingCustom dimension spacing of the grid (m axis). 0 (default) to disable.
removeRedundantPointsif 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.

Reimplemented in QgsTriangulatedSurface.

Definition at line 403 of file qgspolyhedralsurface.cpp.

◆ swapXy()

void QgsPolyhedralSurface::swapXy ( )
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.

Since
QGIS 3.2

Implements QgsAbstractGeometry.

Definition at line 888 of file qgspolyhedralsurface.cpp.

◆ toCurveType()

QgsMultiSurface * QgsPolyhedralSurface::toCurveType ( ) const
overridevirtual

Returns the geometry converted to the more generic curve type.

E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface

Returns
the converted geometry. Caller takes ownership

Implements QgsAbstractGeometry.

Definition at line 897 of file qgspolyhedralsurface.cpp.

◆ toMultiPolygon()

QgsMultiPolygon * QgsPolyhedralSurface::toMultiPolygon ( ) const

Converts a polyhedral surface to a multipolygon.

Caller takes ownership.

Definition at line 929 of file qgspolyhedralsurface.cpp.

◆ transform() [1/3]

void QgsPolyhedralSurface::transform ( const QgsCoordinateTransform ct,
Qgis::TransformDirection  d = Qgis::TransformDirection::Forward,
bool  transformZ = false 
)
overridevirtual

Transforms the geometry using a coordinate transform.

Parameters
ctcoordinate transform
dtransformation direction
transformZset 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 566 of file qgspolyhedralsurface.cpp.

◆ transform() [2/3]

void QgsPolyhedralSurface::transform ( const QTransform &  t,
double  zTranslate = 0.0,
double  zScale = 1.0,
double  mTranslate = 0.0,
double  mScale = 1.0 
)
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 575 of file qgspolyhedralsurface.cpp.

◆ transform() [3/3]

bool QgsPolyhedralSurface::transform ( QgsAbstractGeometryTransformer transformer,
QgsFeedback feedback = nullptr 
)
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.

Returns
true if the geometry was successfully transformed.
Since
QGIS 3.18

Implements QgsAbstractGeometry.

Definition at line 908 of file qgspolyhedralsurface.cpp.

◆ transformVertices()

void QgsPolyhedralSurface::transformVertices ( const std::function< QgsPoint(const QgsPoint &) > &  transform)
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.

Note
Not available in Python bindings
Since
QGIS 3.4

Reimplemented from QgsAbstractGeometry.

Definition at line 950 of file qgspolyhedralsurface.cpp.

◆ vertexAngle()

double QgsPolyhedralSurface::vertexAngle ( QgsVertexId  vertex) const
overridevirtual

Returns approximate rotation angle for a vertex.

Usually average angle between adjacent segments.

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

Implements QgsAbstractGeometry.

Definition at line 762 of file qgspolyhedralsurface.cpp.

◆ vertexAt()

QgsPoint QgsPolyhedralSurface::vertexAt ( QgsVertexId  id) const
overridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometry.

Definition at line 803 of file qgspolyhedralsurface.cpp.

◆ vertexCount()

int QgsPolyhedralSurface::vertexCount ( int  part = 0,
int  ring = 0 
) const
overridevirtual

Returns the number of vertices of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 773 of file qgspolyhedralsurface.cpp.

◆ vertexNumberFromVertexId()

int QgsPolyhedralSurface::vertexNumberFromVertexId ( QgsVertexId  id) const
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.

Definition at line 610 of file qgspolyhedralsurface.cpp.

◆ wkbSize()

int QgsPolyhedralSurface::wkbSize ( QgsAbstractGeometry::WkbFlags  flags = QgsAbstractGeometry::WkbFlags()) const
overridevirtual

Returns the length of the QByteArray returned by asWkb()

The optional flags argument specifies flags controlling WKB export behavior

Since
QGIS 3.16

Implements QgsAbstractGeometry.

Definition at line 227 of file qgspolyhedralsurface.cpp.

Member Data Documentation

◆ mPatches

QVector< QgsPolygon * > QgsPolyhedralSurface::mPatches
protected

Definition at line 377 of file qgspolyhedralsurface.h.


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