Abstract base class for curved geometry type. More...

#include <qgscurve.h>

Inheritance diagram for QgsCurve:

[legend]

Public Member Functions
	QgsCurve ()=default

virtual void	addToPainterPath (QPainterPath &path) const =0
	Adds a curve to a painter path.

void	adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override
	Returns the vertices adjacent to a specified vertex within a 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.

virtual QPolygonF	asQPolygonF () const
	Returns a QPolygonF representing the points.

QgsAbstractGeometry *	boundary () const override
	Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).

QgsBox3D	boundingBox3D () const override
	Returns the 3D bounding box for the geometry.

QgsCurve *	clone () const override=0
	Clones the geometry by performing a deep copy.

QgsCoordinateSequence	coordinateSequence () const override
	Retrieves the sequence of geometries, rings and nodes.

virtual QgsCurve *	curveSubstring (double startDistance, double endDistance) const =0
	Returns a new curve representing a substring of this curve.

virtual QgsLineString *	curveToLine (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const =0
	Returns a new line string geometry corresponding to a segmentized approximation of the curve.

virtual void	drawAsPolygon (QPainter &p) const =0
	Draws the curve as a polygon on the specified QPainter.

virtual QgsPoint	endPoint () const =0
	Returns the end point of the curve.

virtual bool	equals (const QgsCurve &other) const =0
	Checks whether this curve exactly equals another curve.

virtual int	indexOf (const QgsPoint &point) const =0
	Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found.

virtual QgsPoint *	interpolatePoint (double distance) const =0
	Returns an interpolated point on the curve at the specified distance.

virtual bool	isClosed () const
	Returns `true` if the curve is closed.

virtual bool	isClosed2D () const
	Returns true if the curve is closed.

virtual bool	isRing () const
	Returns `true` if the curve is a ring.

bool	isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override
	Checks validity of the geometry, and returns `true` if the geometry is valid.

virtual double	mAt (int index) const =0
	Returns the m-coordinate of the specified node in the line string.

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

virtual int	numPoints () const =0
	Returns the number of points in the curve.

bool	operator!= (const QgsAbstractGeometry &other) const override

bool	operator== (const QgsAbstractGeometry &other) const override

Qgis::AngularDirection	orientation () const
	Returns the curve's orientation, e.g.

int	partCount () const override
	Returns count of parts contained in the geometry.

virtual bool	pointAt (int node, QgsPoint &point, Qgis::VertexType &type) const =0
	Returns the point and vertex id of a point within the curve.

virtual void	points (QgsPointSequence &pt) const =0
	Returns a list of points within the curve.

virtual QgsCurve *	reversed () const =0
	Returns a reversed copy of the curve, where the direction of the curve has been flipped.

int	ringCount (int part=0) const override
	Returns the number of rings of which this geometry is built.

virtual void	scroll (int firstVertexIndex)=0
	Scrolls the curve vertices so that they start with the vertex at the given index.

QgsCurve *	segmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
	Returns a geometry without curves.

double	sinuosity () const
	Returns the curve sinuosity, which is the ratio of the curve length() to curve straightDistance2d().

virtual std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > >	splitCurveAtVertex (int index) const =0
	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.

virtual QgsPoint	startPoint () const =0
	Returns the starting point of the curve.

double	straightDistance2d () const
	Returns the straight distance of the curve, i.e.

virtual void	sumUpArea (double &sum) const =0
	Sums up the area of the curve by iterating over the vertices (shoelace formula).

QgsCurve *	toCurveType () const override
	Returns the geometry converted to the more generic curve type.

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.

virtual double	xAt (int index) const =0
	Returns the x-coordinate of the specified node in the line string.

virtual double	yAt (int index) const =0
	Returns the y-coordinate of the specified node in the line string.

virtual double	zAt (int index) const =0
	Returns the z-coordinate of the specified node in the line string.

Public Member Functions inherited from QgsAbstractGeometry
	QgsAbstractGeometry ()=default

	QgsAbstractGeometry (const QgsAbstractGeometry &geom)

virtual	~QgsAbstractGeometry ()=default

virtual bool	addMValue (double mValue=0)=0
	Adds a measure to the geometry, initialized to a preset value.

virtual bool	addZValue (double zValue=0)=0
	Adds a z-dimension to the geometry, initialized to a preset value.

virtual double	area () const
	Returns the planar, 2-dimensional area of the geometry.

virtual QDomElement	asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
	Returns a GML2 representation of the geometry.

virtual QDomElement	asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0
	Returns a GML3 representation of the geometry.

QString	asJson (int precision=17)
	Returns a GeoJSON representation of the geometry as a QString.

virtual json	asJsonObject (int precision=17) const
	Returns a json object representation of the geometry.

virtual QByteArray	asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
	Returns a WKB representation of the geometry.

virtual QString	asWkt (int precision=17) const =0
	Returns a WKT representation of the geometry.

virtual QgsRectangle	boundingBox () const
	Returns the minimal bounding box for the geometry.

virtual bool	boundingBoxIntersects (const QgsBox3D &box3d) const
	Returns `true` if the bounding box of this geometry intersects with a box3d.

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 void	clear ()=0
	Clears the geometry, ie reset it to a null geometry.

virtual double	closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int leftOf=nullptr, double epsilon=4 std::numeric_limits< double >::epsilon()) const =0
	Searches for the closest segment of the geometry to a given point.

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.

