QGIS API Documentation  2.99.0-Master (c558d51)
Public Member Functions | Properties | Friends | List of all members
QgsPoint Class Reference

A class to represent a point. More...

#include <qgspoint.h>

Public Member Functions

 QgsPoint ()
 Default constructor. More...
 
 QgsPoint (const QgsPoint &p)
 Create a point from another point. More...
 
 QgsPoint (double x, double y)
 Create a point from x,y coordinates. More...
 
 QgsPoint (QPointF point)
 Create a point from a QPointF. More...
 
 QgsPoint (QPoint point)
 Create a point from a QPoint. More...
 
 ~QgsPoint ()
 
double azimuth (const QgsPoint &other) const
 Calculates azimuth between this point and other one (clockwise in degree, starting from north) More...
 
bool compare (const QgsPoint &other, double epsilon=4 *DBL_EPSILON) const
 Compares this point with another point with a fuzzy tolerance. 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 distance between this point and another point. More...
 
void multiply (double scalar)
 Multiply x and y by the given value. More...
 
int onSegment (const QgsPoint &a, const QgsPoint &b) const
 Test if this point is on the segment defined by points a, b. More...
 
bool operator!= (const QgsPoint &other) const
 Inequality operator. More...
 
QgsPoint operator* (double scalar) const
 Multiplies the coordinates in this point by a scalar quantity. More...
 
QgsPointoperator*= (double scalar)
 Multiplies the coordinates in this point by a scalar quantity in place. More...
 
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...
 
QgsPoint operator/ (double scalar) const
 Divides the coordinates in this point by a scalar quantity. More...
 
QgsPointoperator/= (double scalar)
 Divides the coordinates in this point by a scalar quantity in place. More...
 
QgsPointoperator= (const QgsPoint &other)
 Assignment. More...
 
bool operator== (const QgsPoint &other)
 equality operator More...
 
QgsPoint project (double distance, double bearing) const
 Returns a new point which correponds to this point projected by a specified distance in a specified bearing. More...
 
void set (double x, double y)
 Sets the x and y value of the point. More...
 
void setX (double x)
 Sets the x value of the point. More...
 
void setY (double y)
 Sets the y value of the point. More...
 
double sqrDist (double x, double y) const
 Returns the squared distance between this point a specified x, y coordinate. More...
 
double sqrDist (const QgsPoint &other) const
 Returns the squared distance between this point another point. More...
 
double sqrDistToSegment (double x1, double y1, double x2, double y2, QgsPoint &minDistPoint, double epsilon=DEFAULT_SEGMENT_EPSILON) const
 Returns the minimum distance between this point and a segment. More...
 
QString toDegreesMinutes (int thePrecision, const bool useSuffix=true, const bool padded=false) const
 Return a string representation as degrees minutes. More...
 
QString toDegreesMinutesSeconds (int thePrecision, const bool useSuffix=true, const bool padded=false) const
 Return a string representation as degrees minutes seconds. More...
 
QPointF toQPointF () const
 Converts a point to a QPointF. More...
 
QString toString () const
 String representation of the point (x,y) More...
 
QString toString (int thePrecision) const
 As above but with precision for string representation of a point. More...
 
QString wellKnownText () const
 Return the well known text representation for the point. More...
 
double x () const
 Get the x value of the point. More...
 
double y () const
 Get the y value of the point. More...
 

Properties

double x
 
double y
 

Friends

uint qHash (const QgsPoint &pnt)
 

Detailed Description

A class to represent a point.

Currently no Z axis / 2.5D support is implemented.

Definition at line 111 of file qgspoint.h.

Constructor & Destructor Documentation

QgsPoint::QgsPoint ( )
inline

Default constructor.

Definition at line 120 of file qgspoint.h.

QgsPoint::QgsPoint ( const QgsPoint p)

Create a point from another point.

Definition at line 118 of file qgspoint.cpp.

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

Create a point from x,y coordinates.

Parameters
xx coordinate
yy coordinate

Definition at line 132 of file qgspoint.h.

QgsPoint::QgsPoint ( QPointF  point)
inline

Create a point from a QPointF.

Parameters
pointQPointF source
Note
added in QGIS 2.7

Definition at line 141 of file qgspoint.h.

QgsPoint::QgsPoint ( QPoint  point)
inline

Create a point from a QPoint.

Parameters
pointQPoint source
Note
added in QGIS 2.7

Definition at line 150 of file qgspoint.h.

QgsPoint::~QgsPoint ( )
inline

Definition at line 155 of file qgspoint.h.

Member Function Documentation

double QgsPoint::azimuth ( const QgsPoint other) const

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

Definition at line 368 of file qgspoint.cpp.

bool QgsPoint::compare ( const QgsPoint other,
double  epsilon = 4 * DBL_EPSILON 
) const

Compares this point with another point with a fuzzy tolerance.

Parameters
otherpoint to compare with
epsilonmaximum difference for coordinates between the points
Returns
true if points are equal within specified tolerance
Note
added in QGIS 2.9

Definition at line 383 of file qgspoint.cpp.

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

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

Parameters
xx-coordniate
yy-coordinate
See also
sqrDist()
Note
added in QGIS 2.16

Definition at line 358 of file qgspoint.cpp.

double QgsPoint::distance ( const QgsPoint other) const

Returns the distance between this point and another point.

Parameters
otherother point
See also
sqrDist()
Note
added in QGIS 2.16

Definition at line 363 of file qgspoint.cpp.

void QgsPoint::multiply ( double  scalar)

Multiply x and y by the given value.

Definition at line 416 of file qgspoint.cpp.

