Compound curve geometry type. More...

#include <qgscompoundcurve.h>

Inheritance diagram for QgsCompoundCurve:

Public Member Functions
	QgsCompoundCurve ()

	QgsCompoundCurve (const QgsCompoundCurve &curve)

	~QgsCompoundCurve () override

void	addCurve (QgsCurve *c)
	Adds a curve to the geometry (takes ownership) More...

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

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

void	addVertex (const QgsPoint &pt)
	Adds a vertex to the end of the geometry. More...

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

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

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

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

QByteArray	asWkb () const override
	Returns a WKB representation of the geometry. More...

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

const QgsCompoundCurve *	cast (const QgsAbstractGeometry *geom) const
	Cast the geom to a QgsCompoundCurve. More...

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

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

void	close ()
	Appends first point if not already closed. More...

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

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

const QgsCurve *	curveAt (int i) const
	Returns the curve at the specified index. More...

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

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

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

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

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

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

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

QgsPoint	endPoint () const override
	Returns the end point of the curve. More...

bool	equals (const QgsCurve &other) const override
	Checks whether this curve exactly equals another curve. More...

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

bool	fromWkb (QgsConstWkbPtr &wkb) override
	Sets the geometry from a WKB string. More...

bool	fromWkt (const QString &wkt) override
	Sets the geometry from a WKT string. More...

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

bool	hasCurvedSegments () const override
	Returns true if the geometry contains curved segments. More...

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

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

double	length () const override
	Returns the length of the geometry. More...

bool	moveVertex (QgsVertexId position, const QgsPoint &newPos) override
	Moves a vertex within the geometry. More...

int	nCurves () const
	Returns the number of curves in the geometry. More...

int	numPoints () const override
	Returns the number of points in the curve. More...

QgsCompoundCurve &	operator= (const QgsCompoundCurve &curve)

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

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

void	removeCurve (int i)
	Removes a curve from the geometry. More...

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

QgsCompoundCurve *	reversed () const override
	Returns a reversed copy of the curve, where the direction of the curve has been flipped. More...

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

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

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

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

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

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

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

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

double	xAt (int index) const override
	Returns the x-coordinate of the specified node in the line string. More...

double	yAt (int index) const override
	Returns the y-coordinate of the specified node in the line string. More...

Public Member Functions inherited from QgsCurve
	QgsCurve ()=default
	Constructor for QgsCurve. More...

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

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

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

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

const QgsCurve *	cast (const QgsAbstractGeometry *geom) const
	Cast the geom to a QgsCurve. More...

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

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

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

bool	nextVertex (QgsVertexId &id, QgsPoint &vertex) const override
	Returns next vertex id and coordinates. More...

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

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

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

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

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

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

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

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

QgsPoint	vertexAt (QgsVertexId id) const override
	Returns the point corresponding to a specified vertex id. More...

int	vertexCount (int part=0, int ring=0) const override
	Returns the number of vertices of which this geometry is built. More...

int	vertexNumberFromVertexId (QgsVertexId id) const override
	Returns the vertex number corresponding to a vertex id. More...

Public Member Functions inherited from QgsAbstractGeometry
	QgsAbstractGeometry ()=default
	Constructor for QgsAbstractGeometry. More...

	QgsAbstractGeometry (const QgsAbstractGeometry &geom)

virtual	~QgsAbstractGeometry ()=default

virtual double	area () const
	Returns the area of the geometry. More...

virtual QgsPoint	centroid () const
	Returns the centroid of the geometry. More...

virtual bool	convertTo (QgsWkbTypes::Type type)
	Converts the geometry to a specified type. More...

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

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

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

QgsAbstractGeometry &	operator= (const QgsAbstractGeometry &geom)

virtual double	perimeter () const
	Returns the perimeter of the geometry. More...

QgsVertexIterator	vertices () const
	Returns Java-style iterator for traversal of vertices of the geometry. More...

vertex_iterator	vertices_begin () const
	Returns STL-style iterator pointing to the first vertex of the geometry. More...

vertex_iterator	vertices_end () const
	Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More...

QgsWkbTypes::Type	wkbType () const
	Returns the WKB type of the geometry. More...

QString	wktTypeStr () const
	Returns the WKT type string of the geometry. More...

