QGIS API Documentation 3.99.0-Master (09f76ad7019)
Loading...
Searching...
No Matches
qgsmulticurve.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmulticurve.h
3 -------------------------------------------------------------------
4Date : 28 Oct 2014
5Copyright : (C) 2014 by Marco Hugentobler
6email : marco.hugentobler at sourcepole dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSMULTICURVE_H
17#define QGSMULTICURVE_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
22
23#include <QString>
24
25using namespace Qt::StringLiterals;
26
32class CORE_EXPORT QgsMultiCurve: public QgsGeometryCollection
33{
34 public:
36
37
38#ifndef SIP_RUN
39
45 QgsCurve *curveN( int index );
46#else
47
55 SIP_PYOBJECT curveN( int index ) SIP_TYPEHINT( QgsCurve );
56 % MethodCode
57 if ( a0 < 0 || a0 >= sipCpp->numGeometries() )
58 {
59 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
60 sipIsErr = 1;
61 }
62 else
63 {
64 return sipConvertFromType( sipCpp->curveN( a0 ), sipType_QgsCurve, NULL );
65 }
66 % End
67#endif
68
69#ifndef SIP_RUN
70
78 const QgsCurve *curveN( int index ) const;
79#endif
80
81 QString geometryType() const override SIP_HOLDGIL;
82 QgsMultiCurve *clone() const override SIP_FACTORY;
83 void clear() override;
84 QgsMultiCurve *toCurveType() const override SIP_FACTORY;
85 bool fromWkt( const QString &wkt ) override;
86 QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
87 QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
88 json asJsonObject( int precision = 17 ) const override SIP_SKIP;
90 bool addGeometries( const QVector< QgsAbstractGeometry * > &geometries SIP_TRANSFER ) override;
91 bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override;
92 QgsMultiCurve *simplifyByDistance( double tolerance ) const override SIP_FACTORY;
93
98
100
101#ifndef SIP_RUN
102
111 inline static const QgsMultiCurve *cast( const QgsAbstractGeometry *geom ) // cppcheck-suppress duplInheritedMember
112 {
113 if ( !geom )
114 return nullptr;
115
116 const Qgis::WkbType flatType = QgsWkbTypes::flatType( geom->wkbType() );
117 if ( flatType == Qgis::WkbType::MultiCurve
118 || flatType == Qgis::WkbType::MultiLineString )
119 return static_cast<const QgsMultiCurve *>( geom );
120 return nullptr;
121 }
122
131 inline static QgsMultiCurve *cast( QgsAbstractGeometry *geom ) // cppcheck-suppress duplInheritedMember
132 {
133 if ( !geom )
134 return nullptr;
135
136 const Qgis::WkbType flatType = QgsWkbTypes::flatType( geom->wkbType() );
137 if ( flatType == Qgis::WkbType::MultiCurve
138 || flatType == Qgis::WkbType::MultiLineString )
139 return static_cast<QgsMultiCurve *>( geom );
140 return nullptr;
141 }
142#endif
143
145
146#ifdef SIP_RUN
147 SIP_PYOBJECT __repr__();
148 % MethodCode
149 QString wkt = sipCpp->asWkt();
150 if ( wkt.length() > 1000 )
151 wkt = wkt.left( 1000 ) + u"..."_s;
152 QString str = u"<QgsMultiCurve: %1>"_s.arg( wkt );
153 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
154 % End
155#endif
156
157};
158
159// clazy:excludeall=qstring-allocations
160
161#endif // QGSMULTICURVE_H
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:280
@ MultiLineString
MultiLineString.
Definition qgis.h:287
@ MultiCurve
MultiCurve.
Definition qgis.h:293
AxisOrder
Axis order for GML generation.
@ XY
X comes before Y (or lon before lat).
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
QgsAbstractGeometry()=default
Abstract base class for curved geometry type.
Definition qgscurve.h:36
QgsGeometryCollection * toCurveType() const override
Returns the geometry converted to the more generic curve type.
json asJsonObject(int precision=17) const override
Returns a json object representation of the geometry.
bool fromWkt(const QString &wkt) override
Sets the geometry from a WKT string.
void clear() override
Clears the geometry, ie reset it to a null geometry.
QString geometryType() const override
Returns a unique string representing the geometry type.
virtual bool insertGeometry(QgsAbstractGeometry *g, int index)
Inserts a geometry before a specified index and takes ownership.
QgsGeometryCollection * simplifyByDistance(double tolerance) const override
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.
QgsGeometryCollection()
Constructor for an empty geometry collection.
QgsAbstractGeometry * boundary() const override
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the...
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.
QgsGeometryCollection * clone() const override
Clones the geometry by performing a deep copy.
virtual bool addGeometries(const QVector< QgsAbstractGeometry * > &geometries)
Adds a list of geometries to the collection, transferring ownership to the collection.
QgsGeometryCollection * createEmptyWithSameType() const override
Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
virtual bool addGeometry(QgsAbstractGeometry *g)
Adds a geometry and takes ownership. Returns true in case of success.
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.
Multi curve geometry collection.
QgsMultiCurve * reversed() const
Returns a copy of the multi curve, where each component curve has had its line direction reversed.
static QgsMultiCurve * cast(QgsAbstractGeometry *geom)
Cast the geom to a QgsMultiCurve.
static const QgsMultiCurve * cast(const QgsAbstractGeometry *geom)
Cast the geom to a QgsMultiCurve.
QgsCurve * curveN(int index)
Returns the curve with the specified index.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
#define SIP_TYPEHINT(type)
Definition qgis_sip.h:240
#define SIP_SKIP
Definition qgis_sip.h:134
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_HOLDGIL
Definition qgis_sip.h:179
#define SIP_FACTORY
Definition qgis_sip.h:84