int QgsPoint::onSegment ( const QgsPoint a,
const QgsPoint b 
) const

Test if this point is on the segment defined by points a, b.

Returns
0 if this point is not on the open ray through a and b, 1 if point is on open ray a, 2 if point is within line segment, 3 if point is on open ray b.

Definition at line 422 of file qgspoint.cpp.

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

Inequality operator.

Definition at line 397 of file qgspoint.cpp.

QgsPoint QgsPoint::operator* ( double  scalar) const
inline

Multiplies the coordinates in this point by a scalar quantity.

Definition at line 319 of file qgspoint.h.

QgsPoint& QgsPoint::operator*= ( double  scalar)
inline

Multiplies the coordinates in this point by a scalar quantity in place.

Definition at line 325 of file qgspoint.h.

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

Adds a vector to this point.

Definition at line 313 of file qgspoint.h.

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

Adds a vector to this point in place.

Definition at line 307 of file qgspoint.h.

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

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

Definition at line 304 of file qgspoint.h.

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

Subtracts a vector from this point.

Definition at line 316 of file qgspoint.h.

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

Subtracts a vector from this point in place.

Definition at line 310 of file qgspoint.h.

QgsPoint QgsPoint::operator/ ( double  scalar) const
inline

Divides the coordinates in this point by a scalar quantity.

Definition at line 322 of file qgspoint.h.

QgsPoint& QgsPoint::operator/= ( double  scalar)
inline

Divides the coordinates in this point by a scalar quantity in place.

Definition at line 328 of file qgspoint.h.

QgsPoint & QgsPoint::operator= ( const QgsPoint other)

Assignment.

Definition at line 405 of file qgspoint.cpp.

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

equality operator

Definition at line 389 of file qgspoint.cpp.

QgsPoint QgsPoint::project ( double  distance,
double  bearing 
) const

Returns a new point which correponds to this point projected by a specified distance in a specified bearing.

Parameters
distancedistance to project
bearingangle to project in, clockwise in degrees starting from north
Note
added in QGIS 2.16

Definition at line 375 of file qgspoint.cpp.

void QgsPoint::set ( double  x,
double  y 
)
inline

Sets the x and y value of the point.

Definition at line 175 of file qgspoint.h.

void QgsPoint::setX ( double  x)
inline

Sets the x value of the point.

Parameters
xx coordinate

Definition at line 161 of file qgspoint.h.

void QgsPoint::setY ( double  y)
inline

Sets the y value of the point.

Parameters
yy coordinate

Definition at line 169 of file qgspoint.h.

double QgsPoint::sqrDist ( double  x,
double  y 
) const

Returns the squared distance between this point a specified x, y coordinate.

See also
distance()

Definition at line 348 of file qgspoint.cpp.

double QgsPoint::sqrDist ( const QgsPoint other) const

Returns the squared distance between this point another point.

See also
distance()

Definition at line 353 of file qgspoint.cpp.

double QgsPoint::sqrDistToSegment ( double  x1,
double  y1,
double  x2,
double  y2,
QgsPoint minDistPoint,
double  epsilon = DEFAULT_SEGMENT_EPSILON 
) const

Returns the minimum distance between this point and a segment.

Definition at line 452 of file qgspoint.cpp.

QString QgsPoint::toDegreesMinutes ( int  thePrecision,
const bool  useSuffix = true,
const bool  padded = false 
) const

Return a string representation as degrees minutes.

Its up to the calling function to ensure that this point can be meaningfully represented in this form.

Parameters
thePrecisionnumber of decimal points to use for minutes
useSuffixset to true to include a direction suffix (eg 'N'), set to false to use a "-" prefix for west and south coordinates
paddedset to true to force minutes to use two decimals, eg, '05' instead of '5'.

Definition at line 259 of file qgspoint.cpp.

QString QgsPoint::toDegreesMinutesSeconds ( int  thePrecision,
const bool  useSuffix = true,
const bool  padded = false 
) const

Return a string representation as degrees minutes seconds.

Its up to the calling function to ensure that this point can be meaningfully represented in this form.

Parameters
thePrecisionnumber of decimal points to use for seconds
useSuffixset to true to include a direction suffix (eg 'N'), set to false to use a "-" prefix for west and south coordinates
paddedset to true to force minutes and seconds to use two decimals, eg, '05' instead of '5'.

Definition at line 145 of file qgspoint.cpp.

QPointF QgsPoint::toQPointF ( ) const

Converts a point to a QPointF.

Returns
QPointF with same x and y values
Note
added in QGIS 2.7

Definition at line 124 of file qgspoint.cpp.

QString QgsPoint::toString ( ) const

String representation of the point (x,y)

Definition at line 129 of file qgspoint.cpp.

QString QgsPoint::toString ( int  thePrecision) const

As above but with precision for string representation of a point.

Definition at line 138 of file qgspoint.cpp.

QString QgsPoint::wellKnownText ( ) const

Return the well known text representation for the point.

The wkt is created without an SRID.

Returns
Well known text in the form POINT(x y)

Definition at line 343 of file qgspoint.cpp.

double QgsPoint::x ( ) const
inline

Get the x value of the point.

Returns
x coordinate

Definition at line 184 of file qgspoint.h.

double QgsPoint::y ( ) const
inline

Get the y value of the point.

Returns
y coordinate

Definition at line 192 of file qgspoint.h.

Friends And Related Function Documentation

uint qHash ( const QgsPoint pnt)
friend

Definition at line 358 of file qgspoint.h.

Property Documentation

double QgsPoint::x
readwrite

Definition at line 115 of file qgspoint.h.

double QgsPoint::y
readwrite

Definition at line 116 of file qgspoint.h.


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