virtual QgsAbstractGeometry *	createEmptyWithSameType () const =0
	Creates a new geometry with the same class and same WKB type as the original and transfers ownership.

virtual bool	deleteVertex (QgsVertexId position)=0
	Deletes a vertex within the geometry.

virtual int	dimension () const =0
	Returns the inherent dimension of the geometry.

virtual void	draw (QPainter &p) const =0
	Draws the geometry using the specified QPainter.

virtual bool	dropMValue ()=0
	Drops any measure values which exist in the geometry.

virtual bool	dropZValue ()=0
	Drops any z-dimensions which exist in the geometry.

virtual void	filterVertices (const std::function< bool(const QgsPoint &) > &filter)
	Filters the vertices from the geometry in place, removing any which do not return `true` for the filter function check.

virtual bool	fromWkb (QgsConstWkbPtr &wkb)=0
	Sets the geometry from a WKB string.

virtual bool	fromWkt (const QString &wkt)=0
	Sets the geometry from a WKT string.

virtual bool	fuzzyDistanceEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const =0
	Performs fuzzy distance comparison between this geometry and other using an epsilon.

virtual bool	fuzzyEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const =0
	Performs fuzzy comparison between this geometry and other using an epsilon.

virtual QString	geometryType () const =0
	Returns a unique string representing the geometry type.

virtual bool	hasCurvedSegments () const
	Returns `true` if the geometry contains curved segments.

virtual bool	insertVertex (QgsVertexId position, const QgsPoint &vertex)=0
	Inserts a vertex into the geometry.

bool	is3D () const
	Returns `true` if the geometry is 3D and contains a z-value.

virtual bool	isEmpty () const
	Returns `true` if the geometry is empty.

bool	isMeasure () const
	Returns `true` if the geometry contains m values.

virtual double	length () const
	Returns the planar, 2-dimensional length of the geometry.

virtual bool	moveVertex (QgsVertexId position, const QgsPoint &newPos)=0
	Moves a vertex within the geometry.

virtual int	nCoordinates () const
	Returns the number of nodes contained in the geometry.

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.

virtual double	perimeter () const
	Returns the planar, 2-dimensional perimeter of the geometry.

virtual bool	removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false)=0
	Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry.

virtual double	segmentLength (QgsVertexId startVertex) const =0
	Returns the length of the segment of the geometry which begins at startVertex.

