Line string geometry type, with support for z-dimension and m-values. More...

#include <qgslinestring.h>

Inheritance diagram for QgsLineString:

[legend]

Public Member Functions
	QgsLineString ()
	Constructor for an empty linestring geometry.

	QgsLineString (const QgsLineSegment2D &segment)
	Construct a linestring from a single 2d line segment.

	QgsLineString (const QgsPoint &p1, const QgsPoint &p2)
	Constructs a linestring with a single segment from p1 to p2.

	QgsLineString (const QVector< double > &x, const QVector< double > &y, const QVector< double > &z=QVector< double >(), const QVector< double > &m=QVector< double >(), bool is25DType=false)
	Construct a linestring from arrays of coordinates.

	QgsLineString (const QVector< QgsPoint > &points)
	Construct a linestring from a vector of points.

	QgsLineString (const QVector< QgsPointXY > &points)
	Construct a linestring from list of points.

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

void	addToPainterPath (QPainterPath &path) const override
	Adds a curve to a painter path.

void	addVertex (const QgsPoint &pt)
	Adds a new vertex to the end of the line string.

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

void	append (const QgsLineString *line)
	Appends the contents of another line string to the end of this line string.

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

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

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

QString	asKml (int precision=17) const override
	Returns a KML representation of the geometry.

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

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.

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

bool	boundingBoxIntersects (const QgsRectangle &rectangle) const override
	Returns `true` if the bounding box of this geometry intersects with a rectangle.

Q_DECL_DEPRECATED QgsBox3D	calculateBoundingBox3d () const
	Calculates the minimal 3D bounding box for the geometry.

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

QgsPoint	centroid () const override
	Returns the centroid of the geometry.

void	clear () override
	Clears the geometry, ie reset it to a null geometry.

QgsLineString *	clone () const override
	Clones the geometry by performing a deep copy.

void	close ()
	Closes the line string by appending the first point to the end of the line, if it is not already closed.

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.

QVector< QgsVertexId >	collectDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false) const
	Returns a list of any duplicate nodes contained in the geometry, within the specified tolerance.

bool	convertTo (Qgis::WkbType type) override
	Converts the geometry to a specified type.

QgsLineString *	createEmptyWithSameType () const override
	Creates a new geometry with the same class and same WKB type as the original and transfers ownership.

QgsLineString *	curveSubstring (double startDistance, double endDistance) const override
	Returns a new curve representing a substring of this curve.

