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

#include <qgssimplecurve.h>

Inheritance diagram for QgsSimpleCurve:

[legend]

Public Member Functions
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	append (const QgsSimpleCurve *curve)
	Appends the contents of another simple curve to the end of this simple curve.
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.
void	clear () override
	Clears the geometry, ie reset it to a null geometry.
int	dimension () const override
	Returns the inherent dimension of the geometry.
bool	dropMValue () override
	Drops any measure values which exist in the geometry.
bool	dropZValue () override
	Drops any z-dimensions which exist in the geometry.
QgsPoint	endPoint () const override
	Returns the end point of the curve.
bool	equals (const QgsCurve &other) const override
	Checks whether this curve exactly equals another curve.
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	fromWkt (const QString &wkt) override
	Sets the geometry from a WKT 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.
bool	isEmpty () const override
	Returns `true` if the geometry is empty.
double	mAt (int index) const override
	Returns the m value of the specified node in the simple curve.
const double *	mData () const
	Returns a const pointer to the m vertex data, or `nullptr` if the simple curve does not have m values.
bool	moveVertex (QgsVertexId position, const QgsPoint &newPos) override
	Moves a vertex within the geometry.
QVector< double >	mVector () const
	Returns the m vertex values as a vector.
int	nCoordinates () const override
	Returns the number of nodes contained in the geometry.
int	numPoints () const override
	Returns the number of points in the curve.
QgsPoint	pointN (int i) const
	Returns the specified point from inside the simple curve.
void	points (QgsPointSequence &pts) const override
	Returns a list of points within the curve.
QgsSimpleCurve *	reversed () const override
	Returns a reversed copy of the curve, where the direction of the curve has been flipped.
void	scroll (int firstVertexIndex) final
	Scrolls the curve vertices so that they start with the vertex at the given index.
void	setMAt (int index, double m)
	Sets the m value of the specified node in the simple curve.
void	setPoints (const QgsPointSequence &points)
	Resets the simple curve to match the specified list of points.
void	setXAt (int index, double x)
	Sets the x-coordinate of the specified node in the simple curve.
void	setYAt (int index, double y)
	Sets the y-coordinate of the specified node in the simple curve.
void	setZAt (int index, double z)
	Sets the z-coordinate of the specified node in the simple curve.
QgsPoint	startPoint () const override
	Returns the starting point of the curve.
void	swapXy () override
	Swaps the x and y coordinates from the geometry.
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.
int	wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
	Returns the length of the QByteArray returned by asWkb().
double	xAt (int index) const override
	Returns the x-coordinate of the specified node in the line string.
const double *	xData () const
	Returns a const pointer to the x vertex data.
QVector< double >	xVector () const
	Returns the x vertex values as a vector.
double	yAt (int index) const override
	Returns the y-coordinate of the specified node in the line string.
const double *	yData () const
	Returns a const pointer to the y vertex data.
QVector< double >	yVector () const
	Returns the y vertex values as a vector.
double	zAt (int index) const override
	Returns the z-coordinate of the specified node in the simple curve.
const double *	zData () const
	Returns a const pointer to the z vertex data, or `nullptr` if the simple curve does not have z values.
QVector< double >	zVector () const
	Returns the z vertex values as a vector.
Public Member Functions inherited from QgsCurve
	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 double	distanceBetweenVertices (QgsVertexId fromVertex, QgsVertexId toVertex) const =0
	Returns the distance along the curve between two vertices.
virtual void	drawAsPolygon (QPainter &p) const =0
	Draws the curve as a polygon on the specified QPainter.
bool	hasVertex (QgsVertexId position) const override
	Returns `true` if the geometry contains a vertex matching the given position.
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.
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).
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 type of a point within the curve.
int	ringCount (int part=0) const override
	Returns the number of rings of which this geometry is built.
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 including the vertex at index, and the portion of the curve from the vertex at index (inclusive) to the end 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).
virtual void	sumUpArea3D (double &sum) const =0
	Sums up the 3d 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.