virtual const QgsAbstractGeometry *	simplifiedTypeRef () const
	Returns a reference to the simplest lossless representation of this geometry, e.g.

virtual QgsAbstractGeometry *	simplifyByDistance (double tolerance) const =0
	Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.

virtual QgsAbstractGeometry *	snappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0, bool removeRedundantPoints=false) const =0
	Makes a new geometry with all the points or vertices snapped to the closest point of the grid.

virtual void	swapXy ()=0
	Swaps the x and y coordinates from the geometry.

virtual void	transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false)=0
	Transforms the geometry using a coordinate transform.

virtual void	transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0)=0
	Transforms the x and y components of the geometry using a QTransform object t.

virtual bool	transform (QgsAbstractGeometryTransformer transformer, QgsFeedback feedback=nullptr)=0
	Transforms the vertices from the geometry in place, using the specified geometry transformer object.

virtual void	transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform)
	Transforms the vertices from the geometry in place, applying the transform function to every vertex.

virtual double	vertexAngle (QgsVertexId vertex) const =0
	Returns approximate angle at a vertex.

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.

virtual int	wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
	Returns the length of the QByteArray returned by asWkb()

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 QgsCurve *	cast (const QgsAbstractGeometry *geom)
	Cast the geom to a QgsCurve.

Protected Member Functions
int	childCount () const override
	Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.

QgsPoint	childPoint (int index) const override
	Returns point at index (for geometries without child geometries - i.e.

void	clearCache () const override
	Clears any cached parameters associated with the geometry, e.g., bounding boxes.

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, bool removeRedundantPoints) const
	Helper function for QgsCurve subclasses to snap to grids.

Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsRectangle	calculateBoundingBox () const
	Default calculator for the minimal bounding box for the geometry.

virtual QgsBox3D	calculateBoundingBox3D () const
	Calculates the minimal 3D bounding box for the geometry.