QgsLineString *	curveToLine (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.

bool	deleteVertex (QgsVertexId position) override
	Deletes a vertex within the geometry.

int	dimension () const override
	Returns the inherent dimension of the geometry.

void	draw (QPainter &p) const override
	Draws the geometry using the specified QPainter.

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

bool	dropMValue () override
	Drops any measure values which exist in the geometry.

bool	dropZValue () override
	Drops any z-dimensions which exist in the geometry.

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	extend (double startDistance, double endDistance)
	Extends the line geometry by extrapolating out the start or end of the line by a specified distance.

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.

QString	geometryType () const override
	Returns a unique string representing the geometry type.

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.

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

QgsLineString *	interpolateM (bool use3DDistance=true) const
	Returns a copy of this line with all missing (NaN) m values interpolated from m values of surrounding vertices.

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

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

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

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

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

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

double	length3D () const
	Returns the length in 3D world of the line string.

double	mAt (int index) const override
	Returns the m value of the specified node in the line string.

const double *	mData () const
	Returns a const pointer to the m vertex data, or `nullptr` if the linestring does not have m values.

QgsLineString *	measuredLine (double start, double end) const
	Re-write the measure ordinate (or add one, if it isn't already there) interpolating the measure between the supplied start and end values.

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.

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

QgsPoint	pointN (int i) const
	Returns the specified point from inside the line string.

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

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.

QgsLineString *	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.

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

void	setMAt (int index, double m)
	Sets the m value of the specified node in the line string.

void	setPoints (const QgsPointSequence &points)
	Resets the line string to match the specified list of points.

void	setPoints (size_t size, const double x, const double y, const double z=nullptr, const double m=nullptr)
	Resets the line string to match the specified point data.

void	setXAt (int index, double x)
	Sets the x-coordinate of the specified node in the line string.

void	setYAt (int index, double y)
	Sets the y-coordinate of the specified node in the line string.

void	setZAt (int index, double z)
	Sets the z-coordinate of the specified node in the line string.

QgsLineString *	simplifyByDistance (double tolerance) const override
	Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.

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

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.

QgsPoint	startPoint () const override
	Returns the starting point of the curve.

void	sumUpArea (double &sum) const override
	Calculates the shoelace/triangle formula sum for the points in the linestring.

void	swapXy () override
	Swaps the x and y coordinates from the geometry.

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

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

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

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

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

double	vertexAngle (QgsVertexId vertex) const override
	Returns approximate angle at a vertex.

void	visitPointsByRegularDistance (double distance, const std::function< bool(double x, double y, double z, double m, double startSegmentX, double startSegmentY, double startSegmentZ, double startSegmentM, double endSegmentX, double endSegmentY, double endSegmentZ, double endSegmentM) > &visitPoint) const
	Visits regular points along the linestring, spaced by distance.

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 line string.

const double *	zData () const
	Returns a const pointer to the z vertex data, or `nullptr` if the linestring 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
	Constructor for QgsCurve.

void	adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override
	Returns the vertices adjacent to a specified vertex within a geometry.

QPainterPath	asQPainterPath () const override
	Returns the geometry represented as a QPainterPath.

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.

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

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

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.

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

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

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
	Constructor for QgsAbstractGeometry.

	QgsAbstractGeometry (const QgsAbstractGeometry &geom)

virtual	~QgsAbstractGeometry ()=default

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

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

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

virtual 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	hasCurvedSegments () const
	Returns `true` if the geometry contains curved segments.

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

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

QgsAbstractGeometry &	operator= (const QgsAbstractGeometry &geom)

QgsGeometryPartIterator	parts ()
	Returns Java-style iterator for traversal of parts of the geometry.

QgsGeometryConstPartIterator	parts () const
	Returns Java-style iterator for traversal of parts of the geometry.

part_iterator	parts_begin ()
	Returns STL-style iterator pointing to the first part of the geometry.

part_iterator	parts_end ()
	Returns STL-style iterator pointing to the imaginary part after the last part of the geometry.

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

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

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

static QgsLineString *	fromBezierCurve (const QgsPoint &start, const QgsPoint &controlPoint1, const QgsPoint &controlPoint2, const QgsPoint &end, int segments=30)
	Returns a new linestring created by segmentizing the bezier curve between start and end, with the specified control points.

static QgsLineString *	fromQPolygonF (const QPolygonF &polygon)
	Returns a new linestring from a QPolygonF polygon input.

Static Public Member Functions inherited from QgsCurve
static const QgsCurve *	cast (const QgsAbstractGeometry *geom)
	Cast the geom to a QgsCurve.

Protected Member Functions
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.

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

Friends
class	QgsPolygon

class	QgsTriangle

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

Protected Attributes inherited from QgsCurve
QgsBox3D	mBoundingBox
	Cached bounding box.

bool	mHasCachedSummedUpArea = false

double	mSummedUpArea = 0

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

Detailed Description

Line string geometry type, with support for z-dimension and m-values.

Definition at line 44 of file qgslinestring.h.

Constructor & Destructor Documentation

◆ QgsLineString() [1/6]

QgsLineString::QgsLineString ( )

Constructor for an empty linestring geometry.

Definition at line 45 of file qgslinestring.cpp.

◆ QgsLineString() [2/6]

QgsLineString::QgsLineString ( const QVector< QgsPoint > & points )

Construct a linestring from a vector of points.

Z and M type will be set based on the type of the first point in the vector.

Definition at line 50 of file qgslinestring.cpp.

◆ QgsLineString() [3/6]

QgsLineString::QgsLineString ( const QVector< QgsPointXY > & points )

Construct a linestring from list of points.

This constructor is more efficient then calling setPoints() or repeatedly calling addVertex()

Definition at line 158 of file qgslinestring.cpp.

◆ QgsLineString() [4/6]

QgsLineString::QgsLineString ( const QgsLineSegment2D & segment )

explicit

Construct a linestring from a single 2d line segment.

Since: QGIS 3.2

Definition at line 170 of file qgslinestring.cpp.

◆ QgsLineString() [5/6]

QgsLineString::QgsLineString	(	const QVector< double > &	x,
		const QVector< double > &	y,
		const QVector< double > &	z = `QVector<double>()`,
		const QVector< double > &	m = `QVector<double>()`,
		bool	is25DType = `false`
	)

Construct a linestring from arrays of coordinates.

If the z or m arrays are non-empty then the resultant linestring will have z and m types accordingly. This constructor is more efficient then calling setPoints() or repeatedly calling addVertex()

If the z vector is filled, then the geometry type will either be a LineStringZ(M) or LineString25D depending on the is25DType argument. If is25DType is true (and the m vector is unfilled) then the created Linestring will be a LineString25D type. Otherwise, the LineString will be LineStringZ (or LineStringZM) type.

If the sizes of x and y are non-equal then the resultant linestring will be created using the minimum size of these arrays.

Definition at line 87 of file qgslinestring.cpp.

◆ QgsLineString() [6/6]

QgsLineString::QgsLineString	(	const QgsPoint &	p1,
		const QgsPoint &	p2
	)

Constructs a linestring with a single segment from p1 to p2.

Since: QGIS 3.2

Definition at line 133 of file qgslinestring.cpp.

Member Function Documentation

◆ addMValue()

bool QgsLineString::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 2276 of file qgslinestring.cpp.

◆ addToPainterPath()

void QgsLineString::addToPainterPath ( QPainterPath & path ) const

overridevirtual

Adds a curve to a painter path.

Implements QgsCurve.

Definition at line 1654 of file qgslinestring.cpp.

◆ addVertex()

void QgsLineString::addVertex ( const QgsPoint & pt )

Adds a new vertex to the end of the line string.

Parameters

pt	vertex to add

Definition at line 1962 of file qgslinestring.cpp.

◆ addZValue()

bool QgsLineString::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 2252 of file qgslinestring.cpp.

◆ append()

void QgsLineString::append ( const QgsLineString * line )

Appends the contents of another line string to the end of this line string.

Parameters

line	line to append. Ownership is not transferred.

Definition at line 1392 of file qgslinestring.cpp.

◆ asGml2()

QDomElement QgsLineString::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

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace
axisOrder	Axis order for generated GML

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

Implements QgsAbstractGeometry.

Definition at line 902 of file qgslinestring.cpp.

◆ asGml3()

QDomElement QgsLineString::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

doc	DOM document
precision	number of decimal places for coordinates
ns	XML namespace
axisOrder	Axis order for generated GML

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

Implements QgsAbstractGeometry.

Definition at line 917 of file qgslinestring.cpp.

◆ asJsonObject()

json QgsLineString::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 931 of file qgslinestring.cpp.

◆ asKml()

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

overridevirtual

Returns a KML representation of the geometry.

Since: QGIS 3.12

Reimplemented from QgsCurve.

Definition at line 942 of file qgslinestring.cpp.

◆ asQPolygonF()

QPolygonF QgsLineString::asQPolygonF ( ) const

overridevirtual

Returns a QPolygonF representing the points.

Reimplemented from QgsCurve.

Definition at line 608 of file qgslinestring.cpp.

◆ asWkb()

QByteArray QgsLineString::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 868 of file qgslinestring.cpp.

◆ asWkt()

QString QgsLineString::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 887 of file qgslinestring.cpp.

◆ boundingBoxIntersects() [1/2]

bool QgsLineString::boundingBoxIntersects ( const QgsBox3D & box3d ) const

overridevirtual

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

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

Since: QGIS 3.34

Reimplemented from QgsAbstractGeometry.

Definition at line 482 of file qgslinestring.cpp.

◆ boundingBoxIntersects() [2/2]

bool QgsLineString::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 402 of file qgslinestring.cpp.

◆ calculateBoundingBox3d()

QgsBox3D QgsLineString::calculateBoundingBox3d ( ) const

Calculates the minimal 3D bounding box for the geometry.

Deprecated: use calculateBoundingBox3D instead

See also: calculateBoundingBox()

Since: QGIS 3.26

Deprecated:: since QGIS 3.34

Definition at line 786 of file qgslinestring.cpp.

◆ calculateBoundingBox3D()

QgsBox3D QgsLineString::calculateBoundingBox3D ( ) const

overridevirtual

Calculates the minimal 3D bounding box for the geometry.

See also: calculateBoundingBox()

Since: QGIS 3.34

Reimplemented from QgsAbstractGeometry.

Definition at line 759 of file qgslinestring.cpp.

◆ cast()

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

inlinestatic

Cast the geom to a QgsLineString.

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

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

Definition at line 1071 of file qgslinestring.h.

◆ centroid()

QgsPoint QgsLineString::centroid ( ) const

overridevirtual

Returns the centroid of the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 2070 of file qgslinestring.cpp.

◆ clear()

void QgsLineString::clear ( )

overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 273 of file qgslinestring.cpp.

◆ clone()

QgsLineString * QgsLineString::clone ( ) const

overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsCurve.

Definition at line 268 of file qgslinestring.cpp.

◆ close()

void QgsLineString::close ( )

Closes the line string by appending the first point to the end of the line, if it is not already closed.

Definition at line 2184 of file qgslinestring.cpp.

◆ closestSegment()

double QgsLineString::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

pt	specifies the point to find closest segment to
segmentPt	storage for the closest point within the geometry
vertexAfter	storage for the ID of the vertex at the end of the closest segment
leftOf	indicates 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)
epsilon	epsilon for segment snapping

Returns: squared distance to closest segment or negative value on error

Implements QgsAbstractGeometry.

Definition at line 1982 of file qgslinestring.cpp.

◆ collectDuplicateNodes()

QVector< QgsVertexId > QgsLineString::collectDuplicateNodes	(	double	epsilon = `4 * std::numeric_limits<double>::epsilon()`,
		bool	useZValues = `false`
	)		const

Returns a list of any duplicate nodes contained in the geometry, within the specified tolerance.

If useZValues is true then z values will also be considered when testing for duplicates.

Since: QGIS 3.16

Definition at line 569 of file qgslinestring.cpp.

◆ compareToSameClass()

int QgsLineString::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 1724 of file qgslinestring.cpp.

◆ convertTo()

bool QgsLineString::convertTo ( Qgis::WkbType type )

overridevirtual

Converts the geometry to a specified type.

Returns: true if conversion was successful

Reimplemented from QgsAbstractGeometry.

Definition at line 2335 of file qgslinestring.cpp.

◆ createEmptyWithSameType()

QgsLineString * QgsLineString::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()

Implements QgsAbstractGeometry.

Definition at line 1717 of file qgslinestring.cpp.

◆ curveSubstring()

QgsLineString * QgsLineString::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 1550 of file qgslinestring.cpp.

◆ curveToLine()

QgsLineString * QgsLineString::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

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

Implements QgsCurve.

Definition at line 1150 of file qgslinestring.cpp.

◆ deleteVertex()

bool QgsLineString::deleteVertex ( QgsVertexId position )

overridevirtual

Deletes a vertex within the geometry.

Parameters

position vertex id for vertex to delete

Returns: true if delete was successful

See also: insertVertex; moveVertex

Implements QgsAbstractGeometry.

Definition at line 1929 of file qgslinestring.cpp.

◆ dimension()

int QgsLineString::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 1815 of file qgslinestring.cpp.

◆ draw()

void QgsLineString::draw ( QPainter & p ) const

overridevirtual

Draws the geometry using the specified QPainter.

Parameters

p	destination QPainter

Implements QgsAbstractGeometry.

Definition at line 1649 of file qgslinestring.cpp.

◆ drawAsPolygon()

void QgsLineString::drawAsPolygon ( QPainter & p ) const

overridevirtual

Draws the curve as a polygon on the specified QPainter.

Parameters

p	destination QPainter

Implements QgsCurve.

Definition at line 1673 of file qgslinestring.cpp.

◆ dropMValue()

bool QgsLineString::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 2318 of file qgslinestring.cpp.

◆ dropZValue()

bool QgsLineString::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 2307 of file qgslinestring.cpp.

◆ endPoint()

QgsPoint QgsLineString::endPoint ( ) const

overridevirtual

Returns the end point of the curve.

See also: startPoint

Implements QgsCurve.

Definition at line 1135 of file qgslinestring.cpp.

◆ equals()

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

inlineoverridevirtual

Checks whether this curve exactly equals another curve.

Implements QgsCurve.

Definition at line 426 of file qgslinestring.h.

◆ extend()

void QgsLineString::extend	(	double	startDistance,
		double	endDistance
	)

Extends the line geometry by extrapolating out the start or end of the line by a specified distance.

Lines are extended using the bearing of the first or last segment in the line.

Definition at line 1685 of file qgslinestring.cpp.

◆ filterVertices()

void QgsLineString::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 2399 of file qgslinestring.cpp.

◆ fromBezierCurve()

QgsLineString * QgsLineString::fromBezierCurve	(	const QgsPoint &	start,
		const QgsPoint &	controlPoint1,
		const QgsPoint &	controlPoint2,
		const QgsPoint &	end,
		int	segments = `30`
	)

static

Returns a new linestring created by segmentizing the bezier curve between start and end, with the specified control points.

The segments parameter controls how many line segments will be present in the returned linestring.

Any z or m values present in the input coordinates will be interpolated along with the x and y values.

Since: QGIS 3.10

Definition at line 187 of file qgslinestring.cpp.

◆ fromQPolygonF()

QgsLineString * QgsLineString::fromQPolygonF ( const QPolygonF & polygon )

static

Returns a new linestring from a QPolygonF polygon input.

Since: QGIS 3.10

Definition at line 248 of file qgslinestring.cpp.

◆ fromWkb()

bool QgsLineString::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 742 of file qgslinestring.cpp.

◆ fromWkt()

bool QgsLineString::fromWkt ( const QString & wkt )

overridevirtual

Sets the geometry from a WKT string.

See also: fromWkb

Implements QgsAbstractGeometry.

Definition at line 834 of file qgslinestring.cpp.

◆ fuzzyDistanceEqual()

bool QgsLineString::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 397 of file qgslinestring.h.

◆ fuzzyEqual()

bool QgsLineString::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 368 of file qgslinestring.h.

◆ geometryType()

QString QgsLineString::geometryType ( ) const

overridevirtual

Returns a unique string representing the geometry type.

See also: wkbType; wktTypeStr

Implements QgsAbstractGeometry.

Definition at line 1810 of file qgslinestring.cpp.

◆ indexOf()

int QgsLineString::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 288 of file qgslinestring.cpp.

◆ insertVertex()

bool QgsLineString::insertVertex	(	QgsVertexId	position,
		const QgsPoint &	vertex
	)

overridevirtual

Inserts a vertex into the geometry.

Parameters

position	vertex id for position of inserted vertex
vertex	vertex to insert

Returns: true if insert was successful

See also: moveVertex; deleteVertex

Implements QgsAbstractGeometry.

Definition at line 1883 of file qgslinestring.cpp.

◆ interpolateM()

QgsLineString * QgsLineString::interpolateM ( bool use3DDistance = true ) const

Returns a copy of this line with all missing (NaN) m values interpolated from m values of surrounding vertices.

If the line does not contain m values, nullptr is returned.

The use3DDistance controls whether 2D or 3D distances between vertices should be used during interpolation. This option is only considered for lines with z values.

Since: QGIS 3.38

Definition at line 2510 of file qgslinestring.cpp.

◆ interpolatePoint()

QgsPoint * QgsLineString::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 1530 of file qgslinestring.cpp.

◆ isClosed()

bool QgsLineString::isClosed ( ) const

overridevirtual

Returns true if the curve is closed.

See also: isClosed2D()

Reimplemented from QgsCurve.

Definition at line 391 of file qgslinestring.cpp.

◆ isClosed2D()

bool QgsLineString::isClosed2D ( ) const

overridevirtual

Returns true if the curve is closed.

Unlike isClosed. It looks only for XY coordinates.

See also: isClosed()

Since: QGIS 3.20

Reimplemented from QgsCurve.

Definition at line 382 of file qgslinestring.cpp.

◆ isEmpty()

bool QgsLineString::isEmpty ( ) const

overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 283 of file qgslinestring.cpp.

◆ isValid()

bool QgsLineString::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

Reimplemented from QgsCurve.

Definition at line 319 of file qgslinestring.cpp.

◆ length()

double QgsLineString::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 1004 of file qgslinestring.cpp.

◆ length3D()

double QgsLineString::length3D ( ) const

Returns the length in 3D world of the line string.

If it is not a 3D line string, return its 2D length.

See also: length()

Since: QGIS 3.10

Definition at line 1089 of file qgslinestring.cpp.

◆ mAt()

double QgsLineString::mAt ( int index ) const

inlineoverridevirtual

Returns the m value of the specified node in the line string.

Parameters

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

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

See also: setMAt()

Implements QgsCurve.

Definition at line 679 of file qgslinestring.h.

◆ mData()

const double * QgsLineString::mData ( ) const

inline

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

Note: Not available in Python bindings

See also: xData(); yData()

Since: QGIS 3.2

Definition at line 575 of file qgslinestring.h.

◆ measuredLine()

QgsLineString * QgsLineString::measuredLine	(	double	start,
		double	end
	)		const

Re-write the measure ordinate (or add one, if it isn't already there) interpolating the measure between the supplied start and end values.

Since: QGIS 3.36

Definition at line 2474 of file qgslinestring.cpp.

◆ moveVertex()

bool QgsLineString::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 1909 of file qgslinestring.cpp.

◆ mVector()

QVector< double > QgsLineString::mVector ( ) const

inline

Returns the m vertex values as a vector.

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 618 of file qgslinestring.h.

◆ nCoordinates()

int QgsLineString::nCoordinates ( ) const

overridevirtual

Returns the number of nodes contained in the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 1162 of file qgslinestring.cpp.

◆ numPoints()

int QgsLineString::numPoints ( ) const

overridevirtual

Returns the number of points in the curve.

Implements QgsCurve.

Definition at line 1157 of file qgslinestring.cpp.

◆ pointAt()

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

overridevirtual

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

Implements QgsCurve.

Definition at line 2059 of file qgslinestring.cpp.

◆ pointN()

QgsPoint QgsLineString::pointN ( int i ) const

Returns the specified point from inside the line string.

Parameters

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

Definition at line 1167 of file qgslinestring.cpp.

◆ points()

void QgsLineString::points ( QgsPointSequence & pt ) const

overridevirtual

Returns a list of points within the curve.

Implements QgsCurve.

Definition at line 1252 of file qgslinestring.cpp.

◆ removeDuplicateNodes()

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

Implements QgsAbstractGeometry.

Definition at line 342 of file qgslinestring.cpp.

◆ reversed()

QgsLineString * QgsLineString::reversed ( ) const

overridevirtual

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

Implements QgsCurve.

Definition at line 1454 of file qgslinestring.cpp.

◆ scroll()

void QgsLineString::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 791 of file qgslinestring.cpp.

◆ segmentLength()

double QgsLineString::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.

Implements QgsAbstractGeometry.

Definition at line 2236 of file qgslinestring.cpp.

◆ setMAt()

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

inline

Sets the m value of the specified node in the line string.

Parameters

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

See also: mAt()

Definition at line 851 of file qgslinestring.h.

◆ setPoints() [1/2]

void QgsLineString::setPoints ( const QgsPointSequence & points )

Resets the line string to match the specified list of points.

The line string will inherit the dimensionality of the first point in the list.

Parameters

points new points for line string. If empty, line string will be cleared.

Definition at line 1333 of file qgslinestring.cpp.

◆ setPoints() [2/2]

void QgsLineString::setPoints	(	size_t	size,
		const double *	x,
		const double *	y,
		const double *	z = `nullptr`,
		const double *	m = `nullptr`
	)

Resets the line string to match the specified point data.

The line string dimensionality will be based on whether z or m arrays are specified.

Parameters

size	point count.
x	array of x data
y	array of y data
z	array of z data, can be `nullptr`
m	array of m data, can be `nullptr`

Note: Not available from Python bindings

Since: QGIS 3.26

Definition at line 1263 of file qgslinestring.cpp.

◆ setXAt()

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

Sets 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. Corresponding node must already exist in line string.
x	x-coordinate of node

See also: xAt()

Definition at line 1232 of file qgslinestring.cpp.

◆ setYAt()

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

Sets 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. Corresponding node must already exist in line string.
y	y-coordinate of node

See also: yAt()

Definition at line 1239 of file qgslinestring.cpp.

◆ setZAt()

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

inline

Sets 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. Corresponding node must already exist in line string, and the line string must have z-dimension.
z	z-coordinate of node

See also: zAt()

Definition at line 807 of file qgslinestring.h.

◆ simplifyByDistance()

QgsLineString * QgsLineString::simplifyByDistance ( double tolerance ) const

overridevirtual

Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.

The caller takes ownership of the returned geometry. Curved geometries will be segmentized prior to simplification.

If a simplified geometry cannot be calculated nullptr will be returned.

The returned geometry may be invalid and contain self-intersecting rings.

Since: QGIS 3.38

Implements QgsAbstractGeometry.

Definition at line 661 of file qgslinestring.cpp.

◆ snappedToGrid()

QgsLineString * QgsLineString::snappedToGrid	(	double	hSpacing,
		double	vSpacing,
		double	dSpacing = `0`,
		double	mSpacing = `0`,
		bool	removeRedundantPoints = `false`
	)		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

hSpacing	Horizontal spacing of the grid (x axis). 0 to disable.
vSpacing	Vertical spacing of the grid (y axis). 0 to disable.
dSpacing	Depth spacing of the grid (z axis). 0 (default) to disable.
mSpacing	Custom dimension spacing of the grid (m axis). 0 (default) to disable.
removeRedundantPoints	if `true`, then points which are redundant (e.g. they represent mid points on a straight line segment) will be skipped (since QGIS 3.38)

Implements QgsAbstractGeometry.

Definition at line 329 of file qgslinestring.cpp.

◆ splitCurveAtVertex()

std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > QgsLineString::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 1030 of file qgslinestring.cpp.

◆ startPoint()

QgsPoint QgsLineString::startPoint ( ) const

overridevirtual

Returns the starting point of the curve.

See also: endPoint

Implements QgsCurve.

Definition at line 1126 of file qgslinestring.cpp.

◆ sumUpArea()

void QgsLineString::sumUpArea ( double & sum ) const

overridevirtual

Calculates the shoelace/triangle formula sum for the points in the linestring.

If the linestring is closed (i.e. a polygon) then the polygon area is equal to the absolute value of the sum. Please note that the sum will be negative if the points are defined in clockwise order. Therefore, if you want to use the sum as an area (as the method name indicates) then you probably should use the absolute value, since otherwise a bug can be introduced (such as the bug fixed for github issue 49578)

See also: https://en.wikipedia.org/wiki/Shoelace_formula#Triangle_formula

Implements QgsCurve.

Definition at line 2116 of file qgslinestring.cpp.

◆ swapXy()

void QgsLineString::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 2329 of file qgslinestring.cpp.

◆ toCurveType()

QgsCompoundCurve * QgsLineString::toCurveType ( ) const

overridevirtual

Returns the geometry converted to the more generic curve type QgsCompoundCurve.

Returns: the converted geometry. Caller takes ownership

Reimplemented from QgsCurve.

Definition at line 1678 of file qgslinestring.cpp.

◆ transform() [1/3]

void QgsLineString::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 1826 of file qgslinestring.cpp.

◆ transform() [2/3]

void QgsLineString::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 1848 of file qgslinestring.cpp.

◆ transform() [3/3]

bool QgsLineString::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 2355 of file qgslinestring.cpp.

◆ transformVertices()

void QgsLineString::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 2445 of file qgslinestring.cpp.

◆ vertexAngle()

double QgsLineString::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

vertex the vertex id

Returns: rotation in radians, clockwise from north

Implements QgsAbstractGeometry.

Definition at line 2193 of file qgslinestring.cpp.

◆ visitPointsByRegularDistance()

void QgsLineString::visitPointsByRegularDistance	(	double	distance,
		const std::function< bool(double x, double y, double z, double m, double startSegmentX, double startSegmentY, double startSegmentZ, double startSegmentM, double endSegmentX, double endSegmentY, double endSegmentZ, double endSegmentM) > &	visitPoint
	)		const

Visits regular points along the linestring, spaced by distance.

The visitPoint function should return false to abort further traversal.

Definition at line 1470 of file qgslinestring.cpp.

◆ wkbSize()

int QgsLineString::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 861 of file qgslinestring.cpp.

◆ xAt()

double QgsLineString::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 1216 of file qgslinestring.cpp.

◆ xData()

const double * QgsLineString::xData ( ) const

inline

Returns a const pointer to the x vertex data.

Note: Not available in Python bindings

See also: yData()

Since: QGIS 3.2

Definition at line 535 of file qgslinestring.h.

◆ xVector()

QVector< double > QgsLineString::xVector ( ) const

inline

Returns the x vertex values as a vector.

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 588 of file qgslinestring.h.

◆ yAt()

double QgsLineString::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 1224 of file qgslinestring.cpp.

◆ yData()

const double * QgsLineString::yData ( ) const

inline

Returns a const pointer to the y vertex data.

Note: Not available in Python bindings

See also: xData()

Since: QGIS 3.2

Definition at line 546 of file qgslinestring.h.

◆ yVector()

QVector< double > QgsLineString::yVector ( ) const

inline

Returns the y vertex values as a vector.

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 598 of file qgslinestring.h.

◆ zAt()

double QgsLineString::zAt ( int index ) const

inlineoverridevirtual

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 NaN if index is out of bounds or the line does not have a z dimension

See also: setZAt()

Implements QgsCurve.

Definition at line 633 of file qgslinestring.h.

◆ zData()

const double * QgsLineString::zData ( ) const

inline

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

Note: Not available in Python bindings

See also: xData(); yData()

Since: QGIS 3.2

Definition at line 559 of file qgslinestring.h.

◆ zVector()

QVector< double > QgsLineString::zVector ( ) const

inline

Returns the z vertex values as a vector.

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 608 of file qgslinestring.h.

Friends And Related Symbol Documentation

◆ QgsPolygon

friend class QgsPolygon

friend

Definition at line 1236 of file qgslinestring.h.

◆ QgsTriangle

friend class QgsTriangle

friend

Definition at line 1237 of file qgslinestring.h.

◆ TestQgsGeometry

friend class TestQgsGeometry

friend

Definition at line 1238 of file qgslinestring.h.

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

/home/fischer/src/qgis-3.38/src/core/geometry/qgslinestring.h
/home/fischer/src/qgis-3.38/src/core/geometry/qgslinestring.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLineString() [1/6]

◆ QgsLineString() [2/6]

◆ QgsLineString() [3/6]

◆ QgsLineString() [4/6]

◆ QgsLineString() [5/6]

◆ QgsLineString() [6/6]

Member Function Documentation

◆ addMValue()

◆ addToPainterPath()

◆ addVertex()

◆ addZValue()

◆ append()

◆ asGml2()

◆ asGml3()

◆ asJsonObject()

◆ asKml()

◆ asQPolygonF()

◆ asWkb()

◆ asWkt()

◆ boundingBoxIntersects() [1/2]

◆ boundingBoxIntersects() [2/2]

◆ calculateBoundingBox3d()

◆ calculateBoundingBox3D()

◆ cast()

◆ centroid()

◆ clear()

◆ clone()

◆ close()

◆ closestSegment()

◆ collectDuplicateNodes()

◆ compareToSameClass()

◆ convertTo()

◆ createEmptyWithSameType()

◆ curveSubstring()

◆ curveToLine()

◆ deleteVertex()

◆ dimension()

◆ draw()

◆ drawAsPolygon()

◆ dropMValue()

◆ dropZValue()

◆ endPoint()

◆ equals()

◆ extend()

◆ filterVertices()

◆ fromBezierCurve()

◆ fromQPolygonF()

◆ fromWkb()

◆ fromWkt()

◆ fuzzyDistanceEqual()

◆ fuzzyEqual()

◆ geometryType()

◆ indexOf()

◆ insertVertex()

◆ interpolateM()

◆ interpolatePoint()

◆ isClosed()

◆ isClosed2D()

◆ isEmpty()

◆ isValid()

◆ length()

◆ length3D()

◆ mAt()

◆ mData()

◆ measuredLine()

◆ moveVertex()

◆ mVector()

◆ nCoordinates()

◆ numPoints()

◆ pointAt()

◆ pointN()

◆ points()

◆ removeDuplicateNodes()