Public Member Functions inherited from QgsAbstractGeometry
	QgsAbstractGeometry ()=default
	QgsAbstractGeometry (const QgsAbstractGeometry &geom)
virtual	~QgsAbstractGeometry ()=default
virtual double	area () const
	Returns the planar, 2-dimensional area of the geometry.
virtual double	area3D () const
	Returns the 3-dimensional surface 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 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 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 bool	deleteVertices (const QSet< QgsVertexId > &positions)=0
	Deletes vertices within the geometry.
virtual void	draw (QPainter &p) const =0
	Draws the geometry using the specified QPainter.
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.
bool	isMeasure () const
	Returns `true` if the geometry contains m values.
virtual double	length () const
	Returns the planar, 2-dimensional length of 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 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.
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 QgsSimpleCurve *	cast (const QgsAbstractGeometry *geom)
	Cast the geom to a QgsSimpleCurve.
static QgsSimpleCurve *	cast (QgsAbstractGeometry *geom)
	Cast the geom to a QgsSimpleCurve.
Static Public Member Functions inherited from QgsCurve
static const QgsCurve *	cast (const QgsAbstractGeometry *geom)
	Cast the geom to a QgsCurve.
static QgsCurve *	cast (QgsAbstractGeometry *geom)
	Cast the geom to a QgsCurve.

Protected Member Functions
	QgsSimpleCurve ()=default
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.
void	importVerticesFromWkb (const QgsConstWkbPtr &wkb)
	Imports vertices from wkb geometry representation.
void	splitCurveAtVertexProtected (int index, QVector< double > &x1, QVector< double > &y1, QVector< double > &z1, QVector< double > &m1, QVector< double > &x2, QVector< double > &y2, QVector< double > &z2, QVector< double > &m2) const
	Returns coordinate vectors for the split curves.
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.
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 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
QVector< double >	mM
QVector< double >	mX
QVector< double >	mY
QVector< double >	mZ
Protected Attributes inherited from QgsCurve
QgsBox3D	mBoundingBox
	Cached bounding box.
bool	mHasCachedSummedUpArea = false
bool	mHasCachedSummedUpArea3D = false
double	mSummedUpArea = 0
double	mSummedUpArea3D = 0
Protected Attributes inherited from QgsAbstractGeometry
Qgis::WkbType	mWkbType = Qgis::WkbType::Unknown

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 simple curved geometry type.

This class is not part of the SQL/MM standard and only exists for implementation convenience.

Since: QGIS 4.2

Definition at line 38 of file qgssimplecurve.h.

Constructor & Destructor Documentation

◆ QgsSimpleCurve()

QgsSimpleCurve::QgsSimpleCurve ( )

protecteddefault

Member Function Documentation

◆ addMValue()

bool QgsSimpleCurve::addMValue ( double mValue = 0 )

overridevirtual

Adds a measure to the geometry, initialized to a preset value.

Parameters

mValue initial m-value for all nodes

Returns: true on success

See also: dropMValue(); addZValue()

Implements QgsAbstractGeometry.

Definition at line 202 of file qgssimplecurve.cpp.

◆ addZValue()

bool QgsSimpleCurve::addZValue ( double zValue = 0 )

overridevirtual

Adds a z-dimension to the geometry, initialized to a preset value.

Parameters

zValue initial z-value for all nodes

Returns: true on success

See also: dropZValue(); addMValue()

Implements QgsAbstractGeometry.

Definition at line 220 of file qgssimplecurve.cpp.

◆ append()

void QgsSimpleCurve::append ( const QgsSimpleCurve * curve )

Appends the contents of another simple curve to the end of this simple curve.

Parameters

curve curve to append. Ownership is not transferred.

Note: The curve type to be appended must match the base curve type. That is, Only LinearStrings can be appended to LinearStrings and only CircularStrings can be appended to CircularStrings.

