QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
Multi point geometry collection. More...
#include <qgsmultipoint.h>
Public Member Functions | |
QgsMultiPoint () SIP_HOLDGIL | |
Constructor for an empty multipoint geometry. More... | |
bool | addGeometry (QgsAbstractGeometry *g) override |
Adds a geometry and takes ownership. Returns true in case of success. 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... | |
QgsAbstractGeometry * | boundary () const override |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More... | |
void | clear () override |
Clears the geometry, ie reset it to a null geometry. More... | |
QgsMultiPoint * | clone () const override |
Clones the geometry by performing a deep copy. More... | |
QgsMultiPoint * | createEmptyWithSameType () const override |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. 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 | 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 | insertGeometry (QgsAbstractGeometry *g, int index) override |
Inserts a geometry before a specified index and takes ownership. More... | |
bool | isValid (QString &error, int flags=0) const override SIP_HOLDGIL |
Checks validity of the geometry, and returns true if the geometry is valid. More... | |
int | nCoordinates () const override SIP_HOLDGIL |
Returns the number of nodes contained in the geometry. More... | |
QgsPoint * | pointN (int index) |
Returns the point with the specified index. More... | |
const QgsPoint * | pointN (int index) const |
Returns the point with the specified index. More... | |
double | segmentLength (QgsVertexId startVertex) const override |
Returns the length of the segment of the geometry which begins at startVertex. More... | |
QgsMultiPoint * | toCurveType () const override |
Returns the geometry converted to the more generic curve type. More... | |
int | vertexNumberFromVertexId (QgsVertexId id) const override |
Returns the vertex number corresponding to a vertex id. More... | |
![]() | |
QgsGeometryCollection () SIP_HOLDGIL | |
Constructor for an empty geometry collection. More... | |
QgsGeometryCollection (const QgsGeometryCollection &c) | |
~QgsGeometryCollection () override | |
bool | addMValue (double mValue=0) override |
Adds a measure to the geometry, initialized to a preset value. More... | |
bool | addZValue (double zValue=0) override |
Adds a z-dimension to the geometry, initialized to a preset value. More... | |
void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override |
Returns the vertices adjacent to a specified vertex within a geometry. More... | |
double | area () const override SIP_HOLDGIL |
Returns the planar, 2-dimensional area of the 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... | |
QByteArray | asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
QString | asWkt (int precision=17) const override |
Returns a WKT representation of the geometry. More... | |
QgsRectangle | boundingBox () const override |
Returns the minimal bounding box for the geometry. 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... | |
QgsCoordinateSequence | coordinateSequence () const override |
Retrieves the sequence of geometries, rings and nodes. 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... | |
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... | |
bool | fromWkb (QgsConstWkbPtr &wkb) override |
Sets the geometry from a WKB string. More... | |
const QgsAbstractGeometry * | geometryN (int n) const |
Returns a const reference to a geometry from within the collection. More... | |
QgsAbstractGeometry * | geometryN (int n) SIP_HOLDGIL |
Returns a geometry from within the collection. More... | |
bool | hasCurvedSegments () const override SIP_HOLDGIL |
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 SIP_HOLDGIL |
Returns true if the geometry is empty. More... | |
double | length () const override SIP_HOLDGIL |
Returns the planar, 2-dimensional length of the geometry. More... | |
bool | moveVertex (QgsVertexId position, const QgsPoint &newPos) override |
Moves a vertex within the geometry. More... | |
bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const override |
Returns next vertex id and coordinates. More... | |
int | numGeometries () const SIP_HOLDGIL |
Returns the number of geometries within the collection. More... | |
bool | operator!= (const QgsAbstractGeometry &other) const override |
QgsGeometryCollection & | operator= (const QgsGeometryCollection &c) |
bool | operator== (const QgsAbstractGeometry &other) const override |
int | partCount () const override |
Returns count of parts contained in the geometry. More... | |
double | perimeter () const override SIP_HOLDGIL |
Returns the planar, 2-dimensional perimeter of 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... | |
virtual bool | removeGeometry (int nr) |
Removes a geometry from the collection. More... | |
void | reserve (int size) SIP_HOLDGIL |
Attempts to allocate memory for at least size geometries. More... | |
int | ringCount (int part=0) const override |
Returns the number of rings of which this geometry is built. More... | |
QgsAbstractGeometry * | segmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override |
Returns a geometry without curves. More... | |
QgsGeometryCollection * | 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... | |
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... | |
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... | |
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 | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
Returns the length of the QByteArray returned by asWkb() More... | |
![]() | |
QgsAbstractGeometry ()=default | |
Constructor for QgsAbstractGeometry. More... | |
QgsAbstractGeometry (const QgsAbstractGeometry &geom) | |
virtual | ~QgsAbstractGeometry ()=default |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. More... | |
virtual QByteArray | asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns a WKB representation of the geometry. More... | |
virtual QgsPoint | centroid () const |
Returns the centroid of the 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 (QgsWkbTypes::Type type) |
Converts the geometry to a specified type. More... | |
bool | is3D () const SIP_HOLDGIL |
Returns true if the geometry is 3D and contains a z-value. More... | |
bool | isMeasure () const SIP_HOLDGIL |
Returns true if the geometry contains m values. More... | |
QgsAbstractGeometry & | operator= (const QgsAbstractGeometry &geom) |
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... | |
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... | |
QgsWkbTypes::Type | 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 QgsMultiPoint * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsLineString. More... | |
![]() | |
static const QgsGeometryCollection * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsGeometryCollection. More... | |
Protected Member Functions | |
bool | wktOmitChildType () const override |
Returns whether child type names are omitted from Wkt representations of the collection. More... | |
![]() | |
QgsRectangle | calculateBoundingBox () const override |
Default calculator for the minimal bounding box for the geometry. 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... | |
QgsAbstractGeometry * | childGeometry (int index) const override |
Returns pointer to child geometry (for geometries with child geometries - i.e. More... | |
void | clearCache () const override |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. More... | |
bool | fromCollectionWkt (const QString &wkt, const QVector< QgsAbstractGeometry * > &subtypes, const QString &defaultChildWkbType=QString()) |
Reads a collection from a WKT string. More... | |
![]() | |
virtual QgsPoint | childPoint (int index) const |
Returns point at index (for geometries without 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 | |
![]() | |
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 } |
WKB export flags. More... | |
![]() | |
QVector< QgsAbstractGeometry * > | mGeometries |
![]() | |
QgsWkbTypes::Type | mWkbType = QgsWkbTypes::Unknown |
QgsMultiPoint::QgsMultiPoint | ( | ) |
Constructor for an empty multipoint geometry.
Definition at line 27 of file qgsmultipoint.cpp.
|
overridevirtual |
Adds a geometry and takes ownership. Returns true
in case of success.
Reimplemented from QgsGeometryCollection.
Definition at line 149 of file qgsmultipoint.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 |
Reimplemented from QgsGeometryCollection.
Definition at line 85 of file qgsmultipoint.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 |
Reimplemented from QgsGeometryCollection.
Definition at line 105 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns a json object representation of the geometry.
Reimplemented from QgsGeometryCollection.
Definition at line 125 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
nullptr
for some geometry types. Reimplemented from QgsGeometryCollection.
Definition at line 183 of file qgsmultipoint.cpp.
|
inlinestatic |
Cast the geom to a QgsLineString.
Should be used by qgsgeometry_cast<QgsLineString *>( geometry ).
Definition at line 107 of file qgsmultipoint.h.
|
overridevirtual |
Clears the geometry, ie reset it to a null geometry.
Reimplemented from QgsGeometryCollection.
Definition at line 79 of file qgsmultipoint.cpp.
|
overridevirtual |
Clones the geometry by performing a deep copy.
Reimplemented from QgsGeometryCollection.
Definition at line 54 of file qgsmultipoint.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.
Reimplemented from QgsGeometryCollection.
Definition at line 47 of file qgsmultipoint.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 QgsGeometryCollection.
Definition at line 206 of file qgsmultipoint.cpp.
|
overridevirtual |
Sets the geometry from a WKT string.
Reimplemented from QgsGeometryCollection.
Definition at line 64 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns a unique string representing the geometry type.
Reimplemented from QgsGeometryCollection.
Definition at line 42 of file qgsmultipoint.cpp.
|
overridevirtual |
Inserts a geometry before a specified index and takes ownership.
Returns true
in case of success.
g | geometry to insert. Ownership is transferred to the collection. |
index | position to insert geometry before |
Reimplemented from QgsGeometryCollection.
Definition at line 172 of file qgsmultipoint.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 QgsGeometry::ValidityFlags). |
true
if geometry is validReimplemented from QgsGeometryCollection.
Definition at line 201 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns the number of nodes contained in the geometry.
Reimplemented from QgsGeometryCollection.
Definition at line 144 of file qgsmultipoint.cpp.
QgsPoint * QgsMultiPoint::pointN | ( | int | index | ) |
Returns the point with the specified index.
Definition at line 32 of file qgsmultipoint.cpp.
const QgsPoint * QgsMultiPoint::pointN | ( | int | index | ) | const |
Returns the point with the specified index.
Definition at line 37 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns the length of the segment of the geometry which begins at startVertex.
Reimplemented from QgsGeometryCollection.
Definition at line 196 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns the geometry converted to the more generic curve type.
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface
Reimplemented from QgsGeometryCollection.
Definition at line 59 of file qgsmultipoint.cpp.
|
overridevirtual |
Returns the vertex number corresponding to a vertex id.
The vertex numbers start at 0, so a return value of 0 corresponds to the first vertex.
Returns -1 if a corresponding vertex could not be found.
Reimplemented from QgsGeometryCollection.
Definition at line 188 of file qgsmultipoint.cpp.
|
overrideprotectedvirtual |
Returns whether child type names are omitted from Wkt representations of the collection.
Reimplemented from QgsGeometryCollection.
Definition at line 231 of file qgsmultipoint.cpp.