QGIS API Documentation  3.3.0-Master (1bf63f1)
Public Member Functions | Protected Member Functions | Properties | List of all members
QgsPoint Class Reference

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

#include <qgspoint.h>

Inheritance diagram for QgsPoint:
Inheritance graph
[legend]

Public Member Functions

 QgsPoint (double x=0.0, double y=0.0, double z=std::numeric_limits< double >::quiet_NaN(), double m=std::numeric_limits< double >::quiet_NaN(), QgsWkbTypes::Type wkbType=QgsWkbTypes::Unknown)
 Construct a point with the provided initial coordinate values. More...
 
 QgsPoint (const QgsPointXY &p)
 Construct a QgsPoint from a QgsPointXY object. More...
 
 QgsPoint (QPointF p)
 Construct a QgsPoint from a QPointF. More...
 
 QgsPoint (QgsWkbTypes::Type wkbType, double x=0.0, double y=0.0, 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. More...
 
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...
 
QDomElement asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML2 representation of the geometry. More...
 
QDomElement asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML3 representation of the geometry. More...
 
QString asJson (int precision=17) const override
 Returns a GeoJSON representation of the geometry. More...
 
QByteArray asWkb () const override
 Returns a WKB representation of the geometry. More...
 
QString asWkt (int precision=17) const override
 Returns a WKT representation of the geometry. More...
 
double azimuth (const QgsPoint &other) const
 Calculates azimuth between this point and other one (clockwise in degree, starting from north) More...
 
QgsAbstractGeometryboundary () const override
 Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More...
 
QgsRectangle boundingBox () const override
 Returns the minimal bounding box for the geometry. More...
 
const QgsPointcast (const QgsAbstractGeometry *geom) const
 Cast the geom to a QgsPoint. More...
 
void clear () override
 Clears the geometry, ie reset it to a null geometry. More...
 
QgsPointclone () 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...
 
bool convertTo (QgsWkbTypes::Type type) override
 Converts the geometry to a specified type. More...
 
QgsCoordinateSequence coordinateSequence () const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
QgsPointcreateEmptyWithSameType () const override
 Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More...
 
bool deleteVertex (QgsVertexId position) override
 Deletes a vertex within the geometry. More...
 
int dimension () const override
 Returns the inherent dimension of the geometry. More...
 
double distance (double x, double y) const
 Returns the distance between this point and a specified x, y coordinate. More...
 
double distance (const QgsPoint &other) const
 Returns the 2D distance between this point and another point. More...
 
double distance3D (double x, double y, double z) const
 Returns the 3D distance between this point and a specified x, y, z coordinate. More...
 
double distance3D (const QgsPoint &other) const
 Returns the 3D distance between this point and another point. More...
 
double distanceSquared (double x, double y) const
 Returns the squared distance between this point a specified x, y coordinate. More...
 
double distanceSquared (const QgsPoint &other) const
 Returns the squared distance between this point another point. More...
 
double distanceSquared3D (double x, double y, double z) const
 Returns the 3D squared distance between this point a specified x, y, z coordinate. More...
 
double distanceSquared3D (const QgsPoint &other) const
 Returns the 3D squared distance between this point another point. 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...
 
void filterVertices (const std::function< bool(const QgsPoint &) > &filter) override
 Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. More...
 
bool fromWkb (QgsConstWkbPtr &wkb) override
 Sets the geometry from a WKB string. More...
 
bool fromWkt (const QString &wkt) override
 Sets the geometry from a WKT string. More...
 
QString geometryType () const override
 Returns a unique string representing the geometry type. More...
 
double inclination (const QgsPoint &other) const
 Calculates inclination between this point and other one (starting from zenith = 0 to nadir = 180. More...
 
bool insertVertex (QgsVertexId position, const QgsPoint &vertex) override
 Inserts a vertex into the geometry. More...
 
bool isEmpty () const override
 Returns true if the geometry is empty. More...
 
double m () const
 Returns the point's m value. More...
 
bool moveVertex (QgsVertexId position, const QgsPoint &newPos) override
 Moves a vertex within the geometry. More...
 
int nCoordinates () const override
 Returns the number of nodes contained in the geometry. More...
 
bool nextVertex (QgsVertexId &id, QgsPoint &vertex) const override
 Returns next vertex id and coordinates. More...
 
bool operator!= (const QgsAbstractGeometry &other) const override
 
QgsPoint operator+ (QgsVector v) const
 Adds a vector to this point. More...
 
QgsPointoperator+= (QgsVector v)
 Adds a vector to this point in place. More...
 
QgsVector operator- (const QgsPoint &p) const
 Calculates the vector obtained by subtracting a point from this point. More...
 
QgsPoint operator- (QgsVector v) const
 Subtracts a vector from this point. More...
 
QgsPointoperator-= (QgsVector v)
 Subtracts a vector from this point in place. More...
 
bool operator== (const QgsAbstractGeometry &other) const override
 
int partCount () const override
 Returns count of parts contained in the geometry. More...
 
QgsPoint project (double distance, double azimuth, double inclination=90.0) const
 Returns a new point which correspond to this point projected by a specified distance with specified angles (azimuth and inclination). 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...
 
int ringCount (int=0) const override
 Returns the number of rings of which this geometry is built. More...
 
double & rm ()
 Returns a reference to the m value of this point. More...
 
double & rx ()
 Returns a reference to the x-coordinate of this point. More...
 
double & ry ()
 Returns a reference to the y-coordinate of this point. More...
 
double & rz ()
 Returns a reference to the z-coordinate of this point. More...
 
double segmentLength (QgsVertexId startVertex) const override
 Returns the length of the segment of the geometry which begins at startVertex. More...
 
void setM (double m)
 Sets the point's m-value. More...
 
void setX (double x)
 Sets the point's x-coordinate. More...
 
void setY (double y)
 Sets the point's y-coordinate. More...
 
void setZ (double z)
 Sets the point's z-coordinate. More...
 
QgsPointsnappedToGrid (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...
 
QgsPointtoCurveType () const override
 Returns the geometry converted to the more generic curve type. More...
 
QPointF toQPointF () const
 Returns the point as a QPointF. 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...
 
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
 Angle undefined. More...
 
QgsPoint vertexAt (QgsVertexId) const override
 Returns the point corresponding to a specified vertex id. More...
 
int vertexCount (int=0, int=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...
 
double x () const
 Returns the point's x-coordinate. More...
 
double y () const
 Returns the point's y-coordinate. More...
 
double z () const
 Returns the point's z-coordinate. More...
 
- Public Member Functions inherited from QgsAbstractGeometry
 QgsAbstractGeometry ()=default
 Constructor for QgsAbstractGeometry. More...
 
 QgsAbstractGeometry (const QgsAbstractGeometry &geom)
 
virtual ~QgsAbstractGeometry ()=default
 
virtual double area () const
 Returns the area of the geometry. More...
 
virtual QgsPoint centroid () const
 Returns the centroid of the geometry. More...
 
virtual bool hasCurvedSegments () const
 Returns true if the geometry contains curved segments. More...
 
bool is3D () const
 Returns true if the geometry is 3D and contains a z-value. More...
 
bool isMeasure () const
 Returns true if the geometry contains m values. More...
 
virtual double length () const
 Returns the length of the geometry. More...
 
QgsAbstractGeometryoperator= (const QgsAbstractGeometry &geom)
 
virtual double perimeter () const
 Returns the perimeter of the geometry. More...
 
virtual QgsAbstractGeometrysegmentize (double tolerance=M_PI/180., SegmentationToleranceType toleranceType=MaximumAngle) const
 Returns a version of the geometry without curves. More...
 
QgsVertexIterator vertices () const
 Returns Java-style iterator for traversal of vertices of the geometry. More...
 
vertex_iterator vertices_begin () const
 Returns STL-style iterator pointing to the first vertex of the geometry. More...
 
vertex_iterator vertices_end () const
 Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More...
 
QgsWkbTypes::Type wkbType () const
 Returns the WKB type of the geometry. More...
 
QString wktTypeStr () const
 Returns the WKT type string of the geometry. More...
 

Protected Member Functions

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...
 
- Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsRectangle calculateBoundingBox () const
 Default calculator for the minimal bounding box for the geometry. More...
 
virtual QgsAbstractGeometrychildGeometry (int index) const
 Returns pointer to child geometry (for geometries with child geometries - i.e. More...
 
virtual void clearCache () const
 Clears any cached parameters associated with the geometry, e.g., bounding boxes. 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...
 

Properties

double m
 
double x
 
double y
 
double z
 

Additional Inherited Members

- Public Types inherited from QgsAbstractGeometry
enum  AxisOrder { XY = 0, YX }
 Axis order for GML generation. More...
 
enum  SegmentationToleranceType { MaximumAngle = 0, MaximumDifference }
 Segmentation tolerance as maximum angle or maximum difference between approximation and circle. More...
 
- Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown
 

Detailed Description

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

Since
QGIS 3.0, (previously QgsPointv2 since QGIS 2.10)

Definition at line 37 of file qgspoint.h.

Constructor & Destructor Documentation

◆ QgsPoint() [1/4]

QgsPoint::QgsPoint ( double  x = 0.0,
double  y = 0.0,
double  z = std::numeric_limits<double>::quiet_NaN(),
double  m = std::numeric_limits<double>::quiet_NaN(),
QgsWkbTypes::Type  wkbType = QgsWkbTypes::Unknown 
)

Construct a point with the provided initial coordinate values.

If wkbType is set to QgsWkbTypes::Point, QgsWkbTypes::PointZ, QgsWkbTypes::PointM or QgsWkbTypes::PointZM the type will be set accordingly. If it is left to the default QgsWkbTypes::Unknown, the type will be set based on the following rules:

  • If only x and y are specified, the type will be a 2D point.
  • If any or both of the Z and M are specified, the appropriate type will be created.
pt = QgsPoint(43.4, 5.3)
pt.asWkt() # Point(43.4 5.3)
pt_z = QgsPoint(120, 343, 77)
pt.asWkt() # PointZ(120 343 77)
pt_m = QgsPoint(33, 88, m=5)
pt_m.m() # 5
pt_m.wkbType() # QgsWkbTypes.PointM
pt = QgsPoint(30, 40, wkbType=QgsWkbTypes.PointZ)
pt.z() # nan
pt.wkbType() # QgsWkbTypes.PointZ

Definition at line 36 of file qgspoint.cpp.

◆ QgsPoint() [2/4]

QgsPoint::QgsPoint ( const QgsPointXY p)
explicit

Construct a QgsPoint from a QgsPointXY object.

Definition at line 60 of file qgspoint.cpp.

◆ QgsPoint() [3/4]

QgsPoint::QgsPoint ( QPointF  p)
explicit

Construct a QgsPoint from a QPointF.

Definition at line 69 of file qgspoint.cpp.

◆ QgsPoint() [4/4]

QgsPoint::QgsPoint ( QgsWkbTypes::Type  wkbType,
double  x = 0.0,
double  y = 0.0,
double  z = std::numeric_limits<double>::quiet_NaN(),
double  m = std::numeric_limits<double>::quiet_NaN() 
)
explicit

Create a new point with the given wkbtype and values.

Note
Not available in Python bindings

Definition at line 78 of file qgspoint.cpp.

Member Function Documentation

◆ addMValue()

bool QgsPoint::addMValue ( double  mValue = 0)
overridevirtual

Adds a measure to the geometry, initialized to a preset value.

Parameters
mValueinitial m-value for all nodes
Returns
true on success
See also
dropMValue()
addZValue()
Since
QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 480 of file qgspoint.cpp.

◆ addZValue()

bool QgsPoint::addZValue ( double  zValue = 0)
overridevirtual

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

Parameters
zValueinitial z-value for all nodes
Returns
true on success
See also
dropZValue()
addMValue()
Since
QGIS 2.12

Implements QgsAbstractGeometry.

Definition at line 469 of file qgspoint.cpp.

◆ adjacentVertices()

void QgsPoint::adjacentVertices ( QgsVertexId  vertex,
QgsVertexId previousVertex,
QgsVertexId nextVertex 
) const
overridevirtual

Returns the vertices adjacent to a specified vertex within a geometry.

Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 421 of file qgspoint.cpp.

◆ asGml2()

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

Returns a GML2 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
axisOrderAxis order for generated GML
See also
asWkb()
asWkt()
asGml3()
asJson()

Implements QgsAbstractGeometry.

Definition at line 235 of file qgspoint.cpp.

◆ asGml3()

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

Returns a GML3 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
axisOrderAxis order for generated GML
See also
asWkb()
asWkt()
asGml2()
asJson()

Implements QgsAbstractGeometry.

Definition at line 258 of file qgspoint.cpp.

◆ asJson()

QString QgsPoint::asJson ( int  precision = 17) const
overridevirtual

Returns a GeoJSON representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See also
asWkb()
asWkt()
asGml2()
asGml3()

Implements QgsAbstractGeometry.

Definition at line 282 of file qgspoint.cpp.

◆ asWkb()

QByteArray QgsPoint::asWkb ( ) const
overridevirtual

Returns a WKB representation of the geometry.

See also
asWkt
asGml2
asGml3
asJson()
Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 201 of file qgspoint.cpp.

◆ asWkt()

QString QgsPoint::asWkt ( int  precision = 17) const
overridevirtual

Returns a WKT representation of the geometry.

Parameters
precisionnumber of decimal places for coordinates
See also
asWkb()
asGml2()
asGml3()
asJson()

Implements QgsAbstractGeometry.

Definition at line 223 of file qgspoint.cpp.

◆ azimuth()

double QgsPoint::azimuth ( const QgsPoint other) const

Calculates azimuth between this point and other one (clockwise in degree, starting from north)

Since
QGIS 3.0

Definition at line 624 of file qgspoint.cpp.

◆ boundary()

QgsAbstractGeometry * QgsPoint::boundary ( ) const
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.

Returns
boundary for geometry. May be null for some geometry types.
Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 347 of file qgspoint.cpp.

◆ boundingBox()

QgsRectangle QgsPoint::boundingBox ( ) const
overridevirtual

Returns the minimal bounding box for the geometry.

Implements QgsAbstractGeometry.

Definition at line 675 of file qgspoint.cpp.

◆ cast()

const QgsPoint* QgsPoint::cast ( const QgsAbstractGeometry geom) const
inline

Cast the geom to a QgsPoint.

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

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

Definition at line 489 of file qgspoint.h.

◆ childCount()

int QgsPoint::childCount ( ) const
overrideprotectedvirtual

Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e.

curve / point)

Note
used for vertex_iterator implementation
Since
QGIS 3.0

Reimplemented from QgsAbstractGeometry.

Definition at line 690 of file qgspoint.cpp.

◆ childPoint()

QgsPoint QgsPoint::childPoint ( int  index) const
overrideprotectedvirtual

Returns point at index (for geometries without child geometries - i.e.

curve / point)

Note
used for vertex_iterator implementation
Since
QGIS 3.0

Reimplemented from QgsAbstractGeometry.

Definition at line 695 of file qgspoint.cpp.

◆ clear()

void QgsPoint::clear ( )
overridevirtual

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

Implements QgsAbstractGeometry.

Definition at line 294 of file qgspoint.cpp.

◆ clone()

QgsPoint * QgsPoint::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Implements QgsAbstractGeometry.

Definition at line 94 of file qgspoint.cpp.

◆ closestSegment()

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

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

Parameters
ptspecifies the point to find closest segment to
segmentPtstorage for the closest point within the geometry
vertexAfterstorage for the ID of the vertex at the end of the closest segment
leftOfindicates 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)
epsilonepsilon for segment snapping
Returns
squared distance to closest segment or negative value on error

Implements QgsAbstractGeometry.

Definition at line 388 of file qgspoint.cpp.

◆ convertTo()

bool QgsPoint::convertTo ( QgsWkbTypes::Type  type)
overridevirtual

Converts the geometry to a specified type.

Returns
true if conversion was successful
Since
QGIS 2.14

Reimplemented from QgsAbstractGeometry.

Definition at line 538 of file qgspoint.cpp.

◆ coordinateSequence()

QgsCoordinateSequence QgsPoint::coordinateSequence ( ) const
overridevirtual

Retrieves the sequence of geometries, rings and nodes.

Returns
coordinate sequence

Implements QgsAbstractGeometry.

Definition at line 324 of file qgspoint.cpp.

◆ createEmptyWithSameType()

QgsPoint * QgsPoint::createEmptyWithSameType ( ) const
overridevirtual

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

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

See also
clone()
Since
3.0

Implements QgsAbstractGeometry.

Definition at line 701 of file qgspoint.cpp.

◆ deleteVertex()

bool QgsPoint::deleteVertex ( QgsVertexId  position)
overridevirtual

Deletes a vertex within the geometry.

Parameters
positionvertex id for vertex to delete
Returns
true if delete was successful
See also
insertVertex
moveVertex

Implements QgsAbstractGeometry.

Definition at line 382 of file qgspoint.cpp.

◆ dimension()

int QgsPoint::dimension ( ) const
overridevirtual

Returns the inherent dimension of the geometry.

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

Implements QgsAbstractGeometry.

Definition at line 685 of file qgspoint.cpp.

◆ distance() [1/2]

double QgsPoint::distance ( double  x,
double  y 
) const
inline

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

See also
distanceSquared()
Since
QGIS 3.0

Definition at line 276 of file qgspoint.h.

◆ distance() [2/2]

double QgsPoint::distance ( const QgsPoint other) const
inline

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

Since
QGIS 3.0

Definition at line 287 of file qgspoint.h.

◆ distance3D() [1/2]

double QgsPoint::distance3D ( double  x,
double  y,
double  z 
) const

Returns the 3D distance between this point and a specified x, y, z coordinate.

In certain cases it may be more appropriate to call the faster distanceSquared() method, e.g., when comparing distances.

See also
distanceSquared()
Since
QGIS 3.0

Definition at line 588 of file qgspoint.cpp.

◆ distance3D() [2/2]

double QgsPoint::distance3D ( const QgsPoint other) const

Returns the 3D 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.

Since
QGIS 3.0

Definition at line 597 of file qgspoint.cpp.

◆ distanceSquared() [1/2]

double QgsPoint::distanceSquared ( double  x,
double  y 
) const
inline

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

See also
distance()
Since
QGIS 3.0

Definition at line 299 of file qgspoint.h.

◆ distanceSquared() [2/2]

double QgsPoint::distanceSquared ( const QgsPoint other) const
inline

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

See also
distance()
Since
QGIS 3.0

Definition at line 311 of file qgspoint.h.

◆ distanceSquared3D() [1/2]

double QgsPoint::distanceSquared3D ( double  x,
double  y,
double  z 
) const

Returns the 3D squared distance between this point a specified x, y, z 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.

See also
distance()
Since
QGIS 3.0

Definition at line 606 of file qgspoint.cpp.

◆ distanceSquared3D() [2/2]

double QgsPoint::distanceSquared3D ( const QgsPoint other) const

Returns the 3D 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.

See also
distance()
Since
QGIS 3.0

Definition at line 615 of file qgspoint.cpp.

◆ draw()

void QgsPoint::draw ( QPainter &  p) const
overridevirtual

Draws the geometry using the specified QPainter.

Parameters
pdestination QPainter

Implements QgsAbstractGeometry.

Definition at line 289 of file qgspoint.cpp.

◆ dropMValue()

bool QgsPoint::dropMValue ( )
overridevirtual

Drops any measure values which exist in the geometry.

Returns
true if m-values were present and have been removed
See also
addMValue()
dropZValue()
Since
QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 521 of file qgspoint.cpp.

◆ dropZValue()

bool QgsPoint::dropZValue ( )
overridevirtual

Drops any z-dimensions which exist in the geometry.

Returns
true if Z values were present and have been removed
See also
addZValue()
dropMValue()
Since
QGIS 2.14

Implements QgsAbstractGeometry.

Definition at line 510 of file qgspoint.cpp.

◆ filterVertices()

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

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

Has no meaning when called on a single point geometry.

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

Note
Not available in Python bindings
Since
QGIS 3.2

Reimplemented from QgsAbstractGeometry.

Definition at line 571 of file qgspoint.cpp.

◆ fromWkb()

bool QgsPoint::fromWkb ( QgsConstWkbPtr wkb)
overridevirtual

Sets the geometry from a WKB string.

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

See also
fromWkt

Implements QgsAbstractGeometry.

Definition at line 125 of file qgspoint.cpp.

◆ fromWkt()

bool QgsPoint::fromWkt ( const QString &  wkt)
overridevirtual

Sets the geometry from a WKT string.

See also
fromWkb

Implements QgsAbstractGeometry.

Definition at line 153 of file qgspoint.cpp.

◆ geometryType()

QString QgsPoint::geometryType ( ) const
overridevirtual

Returns a unique string representing the geometry type.

See also
wkbType
wktTypeStr

Implements QgsAbstractGeometry.

Definition at line 680 of file qgspoint.cpp.

◆ inclination()

double QgsPoint::inclination ( const QgsPoint other) const

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

Since
QGIS 3.0

Definition at line 631 of file qgspoint.cpp.

◆ insertVertex()

bool QgsPoint::insertVertex ( QgsVertexId  position,
const QgsPoint vertex 
)
overridevirtual

Inserts a vertex into the geometry.

Parameters
positionvertex id for position of inserted vertex
vertexvertex to insert
Returns
true if insert was successful
See also
moveVertex
deleteVertex

Implements QgsAbstractGeometry.

Definition at line 352 of file qgspoint.cpp.

◆ isEmpty()

bool QgsPoint::isEmpty ( ) const
overridevirtual

Returns true if the geometry is empty.

Reimplemented from QgsAbstractGeometry.

Definition at line 670 of file qgspoint.cpp.

◆ m()

double QgsPoint::m ( ) const
inline

Returns the point's m value.

See also
setM()
rm()

Definition at line 170 of file qgspoint.h.

◆ moveVertex()

bool QgsPoint::moveVertex ( QgsVertexId  position,
const QgsPoint newPos 
)
overridevirtual

Moves a vertex within the geometry.

Parameters
positionvertex id for vertex to move
newPosnew position of vertex
Returns
true if move was successful
See also
insertVertex
deleteVertex

Implements QgsAbstractGeometry.

Definition at line 365 of file qgspoint.cpp.

◆ nCoordinates()

int QgsPoint::nCoordinates ( ) const
overridevirtual

Returns the number of nodes contained in the geometry.

Reimplemented from QgsAbstractGeometry.

Definition at line 334 of file qgspoint.cpp.

◆ nextVertex()

bool QgsPoint::nextVertex ( QgsVertexId id,
QgsPoint vertex 
) const
overridevirtual

Returns next vertex id and coordinates.

Parameters
idinitial value should be the starting vertex id. The next vertex id will be stored in this variable if found.
vertexcontainer for found node
Returns
false if at end

Implements QgsAbstractGeometry.

Definition at line 399 of file qgspoint.cpp.

◆ operator!=()

bool QgsPoint::operator!= ( const QgsAbstractGeometry other) const
inlineoverridevirtual

Implements QgsAbstractGeometry.

Definition at line 139 of file qgspoint.h.

◆ operator+()

QgsPoint QgsPoint::operator+ ( QgsVector  v) const
inline

Adds a vector to this point.

Since
QGIS 3.0

Definition at line 416 of file qgspoint.h.

◆ operator+=()

QgsPoint& QgsPoint::operator+= ( QgsVector  v)
inline

Adds a vector to this point in place.

Since
QGIS 3.0

Definition at line 404 of file qgspoint.h.

◆ operator-() [1/2]

QgsVector QgsPoint::operator- ( const QgsPoint p) const
inline

Calculates the vector obtained by subtracting a point from this point.

Since
QGIS 3.0

Definition at line 398 of file qgspoint.h.

◆ operator-() [2/2]

QgsPoint QgsPoint::operator- ( QgsVector  v) const
inline

Subtracts a vector from this point.

Since
QGIS 3.0

Definition at line 422 of file qgspoint.h.

◆ operator-=()

QgsPoint& QgsPoint::operator-= ( QgsVector  v)
inline

Subtracts a vector from this point in place.

Since
QGIS 3.0

Definition at line 410 of file qgspoint.h.

◆ operator==()

bool QgsPoint::operator== ( const QgsAbstractGeometry other) const
inlineoverridevirtual

Implements QgsAbstractGeometry.

Definition at line 120 of file qgspoint.h.

◆ partCount()

int QgsPoint::partCount ( ) const
overridevirtual

Returns count of parts contained in the geometry.

See also
vertexCount
ringCount

Implements QgsAbstractGeometry.

Definition at line 443 of file qgspoint.cpp.

◆ project()

QgsPoint QgsPoint::project ( double  distance,
double  azimuth,
double  inclination = 90.0 
) const

Returns a new point which correspond to this point projected by a specified distance with specified angles (azimuth and inclination).

M value is preserved.

Parameters
distancedistance to project
azimuthangle to project in X Y, clockwise in degrees starting from north
inclinationangle to project in Z (3D). If the point is 2D, the Z value is assumed to be 0.
Returns
The point projected. If a 2D point is projected a 3D point will be returned except if inclination is 90. A 3D point is always returned if a 3D point is projected. Example:
p = QgsPoint( 1, 2 ) # 2D point
pr = p.project ( 1, 0 )
# pr is a 2D point: 'Point (1 3)'
pr = p.project ( 1, 0, 90 )
# pr is a 2D point: 'Point (1 3)'
pr = p.project (1, 0, 0 )
# pr is a 3D point: 'PointZ (1 2 1)'
p = QgsPoint( QgsWkbTypes.PointZ, 1, 2, 2 ) # 3D point
pr = p.project ( 1, 0 )
# pr is a 3D point: 'PointZ (1 3 2)'
pr = p.project ( 1, 0, 90 )
# pr is a 3D point: 'PointZ (1 3 2)'
pr = p.project (1, 0, 0 )
# pr is a 3D point: 'PointZ (1 2 3)'
Since
QGIS 3.0

Definition at line 643 of file qgspoint.cpp.

◆ removeDuplicateNodes()

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

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

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

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

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

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

Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 120 of file qgspoint.cpp.

◆ ringCount()

int QgsPoint::ringCount ( int  part = 0) const
overridevirtual

Returns the number of rings of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 438 of file qgspoint.cpp.

◆ rm()

double& QgsPoint::rm ( )
inline

Returns a reference to the m value of this point.

Using a reference makes it possible to directly manipulate m in place.

See also
m()
setM()
Note
not available in Python bindings

Definition at line 206 of file qgspoint.h.

◆ rx()

double& QgsPoint::rx ( )
inline

Returns a reference to the x-coordinate of this point.

Using a reference makes it possible to directly manipulate x in place.

See also
x()
setX()
Note
not available in Python bindings

Definition at line 179 of file qgspoint.h.

◆ ry()

double& QgsPoint::ry ( )
inline

Returns a reference to the y-coordinate of this point.

Using a reference makes it possible to directly manipulate y in place.

See also
y()
setY()
Note
not available in Python bindings

Definition at line 188 of file qgspoint.h.

◆ rz()

double& QgsPoint::rz ( )
inline

Returns a reference to the z-coordinate of this point.

Using a reference makes it possible to directly manipulate z in place.

See also
z()
setZ()
Note
not available in Python bindings

Definition at line 197 of file qgspoint.h.

◆ segmentLength()

double QgsPoint::segmentLength ( QgsVertexId  startVertex) const
overridevirtual

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

Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 458 of file qgspoint.cpp.

◆ setM()

void QgsPoint::setM ( double  m)
inline

Sets the point's m-value.

Note
calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to add a m value and force the point to have an m dimension.
See also
m()
rm()

Definition at line 252 of file qgspoint.h.

◆ setX()

void QgsPoint::setX ( double  x)
inline

Sets the point's x-coordinate.

See also
x()
rx()

Definition at line 213 of file qgspoint.h.

◆ setY()

void QgsPoint::setY ( double  y)
inline

Sets the point's y-coordinate.

See also
y()
ry()

Definition at line 224 of file qgspoint.h.

◆ setZ()

void QgsPoint::setZ ( double  z)
inline

Sets the point's z-coordinate.

Note
calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to add a z value and force the point to have a z dimension.
See also
z()
rz()

Definition at line 237 of file qgspoint.h.

◆ snappedToGrid()

QgsPoint * QgsPoint::snappedToGrid ( double  hSpacing,
double  vSpacing,
double  dSpacing = 0,
double  mSpacing = 0 
) const
overridevirtual

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

Ownership is transferred to the caller.

If the gridified geometry could not be calculated a nullptr will be returned. It may generate an invalid geometry (in some corner cases). It can also be thought as rounding the edges and it may be useful for removing errors. Example:

geometry->snappedToGrid(1, 1);

In this case we use a 2D grid of 1x1 to gridify. In this case, it can be thought like rounding the x and y of all the points/vertices to full units (remove all decimals).

Parameters
hSpacingHorizontal spacing of the grid (x axis). 0 to disable.
vSpacingVertical spacing of the grid (y axis). 0 to disable.
dSpacingDepth spacing of the grid (z axis). 0 (default) to disable.
mSpacingCustom dimension spacing of the grid (m axis). 0 (default) to disable.
Since
3.0

Implements QgsAbstractGeometry.

Definition at line 99 of file qgspoint.cpp.

◆ swapXy()

void QgsPoint::swapXy ( )
overridevirtual

Swaps the x and y coordinates from the geometry.

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

Since
QGIS 3.2

Implements QgsAbstractGeometry.

Definition at line 532 of file qgspoint.cpp.

◆ toCurveType()

QgsPoint * QgsPoint::toCurveType ( ) const
overridevirtual

Returns the geometry converted to the more generic curve type.

E.g. QgsLineString -> QgsCompoundCurve, QgsPolygon -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygon -> QgsMultiSurface

Returns
the converted geometry. Caller takes ownership

Implements QgsAbstractGeometry.

Definition at line 453 of file qgspoint.cpp.

◆ toQPointF()

QPointF QgsPoint::toQPointF ( ) const
inline

Returns the point as a QPointF.

Since
QGIS 2.14

Definition at line 264 of file qgspoint.h.

◆ transform() [1/2]

void QgsPoint::transform ( const QgsCoordinateTransform ct,
QgsCoordinateTransform::TransformDirection  d = QgsCoordinateTransform::ForwardTransform,
bool  transformZ = false 
)
overridevirtual

Transforms the geometry using a coordinate transform.

Parameters
ctcoordinate transform
dtransformation direction
transformZset 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 310 of file qgspoint.cpp.

◆ transform() [2/2]

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

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

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

Implements QgsAbstractGeometry.

Definition at line 491 of file qgspoint.cpp.

◆ transformVertices()

void QgsPoint::transformVertices ( const std::function< QgsPoint(const QgsPoint &) > &  transform)
overridevirtual

Transforms the vertices from the geometry in place, applying the transform function to every vertex.

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

Transform functions are not permitted to alter the dimensionality of vertices. If a transform which adds (or removes) z/m values is desired, first call the corresponding addZValue() or addMValue() function to change the geometry's dimensionality and then transform.

Note
Not available in Python bindings
Since
QGIS 3.4

Reimplemented from QgsAbstractGeometry.

Definition at line 576 of file qgspoint.cpp.

◆ vertexAngle()

double QgsPoint::vertexAngle ( QgsVertexId  vertex) const
overridevirtual

Angle undefined.

Always returns 0.0

Parameters
vertexthe vertex id
Returns
0.0

Implements QgsAbstractGeometry.

Definition at line 427 of file qgspoint.cpp.

◆ vertexAt()

QgsPoint QgsPoint::vertexAt ( QgsVertexId  id) const
overridevirtual

Returns the point corresponding to a specified vertex id.

Implements QgsAbstractGeometry.

Definition at line 448 of file qgspoint.cpp.

◆ vertexCount()

int QgsPoint::vertexCount ( int  part = 0,
int  ring = 0 
) const
overridevirtual

Returns the number of vertices of which this geometry is built.

Implements QgsAbstractGeometry.

Definition at line 433 of file qgspoint.cpp.

◆ vertexNumberFromVertexId()

int QgsPoint::vertexNumberFromVertexId ( QgsVertexId  id) const
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.

Since
QGIS 3.0

Implements QgsAbstractGeometry.

Definition at line 339 of file qgspoint.cpp.

◆ x()

double QgsPoint::x ( ) const
inline

Returns the point's x-coordinate.

See also
setX()
rx()

Definition at line 149 of file qgspoint.h.

◆ y()

double QgsPoint::y ( ) const
inline

Returns the point's y-coordinate.

See also
setY()
ry()

Definition at line 156 of file qgspoint.h.

◆ z()

double QgsPoint::z ( ) const
inline

Returns the point's z-coordinate.

See also
setZ()
rz()

Definition at line 163 of file qgspoint.h.

Property Documentation

◆ m

double QgsPoint::m
readwrite

Definition at line 44 of file qgspoint.h.

◆ x

double QgsPoint::x
readwrite

Definition at line 41 of file qgspoint.h.

◆ y

double QgsPoint::y
readwrite

Definition at line 42 of file qgspoint.h.

◆ z

double QgsPoint::z
readwrite

Definition at line 43 of file qgspoint.h.


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