Warning: It is the caller's responsibility to ensure that the first point in the appended curve matches the last point in the existing curve, or the result will be undefined.

Definition at line 578 of file qgssimplecurve.cpp.

◆ asWkb()

QByteArray QgsSimpleCurve::asWkb ( QgsAbstractGeometry::WkbFlags flags = QgsAbstractGeometry::WkbFlags() ) const

overridevirtual

Returns a WKB representation of the geometry.

The optional flags argument specifies flags controlling WKB export behavior (since QGIS 3.14).

See also: asWkt; asGml2; asGml3; asJson()

Implements QgsAbstractGeometry.

Definition at line 39 of file qgssimplecurve.cpp.

◆ asWkt()

QString QgsSimpleCurve::asWkt ( int precision = 17 ) const

overridevirtual

Returns a WKT representation of the geometry.

Parameters

precision number of decimal places for coordinates

See also: asWkb(); asGml2(); asGml3(); asJson()

Implements QgsAbstractGeometry.

Definition at line 52 of file qgssimplecurve.cpp.

◆ cast() [1/2]

const QgsSimpleCurve * QgsSimpleCurve::cast ( const QgsAbstractGeometry * geom )

inlinestatic

Cast the geom to a QgsSimpleCurve.

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

Objects will be automatically converted to the appropriate target type.

Note: Not available in Python.

Definition at line 52 of file qgssimplecurve.h.

◆ cast() [2/2]

QgsSimpleCurve * QgsSimpleCurve::cast ( QgsAbstractGeometry * geom )

inlinestatic

Cast the geom to a QgsSimpleCurve.

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

Objects will be automatically converted to the appropriate target type.

Note: Not available in Python.

Definition at line 66 of file qgssimplecurve.h.

◆ clear()

void QgsSimpleCurve::clear ( )

overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 140 of file qgssimplecurve.cpp.

◆ compareToSameClass()

int QgsSimpleCurve::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 433 of file qgssimplecurve.cpp.

◆ dimension()

int QgsSimpleCurve::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 297 of file qgssimplecurve.cpp.

◆ dropMValue()

bool QgsSimpleCurve::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()

Implements QgsAbstractGeometry.

Definition at line 244 of file qgssimplecurve.cpp.

◆ dropZValue()

bool QgsSimpleCurve::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()

Implements QgsAbstractGeometry.

Definition at line 255 of file qgssimplecurve.cpp.

◆ endPoint()

QgsPoint QgsSimpleCurve::endPoint ( ) const

overridevirtual

Returns the end point of the curve.

See also: startPoint

Implements QgsCurve.

Definition at line 311 of file qgssimplecurve.cpp.

◆ equals()

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

inlineoverridevirtual

Checks whether this curve exactly equals another curve.

Implements QgsCurve.

Definition at line 295 of file qgssimplecurve.h.

◆ filterVertices()

void QgsSimpleCurve::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 320 of file qgssimplecurve.cpp.

◆ fromWkb()

bool QgsSimpleCurve::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 67 of file qgssimplecurve.cpp.

◆ fromWkt()

bool QgsSimpleCurve::fromWkt ( const QString & wkt )

overridevirtual

Sets the geometry from a WKT string.

See also: fromWkb

Implements QgsAbstractGeometry.

Definition at line 114 of file qgssimplecurve.cpp.

◆ fuzzyDistanceEqual()

bool QgsSimpleCurve::fuzzyDistanceEqual	(	const QgsAbstractGeometry &	other,
		double	epsilon = 1e-8 ) const

inlineoverridevirtual

Performs fuzzy distance comparison between this geometry and other using an epsilon.

Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry. It focuses on the numerical differences or relationships between these values. On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values. This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).

See also: fuzzyEqual; QgsGeometryUtilsBase::fuzzyEqual

Since: QGIS 3.36

Implements QgsAbstractGeometry.

Definition at line 266 of file qgssimplecurve.h.

◆ fuzzyEqual()