virtual QgsAbstractGeometry *	childGeometry (int index) const
	Returns pointer to child geometry (for geometries with child geometries - i.e.

virtual int	compareToSameClass (const QgsAbstractGeometry *other) const =0
	Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.

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
QgsBox3D	mBoundingBox
	Cached bounding box.

bool	mHasCachedSummedUpArea = false

double	mSummedUpArea = 0

Protected Attributes inherited from QgsAbstractGeometry
Qgis::WkbType	mWkbType = Qgis::WkbType::Unknown

Friends
class	TestQgsGeometry

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

Detailed Description

Abstract base class for curved geometry type.

Definition at line 34 of file qgscurve.h.

Constructor & Destructor Documentation

◆ QgsCurve()

QgsCurve::QgsCurve ( )

default

Member Function Documentation

◆ addToPainterPath()

virtual void QgsCurve::addToPainterPath ( QPainterPath & path ) const

pure virtual

Adds a curve to a painter path.

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ adjacentVertices()

void QgsCurve::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 112 of file qgscurve.cpp.

◆ asKml()

QString QgsCurve::asKml ( int precision = 17 ) const

overridevirtual

Returns a KML representation of the geometry.

Since: QGIS 3.12

Implements QgsAbstractGeometry.

Reimplemented in QgsLineString.

Definition at line 164 of file qgscurve.cpp.

◆ asQPainterPath()

QPainterPath QgsCurve::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 70 of file qgscurve.cpp.

◆ asQPolygonF()

QPolygonF QgsCurve::asQPolygonF ( ) const

virtual

Returns a QPolygonF representing the points.

Reimplemented in QgsLineString.

Definition at line 266 of file qgscurve.cpp.

◆ boundary()

QgsAbstractGeometry * QgsCurve::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 149 of file qgscurve.cpp.

◆ boundingBox3D()

QgsBox3D QgsCurve::boundingBox3D ( ) const

overridevirtual

Returns the 3D bounding box for the geometry.

Since: QGIS 3.34

Implements QgsAbstractGeometry.

Definition at line 238 of file qgscurve.cpp.

◆ cast()

static const QgsCurve * QgsCurve::cast ( const QgsAbstractGeometry * geom )

inlinestatic

Cast the geom to a QgsCurve.

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

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

Definition at line 303 of file qgscurve.h.

◆ childCount()

int QgsCurve::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 302 of file qgscurve.cpp.

◆ childPoint()

QgsPoint QgsCurve::childPoint ( int index ) const

overrideprotectedvirtual

Returns point at index (for geometries without child geometries - i.e.

curve / point)

Note: used for vertex_iterator implementation

Reimplemented from QgsAbstractGeometry.

Definition at line 307 of file qgscurve.cpp.

◆ clearCache()

void QgsCurve::clearCache ( ) const

overrideprotectedvirtual

Clears any cached parameters associated with the geometry, e.g., bounding boxes.

Reimplemented from QgsAbstractGeometry.

Definition at line 293 of file qgscurve.cpp.

◆ clone()

QgsCurve * QgsCurve::clone ( ) const

overridepure virtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometry.

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ coordinateSequence()

QgsCoordinateSequence QgsCurve::coordinateSequence ( ) const

overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Returns: coordinate sequence

Implements QgsAbstractGeometry.

Definition at line 77 of file qgscurve.cpp.

◆ curveSubstring()

virtual QgsCurve * QgsCurve::curveSubstring	(	double	startDistance,
		double	endDistance
	)		const

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ curveToLine()

virtual QgsLineString * QgsCurve::curveToLine	(	double	tolerance = `M_PI_2/90`,
		SegmentationToleranceType	toleranceType = `MaximumAngle`
	)		const

pure virtual

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

Parameters

tolerance	segmentation tolerance
toleranceType	maximum segmentation angle or maximum difference between approximation and curve

Uses a MaximumAngle tolerance of 1 degrees by default (360 segments in a full circle)

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ drawAsPolygon()

virtual void QgsCurve::drawAsPolygon ( QPainter & p ) const

pure virtual

Draws the curve as a polygon on the specified QPainter.

Parameters

p	destination QPainter

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ endPoint()

virtual QgsPoint QgsCurve::endPoint ( ) const

pure virtual

Returns the end point of the curve.

See also: startPoint

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ equals()

virtual bool QgsCurve::equals ( const QgsCurve & other ) const

pure virtual

Checks whether this curve exactly equals another curve.

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ indexOf()

virtual int QgsCurve::indexOf ( const QgsPoint & point ) const

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ interpolatePoint()

virtual QgsPoint * QgsCurve::interpolatePoint ( double distance ) const

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ isClosed()

bool QgsCurve::isClosed ( ) const

virtual

Returns true if the curve is closed.

See also: isClosed2D()

Reimplemented in QgsLineString.

Definition at line 53 of file qgscurve.cpp.

◆ isClosed2D()

bool QgsCurve::isClosed2D ( ) const

virtual

Returns true if the curve is closed.

Unlike isClosed. It looks only for XY coordinates.

See also: isClosed()

Since: QGIS 3.20

Reimplemented in QgsLineString.

Definition at line 41 of file qgscurve.cpp.

◆ isRing()

bool QgsCurve::isRing ( ) const

virtual

Returns true if the curve is a ring.

Definition at line 65 of file qgscurve.cpp.

◆ isValid()

bool QgsCurve::isValid	(	QString &	error,
		Qgis::GeometryValidityFlags	flags = `Qgis::GeometryValidityFlags()`
	)		const

overridevirtual

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

Parameters

error	will be set to the validity error message
flags	indicates 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.

Reimplemented in QgsLineString.

Definition at line 247 of file qgscurve.cpp.

◆ mAt()

virtual double QgsCurve::mAt ( int index ) const

pure virtual

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

Parameters

index index of node, where the first node in the line is 0

Returns: m-coordinate of node, or 0.0 if index is out of bounds

Since: QGIS 3.28

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ nextVertex()

bool QgsCurve::nextVertex	(	QgsVertexId &	id,
		QgsPoint &	vertex
	)		const

overridevirtual

Returns next vertex id and coordinates.

Parameters

id	initial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertex	container for found node

Returns: false if at end

Implements QgsAbstractGeometry.

Definition at line 87 of file qgscurve.cpp.

◆ normalize()

void QgsCurve::normalize ( )

finalvirtual

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.

Definition at line 211 of file qgscurve.cpp.

◆ numPoints()

virtual int QgsCurve::numPoints ( ) const

pure virtual

Returns the number of points in the curve.

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ operator!=()

bool QgsCurve::operator!= ( const QgsAbstractGeometry & other ) const

overridevirtual

Implements QgsAbstractGeometry.

Definition at line 36 of file qgscurve.cpp.

◆ operator==()

bool QgsCurve::operator== ( const QgsAbstractGeometry & other ) const

overridevirtual

Implements QgsAbstractGeometry.

Definition at line 27 of file qgscurve.cpp.

◆ orientation()

Qgis::AngularDirection QgsCurve::orientation ( ) const

Returns the curve's orientation, e.g.

clockwise or counter-clockwise.

Warning: The result is not predictable for non-closed curves.

Since: QGIS 3.6

Definition at line 286 of file qgscurve.cpp.

◆ partCount()

int QgsCurve::partCount ( ) const

overridevirtual

Returns count of parts contained in the geometry.

See also: vertexCount; ringCount

Implements QgsAbstractGeometry.

Definition at line 193 of file qgscurve.cpp.

◆ pointAt()

virtual bool QgsCurve::pointAt	(	int	node,
		QgsPoint &	point,
		Qgis::VertexType &	type
	)		const

pure virtual

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

Parameters

node	node number, where the first node is 0
point	will be set to point at corresponding node in the curve
type	will be set to the vertex type of the node

Returns: true if node exists within the curve

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ points()

virtual void QgsCurve::points ( QgsPointSequence & pt ) const

pure virtual

Returns a list of points within the curve.

Implemented in QgsLineString, QgsCircularString, and QgsCompoundCurve.

◆ reversed()

virtual QgsCurve * QgsCurve::reversed ( ) const

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ ringCount()

int QgsCurve::ringCount ( int part = 0 ) const

overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 187 of file qgscurve.cpp.

◆ scroll()

virtual void QgsCurve::scroll ( int firstVertexIndex )

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ segmentize()

QgsCurve * QgsCurve::segmentize	(	double	tolerance = `M_PI_2 / 90`,
		SegmentationToleranceType	toleranceType = `MaximumAngle`
	)		const

overridevirtual

Returns a geometry without curves.

Caller takes ownership

Parameters

tolerance	segmentation tolerance
toleranceType	maximum segmentation angle or maximum difference between approximation and curve

Reimplemented from QgsAbstractGeometry.

Definition at line 175 of file qgscurve.cpp.

◆ sinuosity()

double QgsCurve::sinuosity ( ) const

Returns the curve sinuosity, which is the ratio of the curve length() to curve straightDistance2d().

Larger numbers indicate a more "sinuous" curve (i.e. more "bendy"). The minimum value returned of 1.0 indicates a perfectly straight curve.

If a curve isClosed(), it has infinite sinuosity and will return NaN.

Since: QGIS 3.2

Definition at line 277 of file qgscurve.cpp.

◆ snapToGridPrivate()

bool QgsCurve::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,
		bool	removeRedundantPoints
	)		const

