QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsCompoundCurve Class Reference

Compound curve geometry type. More...

#include <qgscompoundcurve.h>

Inheritance diagram for QgsCompoundCurve:
Inheritance graph
[legend]

Public Member Functions

 QgsCompoundCurve ()
 
 QgsCompoundCurve (const QgsCompoundCurve &curve)
 
 ~QgsCompoundCurve () override
 
void addCurve (QgsCurve *c, bool extendPrevious=false)
 Adds a curve to the geometry (takes ownership). More...
 
bool addMValue (double mValue=0) override
 Adds a measure to the geometry, initialized to a preset value. More...
 
void addToPainterPath (QPainterPath &path) const override
 Adds a curve to a painter path. More...
 
void addVertex (const QgsPoint &pt)
 Adds a vertex to the end of the geometry. More...
 
bool addZValue (double zValue=0) override
 Adds a z-dimension to the geometry, initialized to a preset value. More...
 
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. More...
 
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. More...
 
json asJsonObject (int precision=17) const override
 Returns a json object representation of the geometry. More...
 
QByteArray asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 
QString asWkt (int precision=17) const override
 Returns a WKT representation of the geometry. More...
 
bool boundingBoxIntersects (const QgsRectangle &rectangle) const override SIP_HOLDGIL
 Returns true if the bounding box of this geometry intersects with a rectangle. More...
 
void clear () override
 Clears the geometry, ie reset it to a null geometry. More...
 
QgsCompoundCurveclone () const override
 Clones the geometry by performing a deep copy. More...
 
void close ()
 Appends first point if not already closed. More...
 
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. More...
 
void condenseCurves ()
 Condenses the curves in this geometry by combining adjacent linestrings a to a single continuous linestring, and combining adjacent circularstrings to a single continuous circularstring. More...
 
QgsCompoundCurvecreateEmptyWithSameType () const override
 Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More...
 
const QgsCurvecurveAt (int i) const SIP_HOLDGIL
 Returns the curve at the specified index. More...
 
QgsCompoundCurvecurveSubstring (double startDistance, double endDistance) const override
 Returns a new curve representing a substring of this curve. More...
 