bool QgsSimpleCurve::fuzzyEqual	(	const QgsAbstractGeometry &	other,
		double	epsilon = 1e-8 ) const

inlineoverridevirtual

Performs fuzzy comparison between this geometry and other using an epsilon.

The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.

See also: fuzzyDistanceEqual; QgsGeometryUtilsBase::fuzzyDistanceEqual

Since: QGIS 3.36

Implements QgsAbstractGeometry.

Definition at line 236 of file qgssimplecurve.h.

◆ importVerticesFromWkb()

void QgsSimpleCurve::importVerticesFromWkb ( const QgsConstWkbPtr & wkb )

protected

Imports vertices from wkb geometry representation.

Parameters

wkb	const wkb pointer

Definition at line 84 of file qgssimplecurve.cpp.

◆ isEmpty()

bool QgsSimpleCurve::isEmpty ( ) const

overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 751 of file qgssimplecurve.cpp.

◆ mAt()

double QgsSimpleCurve::mAt ( int index ) const

inlineoverridevirtual

Returns the m value of the specified node in the simple curve.

Parameters

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

Returns: m value of node, or NaN if index is out of bounds or the curve does not have m values

See also: setMAt()

Implements QgsCurve.

Definition at line 417 of file qgssimplecurve.h.

◆ mData()

const double * QgsSimpleCurve::mData ( ) const

inline

Returns a const pointer to the m vertex data, or nullptr if the simple curve does not have m values.

Note: Not available in Python bindings

See also: xData(); yData()

Definition at line 202 of file qgssimplecurve.h.

◆ moveVertex()

bool QgsSimpleCurve::moveVertex	(	QgsVertexId	position,
		const QgsPoint &	newPos )

overridevirtual

Moves a vertex within the geometry.

Parameters

position	vertex id for vertex to move
newPos	new position of vertex

Returns: true if move was successful

See also: insertVertex; deleteVertex

Implements QgsAbstractGeometry.

Definition at line 394 of file qgssimplecurve.cpp.

◆ mVector()

QVector< double > QgsSimpleCurve::mVector ( ) const

inline

Returns the m vertex values as a vector.

Note: Not available in Python bindings

Definition at line 232 of file qgssimplecurve.h.

◆ nCoordinates()

int QgsSimpleCurve::nCoordinates ( ) const

overridevirtual

Returns the number of nodes contained in the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 197 of file qgssimplecurve.cpp.

◆ numPoints()

int QgsSimpleCurve::numPoints ( ) const

overridevirtual

Returns the number of points in the curve.

Implements QgsCurve.

Definition at line 192 of file qgssimplecurve.cpp.

◆ pointN()

QgsPoint QgsSimpleCurve::pointN ( int i ) const

Returns the specified point from inside the simple curve.

Parameters

i	index of point, starting at 0 for the first point

Definition at line 149 of file qgssimplecurve.cpp.

◆ points()

void QgsSimpleCurve::points ( QgsPointSequence & pt ) const

overridevirtual

Returns a list of points within the curve.

Implements QgsCurve.

Definition at line 643 of file qgssimplecurve.cpp.

◆ reversed()

QgsSimpleCurve * QgsSimpleCurve::reversed ( ) const

overridevirtual

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

Implements QgsCurve.

Definition at line 415 of file qgssimplecurve.cpp.

◆ scroll()

void QgsSimpleCurve::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 707 of file qgssimplecurve.cpp.

◆ setMAt()

void QgsSimpleCurve::setMAt	(	int	index,
		double	m )

inline

Sets the m value of the specified node in the simple curve.

Parameters

index	index of node, where the first node in the curve is 0. Corresponding node must already exist in the simple curve, and the simple curve must have m values.
m	m value of node

See also: mAt()

Definition at line 591 of file qgssimplecurve.h.

◆ setPoints()

void QgsSimpleCurve::setPoints ( const QgsPointSequence & points )

Resets the simple curve to match the specified list of points.