protected

Helper function for QgsCurve subclasses to snap to grids.

Note: Not available in Python bindings.

Definition at line 317 of file qgscurve.cpp.

◆ splitCurveAtVertex()

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

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ startPoint()

virtual QgsPoint QgsCurve::startPoint ( ) const

pure virtual

Returns the starting point of the curve.

See also: endPoint

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ straightDistance2d()

double QgsCurve::straightDistance2d ( ) const

Returns the straight distance of the curve, i.e.

the direct/euclidean distance between the first and last vertex of the curve. (Also known as "as the crow flies" distance).

Since: QGIS 3.2

Definition at line 272 of file qgscurve.cpp.

◆ sumUpArea()

virtual void QgsCurve::sumUpArea ( double & sum ) const

pure virtual

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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ toCurveType()

QgsCurve * QgsCurve::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.

Reimplemented in QgsLineString.

Definition at line 206 of file qgscurve.cpp.

◆ vertexAt()

QgsPoint QgsCurve::vertexAt ( QgsVertexId id ) const

overridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometry.

Definition at line 198 of file qgscurve.cpp.

◆ vertexCount()

int QgsCurve::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 180 of file qgscurve.cpp.

◆ vertexNumberFromVertexId()

int QgsCurve::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 140 of file qgscurve.cpp.