Protected Member Functions
QgsRectangle	calculateBoundingBox () const override
	Default calculator for the minimal bounding box for the geometry. More...

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

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

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

bool	snapToGridPrivate (double hSpacing, double vSpacing, double dSpacing, double mSpacing, const QVector< double > &srcX, const QVector< double > &srcY, const QVector< double > &srcZ, const QVector< double > &srcM, QVector< double > &outX, QVector< double > &outY, QVector< double > &outZ, QVector< double > &outM) const
	Helper function for QgsCurve subclasses to snap to grids. More...

Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsAbstractGeometry *	childGeometry (int index) const
	Returns pointer to child geometry (for geometries with child geometries - i.e. More...

virtual bool	hasChildGeometries () const
	Returns whether the geometry has any child geometries (false for point / curve, true otherwise) More...

void	setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType)
	Updates the geometry type based on whether sub geometries contain z or m values. More...

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

Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type	mWkbType = QgsWkbTypes::Unknown

Detailed Description

Compound curve geometry type.

Since: QGIS 2.10

Definition at line 31 of file qgscompoundcurve.h.

Constructor & Destructor Documentation

◆ QgsCompoundCurve() [1/2]

QgsCompoundCurve::QgsCompoundCurve ( )

Definition at line 28 of file qgscompoundcurve.cpp.

◆ QgsCompoundCurve() [2/2]

QgsCompoundCurve::QgsCompoundCurve ( const QgsCompoundCurve & curve )

Definition at line 76 of file qgscompoundcurve.cpp.

◆ ~QgsCompoundCurve()

QgsCompoundCurve::~QgsCompoundCurve ( )

override

Definition at line 33 of file qgscompoundcurve.cpp.

Member Function Documentation

◆ addCurve()

void QgsCompoundCurve::addCurve ( QgsCurve * c )

Adds a curve to the geometry (takes ownership)

Definition at line 444 of file qgscompoundcurve.cpp.

◆ addMValue()

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

Since: QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 873 of file qgscompoundcurve.cpp.

◆ addToPainterPath()

void QgsCompoundCurve::addToPainterPath ( QPainterPath & path ) const

overridevirtual

Adds a curve to a painter path.

Implements QgsCurve.

Definition at line 545 of file qgscompoundcurve.cpp.

◆ addVertex()

void QgsCompoundCurve::addVertex ( const QgsPoint & pt )

Adds a vertex to the end of the geometry.

Definition at line 486 of file qgscompoundcurve.cpp.

◆ addZValue()

bool QgsCompoundCurve::addZValue ( double zValue = 0 )

overridevirtual

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

Parameters

zValue initial z-value for all nodes

Returns: true on success

See also: dropZValue(); addMValue()

Since: QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 858 of file qgscompoundcurve.cpp.

◆ asGml2()