The simple curve will inherit the dimensionality of the first point in the list.

Parameters

points new points for simple curve. If empty, simple curve will be cleared.

Definition at line 654 of file qgssimplecurve.cpp.

◆ setXAt()

void QgsSimpleCurve::setXAt	(	int	index,
		double	x )

Sets the x-coordinate of the specified node in the simple curve.

Parameters

index	index of node, where the first node in the curve is 0. Corresponding node must already exist in the simple curve.
x	x-coordinate of node

See also: xAt()

Definition at line 283 of file qgssimplecurve.cpp.

◆ setYAt()

void QgsSimpleCurve::setYAt	(	int	index,
		double	y )

Sets the y-coordinate of the specified node in the simple curve.

Parameters

index	index of node, where the first node in the curve is 0. Corresponding node must already exist in the simple curve.
y	y-coordinate of node

See also: yAt()

Definition at line 290 of file qgssimplecurve.cpp.

◆ setZAt()

void QgsSimpleCurve::setZAt	(	int	index,
		double	z )

inline

Sets the z-coordinate of the specified node in the simple curve.

Parameters

index	index of node, where the first node in the curve is 0. Corresponding node must already exist in simple curve, and the simple curve must have z-dimension.
z	z-coordinate of node

See also: zAt()

Definition at line 545 of file qgssimplecurve.h.

◆ splitCurveAtVertexProtected()

void QgsSimpleCurve::splitCurveAtVertexProtected	(	int	index,
		QVector< double > &	x1,
		QVector< double > &	y1,
		QVector< double > &	z1,
		QVector< double > &	m1,
		QVector< double > &	x2,
		QVector< double > &	y2,
		QVector< double > &	z2,
		QVector< double > &	m2 ) const

protected

Returns coordinate vectors for the split curves.

Parameters

index	Vertex index that will be used to split the curve
x1	x coordinate vector of the first output curve
y1	y coordinate vector of the first output curve
z1	z coordinate vector of the first output curve
m1	m coordinate vector of the first output curve
x2	x coordinate vector of the second output curve
y2	y coordinate vector of the second output curve
z2	z coordinate vector of the second output curve
m2	m coordinate vector of the second output curve

Note: The vertex index must correspond to a segment vertex, not a curve vertex.

Definition at line 519 of file qgssimplecurve.cpp.

◆ startPoint()

QgsPoint QgsSimpleCurve::startPoint ( ) const

overridevirtual

Returns the starting point of the curve.

See also: endPoint

Implements QgsCurve.

Definition at line 302 of file qgssimplecurve.cpp.

◆ swapXy()

void QgsSimpleCurve::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 745 of file qgssimplecurve.cpp.

◆ transform() [1/3]

void QgsSimpleCurve::transform	(	const QgsCoordinateTransform &	ct,
		Qgis::TransformDirection	d = Qgis::TransformDirection::Forward,
		bool	transformZ = false )

overridevirtual

Transforms the geometry using a coordinate transform.

Parameters

ct	coordinate transform
d	transformation direction
transformZ	set 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 801 of file qgssimplecurve.cpp.

◆ transform() [2/3]

void QgsSimpleCurve::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 823 of file qgssimplecurve.cpp.

◆ transform() [3/3]

bool QgsSimpleCurve::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 757 of file qgssimplecurve.cpp.

◆ transformVertices()

void QgsSimpleCurve::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 366 of file qgssimplecurve.cpp.

◆ wkbSize()

int QgsSimpleCurve::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 32 of file qgssimplecurve.cpp.

◆ xAt()

double QgsSimpleCurve::xAt ( int index ) const

overridevirtual

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

Implements QgsCurve.

Definition at line 267 of file qgssimplecurve.cpp.

◆ xData()

const double * QgsSimpleCurve::xData ( ) const

inline

Returns a const pointer to the x vertex data.

Note: Not available in Python bindings

See also: yData()

Definition at line 171 of file qgssimplecurve.h.

