QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgssurface.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssurface.h
3 --------------
4 begin : September 2014
5 copyright : (C) 2014 by Marco Hugentobler
6 email : marco at sourcepole dot ch
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSSURFACE_H
19#define QGSSURFACE_H
20
21#include "qgis_core.h"
22#include "qgis_sip.h"
23#include "qgsabstractgeometry.h"
24#include "qgsbox3d.h"
25
26class QgsPolygon;
27
33class CORE_EXPORT QgsSurface: public QgsAbstractGeometry
34{
35 public:
36
42
43 QgsBox3D boundingBox3D() const override
44 {
45 if ( mBoundingBox.isNull() )
46 {
47 mBoundingBox = calculateBoundingBox3D();
48 }
49 return mBoundingBox;
50 }
51
52 bool isValid( QString &error SIP_OUT, Qgis::GeometryValidityFlags flags = Qgis::GeometryValidityFlags() ) const override;
53
54
55#ifndef SIP_RUN
56
63 inline static const QgsSurface *cast( const QgsAbstractGeometry *geom )
64 {
65 if ( !geom )
66 return nullptr;
67
68 const Qgis::WkbType flatType = QgsWkbTypes::flatType( geom->wkbType() );
69 if ( flatType == Qgis::WkbType::CurvePolygon
70 || flatType == Qgis::WkbType::Polygon
71 || flatType == Qgis::WkbType::Triangle )
72 return static_cast<const QgsSurface *>( geom );
73 return nullptr;
74 }
75#endif
76 protected:
77
78 void clearCache() const override;
79
81 mutable bool mHasCachedValidity = false;
82 mutable QString mValidityFailureReason;
83};
84
85#endif // QGSSURFACE_H
QFlags< GeometryValidityFlag > GeometryValidityFlags
Geometry validity flags.
Definition: qgis.h:1648
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition: qgis.h:182
@ Polygon
Polygon.
@ Triangle
Triangle.
@ CurvePolygon
CurvePolygon.
Abstract base class for all geometries.
virtual QgsBox3D calculateBoundingBox3D() const
Calculates the minimal 3D bounding box for the geometry.
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 void clearCache() const
Clears any cached parameters associated with the geometry, e.g., bounding boxes.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
A 3-dimensional box composed of x, y, z coordinates.
Definition: qgsbox3d.h:43
Polygon geometry type.
Definition: qgspolygon.h:33
Surface geometry type.
Definition: qgssurface.h:34
QgsBox3D mBoundingBox
Definition: qgssurface.h:80
QgsBox3D boundingBox3D() const override
Returns the 3D bounding box for the geometry.
Definition: qgssurface.h:43
static const QgsSurface * cast(const QgsAbstractGeometry *geom)
Cast the geom to a QgsSurface.
Definition: qgssurface.h:63
QString mValidityFailureReason
Definition: qgssurface.h:82
virtual QgsPolygon * surfaceToPolygon() const =0
Gets a polygon representation of this surface.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:628
#define SIP_OUT
Definition: qgis_sip.h:58
#define SIP_FACTORY
Definition: qgis_sip.h:76