QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
Circular string geometry type. More...
#include <qgscircularstring.h>
Public Member Functions | |
QgsCircularString () SIP_HOLDGIL | |
Constructs an empty circular string. More... | |
QgsCircularString (const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3) SIP_HOLDGIL | |
Constructs a circular string with a single arc passing through p1, p2 and p3. More... | |
QgsCircularString (const QVector< double > &x, const QVector< double > &y, const QVector< double > &z=QVector< double >(), const QVector< double > &m=QVector< double >()) SIP_HOLDGIL | |
Construct a circular string from arrays of coordinates. 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... | |
bool | addZValue (double zValue=0) override |
Adds a z-dimension to the geometry, initialized to a preset value. More... | |
void | append (const QgsCircularString *string) |
Appends the contents of another circular string to the end of this circular string. More... | |
QDomElement | asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML2 representation of the geometry. More... | |
QDomElement | asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML3 representation of the geometry. More... | |
json | asJsonObject (int precision=17) const override |
Returns a json object representation of the geometry. More... | |
QByteArray | asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
QString | asWkt (int precision=17) const override |
Returns a WKT representation of the geometry. More... | |
void | clear () override |
Clears the geometry, ie reset it to a null geometry. More... | |
QgsCircularString * | clone () const override |
Clones the geometry by performing a deep copy. 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... | |
QgsCircularString * | createEmptyWithSameType () const override |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More... | |
QgsCircularString * | curveSubstring (double startDistance, double endDistance) const override |
Returns a new curve representing a substring of this curve. 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 SIP_HOLDGIL |
Returns the inherent dimension of the geometry. More... | |
void | draw (QPainter &p) const override |
Draws the geometry using the specified QPainter. More... | |
void | drawAsPolygon (QPainter &p) const override |
Draws the curve as a polygon on the specified QPainter. More... | |
bool | dropMValue () override |
Drops any measure values which exist in the geometry. More... | |
bool | dropZValue () override |
Drops any z-dimensions which exist in the geometry. More... | |
QgsPoint | endPoint () const override SIP_HOLDGIL |
Returns the end point of the curve. More... | |
bool | equals (const QgsCurve &other) const override |
Checks whether this curve exactly equals another curve. More... | |
void | filterVertices (const std::function< bool(const QgsPoint &) > &filter) override |
Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. More... | |
bool | fromWkb (QgsConstWkbPtr &wkb) override |
Sets the geometry from a WKB string. More... | |
bool | fromWkt (const QString &wkt) override |
Sets the geometry from a WKT string. More... | |
QString | geometryType () const override SIP_HOLDGIL |
Returns a unique string representing the geometry type. More... | |
bool | hasCurvedSegments () const override |
Returns true if the geometry contains curved segments. More... | |
int | indexOf (const QgsPoint &point) const final |
Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found. More... | |
bool | insertVertex (QgsVertexId position, const QgsPoint &vertex) override |
Inserts a vertex into the geometry. More... | |
QgsPoint * | interpolatePoint (double distance) const override |
Returns an interpolated point on the curve at the specified distance. More... | |
bool | isEmpty () const override SIP_HOLDGIL |
Returns true if the geometry is empty. More... | |
bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override |
Checks validity of the geometry, and returns true if the geometry is valid. More... | |
double | length () const override |
Returns the planar, 2-dimensional length of the geometry. More... | |
double | mAt (int index) const override SIP_HOLDGIL |
Returns the m-coordinate of the specified node in the line string. More... | |
bool | moveVertex (QgsVertexId position, const QgsPoint &newPos) override |
Moves a vertex within the geometry. More... | |
int | numPoints () const override SIP_HOLDGIL |
Returns the number of points in the curve. More... | |
bool | pointAt (int node, QgsPoint &point, Qgis::VertexType &type) const override |
Returns the point and vertex id of a point within the curve. More... | |
QgsPoint | pointN (int i) const SIP_HOLDGIL |
Returns the point at index i within the circular string. More... | |
void | points (QgsPointSequence &pts) const override |
Returns a list of points within the curve. 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... | |
QgsCircularString * | reversed () const override |
Returns a reversed copy of the curve, where the direction of the curve has been flipped. More... | |
void | scroll (int firstVertexIndex) final |
Scrolls the curve vertices so that they start with the vertex at the given index. More... | |
double | segmentLength (QgsVertexId startVertex) const override |
Returns the length of the segment of the geometry which begins at startVertex. More... | |
void | setPoints (const QgsPointSequence &points) |
Sets the circular string's points. More... | |
QgsCircularString * | 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... | |
std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > | splitCurveAtVertex (int index) const final |
Splits the curve at the specified vertex index, returning two curves which represent the portion of the curve up to an including the vertex at index, and the portion of the curve from the vertex at index (inclusive) to the end of the curve. More... | |
QgsPoint | startPoint () const override SIP_HOLDGIL |
Returns the starting point of the curve. More... | |
void | sumUpArea (double &sum) const override |
Sums up the area of the curve by iterating over the vertices (shoelace formula). More... | |
void | swapXy () override |
Swaps the x and y coordinates from the geometry. More... | |
void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) override SIP_THROW(QgsCsException) |
Transforms the geometry using a coordinate transform. More... | |
void | transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0) override |
Transforms the x and y components of the geometry using a QTransform object t. More... | |
bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. More... | |
void | transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) override |
Transforms the vertices from the geometry in place, applying the transform function to every vertex. More... | |
double | vertexAngle (QgsVertexId vertex) const override |
Returns approximate angle at a vertex. More... | |
int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
Returns the length of the QByteArray returned by asWkb() More... | |
double | xAt (int index) const override SIP_HOLDGIL |
Returns the x-coordinate of the specified node in the line string. More... | |
double | yAt (int index) const override SIP_HOLDGIL |
Returns the y-coordinate of the specified node in the line string. More... | |
double | zAt (int index) const override SIP_HOLDGIL |
Returns the z-coordinate of the specified node in the line string. More... | |
![]() | |
QgsCurve ()=default | |
Constructor for QgsCurve. More... | |
virtual void | addToPainterPath (QPainterPath &path) const =0 |
Adds a curve to a painter path. More... | |
void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override |
Returns the vertices adjacent to a specified vertex within a geometry. More... | |
QString | asKml (int precision=17) const override |
Returns a KML representation of the geometry. More... | |
QPainterPath | asQPainterPath () const override |
Returns the geometry represented as a QPainterPath. More... | |
virtual QPolygonF | asQPolygonF () const |
Returns a QPolygonF representing the points. More... | |
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... | |
QgsCurve * | clone () const override=0 |
Clones the geometry by performing a deep copy. More... | |
QgsCoordinateSequence | coordinateSequence () const override |
Retrieves the sequence of geometries, rings and nodes. More... | |
virtual QgsCurve * | curveSubstring (double startDistance, double endDistance) const =0 |
Returns a new curve representing a substring of this curve. More... | |
virtual QgsLineString * | curveToLine (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const =0 |
Returns a new line string geometry corresponding to a segmentized approximation of the curve. More... | |
virtual void | drawAsPolygon (QPainter &p) const =0 |
Draws the curve as a polygon on the specified QPainter. More... | |
virtual QgsPoint | endPoint () const =0 |
Returns the end point of the curve. More... | |
virtual bool | equals (const QgsCurve &other) const =0 |
Checks whether this curve exactly equals another curve. More... | |
virtual int | indexOf (const QgsPoint &point) const =0 |
Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found. More... | |
virtual QgsPoint * | interpolatePoint (double distance) const =0 |
Returns an interpolated point on the curve at the specified distance. More... | |
virtual bool | isClosed () const SIP_HOLDGIL |
Returns true if the curve is closed. More... | |
virtual bool | isClosed2D () const SIP_HOLDGIL |
Returns true if the curve is closed. More... | |
virtual bool | isRing () const SIP_HOLDGIL |
Returns true if the curve is a ring. More... | |
bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override |
Checks validity of the geometry, and returns true if the geometry is valid. More... | |
virtual double | mAt (int index) const =0 |
Returns the m-coordinate of the specified node in the line string. More... | |
bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const override |
Returns next vertex id and coordinates. More... | |
void | normalize () final SIP_HOLDGIL |
Reorganizes the geometry into a normalized form (or "canonical" form). More... | |
virtual int | numPoints () const =0 |
Returns the number of points in the curve. More... | |
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. More... | |
int | partCount () const override |
Returns count of parts contained in the geometry. More... | |
virtual bool | pointAt (int node, QgsPoint &point, Qgis::VertexType &type) const =0 |
Returns the point and vertex id of a point within the curve. More... | |
virtual void | points (QgsPointSequence &pt) const =0 |
Returns a list of points within the curve. More... | |
virtual QgsCurve * | reversed () const =0 |
Returns a reversed copy of the curve, where the direction of the curve has been flipped. More... | |
int | ringCount (int part=0) const override |
Returns the number of rings of which this geometry is built. More... | |
virtual void | scroll (int firstVertexIndex)=0 |
Scrolls the curve vertices so that they start with the vertex at the given index. 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... | |
virtual std::tuple< std::unique_ptr< QgsCurve >, std::unique_ptr< QgsCurve > > | splitCurveAtVertex (int index) const =0 |
Splits the curve at the specified vertex index, returning two curves which represent the portion of the curve up to an including the vertex at index, and the portion of the curve from the vertex at index (inclusive) to the end of the curve. More... | |
virtual QgsPoint | startPoint () const =0 |
Returns the starting point of the curve. More... | |
double | straightDistance2d () const |
Returns the straight distance of the curve, i.e. More... | |
virtual void | sumUpArea (double &sum) const =0 |
Sums up the area of the curve by iterating over the vertices (shoelace formula). 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... | |
virtual double | xAt (int index) const =0 |
Returns the x-coordinate of the specified node in the line string. More... | |
virtual double | yAt (int index) const =0 |
Returns the y-coordinate of the specified node in the line string. More... | |
virtual double | zAt (int index) const =0 |
Returns the z-coordinate of the specified node in the line string. More... | |
![]() | |
QgsAbstractGeometry ()=default | |
Constructor for QgsAbstractGeometry. More... | |
QgsAbstractGeometry (const QgsAbstractGeometry &geom) | |
virtual | ~QgsAbstractGeometry ()=default |
virtual bool | addMValue (double mValue=0)=0 |
Adds a measure to the geometry, initialized to a preset value. More... | |
virtual bool | addZValue (double zValue=0)=0 |
Adds a z-dimension to the geometry, initialized to a preset value. More... | |
virtual void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const =0 |
Returns the vertices adjacent to a specified vertex within a geometry. More... | |
virtual double | area () const |
Returns the planar, 2-dimensional area of the geometry. More... | |
virtual QDomElement | asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0 |
Returns a GML2 representation of the geometry. More... | |
virtual QDomElement | asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const =0 |
Returns a GML3 representation of the geometry. More... | |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. More... | |
virtual json | asJsonObject (int precision=17) const |
Returns a json object representation of the geometry. More... | |
virtual QString | asKml (int precision=17) const =0 |
Returns a KML representation of the geometry. More... | |
virtual QPainterPath | asQPainterPath () const =0 |
Returns the geometry represented as a QPainterPath. More... | |
virtual QByteArray | asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns a WKB representation of the geometry. More... | |
virtual QString | asWkt (int precision=17) const =0 |
Returns a WKT representation of the geometry. More... | |
virtual QgsAbstractGeometry * | boundary () const =0 |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More... | |
virtual QgsRectangle | boundingBox () const =0 |
Returns the minimal bounding box for the geometry. More... | |
virtual bool | boundingBoxIntersects (const QgsRectangle &rectangle) const SIP_HOLDGIL |
Returns true if the bounding box of this geometry intersects with a rectangle. More... | |
virtual QgsPoint | centroid () const |
Returns the centroid of the geometry. More... | |
virtual void | clear ()=0 |
Clears the geometry, ie reset it to a null geometry. More... | |
virtual QgsAbstractGeometry * | clone () const =0 |
Clones the geometry by performing a deep copy. More... | |
virtual double | closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const =0 |
Searches for the closest segment of the geometry to a given point. More... | |
virtual int | compareTo (const QgsAbstractGeometry *other) const |
Comparator for sorting of geometry. More... | |
const_part_iterator | const_parts_begin () const |
Returns STL-style iterator pointing to the const first part of the geometry. More... | |
const_part_iterator | const_parts_end () const |
Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. More... | |
virtual bool | convertTo (Qgis::WkbType type) |
Converts the geometry to a specified type. More... | |
virtual QgsCoordinateSequence | coordinateSequence () const =0 |
Retrieves the sequence of geometries, rings and nodes. More... | |
virtual QgsAbstractGeometry * | createEmptyWithSameType () const =0 |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More... | |
virtual bool | deleteVertex (QgsVertexId position)=0 |
Deletes a vertex within the geometry. More... | |
virtual int | dimension () const =0 |
Returns the inherent dimension of the geometry. More... | |
virtual void | draw (QPainter &p) const =0 |
Draws the geometry using the specified QPainter. More... | |
virtual bool | dropMValue ()=0 |
Drops any measure values which exist in the geometry. More... | |
virtual bool | dropZValue ()=0 |
Drops any z-dimensions which exist in the geometry. More... | |
virtual void | filterVertices (const std::function< bool(const QgsPoint &) > &filter) |
Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. More... | |
virtual bool | fromWkb (QgsConstWkbPtr &wkb)=0 |
Sets the geometry from a WKB string. More... | |
virtual bool | fromWkt (const QString &wkt)=0 |
Sets the geometry from a WKT string. More... | |
virtual QString | geometryType () const =0 |
Returns a unique string representing the geometry type. More... | |
virtual bool | hasCurvedSegments () const |
Returns true if the geometry contains curved segments. More... | |
virtual bool | insertVertex (QgsVertexId position, const QgsPoint &vertex)=0 |
Inserts a vertex into the geometry. More... | |
bool | is3D () const SIP_HOLDGIL |
Returns true if the geometry is 3D and contains a z-value. More... | |
virtual bool | isEmpty () const |
Returns true if the geometry is empty. More... | |
bool | isMeasure () const SIP_HOLDGIL |
Returns true if the geometry contains m values. More... | |
virtual bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const =0 |
Checks validity of the geometry, and returns true if the geometry is valid. More... | |
virtual double | length () const |
Returns the planar, 2-dimensional length of the geometry. More... | |
virtual bool | moveVertex (QgsVertexId position, const QgsPoint &newPos)=0 |
Moves a vertex within the geometry. More... | |
virtual int | nCoordinates () const |
Returns the number of nodes contained in the geometry. More... | |
virtual bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const =0 |
Returns next vertex id and coordinates. More... | |
virtual void | normalize ()=0 |
Reorganizes the geometry into a normalized form (or "canonical" form). More... | |
virtual bool | operator!= (const QgsAbstractGeometry &other) const =0 |
QgsAbstractGeometry & | operator= (const QgsAbstractGeometry &geom) |
virtual bool | operator== (const QgsAbstractGeometry &other) const =0 |
virtual int | partCount () const =0 |
Returns count of parts contained in the geometry. More... | |
QgsGeometryPartIterator | parts () |
Returns Java-style iterator for traversal of parts of the geometry. More... | |
QgsGeometryConstPartIterator | parts () const |
Returns Java-style iterator for traversal of parts of the geometry. More... | |
part_iterator | parts_begin () |
Returns STL-style iterator pointing to the first part of the geometry. More... | |
part_iterator | parts_end () |
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. More... | |
virtual double | perimeter () const |
Returns the planar, 2-dimensional perimeter of the geometry. More... | |
virtual bool | removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false)=0 |
Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry. More... | |
virtual int | ringCount (int part=0) const =0 |
Returns the number of rings of which this geometry is built. More... | |
virtual QgsAbstractGeometry * | segmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const |
Returns a version of the geometry without curves. More... | |
virtual double | segmentLength (QgsVertexId startVertex) const =0 |
Returns the length of the segment of the geometry which begins at startVertex. More... | |
virtual const QgsAbstractGeometry * | simplifiedTypeRef () const SIP_HOLDGIL |
Returns a reference to the simplest lossless representation of this geometry, e.g. More... | |
virtual QgsAbstractGeometry * | snappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const =0 |
Makes a new geometry with all the points or vertices snapped to the closest point of the grid. More... | |
virtual void | swapXy ()=0 |
Swaps the x and y coordinates from the geometry. More... | |
virtual QgsAbstractGeometry * | toCurveType () const =0 |
Returns the geometry converted to the more generic curve type. More... | |
virtual void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) SIP_THROW(QgsCsException)=0 |
Transforms the geometry using a coordinate transform. More... | |
virtual void | transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0)=0 |
Transforms the x and y components of the geometry using a QTransform object t. More... | |
virtual bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr)=0 |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. More... | |
virtual void | transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) |
Transforms the vertices from the geometry in place, applying the transform function to every vertex. More... | |
virtual double | vertexAngle (QgsVertexId vertex) const =0 |
Returns approximate angle at a vertex. More... | |
virtual QgsPoint | vertexAt (QgsVertexId id) const =0 |
Returns the point corresponding to a specified vertex id. More... | |
virtual int | vertexCount (int part=0, int ring=0) const =0 |
Returns the number of vertices of which this geometry is built. More... | |
virtual int | vertexNumberFromVertexId (QgsVertexId id) const =0 |
Returns the vertex number corresponding to a vertex id. More... | |
QgsVertexIterator | vertices () const |
Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. More... | |
vertex_iterator | vertices_begin () const |
Returns STL-style iterator pointing to the first vertex of the geometry. More... | |
vertex_iterator | vertices_end () const |
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More... | |
virtual int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns the length of the QByteArray returned by asWkb() More... | |
Qgis::WkbType | wkbType () const SIP_HOLDGIL |
Returns the WKB type of the geometry. More... | |
QString | wktTypeStr () const |
Returns the WKT type string of the geometry. More... | |
Static Public Member Functions | |
static const QgsCircularString * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsCircularString. More... | |
static QgsCircularString | fromTwoPointsAndCenter (const QgsPoint &p1, const QgsPoint &p2, const QgsPoint ¢er, bool useShortestArc=true) |
Creates a circular string with a single arc representing the curve from p1 to p2 with the specified center. More... | |
![]() | |
static const QgsCurve * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsCurve. More... | |
Protected Member Functions | |
QgsRectangle | calculateBoundingBox () const override |
Default calculator for the minimal bounding box for the geometry. More... | |
int | compareToSameClass (const QgsAbstractGeometry *other) const final |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. More... | |
![]() | |
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... | |
![]() | |
virtual QgsRectangle | calculateBoundingBox () const |
Default calculator for the minimal bounding box for the geometry. More... | |
virtual int | childCount () const |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. More... | |
virtual QgsAbstractGeometry * | childGeometry (int index) const |
Returns pointer to child geometry (for geometries with child geometries - i.e. More... | |
virtual QgsPoint | childPoint (int index) const |
Returns point at index (for geometries without child geometries - i.e. More... | |
virtual void | clearCache () const |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. More... | |
virtual int | compareToSameClass (const QgsAbstractGeometry *other) const =0 |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. 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, Qgis::WkbType baseGeomType) |
Updates the geometry type based on whether sub geometries contain z or m values. More... | |
int | sortIndex () const |
Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
QgsRectangle | mBoundingBox |
Cached bounding box. More... | |
bool | mHasCachedSummedUpArea = false |
double | mSummedUpArea = 0 |
![]() | |
Qgis::WkbType | mWkbType = Qgis::WkbType::Unknown |
QgsCircularString::QgsCircularString | ( | ) |
Constructs an empty circular string.
Definition at line 34 of file qgscircularstring.cpp.
QgsCircularString::QgsCircularString | ( | const QgsPoint & | p1, |
const QgsPoint & | p2, | ||
const QgsPoint & | p3 | ||
) |
Constructs a circular string with a single arc passing through p1, p2 and p3.
Definition at line 39 of file qgscircularstring.cpp.
QgsCircularString::QgsCircularString | ( | const QVector< double > & | x, |
const QVector< double > & | y, | ||
const QVector< double > & | z = QVector<double>() , |
||
const QVector< double > & | m = QVector<double>() |
||
) |
Construct a circular string from arrays of coordinates.
If the z or m arrays are non-empty then the resultant circular string will have z and m types accordingly.
This constructor is more efficient then calling setPoints().
If the sizes of x and y are non-equal then the resultant circular string will be created using the minimum size of these arrays.
Definition at line 72 of file qgscircularstring.cpp.
|
overridevirtual |
Adds a measure to the geometry, initialized to a preset value.
mValue | initial m-value for all nodes |
true
on success Implements QgsAbstractGeometry.
Definition at line 1831 of file qgscircularstring.cpp.
|
overridevirtual |
Adds a curve to a painter path.
Implements QgsCurve.
Definition at line 1192 of file qgscircularstring.cpp.
|
overridevirtual |
Adds a z-dimension to the geometry, initialized to a preset value.
zValue | initial z-value for all nodes |
true
on success Implements QgsAbstractGeometry.
Definition at line 1813 of file qgscircularstring.cpp.
void QgsCircularString::append | ( | const QgsCircularString * | string | ) |
Appends the contents of another circular string to the end of this circular string.
string | circular string to append. Ownership is not transferred. |
Definition at line 1059 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a GML2 representation of the geometry.
doc | DOM document |
precision | number of decimal places for coordinates |
ns | XML namespace |
axisOrder | Axis order for generated GML |
Implements QgsAbstractGeometry.
Definition at line 543 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a GML3 representation of the geometry.
doc | DOM document |
precision | number of decimal places for coordinates |
ns | XML namespace |
axisOrder | Axis order for generated GML |
Implements QgsAbstractGeometry.
Definition at line 551 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a json object representation of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 570 of file qgscircularstring.cpp.
|
override |
Definition at line 515 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a WKT representation of the geometry.
precision | number of decimal places for coordinates |
Implements QgsAbstractGeometry.
Definition at line 528 of file qgscircularstring.cpp.
|
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 270 of file qgscircularstring.cpp.
|
inlinestatic |
Cast the geom to a QgsCircularString.
Should be used by qgsgeometry_cast<QgsCircularString *>( geometry ).
Definition at line 182 of file qgscircularstring.h.
|
overridevirtual |
Clears the geometry, ie reset it to a null geometry.
Implements QgsAbstractGeometry.
Definition at line 260 of file qgscircularstring.cpp.
|
overridevirtual |
Clones the geometry by performing a deep copy.
Implements QgsCurve.
Definition at line 255 of file qgscircularstring.cpp.
|
overridevirtual |
Searches for the closest segment of the geometry to a given point.
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 |
Implements QgsAbstractGeometry.
Definition at line 1318 of file qgscircularstring.cpp.
|
finalprotectedvirtual |
Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries.
Implements QgsAbstractGeometry.
Definition at line 159 of file qgscircularstring.cpp.
|
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.
Implements QgsAbstractGeometry.
Definition at line 152 of file qgscircularstring.cpp.
|
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.
Implements QgsCurve.
Definition at line 1683 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a new line string geometry corresponding to a segmentized approximation of the curve.
tolerance | segmentation tolerance |
toleranceType | maximum segmentation angle or maximum difference between approximation and curve |
Uses a MaximumAngle tolerance of 1 degrees by default (360 segments in a full circle)
Implements QgsCurve.
Definition at line 622 of file qgscircularstring.cpp.
|
overridevirtual |
Deletes a vertex within the geometry.
position | vertex id for vertex to delete |
true
if delete was successful Implements QgsAbstractGeometry.
Definition at line 1274 of file qgscircularstring.cpp.
|
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 250 of file qgscircularstring.cpp.
|
overridevirtual |
Draws the geometry using the specified QPainter.
p | destination QPainter |
Implements QgsAbstractGeometry.
Definition at line 1124 of file qgscircularstring.cpp.
|
overridevirtual |
Draws the curve as a polygon on the specified QPainter.
p | destination QPainter |
Implements QgsCurve.
Definition at line 1217 of file qgscircularstring.cpp.
|
overridevirtual |
Drops any measure values which exist in the geometry.
true
if m-values were present and have been removed Implements QgsAbstractGeometry.
Definition at line 1861 of file qgscircularstring.cpp.
|
overridevirtual |
Drops any z-dimensions which exist in the geometry.
true
if Z values were present and have been removed Implements QgsAbstractGeometry.
Definition at line 1849 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the end point of the curve.
Implements QgsCurve.
Definition at line 613 of file qgscircularstring.cpp.
|
overridevirtual |
Checks whether this curve exactly equals another curve.
Implements QgsCurve.
Definition at line 124 of file qgscircularstring.cpp.
|
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.
Reimplemented from QgsAbstractGeometry.
Definition at line 859 of file qgscircularstring.cpp.
|
static |
Creates a circular string with a single arc representing the curve from p1 to p2 with the specified center.
If useShortestArc is true
, then the arc returned will be that corresponding to the shorter arc from p1 to p2. If it is false
, the longer arc from p1 to p2 will be used (i.e. winding the other way around the circle).
Definition at line 118 of file qgscircularstring.cpp.
|
overridevirtual |
Sets the geometry from a WKB string.
After successful read the wkb argument will be at the position where the reading has stopped.
Implements QgsAbstractGeometry.
Definition at line 438 of file qgscircularstring.cpp.
|
overridevirtual |
Sets the geometry from a WKT string.
Implements QgsAbstractGeometry.
Definition at line 483 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a unique string representing the geometry type.
Implements QgsAbstractGeometry.
Definition at line 245 of file qgscircularstring.cpp.
|
overridevirtual |
Returns true
if the geometry contains curved segments.
Reimplemented from QgsAbstractGeometry.
Definition at line 1438 of file qgscircularstring.cpp.
|
finalvirtual |
Returns the index of the first vertex matching the given point, or -1 if a matching vertex is not found.
Implements QgsCurve.
Definition at line 706 of file qgscircularstring.cpp.
|
overridevirtual |
Inserts a vertex into the geometry.
position | vertex id for position of inserted vertex |
vertex | vertex to insert |
true
if insert was successful Implements QgsAbstractGeometry.
Definition at line 1222 of file qgscircularstring.cpp.
|
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.
Implements QgsCurve.
Definition at line 1614 of file qgscircularstring.cpp.
|
overridevirtual |
Returns true
if the geometry is empty.
Reimplemented from QgsAbstractGeometry.
Definition at line 577 of file qgscircularstring.cpp.
|
overridevirtual |
Checks validity of the geometry, and returns true
if the geometry is valid.
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). |
true
if geometry is validImplements QgsAbstractGeometry.
Definition at line 582 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the planar, 2-dimensional length of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 593 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the m-coordinate of the specified node in the line string.
index | index of node, where the first node in the line is 0 |
Implements QgsCurve.
Definition at line 807 of file qgscircularstring.cpp.
|
overridevirtual |
Moves a vertex within the geometry.
position | vertex id for vertex to move |
newPos | new position of vertex |
true
if move was successful Implements QgsAbstractGeometry.
Definition at line 1253 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the number of points in the curve.
Implements QgsCurve.
Definition at line 701 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the point and vertex id of a point within the curve.
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 |
true
if node exists within the curve Implements QgsCurve.
Definition at line 1357 of file qgscircularstring.cpp.
QgsPoint QgsCircularString::pointN | ( | int | i | ) | const |
Returns the point at index i within the circular string.
Definition at line 746 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a list of points within the curve.
Implements QgsCurve.
Definition at line 992 of file qgscircularstring.cpp.
|
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 650 of file qgscircularstring.cpp.
|
overridevirtual |
Returns a reversed copy of the curve, where the direction of the curve has been flipped.
Implements QgsCurve.
Definition at line 1598 of file qgscircularstring.cpp.
|
finalvirtual |
Scrolls the curve vertices so that they start with the vertex at the given index.
Implements QgsCurve.
Definition at line 298 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the length of the segment of the geometry which begins at startVertex.
Implements QgsAbstractGeometry.
Definition at line 1581 of file qgscircularstring.cpp.
void QgsCircularString::setPoints | ( | const QgsPointSequence & | points | ) |
Sets the circular string's points.
Definition at line 1002 of file qgscircularstring.cpp.
|
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:
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).
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. |
Implements QgsAbstractGeometry.
Definition at line 637 of file qgscircularstring.cpp.
|
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.
Implements QgsCurve.
Definition at line 933 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the starting point of the curve.
Implements QgsCurve.
Definition at line 604 of file qgscircularstring.cpp.
|
overridevirtual |
Sums up the area of the curve by iterating over the vertices (shoelace formula).
Implements QgsCurve.
Definition at line 1368 of file qgscircularstring.cpp.
|
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.
Implements QgsAbstractGeometry.
Definition at line 1873 of file qgscircularstring.cpp.
|
overridevirtual |
Transforms the geometry using a coordinate transform.
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 1131 of file qgscircularstring.cpp.
|
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 1155 of file qgscircularstring.cpp.
|
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.
true
if the geometry was successfully transformed.Implements QgsAbstractGeometry.
Definition at line 815 of file qgscircularstring.cpp.
|
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.
Reimplemented from QgsAbstractGeometry.
Definition at line 905 of file qgscircularstring.cpp.
|
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.
vertex | the vertex id |
Implements QgsAbstractGeometry.
Definition at line 1524 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the length of the QByteArray returned by asWkb()
The optional flags argument specifies flags controlling WKB export behavior
Implements QgsAbstractGeometry.
Definition at line 508 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the x-coordinate of the specified node in the line string.
index | index of node, where the first node in the line is 0 |
Implements QgsCurve.
Definition at line 783 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the y-coordinate of the specified node in the line string.
index | index of node, where the first node in the line is 0 |
Implements QgsCurve.
Definition at line 791 of file qgscircularstring.cpp.
|
overridevirtual |
Returns the z-coordinate of the specified node in the line string.
index | index of node, where the first node in the line is 0 |
Implements QgsCurve.
Definition at line 799 of file qgscircularstring.cpp.