QgsLineStringcurveToLine (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
 Returns a new line string geometry corresponding to a segmentized approximation of the curve. More...
 
bool deleteVertex (QgsVertexId position) override
 Deletes a vertex within the geometry. More...
 
int dimension () const override SIP_HOLDGIL
 Returns the inherent dimension of the geometry. More...
 
void draw (QPainter &p) const override
 Draws the geometry using the specified QPainter. More...
 
void drawAsPolygon (QPainter &p) const override
 Draws the curve as a polygon on the specified QPainter. More...
 
bool dropMValue () override
 Drops any measure values which exist in the geometry. More...
 
bool dropZValue () override
 Drops any z-dimensions which exist in the geometry. More...
 
QgsPoint endPoint () const override SIP_HOLDGIL
 Returns the end point of the curve. More...
 
bool equals (const QgsCurve &other) const override
 Checks whether this curve exactly equals another curve. More...
 
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. More...
 
bool fromWkb (QgsConstWkbPtr &wkb) override
 Sets the geometry from a WKB string. More...
 
bool fromWkt (const QString &wkt) override
 Sets the geometry from a WKT string. More...
 
QString geometryType () const override SIP_HOLDGIL
 Returns a unique string representing the geometry type. More...
 
bool hasCurvedSegments () const override
 Returns true if the geometry contains curved segments. More...
 
int indexOf (const QgsPoint &point) const final
 Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found. More...
 
bool insertVertex (QgsVertexId position, const QgsPoint &vertex) override
 Inserts a vertex into the geometry. More...
 
QgsPointinterpolatePoint (double distance) const override
 Returns an interpolated point on the curve at the specified distance. More...
 
bool isEmpty () const override SIP_HOLDGIL
 Returns true if the geometry is empty. More...
 
bool isValid (QString &error, int flags=0) const override
 Checks validity of the geometry, and returns true if the geometry is valid. More...
 
double length () const override SIP_HOLDGIL
 Returns the planar, 2-dimensional length of the geometry. More...
 
bool moveVertex (QgsVertexId position, const QgsPoint &newPos) override
 Moves a vertex within the geometry. More...
 
int nCurves () const SIP_HOLDGIL
 Returns the number of curves in the geometry. More...
 
int numPoints () const override SIP_HOLDGIL
 Returns the number of points in the curve. More...
 
QgsCompoundCurveoperator= (const QgsCompoundCurve &curve)
 
bool pointAt (int node, QgsPoint &point, QgsVertexId::VertexType &type) const override
 Returns the point and vertex id of a point within the curve. More...
 
void points (QgsPointSequence &pts) const override
 Returns a list of points within the curve. More...
 
void removeCurve (int i)
 Removes a curve from the geometry. More...
 
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. More...
 
QgsCompoundCurvereversed () const override
 Returns a reversed copy of the curve, where the direction of the curve has been flipped. More...
 
void scroll (int firstVertexIndex) final
 Scrolls the curve vertices so that they start with the vertex at the given index. More...
 
double segmentLength (QgsVertexId startVertex) const override
 Returns the length of the segment of the geometry which begins at startVertex. More...
 
const QgsAbstractGeometrysimplifiedTypeRef () const override SIP_HOLDGIL
 Returns a reference to the simplest lossless representation of this geometry, e.g. More...
 
QgsCompoundCurvesnappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const override
 Makes a new geometry with all the points or vertices snapped to the closest point of the grid. More...
 
std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > splitCurveAtVertex (int index) const final
 Splits the curve at the specified vertex index, returning two curves which represent the portion of the curve up to an including the vertex at index, and the portion of the curve from the vertex at index (inclusive) to the end of the curve. More...
 
QgsPoint startPoint () const override SIP_HOLDGIL
 Returns the starting point of the curve. More...
 
void sumUpArea (double &sum) const override
 Sums up the area of the curve by iterating over the vertices (shoelace formula). More...
 
void swapXy () override
 Swaps the x and y coordinates from the geometry. More...
 
void transform (const QgsCoordinateTransform &ct, QgsCoordinateTransform::TransformDirection d=QgsCoordinateTransform::ForwardTransform, bool transformZ=false) override SIP_THROW(QgsCsException)
 Transforms the geometry using a coordinate transform. More...
 
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. More...
 
bool transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override
 Transforms the vertices from the geometry in place, using the specified geometry transformer object. More...
 
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. More...
 
double vertexAngle (QgsVertexId vertex) const override
 Returns approximate angle at a vertex. More...
 
int wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 Returns the length of the QByteArray returned by asWkb() More...
 
double xAt (int index) const override SIP_HOLDGIL
 Returns the x-coordinate of the specified node in the line string. More...
 
double yAt (int index) const override SIP_HOLDGIL
 Returns the y-coordinate of the specified node in the line string. More...
 
- Public Member Functions inherited from QgsCurve
 QgsCurve ()=default
 Constructor for QgsCurve. More...
 
void adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override
 Returns the vertices adjacent to a specified vertex within a geometry. More...
 
QString asKml (int precision=17) const override
 Returns a KML representation of the geometry. More...
 
QPainterPath asQPainterPath () const override
 Returns the geometry represented as a QPainterPath. More...
 
virtual QPolygonF asQPolygonF () const
 Returns a QPolygonF representing the points. More...
 
QgsAbstractGeometryboundary () const override
 Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More...
 
QgsRectangle boundingBox () const override
 Returns the minimal bounding box for the geometry. More...
 
QgsCoordinateSequence coordinateSequence () const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
virtual bool isClosed () const SIP_HOLDGIL
 Returns true if the curve is closed. More...
 
virtual bool isClosed2D () const SIP_HOLDGIL
 Returns true if the curve is closed. More...
 
virtual bool isRing () const SIP_HOLDGIL
 Returns true if the curve is a ring. More...
 
bool isValid (QString &error, int flags=0) const override
 Checks validity of the geometry, and returns true if the geometry is valid. More...
 
bool nextVertex (QgsVertexId &id, QgsPoint &vertex) const override
 Returns next vertex id and coordinates. More...
 
void normalize () final SIP_HOLDGIL
 Reorganizes the geometry into a normalized form (or "canonical" form). More...
 
bool operator!= (const QgsAbstractGeometry &other) const override
 
bool operator== (const QgsAbstractGeometry &other) const override
 
Orientation orientation () const
 Returns the curve's orientation, e.g. More...
 
int partCount () const override
 Returns count of parts contained in the geometry. More...
 
int ringCount (int part=0) const override
 Returns the number of rings of which this geometry is built. More...
 
QgsCurvesegmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
 Returns a geometry without curves. More...
 
double sinuosity () const
 Returns the curve sinuosity, which is the ratio of the curve length() to curve straightDistance2d(). More...
 
double straightDistance2d () const
 Returns the straight distance of the curve, i.e. More...
 
QgsCurvetoCurveType () const override
 Returns the geometry converted to the more generic curve type. More...
 
QgsPoint vertexAt (QgsVertexId id) const override
 Returns the point corresponding to a specified vertex id. More...
 
int vertexCount (int part=0, int ring=0) const override
 Returns the number of vertices of which this geometry is built. More...
 
int vertexNumberFromVertexId (QgsVertexId id) const override
 Returns the vertex number corresponding to a vertex id. More...
 
- Public Member Functions inherited from QgsAbstractGeometry
 QgsAbstractGeometry ()=default
 Constructor for QgsAbstractGeometry. More...
 
 QgsAbstractGeometry (const QgsAbstractGeometry &geom)
 
virtual ~QgsAbstractGeometry ()=default
 
virtual double area () const
 Returns the planar, 2-dimensional area of the geometry. More...
 
QString asJson (int precision=17)
 Returns a GeoJSON representation of the geometry as a QString. More...
 
virtual QByteArray asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
 Returns a WKB representation of the geometry. More...
 
virtual QgsPoint centroid () const
 Returns the centroid of the geometry. 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...
 
bool is3D () const SIP_HOLDGIL
 Returns true if the geometry is 3D and contains a z-value. More...
 
bool isMeasure () const SIP_HOLDGIL
 Returns true if the geometry contains m values. More...
 
virtual int nCoordinates () const
 Returns the number of nodes contained in the geometry. More...
 
QgsAbstractGeometryoperator= (const QgsAbstractGeometry &geom)
 
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...
 
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...
 
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 QgsCompoundCurvecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsCompoundCurve. More...
 
- Static Public Member Functions inherited from QgsCurve
static const QgsCurvecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsCurve. More...
 

Protected Member Functions

QgsRectangle calculateBoundingBox () const override
 Default calculator for the minimal bounding box for the geometry. More...
 
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. More...
 
- Protected Member Functions inherited from QgsCurve
int childCount () const override
 Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. More...
 
QgsPoint childPoint (int index) const override
 Returns point at index (for geometries without child geometries - i.e. More...
 
void clearCache () const override
 Clears any cached parameters associated with the geometry, e.g., bounding boxes. More...
 
bool snapToGridPrivate (double hSpacing, double vSpacing, double dSpacing, double mSpacing, const QVector< double > &srcX, const QVector< double > &srcY, const QVector< double > &srcZ, const QVector< double > &srcM, QVector< double > &outX, QVector< double > &outY, QVector< double > &outZ, QVector< double > &outM) const
 Helper function for QgsCurve subclasses to snap to grids. More...
 
- Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsAbstractGeometrychildGeometry (int index) const
 Returns pointer to child geometry (for geometries with child geometries - i.e. 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...
 

Additional Inherited Members

- Public Types inherited from QgsCurve
enum  Orientation { Clockwise , CounterClockwise }
 Curve orientation. More...
 
- 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...
 
- Protected Attributes inherited from QgsCurve
QgsRectangle mBoundingBox
 Cached bounding box. More...
 
- Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown
 

Detailed Description

Compound curve geometry type.

Since
QGIS 2.10

Definition at line 31 of file qgscompoundcurve.h.

Constructor & Destructor Documentation

◆ QgsCompoundCurve() [1/2]

QgsCompoundCurve::QgsCompoundCurve ( )

Definition at line 32 of file qgscompoundcurve.cpp.

◆ QgsCompoundCurve() [2/2]

QgsCompoundCurve::QgsCompoundCurve ( const QgsCompoundCurve curve)

Definition at line 111 of file qgscompoundcurve.cpp.

◆ ~QgsCompoundCurve()

QgsCompoundCurve::~QgsCompoundCurve ( )
override

Definition at line 37 of file qgscompoundcurve.cpp.

Member Function Documentation

◆ addCurve()

void QgsCompoundCurve::addCurve ( QgsCurve c,
bool  extendPrevious = false 
)

Adds a curve to the geometry (takes ownership).

Since QGIS 3.20, if extendPrevious is true, then adding a LineString when the last existing curve in the compound curve is also a LineString will cause the existing linestring to be extended with the newly added LineString vertices instead of appending a whole new LineString curve to the compound curve. This can result in simplified compound curves with lesser number of component curves while still being topologically identical to the desired result.

Definition at line 582 of file qgscompoundcurve.cpp.

◆ addMValue()

bool QgsCompoundCurve::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()
Since
QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 1189 of file qgscompoundcurve.cpp.

◆ addToPainterPath()

void QgsCompoundCurve::addToPainterPath ( QPainterPath &  path) const
overridevirtual

Adds a curve to a painter path.

Implements QgsCurve.

Definition at line 726 of file qgscompoundcurve.cpp.

◆ addVertex()

void QgsCompoundCurve::addVertex ( const QgsPoint pt)

Adds a vertex to the end of the geometry.

Definition at line 638 of file qgscompoundcurve.cpp.

◆ addZValue()

bool QgsCompoundCurve::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()
Since
QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 1174 of file qgscompoundcurve.cpp.

◆ asGml2()

QDomElement QgsCompoundCurve::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.

Definition at line 336 of file qgscompoundcurve.cpp.

◆ asGml3()

QDomElement QgsCompoundCurve::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.

Definition at line 344 of file qgscompoundcurve.cpp.

◆ asJsonObject()

json QgsCompoundCurve::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 362 of file qgscompoundcurve.cpp.

◆ asWkb()

QByteArray QgsCompoundCurve::asWkb ( QgsAbstractGeometry::WkbFlags  flags = QgsAbstractGeometry::WkbFlags()) const
override

Definition at line 294 of file qgscompoundcurve.cpp.

◆ asWkt()

QString QgsCompoundCurve::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 309 of file qgscompoundcurve.cpp.

◆ boundingBoxIntersects()

bool QgsCompoundCurve::boundingBoxIntersects ( const QgsRectangle rectangle) const
overridevirtual

Returns true if the bounding box of this geometry intersects with a rectangle.

Since this test only considers the bounding box of the geometry, is is very fast to calculate and handles invalid geometries.

Since
QGIS 3.20

Reimplemented from QgsAbstractGeometry.

Definition at line 536 of file qgscompoundcurve.cpp.

◆ calculateBoundingBox()

QgsRectangle QgsCompoundCurve::calculateBoundingBox ( ) const
overrideprotectedvirtual

Default calculator for the minimal bounding box for the geometry.

Derived classes should override this method if a more efficient bounding box calculation is available.

Reimplemented from QgsAbstractGeometry.

Definition at line 148 of file qgscompoundcurve.cpp.

◆ cast()

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

Cast the geom to a QgsCompoundCurve.

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

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

Definition at line 166 of file qgscompoundcurve.h.

◆ clear()

void QgsCompoundCurve::clear ( )
overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 140 of file qgscompoundcurve.cpp.

◆ clone()

QgsCompoundCurve * QgsCompoundCurve::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsCurve.

Definition at line 135 of file qgscompoundcurve.cpp.

◆ close()

void QgsCompoundCurve::close ( )

Appends first point if not already closed.

Definition at line 1054 of file qgscompoundcurve.cpp.

◆ closestSegment()

double QgsCompoundCurve::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 917 of file qgscompoundcurve.cpp.

◆ compareToSameClass()

int QgsCompoundCurve::compareToSameClass ( const QgsAbstractGeometry other) const
finalprotectedvirtual

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.

Definition at line 70 of file qgscompoundcurve.cpp.

◆ condenseCurves()

void QgsCompoundCurve::condenseCurves ( )

Condenses the curves in this geometry by combining adjacent linestrings a to a single continuous linestring, and combining adjacent circularstrings to a single continuous circularstring.

Since
QGIS 3.20

Definition at line 671 of file qgscompoundcurve.cpp.

◆ createEmptyWithSameType()

QgsCompoundCurve * QgsCompoundCurve::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()
Since
3.0

Implements QgsAbstractGeometry.

Definition at line 63 of file qgscompoundcurve.cpp.

◆ curveAt()

const QgsCurve * QgsCompoundCurve::curveAt ( int  i) const

Returns the curve at the specified index.

Definition at line 573 of file qgscompoundcurve.cpp.

◆ curveSubstring()

QgsCompoundCurve * QgsCompoundCurve::curveSubstring ( double  startDistance,
double  endDistance 
) const
overridevirtual

Returns a new curve representing a substring of this curve.

The startDistance and endDistance arguments specify the length along the curve which the substring should start and end at. If the endDistance is greater than the total length of the curve then any "extra" length will be ignored.

If z or m values are present, the output z and m will be interpolated using the existing vertices' z or m values.

Since
QGIS 3.4

Implements QgsCurve.

Definition at line 1143 of file qgscompoundcurve.cpp.

◆ curveToLine()

QgsLineString * QgsCompoundCurve::curveToLine ( double  tolerance = M_PI_2 / 90,
SegmentationToleranceType  toleranceType = MaximumAngle 
) const
overridevirtual

Returns a new line string geometry corresponding to a segmentized approximation of the curve.

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

Implements QgsCurve.

Definition at line 476 of file qgscompoundcurve.cpp.

◆ deleteVertex()

bool QgsCompoundCurve::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.

Definition at line 784 of file qgscompoundcurve.cpp.

◆ dimension()

int QgsCompoundCurve::dimension ( ) const
overridevirtual

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 106 of file qgscompoundcurve.cpp.

◆ draw()

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

Draws the geometry using the specified QPainter.

Parameters
pdestination QPainter

Implements QgsAbstractGeometry.

Definition at line 700 of file qgscompoundcurve.cpp.

◆ drawAsPolygon()

void QgsCompoundCurve::drawAsPolygon ( QPainter &  p) const
overridevirtual

Draws the curve as a polygon on the specified QPainter.

Parameters
pdestination QPainter

Implements QgsCurve.

Definition at line 736 of file qgscompoundcurve.cpp.

◆ dropMValue()

bool QgsCompoundCurve::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()
Since
QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 1218 of file qgscompoundcurve.cpp.

◆ dropZValue()

bool QgsCompoundCurve::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()
Since
QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 1204 of file qgscompoundcurve.cpp.

◆ endPoint()

QgsPoint QgsCompoundCurve::endPoint ( ) const
overridevirtual

Returns the end point of the curve.

See also
startPoint

Implements QgsCurve.

Definition at line 388 of file qgscompoundcurve.cpp.

◆ equals()

bool QgsCompoundCurve::equals ( const QgsCurve other) const
overridevirtual

Checks whether this curve exactly equals another curve.

Since
QGIS 3.0

Implements QgsCurve.

Definition at line 42 of file qgscompoundcurve.cpp.

◆ filterVertices()

void QgsCompoundCurve::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 988 of file qgscompoundcurve.cpp.

◆ fromWkb()

bool QgsCompoundCurve::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.

Definition at line 186 of file qgscompoundcurve.cpp.

◆ fromWkt()

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

Sets the geometry from a WKT string.

See also
fromWkb

Implements QgsAbstractGeometry.

Definition at line 226 of file qgscompoundcurve.cpp.

◆ geometryType()

QString QgsCompoundCurve::geometryType ( ) const
overridevirtual

Returns a unique string representing the geometry type.

See also
wkbType
wktTypeStr

Implements QgsAbstractGeometry.

Definition at line 101 of file qgscompoundcurve.cpp.

◆ hasCurvedSegments()

bool QgsCompoundCurve::hasCurvedSegments ( ) const
overridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometry.

Definition at line 1063 of file qgscompoundcurve.cpp.

◆ indexOf()

int QgsCompoundCurve::indexOf ( const QgsPoint point) const
finalvirtual

Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found.

Note
If the curve has m or z values then the search point must have exactly matching m and z values in order to be matched against the curve's vertices.
This method only matches against segment vertices, not curve vertices.
Since
QGIS 3.20

Implements QgsCurve.

Definition at line 461 of file qgscompoundcurve.cpp.

◆ insertVertex()

bool QgsCompoundCurve::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.

Definition at line 746 of file qgscompoundcurve.cpp.

◆ interpolatePoint()

QgsPoint * QgsCompoundCurve::interpolatePoint ( double  distance) const
overridevirtual

Returns an interpolated point on the curve at the specified distance.

If z or m values are present, the output z and m will be interpolated using the existing vertices' z or m values.

If distance is negative, or is greater than the length of the curve, nullptr will be returned.

Since
QGIS 3.4

Implements QgsCurve.

Definition at line 1119 of file qgscompoundcurve.cpp.

◆ isEmpty()

bool QgsCompoundCurve::isEmpty ( ) const
overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 432 of file qgscompoundcurve.cpp.

◆ isValid()

bool QgsCompoundCurve::isValid ( QString &  error,
int  flags = 0 
) 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 QgsGeometry::ValidityFlags).
Returns
true if geometry is valid
Since
QGIS 3.8

Implements QgsAbstractGeometry.

Definition at line 445 of file qgscompoundcurve.cpp.

◆ length()

double QgsCompoundCurve::length ( ) const
overridevirtual

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

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

Reimplemented from QgsAbstractGeometry.

Definition at line 369 of file qgscompoundcurve.cpp.

◆ moveVertex()

bool QgsCompoundCurve::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 767 of file qgscompoundcurve.cpp.

◆ nCurves()

int QgsCompoundCurve::nCurves ( ) const
inline

Returns the number of curves in the geometry.

Definition at line 82 of file qgscompoundcurve.h.

◆ numPoints()

int QgsCompoundCurve::numPoints ( ) const
overridevirtual

Returns the number of points in the curve.

Implements QgsCurve.

Definition at line 415 of file qgscompoundcurve.cpp.

◆ operator=()

QgsCompoundCurve & QgsCompoundCurve::operator= ( const QgsCompoundCurve curve)

Definition at line 121 of file qgscompoundcurve.cpp.

◆ pointAt()

bool QgsCompoundCurve::pointAt ( int  node,
QgsPoint point,
QgsVertexId::VertexType type 
) const
overridevirtual

Returns the point and vertex id of a point within the curve.

Parameters
nodenode number, where the first node is 0
pointwill be set to point at corresponding node in the curve
typewill be set to the vertex type of the node
Returns
true if node exists within the curve

Implements QgsCurve.

Definition at line 922 of file qgscompoundcurve.cpp.

◆ points()

void QgsCompoundCurve::points ( QgsPointSequence pt) const
overridevirtual

Returns a list of points within the curve.

Implements QgsCurve.

Definition at line 397 of file qgscompoundcurve.cpp.

◆ removeCurve()

void QgsCompoundCurve::removeCurve ( int  i)

Removes a curve from the geometry.

Parameters
iindex of curve to remove

Definition at line 627 of file qgscompoundcurve.cpp.

◆ removeDuplicateNodes()

bool QgsCompoundCurve::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.

Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 507 of file qgscompoundcurve.cpp.

◆ reversed()

QgsCompoundCurve * QgsCompoundCurve::reversed ( ) const
overridevirtual

Returns a reversed copy of the curve, where the direction of the curve has been flipped.

Since
QGIS 2.14

Implements QgsCurve.

Definition at line 1108 of file qgscompoundcurve.cpp.

◆ scroll()

void QgsCompoundCurve::scroll ( int  firstVertexIndex)
finalvirtual

Scrolls the curve vertices so that they start with the vertex at the given index.

Warning
This should only be called on closed curves, or the shape of the curve will be altered and the result is undefined.
The firstVertexIndex must correspond to a segment vertex and not a curve point or the result is undefined.
Since
QGIS 3.20

Implements QgsCurve.

Definition at line 164 of file qgscompoundcurve.cpp.

◆ segmentLength()

double QgsCompoundCurve::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.
Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 1097 of file qgscompoundcurve.cpp.

◆ simplifiedTypeRef()

const QgsAbstractGeometry * QgsCompoundCurve::simplifiedTypeRef ( ) const
overridevirtual

Returns a reference to the simplest lossless representation of this geometry, e.g.

if the geometry is a multipart geometry type with a single member geometry, a reference to that part will be returned.

This method employs the following logic:

  • For multipart geometries containing a single part only a direct reference to that part will be returned.
  • For compound curve geometries containing a single curve only a direct reference to that curve will be returned.

This method returns a reference only, and does not involve any geometry cloning.

Note
Ownership of the returned geometry is NOT transferred, and remains with the original geometry object. Callers must take care to ensure that the original geometry object exists for the lifespan of the returned object.
Since
QGIS 3.20

Reimplemented from QgsAbstractGeometry.

Definition at line 565 of file qgscompoundcurve.cpp.

◆ snappedToGrid()

QgsCompoundCurve * QgsCompoundCurve::snappedToGrid ( double  hSpacing,
double  vSpacing,
double  dSpacing = 0,
double  mSpacing = 0 
) 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.
Since
3.0

Implements QgsAbstractGeometry.

Definition at line 488 of file qgscompoundcurve.cpp.

◆ splitCurveAtVertex()

std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > QgsCompoundCurve::splitCurveAtVertex ( int  index) const
finalvirtual

Splits the curve at the specified vertex index, returning two curves which represent the portion of the curve up to an including the vertex at index, and the portion of the curve from the vertex at index (inclusive) to the end of the curve.

Note
The vertex index must correspond to a segment vertex, not a curve vertex.
Not available in Python bindings.
Since
QGIS 3.20

Implements QgsCurve.

Definition at line 1006 of file qgscompoundcurve.cpp.

◆ startPoint()

QgsPoint QgsCompoundCurve::startPoint ( ) const
overridevirtual

Returns the starting point of the curve.

See also
endPoint

Implements QgsCurve.

Definition at line 379 of file qgscompoundcurve.cpp.

◆ sumUpArea()

void QgsCompoundCurve::sumUpArea ( double &  sum) const
overridevirtual

Sums up the area of the curve by iterating over the vertices (shoelace formula).

Implements QgsCurve.

Definition at line 1046 of file qgscompoundcurve.cpp.

◆ swapXy()

void QgsCompoundCurve::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 1232 of file qgscompoundcurve.cpp.

◆ transform() [1/3]

void QgsCompoundCurve::transform ( const QgsCoordinateTransform ct,
QgsCoordinateTransform::TransformDirection  d = QgsCoordinateTransform::ForwardTransform,
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 708 of file qgscompoundcurve.cpp.

◆ transform() [2/3]

void QgsCompoundCurve::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 717 of file qgscompoundcurve.cpp.

◆ transform() [3/3]

bool QgsCompoundCurve::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 967 of file qgscompoundcurve.cpp.

◆ transformVertices()

void QgsCompoundCurve::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 997 of file qgscompoundcurve.cpp.

◆ vertexAngle()

double QgsCompoundCurve::vertexAngle ( QgsVertexId  vertex) const
overridevirtual

Returns approximate angle at a vertex.

This is usually the average angle between adjacent segments, and can be pictured as the orientation of a line following the curvature of the geometry at the specified vertex.

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

Implements QgsAbstractGeometry.

Definition at line 1075 of file qgscompoundcurve.cpp.

◆ wkbSize()

int QgsCompoundCurve::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 284 of file qgscompoundcurve.cpp.

◆ xAt()

double QgsCompoundCurve::xAt ( int  index) const
overridevirtual

Returns the x-coordinate of the specified node in the line string.

Parameters
indexindex of node, where the first node in the line is 0
Returns
x-coordinate of node, or 0.0 if index is out of bounds

Implements QgsCurve.

Definition at line 937 of file qgscompoundcurve.cpp.

◆ yAt()

double QgsCompoundCurve::yAt ( int  index) const
overridevirtual

Returns the y-coordinate of the specified node in the line string.

Parameters
indexindex of node, where the first node in the line is 0
Returns
y-coordinate of node, or 0.0 if index is out of bounds

Implements QgsCurve.

Definition at line 952 of file qgscompoundcurve.cpp.


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