QGIS API Documentation  2.0.1-Dufour
QgsPoint Class Reference

A class to represent a point geometry. More...

`#include <qgspoint.h>`

## Public Member Functions

QgsPoint ()
Default constructor.
QgsPoint (const QgsPoint &p)
QgsPoint (double x, double y)
~QgsPoint ()
void setX (double x)
void setY (double y)
void set (double x, double y)
double x () const
double y () const
QString toString () const
String representation of the point (x,y)
QString toString (int thePrecision) const
As above but with precision for string representation of a point.
QString toDegreesMinutesSeconds (int thePrecision) const
Return a string representation as degrees minutes seconds.
QString toDegreesMinutes (int thePrecision) const
Return a string representation as degrees minutes.
QString wellKnownText () const
double sqrDist (double x, double y) const
Returns the squared distance between this point and x,y.
double sqrDist (const QgsPoint &other) const
Returns the squared distance between this and other point.
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.
double azimuth (const QgsPoint &other)
Calculates azimut between this point and other one (clockwise in degree, starting from north)
bool operator== (const QgsPoint &other)
equality operator
bool operator!= (const QgsPoint &other) const
Inequality operator.
void multiply (const double &scalar)
Multiply x and y by the given value.
int onSegment (const QgsPoint &a, const QgsPoint &b) const
Test if this point is on the segment defined by points a, b.
QgsPointoperator= (const QgsPoint &other)
Assignment.
QgsVector operator- (QgsPoint p) const
QgsPointoperator+= (const QgsVector &v)
QgsPointoperator-= (const QgsVector &v)
QgsPoint operator+ (const QgsVector &v) const
QgsPoint operator- (const QgsVector &v) const

double m_x
x coordinate
double m_y
y coordinate

## Detailed Description

A class to represent a point geometry.

Currently no Z axis / 2.5D support is implemented.

Definition at line 63 of file qgspoint.h.

## Constructor & Destructor Documentation

 QgsPoint::QgsPoint ( )
inline

Default constructor.

Definition at line 67 of file qgspoint.h.

 QgsPoint::QgsPoint ( const QgsPoint & p )

Create a point from another point

Definition at line 115 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

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

Create a point from x,y coordinates

Parameters
 x x coordinate y y coordinate

Definition at line 77 of file qgspoint.h.

 QgsPoint::~QgsPoint ( )
inline

Definition at line 81 of file qgspoint.h.

## Member Function Documentation

 double QgsPoint::azimuth ( const QgsPoint & other )

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

Note
: this function has been added in version 1.7

Definition at line 196 of file qgspoint.cpp.

References M_PI, m_x, m_y, x(), and y().

 void QgsPoint::multiply ( const double & scalar )

Multiply x and y by the given value.

Definition at line 231 of file qgspoint.cpp.

References m_x, and m_y.

 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 237 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

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

Inequality operator.

Definition at line 212 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

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

Definition at line 185 of file qgspoint.h.

References QgsVector::x(), and QgsVector::y().

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

Definition at line 183 of file qgspoint.h.

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

Definition at line 182 of file qgspoint.h.

References m_x, and m_y.

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

Definition at line 186 of file qgspoint.h.

References QgsVector::x(), and QgsVector::y().

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

Definition at line 184 of file qgspoint.h.

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

Assignment.

Definition at line 220 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

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

equality operator

Definition at line 204 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

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

Sets the x and y value of the point

Definition at line 101 of file qgspoint.h.

Referenced by QgsClipper::intersect(), QgsLabel::labelPoint(), and QgsMapToPixel::transform().

 void QgsPoint::setX ( double x )
inline

Sets the x value of the point

Parameters
 x x coordinate

Definition at line 87 of file qgspoint.h.

 void QgsPoint::setY ( double y )
inline

Sets the y value of the point

Parameters
 y y coordinate

Definition at line 95 of file qgspoint.h.

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

Returns the squared distance between this point and x,y.

Definition at line 186 of file qgspoint.cpp.

References m_x, m_y, x(), and y().

 double QgsPoint::sqrDist ( const QgsPoint & other ) const

Returns the squared distance between this and other point.

Definition at line 191 of file qgspoint.cpp.

References sqrDist(), x(), and y().

 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.

Note

Definition at line 267 of file qgspoint.cpp.

References m_x, m_y, qgsDoubleNear(), setX(), setY(), and sqrDist().

Referenced by QgsGeometry::closestSegmentWithContext(), and QgsAnnotationItem::updateBalloon().

 QString QgsPoint::toDegreesMinutes ( int thePrecision ) 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.

Note

Definition at line 162 of file qgspoint.cpp.

References m_x, m_y, and tr.

Referenced by QgsComposerMap::gridAnnotationString().

 QString QgsPoint::toDegreesMinutesSeconds ( int thePrecision ) 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.

Note

Definition at line 137 of file qgspoint.cpp.

References m_x, m_y, and tr.

Referenced by QgsComposerMap::gridAnnotationString().

 QString QgsPoint::toString ( ) const

String representation of the point (x,y)

Definition at line 121 of file qgspoint.cpp.

References m_x, and m_y.

 QString QgsPoint::toString ( int thePrecision ) const

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

Definition at line 130 of file qgspoint.cpp.

References m_x, m_y, tr, x(), and y().

 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 181 of file qgspoint.cpp.

References m_x, m_y, and qgsDoubleToString().

## Member Data Documentation

 double QgsPoint::m_x
private

x coordinate

Definition at line 191 of file qgspoint.h.

 double QgsPoint::m_y
private

y coordinate

Definition at line 194 of file qgspoint.h.

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