QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Multi line string geometry collection. More...
#include <qgsmultilinestring.h>
Public Member Functions | |
QgsMultiLineString () | |
Constructor for an empty multilinestring geometry. | |
QgsMultiLineString (const QList< QgsLineString * > &linestrings) | |
Constructor for a multilinestring containing the specified linestrings. | |
QgsMultiLineString (const QList< QgsLineString > &linestrings) | |
Constructor for a multilinestring containing the specified linestrings. | |
bool | addGeometries (const QVector< QgsAbstractGeometry * > &geometries) final |
Adds a list of geometries to the collection, transferring ownership to the collection. | |
bool | addGeometry (QgsAbstractGeometry *g) override |
Adds a geometry and takes ownership. Returns true in case of success. | |
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. | |
void | clear () override |
Clears the geometry, ie reset it to a null geometry. | |
QgsMultiLineString * | clone () const override |
Clones the geometry by performing a deep copy. | |
QgsMultiLineString * | createEmptyWithSameType () const override |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. | |
bool | fromWkt (const QString &wkt) override |
Sets the geometry from a WKT string. | |
QString | geometryType () const override |
Returns a unique string representing the geometry type. | |
bool | insertGeometry (QgsAbstractGeometry *g, int index) override |
Inserts a geometry before a specified index and takes ownership. | |
QgsLineString * | lineStringN (int index) |
Returns the line string with the specified index. | |
const QgsLineString * | lineStringN (int index) const |
Returns the line string with the specified index. | |
QgsMultiLineString * | measuredLine (double start, double end) const |
Re-write the measure ordinate (or add one, if it isn't already there) interpolating the measure between the supplied start and end values. | |
QgsMultiLineString * | simplifyByDistance (double tolerance) const override |
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm. | |
QgsMultiCurve * | toCurveType () const override |
Returns the geometry converted to the more generic curve type QgsMultiCurve. | |
Public Member Functions inherited from QgsMultiCurve | |
QgsMultiCurve () | |
QgsAbstractGeometry * | boundary () const override |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). | |
QgsCurve * | curveN (int index) |
Returns the curve with the specified index. | |
const QgsCurve * | curveN (int index) const |
Returns the curve with the specified index. | |
QgsMultiCurve * | reversed () const |
Returns a copy of the multi curve, where each component curve has had its line direction reversed. | |
Public Member Functions inherited from QgsGeometryCollection | |
QgsGeometryCollection () | |
Constructor for an empty geometry collection. | |
QgsGeometryCollection (const QgsGeometryCollection &c) | |
~QgsGeometryCollection () override | |
bool | addMValue (double mValue=0) override |
Adds a measure to the geometry, initialized to a preset value. | |
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. | |
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. | |
QgsBox3D | boundingBox3D () const override |
Returns the 3D bounding box for the geometry. | |
bool | boundingBoxIntersects (const QgsBox3D &box3d) const override |
Returns true if the bounding box of this geometry intersects with a box3d. | |
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. | |
bool | deleteVertex (QgsVertexId position) override |
Deletes a vertex within the geometry. | |
int | dimension () const override |
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. | |
QgsGeometryCollection * | extractPartsByType (Qgis::WkbType type, bool useFlatType=true) const |
Returns a new QgsGeometryCollection subclass which consists of the parts of this collection which match the specified WKB type. | |
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 | 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. | |
QgsAbstractGeometry * | geometryN (int n) |
Returns a geometry from within the collection. | |
const QgsAbstractGeometry * | geometryN (int n) const |
Returns a const reference to a geometry from within the collection. | |
bool | hasCurvedSegments () const override |
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. | |
double | length () const override |
Returns the planar, 2-dimensional length of the geometry. | |
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 () final |
Reorganizes the geometry into a normalized form (or "canonical" form). | |
int | numGeometries () const |
Returns the number of geometries within the collection. | |
bool | operator!= (const QgsAbstractGeometry &other) const override |
QgsGeometryCollection & | operator= (const QgsGeometryCollection &c) |
bool | operator== (const QgsAbstractGeometry &other) const override |
int | partCount () const override |
Returns count of parts contained in the geometry. | |
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. | |
virtual bool | removeGeometry (int nr) |
Removes a geometry from the collection. | |
void | reserve (int size) |
Attempts to allocate memory for at least size geometries. | |
int | ringCount (int part=0) const override |
Returns the number of rings of which this geometry is built. | |
QgsAbstractGeometry * | segmentize (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. | |
const QgsAbstractGeometry * | simplifiedTypeRef () const override |
Returns a reference to the simplest lossless representation of this geometry, e.g. | |
QgsGeometryCollection * | snappedToGrid (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. | |
QVector< QgsAbstractGeometry * > | takeGeometries () |
Removes all geometries from the collection, returning them and their ownership to the caller. | |
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 angle at 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 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. | |
QgsAbstractGeometry & | operator= (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. | |
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 QgsMultiLineString * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsMultiLineString. | |
Static Public Member Functions inherited from QgsMultiCurve | |
static const QgsMultiCurve * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsMultiCurve. | |
Static Public Member Functions inherited from QgsGeometryCollection | |
static const QgsGeometryCollection * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsGeometryCollection. | |
Protected Member Functions | |
bool | wktOmitChildType () const override |
Returns whether child type names are omitted from Wkt representations of the collection. | |
Protected Member Functions inherited from QgsGeometryCollection | |
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. | |
QgsAbstractGeometry * | childGeometry (int index) const override |
Returns pointer to child geometry (for geometries with child geometries - i.e. | |
void | clearCache () const override |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. | |
int | compareToSameClass (const QgsAbstractGeometry *other) const final |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. | |
bool | fromCollectionWkt (const QString &wkt, const QVector< QgsAbstractGeometry * > &subtypes, const QString &defaultChildWkbType=QString()) |
Reads a collection from a WKT string. | |
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. | |
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< WkbFlag > | WkbFlags |
Protected Attributes inherited from QgsGeometryCollection | |
QVector< QgsAbstractGeometry * > | mGeometries |
Protected Attributes inherited from QgsAbstractGeometry | |
Qgis::WkbType | mWkbType = Qgis::WkbType::Unknown |
Multi line string geometry collection.
Definition at line 30 of file qgsmultilinestring.h.
QgsMultiLineString::QgsMultiLineString | ( | ) |
Constructor for an empty multilinestring geometry.
Definition at line 29 of file qgsmultilinestring.cpp.
QgsMultiLineString::QgsMultiLineString | ( | const QList< QgsLineString > & | linestrings | ) |
Constructor for a multilinestring containing the specified linestrings.
The linestrings will be internally cloned.
Definition at line 34 of file qgsmultilinestring.cpp.
QgsMultiLineString::QgsMultiLineString | ( | const QList< QgsLineString * > & | linestrings | ) |
Constructor for a multilinestring containing the specified linestrings.
Ownership of the linestrings will be transferred to the multilinestring.
Definition at line 48 of file qgsmultilinestring.cpp.
|
finalvirtual |
Adds a list of geometries to the collection, transferring ownership to the collection.
Returns true
in case of success.
Reimplemented from QgsMultiCurve.
Definition at line 183 of file qgsmultilinestring.cpp.
|
overridevirtual |
Adds a geometry and takes ownership. Returns true
in case of success.
Reimplemented from QgsMultiCurve.
Definition at line 160 of file qgsmultilinestring.cpp.
|
overridevirtual |
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 |
Reimplemented from QgsMultiCurve.
Definition at line 100 of file qgsmultilinestring.cpp.
|
overridevirtual |
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 |
Reimplemented from QgsMultiCurve.
Definition at line 120 of file qgsmultilinestring.cpp.
|
overridevirtual |
Returns a json object representation of the geometry.
Reimplemented from QgsMultiCurve.
Definition at line 140 of file qgsmultilinestring.cpp.
|
inlinestatic |
Cast the geom to a QgsMultiLineString.
Should be used by qgsgeometry_cast<QgsMultiLineString *>( geometry ).
Definition at line 126 of file qgsmultilinestring.h.
|
overridevirtual |
Clears the geometry, ie reset it to a null geometry.
Reimplemented from QgsMultiCurve.
Definition at line 89 of file qgsmultilinestring.cpp.
|
overridevirtual |
Clones the geometry by performing a deep copy.
Reimplemented from QgsMultiCurve.
Definition at line 84 of file qgsmultilinestring.cpp.
|
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.
Reimplemented from QgsMultiCurve.
Definition at line 77 of file qgsmultilinestring.cpp.
|
overridevirtual |
Sets the geometry from a WKT string.
Reimplemented from QgsMultiCurve.
Definition at line 95 of file qgsmultilinestring.cpp.
|
overridevirtual |
Returns a unique string representing the geometry type.
Reimplemented from QgsMultiCurve.
Definition at line 72 of file qgsmultilinestring.cpp.
|
overridevirtual |
Inserts a geometry before a specified index and takes ownership.
Returns true
in case of success.
g | geometry to insert. Ownership is transferred to the collection. |
index | position to insert geometry before |
Reimplemented from QgsMultiCurve.
Definition at line 216 of file qgsmultilinestring.cpp.
QgsLineString * QgsMultiLineString::lineStringN | ( | int | index | ) |
Returns the line string with the specified index.
Definition at line 62 of file qgsmultilinestring.cpp.
const QgsLineString * QgsMultiLineString::lineStringN | ( | int | index | ) | const |
Returns the line string with the specified index.
Definition at line 67 of file qgsmultilinestring.cpp.
QgsMultiLineString * QgsMultiLineString::measuredLine | ( | double | start, |
double | end | ||
) | const |
Re-write the measure ordinate (or add one, if it isn't already there) interpolating the measure between the supplied start and end values.
Definition at line 254 of file qgsmultilinestring.cpp.
|
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.
Reimplemented from QgsMultiCurve.
Definition at line 227 of file qgsmultilinestring.cpp.
|
overridevirtual |
Returns the geometry converted to the more generic curve type QgsMultiCurve.
Reimplemented from QgsMultiCurve.
Definition at line 238 of file qgsmultilinestring.cpp.
|
overrideprotectedvirtual |
Returns whether child type names are omitted from Wkt representations of the collection.
Reimplemented from QgsGeometryCollection.
Definition at line 249 of file qgsmultilinestring.cpp.