◆ xAt()

virtual double QgsCurve::xAt ( int index ) const

pure virtual

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

Parameters

index index 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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ yAt()

virtual double QgsCurve::yAt ( int index ) const

pure virtual

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

Parameters

index index 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

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

◆ zAt()

virtual double QgsCurve::zAt ( int index ) const

pure virtual

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

Parameters

index index of node, where the first node in the line is 0

Returns: z-coordinate of node, or 0.0 if index is out of bounds

Since: QGIS 3.28

Implemented in QgsCircularString, QgsCompoundCurve, and QgsLineString.

Friends And Related Symbol Documentation

◆ TestQgsGeometry

friend class TestQgsGeometry

friend

Definition at line 362 of file qgscurve.h.

Member Data Documentation

◆ mBoundingBox

QgsBox3D QgsCurve::mBoundingBox

mutableprotected

Cached bounding box.

Definition at line 352 of file qgscurve.h.

◆ mHasCachedSummedUpArea

bool QgsCurve::mHasCachedSummedUpArea = false

mutableprotected

Definition at line 354 of file qgscurve.h.

◆ mSummedUpArea

double QgsCurve::mSummedUpArea = 0

mutableprotected

Definition at line 355 of file qgscurve.h.

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

/build/qgis-3.41.0+git20241201+3c143d501a8+99sid/src/core/geometry/qgscurve.h
/build/qgis-3.41.0+git20241201+3c143d501a8+99sid/src/core/geometry/qgscurve.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsCurve()

Member Function Documentation

◆ addToPainterPath()

◆ adjacentVertices()

◆ asKml()

◆ asQPainterPath()

◆ asQPolygonF()

◆ boundary()

◆ boundingBox3D()

◆ cast()

◆ childCount()

◆ childPoint()

◆ clearCache()

◆ clone()

◆ coordinateSequence()

◆ curveSubstring()

◆ curveToLine()

◆ drawAsPolygon()

◆ endPoint()

◆ equals()

◆ indexOf()

◆ interpolatePoint()

◆ isClosed()

◆ isClosed2D()

◆ isRing()

◆ isValid()

◆ mAt()

◆ nextVertex()

◆ normalize()

◆ numPoints()

◆ operator!=()

◆ operator==()

◆ orientation()

◆ partCount()

◆ pointAt()

◆ points()

◆ reversed()

◆ ringCount()

◆ scroll()

◆ segmentize()

◆ sinuosity()

◆ snapToGridPrivate()

◆ splitCurveAtVertex()

◆ startPoint()

◆ straightDistance2d()

◆ sumUpArea()

◆ toCurveType()

◆ vertexAt()

◆ vertexCount()

◆ vertexNumberFromVertexId()

◆ xAt()

◆ yAt()

◆ zAt()

Friends And Related Symbol Documentation

◆ TestQgsGeometry

Member Data Documentation

◆ mBoundingBox

◆ mHasCachedSummedUpArea

◆ mSummedUpArea