QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
Point geometry type, with support for z-dimension and m-values. More...
#include <qgspoint.h>
Public Member Functions | |
QgsPoint (const QgsPointXY &p) | |
Construct a QgsPoint from a QgsPointXY object. | |
QgsPoint (double x=std::numeric_limits< double >::quiet_NaN(), double y=std::numeric_limits< double >::quiet_NaN(), double z=std::numeric_limits< double >::quiet_NaN(), double m=std::numeric_limits< double >::quiet_NaN(), Qgis::WkbType wkbType=Qgis::WkbType::Unknown) | |
Construct a point with the provided initial coordinate values. | |
QgsPoint (Qgis::WkbType wkbType, double x=std::numeric_limits< double >::quiet_NaN(), double y=std::numeric_limits< double >::quiet_NaN(), double z=std::numeric_limits< double >::quiet_NaN(), double m=std::numeric_limits< double >::quiet_NaN()) | |
Create a new point with the given wkbtype and values. | |
QgsPoint (QPointF p) | |
Construct a QgsPoint from a QPointF. | |
bool | addMValue (double mValue=0) override |
Adds a measure to the geometry, initialized to a preset value. | |
bool | addZValue (double zValue=0) override |
Adds a z-dimension to the geometry, initialized to a preset value. | |
void | adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override |
Returns the vertices adjacent to a specified vertex within a geometry. | |
QDomElement | asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML2 representation of the geometry. | |
QDomElement | asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override |
Returns a GML3 representation of the geometry. | |
json | asJsonObject (int precision=17) const override |
Returns a json object representation of the geometry. | |
QString | asKml (int precision=17) const override |
Returns a KML representation of the geometry. | |
QPainterPath | asQPainterPath () const override |
Returns the geometry represented as a QPainterPath. | |
QByteArray | asWkb (QgsAbstractGeometry::WkbFlags=QgsAbstractGeometry::WkbFlags()) const override |
QString | asWkt (int precision=17) const override |
Returns a WKT representation of the geometry. | |
double | azimuth (const QgsPoint &other) const |
Calculates Cartesian azimuth between this point and other one (clockwise in degree, starting from north) | |
QgsAbstractGeometry * | boundary () const override |
Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). | |
QgsBox3D | boundingBox3D () const override |
Returns the 3D bounding box for the geometry. | |
bool | boundingBoxIntersects (const QgsBox3D &box3d) const override |
Returns true if the bounding box of this geometry intersects with a box3d. | |
bool | boundingBoxIntersects (const QgsRectangle &rectangle) const override |
Returns true if the bounding box of this geometry intersects with a rectangle. | |
void | clear () override |
Clears the geometry, ie reset it to a null geometry. | |
QgsPoint * | clone () const override |
Clones the geometry by performing a deep copy. | |
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. | |
bool | convertTo (Qgis::WkbType type) override |
Converts the geometry to a specified type. | |
QgsCoordinateSequence | coordinateSequence () const override |
Retrieves the sequence of geometries, rings and nodes. | |
QgsPoint * | createEmptyWithSameType () const override |
Creates a new geometry with the same class and same WKB type as the original and transfers ownership. | |
bool | deleteVertex (QgsVertexId position) override |
Deletes a vertex within the geometry. | |
int | dimension () const override |
Returns the inherent dimension of the geometry. | |
double | distance (const QgsPoint &other) const |
Returns the Cartesian 2D distance between this point and another point. | |
double | distance (double x, double y) const |
Returns the Cartesian 2D distance between this point and a specified x, y coordinate. | |
double | distance3D (const QgsPoint &other) const |
Returns the Cartesian 3D distance between this point and another point. | |
double | distance3D (double x, double y, double z) const |
Returns the Cartesian 3D distance between this point and a specified x, y, z coordinate. | |
double | distanceSquared (const QgsPoint &other) const |
Returns the Cartesian 2D squared distance between this point another point. | |
double | distanceSquared (double x, double y) const |
Returns the Cartesian 2D squared distance between this point a specified x, y coordinate. | |
double | distanceSquared3D (const QgsPoint &other) const |
Returns the Cartesian 3D squared distance between this point and another point. | |
double | distanceSquared3D (double x, double y, double z) const |
Returns the Cartesian 3D squared distance between this point and a specified x, y, z coordinate. | |
void | draw (QPainter &p) const override |
Draws the geometry using the specified QPainter. | |
bool | dropMValue () override |
Drops any measure values which exist in the geometry. | |
bool | dropZValue () override |
Drops any z-dimensions which exist in the geometry. | |
void | filterVertices (const std::function< bool(const QgsPoint &) > &filter) override |
Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. | |
bool | fromWkb (QgsConstWkbPtr &wkb) override |
Sets the geometry from a WKB string. | |
bool | fromWkt (const QString &wkt) override |
Sets the geometry from a WKT string. | |
bool | fuzzyDistanceEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const override |
Performs fuzzy distance comparison between this geometry and other using an epsilon. | |
bool | fuzzyEqual (const QgsAbstractGeometry &other, double epsilon=1e-8) const override |
Performs fuzzy comparison between this geometry and other using an epsilon. | |
QString | geometryType () const override |
Returns a unique string representing the geometry type. | |
double | inclination (const QgsPoint &other) const |
Calculates Cartesian inclination between this point and other one (starting from zenith = 0 to nadir = 180. | |
bool | insertVertex (QgsVertexId position, const QgsPoint &vertex) override |
Inserts a vertex into the geometry. | |
bool | isEmpty () const override |
Returns true if the geometry is empty. | |
bool | isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override |
Checks validity of the geometry, and returns true if the geometry is valid. | |
double | m () const |
Returns the point's m value. | |
bool | moveVertex (QgsVertexId position, const QgsPoint &newPos) override |
Moves a vertex within the geometry. | |
int | nCoordinates () const override |
Returns the number of nodes contained in the geometry. | |
bool | nextVertex (QgsVertexId &id, QgsPoint &vertex) const override |
Returns next vertex id and coordinates. | |
void | normalize () final |
Reorganizes the geometry into a normalized form (or "canonical" form). | |
bool | operator!= (const QgsAbstractGeometry &other) const override |
QgsPoint | operator+ (QgsVector v) const |
Adds a vector to this point. | |
QgsPoint & | operator+= (QgsVector v) |
Adds a vector to this point in place. | |
QgsVector | operator- (const QgsPoint &p) const |
Calculates the vector obtained by subtracting a point from this point. | |
QgsPoint | operator- (QgsVector v) const |
Subtracts a vector from this point. | |
QgsPoint & | operator-= (QgsVector v) |
Subtracts a vector from this point in place. | |
bool | operator== (const QgsAbstractGeometry &other) const override |
int | partCount () const override |
Returns count of parts contained in the geometry. | |
QgsPoint | project (double distance, double azimuth, double inclination=90.0) const |
Returns a new point which corresponds to this point projected by a specified distance with specified angles (azimuth and inclination), using Cartesian mathematics. | |
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. | |
int | ringCount (int=0) const override |
Returns the number of rings of which this geometry is built. | |
double & | rm () |
Returns a reference to the m value of this point. | |
double & | rx () |
Returns a reference to the x-coordinate of this point. | |
double & | ry () |
Returns a reference to the y-coordinate of this point. | |
double & | rz () |
Returns a reference to the z-coordinate of this point. | |
double | segmentLength (QgsVertexId startVertex) const override |
Returns the length of the segment of the geometry which begins at startVertex. | |
void | setM (double m) |
Sets the point's m-value. | |
void | setX (double x) |
Sets the point's x-coordinate. | |
void | setY (double y) |
Sets the point's y-coordinate. | |
void | setZ (double z) |
Sets the point's z-coordinate. | |
QgsPoint * | 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. | |
void | swapXy () override |
Swaps the x and y coordinates from the geometry. | |
QgsPoint * | toCurveType () const override |
Returns the geometry converted to the more generic curve type. | |
QPointF | toQPointF () const |
Returns the point as a QPointF. | |
void | transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) override |
Transforms the geometry using a coordinate transform. | |
void | transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0) override |
Transforms the x and y components of the geometry using a QTransform object t. | |
bool | transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override |
Transforms the vertices from the geometry in place, using the specified geometry transformer object. | |
void | transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) override |
Transforms the vertices from the geometry in place, applying the transform function to every vertex. | |
double | vertexAngle (QgsVertexId vertex) const override |
Angle undefined. | |
QgsPoint | vertexAt (QgsVertexId) const override |
Returns the point corresponding to a specified vertex id. | |
int | vertexCount (int=0, int=0) const override |
Returns the number of vertices of which this geometry is built. | |
int | vertexNumberFromVertexId (QgsVertexId id) const override |
Returns the vertex number corresponding to a vertex id. | |
int | wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override |
Returns the length of the QByteArray returned by asWkb() | |
double | x () const |
Returns the point's x-coordinate. | |
double | y () const |
Returns the point's y-coordinate. | |
double | z () const |
Returns the point's z-coordinate. | |
![]() | |
QgsAbstractGeometry ()=default | |
Constructor for QgsAbstractGeometry. | |
QgsAbstractGeometry (const QgsAbstractGeometry &geom) | |
virtual | ~QgsAbstractGeometry ()=default |
virtual double | area () const |
Returns the planar, 2-dimensional area of the geometry. | |
QString | asJson (int precision=17) |
Returns a GeoJSON representation of the geometry as a QString. | |
virtual QByteArray | asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0 |
Returns a WKB representation of the geometry. | |
virtual QgsRectangle | boundingBox () const |
Returns the minimal bounding box for the geometry. | |
virtual QgsPoint | centroid () const |
Returns the centroid of the geometry. | |
virtual int | compareTo (const QgsAbstractGeometry *other) const |
Comparator for sorting of geometry. | |
const_part_iterator | const_parts_begin () const |
Returns STL-style iterator pointing to the const first part of the geometry. | |
const_part_iterator | const_parts_end () const |
Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. | |
virtual bool | hasCurvedSegments () const |
Returns true if the geometry contains curved segments. | |
bool | is3D () const |
Returns true if the geometry is 3D and contains a z-value. | |
bool | isMeasure () const |
Returns true if the geometry contains m values. | |
virtual double | length () const |
Returns the planar, 2-dimensional length of the geometry. | |
QgsAbstractGeometry & | operator= (const QgsAbstractGeometry &geom) |
QgsGeometryPartIterator | parts () |
Returns Java-style iterator for traversal of parts of the geometry. | |
QgsGeometryConstPartIterator | parts () const |
Returns Java-style iterator for traversal of parts of the geometry. | |
part_iterator | parts_begin () |
Returns STL-style iterator pointing to the first part of the geometry. | |
part_iterator | parts_end () |
Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. | |
virtual double | perimeter () const |
Returns the planar, 2-dimensional perimeter of the geometry. | |
virtual QgsAbstractGeometry * | segmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const |
Returns a version of the geometry without curves. | |
virtual const QgsAbstractGeometry * | simplifiedTypeRef () const |
Returns a reference to the simplest lossless representation of this geometry, e.g. | |
QgsVertexIterator | vertices () const |
Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. | |
vertex_iterator | vertices_begin () const |
Returns STL-style iterator pointing to the first vertex of the geometry. | |
vertex_iterator | vertices_end () const |
Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. | |
Qgis::WkbType | wkbType () const |
Returns the WKB type of the geometry. | |
QString | wktTypeStr () const |
Returns the WKT type string of the geometry. | |
Static Public Member Functions | |
static const QgsPoint * | cast (const QgsAbstractGeometry *geom) |
Cast the geom to a QgsPoint. | |
Protected Member Functions | |
int | childCount () const override |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. | |
QgsPoint | childPoint (int index) const override |
Returns point at index (for geometries without child geometries - i.e. | |
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. | |
![]() | |
virtual QgsRectangle | calculateBoundingBox () const |
Default calculator for the minimal bounding box for the geometry. | |
virtual QgsBox3D | calculateBoundingBox3D () const |
Calculates the minimal 3D bounding box for the geometry. | |
virtual QgsAbstractGeometry * | childGeometry (int index) const |
Returns pointer to child geometry (for geometries with child geometries - i.e. | |
virtual void | clearCache () const |
Clears any cached parameters associated with the geometry, e.g., bounding boxes. | |
virtual bool | hasChildGeometries () const |
Returns whether the geometry has any child geometries (false for point / curve, true otherwise) | |
void | setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, Qgis::WkbType baseGeomType) |
Updates the geometry type based on whether sub geometries contain z or m values. | |
int | sortIndex () const |
Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. | |
Properties | |
double | m |
double | x |
double | y |
double | z |
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... | |
![]() | |
Qgis::WkbType | mWkbType = Qgis::WkbType::Unknown |
Point geometry type, with support for z-dimension and m-values.
A QgsPoint represents a 2, 3 or 4-dimensional position, with X and Y and optional Z or M coordinates. Since it supports these additional dimensions, QgsPoint is used as the low-level storage of geometry coordinates throughout QGIS.
In some scenarios it is preferable to use the QgsPointXY class instead, which is lighter and has smaller memory requirements compared to QgsPoint. See the QgsPointXY documentation for examples of situations where it is appropriate to use QgsPointXY instead of QgsPoint.
Definition at line 48 of file qgspoint.h.
QgsPoint::QgsPoint | ( | double | x = std::numeric_limits<double>::quiet_NaN() , |
double | y = std::numeric_limits<double>::quiet_NaN() , |
||
double | z = std::numeric_limits<double>::quiet_NaN() , |
||
double | m = std::numeric_limits<double>::quiet_NaN() , |
||
Qgis::WkbType | wkbType = Qgis::WkbType::Unknown |
||
) |
Construct a point with the provided initial coordinate values.
If wkbType is set to Qgis::WkbType::Point
, Qgis::WkbType::PointZ
, Qgis::WkbType::PointM
or Qgis::WkbType::PointZM
the type will be set accordingly. If it is left to the default Qgis::WkbType::Unknown
, the type will be set based on the following rules:
Definition at line 42 of file qgspoint.cpp.
|
explicit |
Construct a QgsPoint from a QgsPointXY object.
Definition at line 66 of file qgspoint.cpp.
|
explicit |
Construct a QgsPoint from a QPointF.
Definition at line 80 of file qgspoint.cpp.
|
explicit |
Create a new point with the given wkbtype and values.
Definition at line 89 of file qgspoint.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 564 of file qgspoint.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 553 of file qgspoint.cpp.
|
overridevirtual |
Returns the vertices adjacent to a specified vertex within a geometry.
Implements QgsAbstractGeometry.
Definition at line 495 of file qgspoint.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 280 of file qgspoint.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 303 of file qgspoint.cpp.
|
overridevirtual |
Returns a json object representation of the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 322 of file qgspoint.cpp.
|
overridevirtual |
Returns a KML representation of the geometry.
Implements QgsAbstractGeometry.
Definition at line 341 of file qgspoint.cpp.
|
overridevirtual |
Returns the geometry represented as a QPainterPath.
Implements QgsAbstractGeometry.
Definition at line 351 of file qgspoint.cpp.
|
override |
Definition at line 242 of file qgspoint.cpp.
|
overridevirtual |
Returns a WKT representation of the geometry.
precision | number of decimal places for coordinates |
Implements QgsAbstractGeometry.
Definition at line 261 of file qgspoint.cpp.
double QgsPoint::azimuth | ( | const QgsPoint & | other | ) | const |
Calculates Cartesian azimuth between this point and other one (clockwise in degree, starting from north)
Definition at line 682 of file qgspoint.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. Implements QgsAbstractGeometry.
Definition at line 416 of file qgspoint.cpp.
|
overridevirtual |
Returns the 3D bounding box for the geometry.
Implements QgsAbstractGeometry.
Definition at line 738 of file qgspoint.cpp.
|
overridevirtual |
Returns true
if the bounding box of this geometry intersects with a box3d.
Since this test only considers the bounding box of the geometry, is is very fast to calculate and handles invalid geometries.
Reimplemented from QgsAbstractGeometry.
Definition at line 542 of file qgspoint.cpp.
|
overridevirtual |
Returns true
if the bounding box of this geometry intersects with a rectangle.
Since this test only considers the bounding box of the geometry, is is very fast to calculate and handles invalid geometries.
Reimplemented from QgsAbstractGeometry.
Definition at line 537 of file qgspoint.cpp.
|
inlinestatic |
Cast the geom to a QgsPoint.
Should be used by qgsgeometry_cast<QgsPoint *>( geometry ).
Definition at line 632 of file qgspoint.h.
|
overrideprotectedvirtual |
Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.
curve / point)
Reimplemented from QgsAbstractGeometry.
Definition at line 753 of file qgspoint.cpp.
|
overrideprotectedvirtual |
Returns point at index (for geometries without child geometries - i.e.
curve / point)
Reimplemented from QgsAbstractGeometry.
Definition at line 758 of file qgspoint.cpp.
|
overridevirtual |
Clears the geometry, ie reset it to a null geometry.
Implements QgsAbstractGeometry.
Definition at line 356 of file qgspoint.cpp.
|
overridevirtual |
Clones the geometry by performing a deep copy.
Implements QgsAbstractGeometry.
Definition at line 105 of file qgspoint.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 462 of file qgspoint.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 770 of file qgspoint.cpp.
|
overridevirtual |
Converts the geometry to a specified type.
true
if conversion was successful Reimplemented from QgsAbstractGeometry.
Definition at line 622 of file qgspoint.cpp.
|
overridevirtual |
Retrieves the sequence of geometries, rings and nodes.
Implements QgsAbstractGeometry.
Definition at line 393 of file qgspoint.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 764 of file qgspoint.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 456 of file qgspoint.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 748 of file qgspoint.cpp.
|
inline |
Returns the Cartesian 2D distance between this point and another point.
In certain cases it may be more appropriate to call the faster distanceSquared() method, e.g., when comparing distances.
Definition at line 404 of file qgspoint.h.
|
inline |
Returns the Cartesian 2D distance between this point and a specified x, y coordinate.
In certain cases it may be more appropriate to call the faster distanceSquared() method, e.g., when comparing distances.
Definition at line 393 of file qgspoint.h.
|
inline |
Returns the Cartesian 3D distance between this point and another point.
In certain cases it may be more appropriate to call the faster distanceSquared3D() method, e.g., when comparing distances.
Definition at line 452 of file qgspoint.h.
|
inline |
Returns the Cartesian 3D distance between this point and a specified x, y, z coordinate.
In certain cases it may be more appropriate to call the faster distanceSquared3D() method, e.g., when comparing distances.
Definition at line 437 of file qgspoint.h.
|
inline |
Returns the Cartesian 2D squared distance between this point another point.
Calling this is faster than calling distance(), and may be useful in use cases such as comparing distances where the extra expense of calling distance() is not required.
Definition at line 426 of file qgspoint.h.
|
inline |
Returns the Cartesian 2D squared distance between this point a specified x, y coordinate.
Calling this is faster than calling distance(), and may be useful in use cases such as comparing distances where the extra expense of calling distance() is not required.
Definition at line 415 of file qgspoint.h.
|
inline |
Returns the Cartesian 3D squared distance between this point and another point.
Calling this is faster than calling distance3D(), and may be useful in use cases such as comparing distances where the extra expense of calling distance3D() is not required.
Definition at line 482 of file qgspoint.h.
|
inline |
Returns the Cartesian 3D squared distance between this point and a specified x, y, z coordinate.
Calling this is faster than calling distance3D(), and may be useful in use cases such as comparing distances where the extra expense of calling distance3D() is not required.
Definition at line 467 of file qgspoint.h.
|
overridevirtual |
Draws the geometry using the specified QPainter.
p | destination QPainter |
Implements QgsAbstractGeometry.
Definition at line 346 of file qgspoint.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 605 of file qgspoint.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 594 of file qgspoint.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 665 of file qgspoint.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 136 of file qgspoint.cpp.
|
overridevirtual |
Sets the geometry from a WKT string.
Implements QgsAbstractGeometry.
Definition at line 164 of file qgspoint.cpp.
|
inlineoverridevirtual |
Performs fuzzy distance comparison between this geometry and other using an epsilon.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry. It focuses on the numerical differences or relationships between these values. On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values. This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).
Implements QgsAbstractGeometry.
Definition at line 224 of file qgspoint.h.
|
inlineoverridevirtual |
Performs fuzzy comparison between this geometry and other using an epsilon.
The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
Implements QgsAbstractGeometry.
Definition at line 195 of file qgspoint.h.
|
overridevirtual |
Returns a unique string representing the geometry type.
Implements QgsAbstractGeometry.
Definition at line 743 of file qgspoint.cpp.
double QgsPoint::inclination | ( | const QgsPoint & | other | ) | const |
Calculates Cartesian inclination between this point and other one (starting from zenith = 0 to nadir = 180.
Horizon = 90) Returns 90.0 if the distance between this point and other one is equal to 0 (same point).
Definition at line 689 of file qgspoint.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 426 of file qgspoint.cpp.
|
overridevirtual |
Returns true
if the geometry is empty.
Reimplemented from QgsAbstractGeometry.
Definition at line 733 of file qgspoint.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 421 of file qgspoint.cpp.
|
inline |
|
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 439 of file qgspoint.cpp.
|
overridevirtual |
Returns the number of nodes contained in the geometry.
Reimplemented from QgsAbstractGeometry.
Definition at line 403 of file qgspoint.cpp.
|
overridevirtual |
Returns next vertex id and coordinates.
id | initial value should be the starting vertex id. The next vertex id will be stored in this variable if found. |
vertex | container for found node |
false
if at end Implements QgsAbstractGeometry.
Definition at line 473 of file qgspoint.cpp.
|
finalvirtual |
Reorganizes the geometry into a normalized form (or "canonical" form).
Polygon rings will be rearranged so that their starting vertex is the lower left and ring orientation follows the right hand rule, collections are ordered by geometry type, and other normalization techniques are applied. The resultant geometry will be geometrically equivalent to the original geometry.
Implements QgsAbstractGeometry.
Definition at line 728 of file qgspoint.cpp.
|
inlineoverridevirtual |
Implements QgsAbstractGeometry.
Definition at line 258 of file qgspoint.h.
Adds a vector to this point.
Definition at line 551 of file qgspoint.h.
Adds a vector to this point in place.
Definition at line 541 of file qgspoint.h.
Calculates the vector obtained by subtracting a point from this point.
Definition at line 536 of file qgspoint.h.
Subtracts a vector from this point.
Definition at line 556 of file qgspoint.h.
Subtracts a vector from this point in place.
Definition at line 546 of file qgspoint.h.
|
inlineoverridevirtual |
Implements QgsAbstractGeometry.
Definition at line 253 of file qgspoint.h.
|
overridevirtual |
Returns count of parts contained in the geometry.
Implements QgsAbstractGeometry.
Definition at line 517 of file qgspoint.cpp.
QgsPoint QgsPoint::project | ( | double | distance, |
double | azimuth, | ||
double | inclination = 90.0 |
||
) | const |
Returns a new point which corresponds to this point projected by a specified distance with specified angles (azimuth and inclination), using Cartesian mathematics.
M value is preserved.
distance | distance to project |
azimuth | angle to project in X Y, clockwise in degrees starting from north |
inclination | angle to project in Z (3D). If the point is 2D, the Z value is assumed to be 0. |
Definition at line 701 of file qgspoint.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 131 of file qgspoint.cpp.
|
overridevirtual |
Returns the number of rings of which this geometry is built.
Implements QgsAbstractGeometry.
Definition at line 512 of file qgspoint.cpp.
|
inline |
Returns a reference to the m value of this point.
Using a reference makes it possible to directly manipulate m in place.
Definition at line 325 of file qgspoint.h.
|
inline |
Returns a reference to the x-coordinate of this point.
Using a reference makes it possible to directly manipulate x in place.
Definition at line 298 of file qgspoint.h.
|
inline |
Returns a reference to the y-coordinate of this point.
Using a reference makes it possible to directly manipulate y in place.
Definition at line 307 of file qgspoint.h.
|
inline |
Returns a reference to the z-coordinate of this point.
Using a reference makes it possible to directly manipulate z in place.
Definition at line 316 of file qgspoint.h.
|
overridevirtual |
Returns the length of the segment of the geometry which begins at startVertex.
Implements QgsAbstractGeometry.
Definition at line 532 of file qgspoint.cpp.
|
inline |
Sets the point's m-value.
Definition at line 371 of file qgspoint.h.
|
inline |
|
inline |
|
inline |
Sets the point's z-coordinate.
Definition at line 356 of file qgspoint.h.
|
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 110 of file qgspoint.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 616 of file qgspoint.cpp.
|
overridevirtual |
Returns the geometry converted to the more generic curve type.
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface
Implements QgsAbstractGeometry.
Definition at line 527 of file qgspoint.cpp.
|
inline |
Returns the point as a QPointF.
Definition at line 382 of file qgspoint.h.
|
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 379 of file qgspoint.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 575 of file qgspoint.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 655 of file qgspoint.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 670 of file qgspoint.cpp.
|
overridevirtual |
Angle undefined.
Always returns 0.0
vertex | the vertex id |
Implements QgsAbstractGeometry.
Definition at line 501 of file qgspoint.cpp.
|
overridevirtual |
Returns the point corresponding to a specified vertex id.
Implements QgsAbstractGeometry.
Definition at line 522 of file qgspoint.cpp.
|
overridevirtual |
Returns the number of vertices of which this geometry is built.
Implements QgsAbstractGeometry.
Definition at line 507 of file qgspoint.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.
Implements QgsAbstractGeometry.
Definition at line 408 of file qgspoint.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 235 of file qgspoint.cpp.
|
inline |
|
inline |
|
inline |
|
readwrite |
Definition at line 55 of file qgspoint.h.
|
readwrite |
Definition at line 52 of file qgspoint.h.
|
readwrite |
Definition at line 53 of file qgspoint.h.
|
readwrite |
Definition at line 54 of file qgspoint.h.