QDomElement QgsCompoundCurve::asGml2	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`,
		QgsAbstractGeometry::AxisOrder	axisOrder = `QgsAbstractGeometry::AxisOrder::XY`
	)		const

overridevirtual

Returns a GML2 representation of the geometry.

Parameters

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

◆ asGml3()

QDomElement QgsCompoundCurve::asGml3	(	QDomDocument &	doc,
		int	precision = `17`,
		const QString &	ns = `"gml"`,
		QgsAbstractGeometry::AxisOrder	axisOrder = `QgsAbstractGeometry::AxisOrder::XY`
	)		const

overridevirtual

Returns a GML3 representation of the geometry.

Parameters

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

◆ asJson()

QString QgsCompoundCurve::asJson ( int precision = 17 ) const

overridevirtual

Returns a GeoJSON representation of the geometry.

Parameters

precision number of decimal places for coordinates

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

Implements QgsAbstractGeometry.

Definition at line 291 of file qgscompoundcurve.cpp.

◆ asWkb()

QByteArray QgsCompoundCurve::asWkb ( ) const

overridevirtual

Returns a WKB representation of the geometry.

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

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 220 of file qgscompoundcurve.cpp.

◆ asWkt()

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

◆ calculateBoundingBox()

QgsRectangle QgsCompoundCurve::calculateBoundingBox ( ) const

overrideprotectedvirtual

Default calculator for the minimal bounding box for the geometry.

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

Reimplemented from QgsAbstractGeometry.

Definition at line 112 of file qgscompoundcurve.cpp.

◆ cast()

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

inline

Cast the geom to a QgsCompoundCurve.

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

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

Since: QGIS 3.0

Definition at line 139 of file qgscompoundcurve.h.

◆ clear()

void QgsCompoundCurve::clear ( )

overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 104 of file qgscompoundcurve.cpp.

◆ clone()

QgsCompoundCurve * QgsCompoundCurve::clone ( ) const

overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsCurve.

Definition at line 99 of file qgscompoundcurve.cpp.

◆ close()

void QgsCompoundCurve::close ( )

Appends first point if not already closed.

Definition at line 793 of file qgscompoundcurve.cpp.

◆ closestSegment()

double QgsCompoundCurve::closestSegment	(	const QgsPoint &	pt,
		QgsPoint &	segmentPt,
		QgsVertexId &	vertexAfter,
		int *	leftOf = `nullptr`,
		double	epsilon = `4 *std::numeric_limits< double >::epsilon()`
	)		const

overridevirtual

Searches for the closest segment of the geometry to a given point.

Parameters

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

◆ createEmptyWithSameType()

QgsCompoundCurve * QgsCompoundCurve::createEmptyWithSameType ( ) const

overridevirtual

Creates a new geometry with the same class and same WKB type as the original and transfers ownership.

To create it, the geometry is default constructed and then the WKB is changed.

See also: clone()

Since: 3.0

Implements QgsAbstractGeometry.

Definition at line 59 of file qgscompoundcurve.cpp.

◆ curveAt()

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

Returns the curve at the specified index.

Definition at line 435 of file qgscompoundcurve.cpp.

◆ curveToLine()

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

overridevirtual

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

Parameters

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

Implements QgsCurve.

Definition at line 375 of file qgscompoundcurve.cpp.

◆ deleteVertex()

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

◆ dimension()

int QgsCompoundCurve::dimension ( ) const

overridevirtual

Returns the inherent dimension of the geometry.

For example, this is 0 for a point geometry, 1 for a linestring and 2 for a polygon.

Implements QgsAbstractGeometry.

Definition at line 71 of file qgscompoundcurve.cpp.

◆ draw()

void QgsCompoundCurve::draw ( QPainter & p ) const

overridevirtual

Draws the geometry using the specified QPainter.

Parameters

p	destination QPainter

Implements QgsAbstractGeometry.

Definition at line 519 of file qgscompoundcurve.cpp.

◆ drawAsPolygon()

void QgsCompoundCurve::drawAsPolygon ( QPainter & p ) const

overridevirtual

Draws the curve as a polygon on the specified QPainter.

Parameters

p	destination QPainter

Implements QgsCurve.

Definition at line 555 of file qgscompoundcurve.cpp.

◆ dropMValue()

bool QgsCompoundCurve::dropMValue ( )

overridevirtual

Drops any measure values which exist in the geometry.

Returns: true if m-values were present and have been removed

See also: addMValue(); dropZValue()

Since: QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 902 of file qgscompoundcurve.cpp.

◆ dropZValue()

bool QgsCompoundCurve::dropZValue ( )

overridevirtual

Drops any z-dimensions which exist in the geometry.

Returns: true if Z values were present and have been removed

See also: addZValue(); dropMValue()

Since: QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 888 of file qgscompoundcurve.cpp.

◆ endPoint()

QgsPoint QgsCompoundCurve::endPoint ( ) const

overridevirtual

Returns the end point of the curve.

See also: startPoint

Implements QgsCurve.

Definition at line 318 of file qgscompoundcurve.cpp.

◆ equals()

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

overridevirtual

Checks whether this curve exactly equals another curve.

Since: QGIS 3.0

Implements QgsCurve.

Definition at line 38 of file qgscompoundcurve.cpp.

◆ filterVertices()

void QgsCompoundCurve::filterVertices ( const std::function< bool(const QgsPoint &) > & filter )

overridevirtual

Filters the vertices from the geometry in place, removing any which do not return true for the filter function check.

Has no meaning when called on a single point geometry.

Depending on the filter used, this may result in an invalid geometry.

Note: Not available in Python bindings

Since: QGIS 3.2

Reimplemented from QgsAbstractGeometry.

Definition at line 776 of file qgscompoundcurve.cpp.

◆ fromWkb()

bool QgsCompoundCurve::fromWkb ( QgsConstWkbPtr & wkb )

overridevirtual

Sets the geometry from a WKB string.

After successful read the wkb argument will be at the position where the reading has stopped.

See also: fromWkt

Implements QgsAbstractGeometry.

Definition at line 128 of file qgscompoundcurve.cpp.

◆ fromWkt()

bool QgsCompoundCurve::fromWkt ( const QString & wkt )

overridevirtual

Sets the geometry from a WKT string.

See also: fromWkb

Implements QgsAbstractGeometry.

Definition at line 168 of file qgscompoundcurve.cpp.

◆ geometryType()

QString QgsCompoundCurve::geometryType ( ) const

overridevirtual

Returns a unique string representing the geometry type.

See also: wkbType; wktTypeStr

Implements QgsAbstractGeometry.

Definition at line 66 of file qgscompoundcurve.cpp.

◆ hasCurvedSegments()

bool QgsCompoundCurve::hasCurvedSegments ( ) const

overridevirtual

Returns true if the geometry contains curved segments.

Reimplemented from QgsAbstractGeometry.

Definition at line 802 of file qgscompoundcurve.cpp.

◆ insertVertex()

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

◆ isEmpty()

bool QgsCompoundCurve::isEmpty ( ) const

overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 362 of file qgscompoundcurve.cpp.

◆ length()

double QgsCompoundCurve::length ( ) const

overridevirtual

Returns the length of the geometry.

See also: area(); perimeter()

Reimplemented from QgsAbstractGeometry.

Definition at line 299 of file qgscompoundcurve.cpp.

◆ moveVertex()

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

◆ nCurves()

int QgsCompoundCurve::nCurves ( ) const

inline

Returns the number of curves in the geometry.

Definition at line 76 of file qgscompoundcurve.h.

◆ numPoints()

int QgsCompoundCurve::numPoints ( ) const

overridevirtual

Returns the number of points in the curve.

Implements QgsCurve.

Definition at line 345 of file qgscompoundcurve.cpp.

◆ operator=()

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

Definition at line 85 of file qgscompoundcurve.cpp.

◆ pointAt()

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

overridevirtual

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

Parameters

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

◆ points()

void QgsCompoundCurve::points ( QgsPointSequence & pt ) const

overridevirtual

Returns a list of points within the curve.

Implements QgsCurve.

Definition at line 327 of file qgscompoundcurve.cpp.

◆ removeCurve()

void QgsCompoundCurve::removeCurve ( int i )

Removes a curve from the geometry.

Parameters

i	index of curve to remove

Definition at line 475 of file qgscompoundcurve.cpp.

◆ removeDuplicateNodes()

bool QgsCompoundCurve::removeDuplicateNodes	(	double	epsilon = `4 *std::numeric_limits< double >::epsilon()`,
		bool	useZValues = `false`
	)

overridevirtual

Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry.

The epsilon parameter specifies the tolerance for coordinates when determining that vertices are identical.

By default, z values are not considered when detecting duplicate nodes. E.g. two nodes with the same x and y coordinate but different z values will still be considered duplicate and one will be removed. If useZValues is true, then the z values are also tested and nodes with the same x and y but different z will be maintained.

Note that duplicate nodes are not tested between different parts of a multipart geometry. E.g. a multipoint geometry with overlapping points will not be changed by this method.

The function will return true if nodes were removed, or false if no duplicate nodes were found.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 406 of file qgscompoundcurve.cpp.

◆ reversed()

QgsCompoundCurve * QgsCompoundCurve::reversed ( ) const

overridevirtual

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

Since: QGIS 2.14

Implements QgsCurve.

Definition at line 847 of file qgscompoundcurve.cpp.

◆ segmentLength()

double QgsCompoundCurve::segmentLength ( QgsVertexId startVertex ) const

overridevirtual

Returns the length of the segment of the geometry which begins at startVertex.

Since: QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 836 of file qgscompoundcurve.cpp.

◆ snappedToGrid()

QgsCompoundCurve * QgsCompoundCurve::snappedToGrid	(	double	hSpacing,
		double	vSpacing,
		double	dSpacing = `0`,
		double	mSpacing = `0`
	)		const

overridevirtual

Makes a new geometry with all the points or vertices snapped to the closest point of the grid.

Ownership is transferred to the caller.

If the gridified geometry could not be calculated a 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.

Since: 3.0

Implements QgsAbstractGeometry.

Definition at line 387 of file qgscompoundcurve.cpp.

◆ startPoint()

QgsPoint QgsCompoundCurve::startPoint ( ) const

overridevirtual

Returns the starting point of the curve.

See also: endPoint

Implements QgsCurve.

Definition at line 309 of file qgscompoundcurve.cpp.

◆ sumUpArea()

void QgsCompoundCurve::sumUpArea ( double & sum ) const

overridevirtual

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

Implements QgsCurve.

Definition at line 785 of file qgscompoundcurve.cpp.

◆ swapXy()

void QgsCompoundCurve::swapXy ( )

overridevirtual

Swaps the x and y coordinates from the geometry.

This can be used to repair geometries which have accidentally had their latitude and longitude coordinates reversed.

Since: QGIS 3.2

Implements QgsAbstractGeometry.

Definition at line 916 of file qgscompoundcurve.cpp.

◆ transform() [1/2]

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

◆ transform() [2/2]

void QgsCompoundCurve::transform	(	const QTransform &	t,
		double	zTranslate = `0.0`,
		double	zScale = `1.0`,
		double	mTranslate = `0.0`,
		double	mScale = `1.0`
	)

overridevirtual

Transforms the x and y components of the geometry using a QTransform object t.

Optionally, the geometry's z values can be scaled via zScale and translated via zTranslate. Similarly, m-values can be scaled via mScale and translated via mTranslate.

Implements QgsAbstractGeometry.

Definition at line 536 of file qgscompoundcurve.cpp.

◆ vertexAngle()

double QgsCompoundCurve::vertexAngle ( QgsVertexId vertex ) const

overridevirtual

Returns approximate angle at a vertex.

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

Parameters

vertex the vertex id

Returns: rotation in radians, clockwise from north

Implements QgsAbstractGeometry.

Definition at line 814 of file qgscompoundcurve.cpp.

◆ xAt()

double QgsCompoundCurve::xAt ( int index ) const

overridevirtual

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

Parameters

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

◆ yAt()

double QgsCompoundCurve::yAt ( int index ) const

overridevirtual

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

Parameters

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

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

/tmp/buildd/qgis-3.2.0+99unstable/src/core/geometry/qgscompoundcurve.h
/tmp/buildd/qgis-3.2.0+99unstable/src/core/geometry/qgscompoundcurve.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsCompoundCurve() [1/2]

◆ QgsCompoundCurve() [2/2]

◆ ~QgsCompoundCurve()

Member Function Documentation

◆ addCurve()

◆ addMValue()

◆ addToPainterPath()

◆ addVertex()

◆ addZValue()

◆ asGml2()

◆ asGml3()

◆ asJson()

◆ asWkb()

◆ asWkt()

◆ calculateBoundingBox()

◆ cast()

◆ clear()

◆ clone()

◆ close()

◆ closestSegment()

◆ createEmptyWithSameType()

◆ curveAt()

◆ curveToLine()

◆ deleteVertex()

◆ dimension()

◆ draw()

◆ drawAsPolygon()

◆ dropMValue()

◆ dropZValue()

◆ endPoint()

◆ equals()

◆ filterVertices()

◆ fromWkb()

◆ fromWkt()

◆ geometryType()

◆ hasCurvedSegments()

◆ insertVertex()

◆ isEmpty()

◆ length()

◆ moveVertex()

◆ nCurves()

◆ numPoints()

◆ operator=()

◆ pointAt()

◆ points()

◆ removeCurve()

◆ removeDuplicateNodes()

◆ reversed()

◆ segmentLength()

◆ snappedToGrid()

◆ startPoint()

◆ sumUpArea()

◆ swapXy()

◆ transform() [1/2]

◆ transform() [2/2]

◆ vertexAngle()

◆ xAt()

◆ yAt()