◆ xVector()

QVector< double > QgsSimpleCurve::xVector ( ) const

inline

Returns the x vertex values as a vector.

Note: Not available in Python bindings

Definition at line 214 of file qgssimplecurve.h.

◆ yAt()

double QgsSimpleCurve::yAt ( int index ) const

overridevirtual

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

Implements QgsCurve.

Definition at line 275 of file qgssimplecurve.cpp.

◆ yData()

const double * QgsSimpleCurve::yData ( ) const

inline

Returns a const pointer to the y vertex data.

Note: Not available in Python bindings

See also: xData()

Definition at line 178 of file qgssimplecurve.h.

◆ yVector()

QVector< double > QgsSimpleCurve::yVector ( ) const

inline

Returns the y vertex values as a vector.

Note: Not available in Python bindings

Definition at line 220 of file qgssimplecurve.h.

◆ zAt()

double QgsSimpleCurve::zAt ( int index ) const

inlineoverridevirtual

Returns the z-coordinate of the specified node in the simple curve.

Parameters

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

Returns: z-coordinate of node, or NaN if index is out of bounds or the curve does not have a z dimension

See also: setZAt()

Implements QgsCurve.

Definition at line 371 of file qgssimplecurve.h.

◆ zData()

const double * QgsSimpleCurve::zData ( ) const

inline

Returns a const pointer to the z vertex data, or nullptr if the simple curve does not have z values.

Note: Not available in Python bindings

See also: xData(); yData()

Definition at line 187 of file qgssimplecurve.h.

◆ zVector()

QVector< double > QgsSimpleCurve::zVector ( ) const

inline

Returns the z vertex values as a vector.

Note: Not available in Python bindings

Definition at line 226 of file qgssimplecurve.h.

Member Data Documentation

◆ mM

QVector<double> QgsSimpleCurve::mM

protected

Definition at line 689 of file qgssimplecurve.h.

◆ mX

QVector<double> QgsSimpleCurve::mX

protected

Definition at line 686 of file qgssimplecurve.h.

◆ mY

QVector<double> QgsSimpleCurve::mY

protected

Definition at line 687 of file qgssimplecurve.h.

◆ mZ

QVector<double> QgsSimpleCurve::mZ

protected

Definition at line 688 of file qgssimplecurve.h.

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

/build/qgis-4.1.0+git20260624+659fe69c07c+99sid/src/core/geometry/qgssimplecurve.h
/build/qgis-4.1.0+git20260624+659fe69c07c+99sid/src/core/geometry/qgssimplecurve.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSimpleCurve()

Member Function Documentation

◆ addMValue()

◆ addZValue()

◆ append()

◆ asWkb()

◆ asWkt()

◆ cast() [1/2]

◆ cast() [2/2]

◆ clear()

◆ compareToSameClass()

◆ dimension()

◆ dropMValue()

◆ dropZValue()

◆ endPoint()

◆ equals()

◆ filterVertices()

◆ fromWkb()

◆ fromWkt()

◆ fuzzyDistanceEqual()

◆ fuzzyEqual()

◆ importVerticesFromWkb()

◆ isEmpty()

◆ mAt()

◆ mData()

◆ moveVertex()

◆ mVector()

◆ nCoordinates()

◆ numPoints()

◆ pointN()

◆ points()

◆ reversed()

◆ scroll()

◆ setMAt()

◆ setPoints()

◆ setXAt()

◆ setYAt()

◆ setZAt()

◆ splitCurveAtVertexProtected()

◆ startPoint()

◆ swapXy()

◆ transform() [1/3]

◆ transform() [2/3]

◆ transform() [3/3]

◆ transformVertices()

◆ wkbSize()

◆ xAt()

◆ xData()

◆ xVector()

◆ yAt()

◆ yData()

◆ yVector()

◆ zAt()

◆ zData()

◆ zVector()

Member Data Documentation

◆ mM

◆ mX

◆ mY

◆ mZ