/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgspoint.h                                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/







class QgsPointXY
{
%Docstring
 A class to represent a point.
 For Z and M support prefer QgsPointV2.
%End

%TypeHeaderCode
#include "qgspointxy.h"
%End
  public:
    QgsPointXY();

    QgsPointXY( const QgsPointXY &p );
%Docstring
Create a point from another point
%End

    QgsPointXY( double x, double y );
%Docstring
 Create a point from x,y coordinates
 \param x x coordinate
 \param y y coordinate
%End

    QgsPointXY( QPointF point );
%Docstring
 Create a point from a QPointF
 \param point QPointF source
.. versionadded:: 2.7
%End

    QgsPointXY( QPoint point );
%Docstring
 Create a point from a QPoint
 \param point QPoint source
.. versionadded:: 2.7
%End

    QgsPointXY( const QgsPoint &point );
%Docstring
 Create a new point.
 Z and M values will be dropped.

.. versionadded:: 3.0
%End

    ~QgsPointXY();

    void setX( double x );
%Docstring
 Sets the x value of the point
 \param x x coordinate
%End

    void setY( double y );
%Docstring
 Sets the y value of the point
 \param y y coordinate
%End

    void set( double x, double y );
%Docstring
Sets the x and y value of the point
%End

    double x() const;
%Docstring
 Get the x value of the point
 :return: x coordinate
 :rtype: float
%End

    double y() const;
%Docstring
 Get the y value of the point
 :return: y coordinate
 :rtype: float
%End

    QPointF toQPointF() const;
%Docstring
 Converts a point to a QPointF
 :return: QPointF with same x and y values
.. versionadded:: 2.7
 :rtype: QPointF
%End

    QString toString() const;
%Docstring
String representation of the point (x,y)
 :rtype: str
%End

    QString toString( int precision ) const;
%Docstring
As above but with precision for string representation of a point
 :rtype: str
%End

    QString toDegreesMinutesSeconds( int precision, const bool useSuffix = true, const bool padded = false ) const;
%Docstring
 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.
  \param precision number of decimal points to use for seconds
  \param useSuffix set to true to include a direction suffix (e.g., 'N'),
  set to false to use a "-" prefix for west and south coordinates
  \param padded set to true to force minutes and seconds to use two decimals,
  e.g., '05' instead of '5'.
 :rtype: str
%End

    QString toDegreesMinutes( int precision, const bool useSuffix = true, const bool padded = false ) const;
%Docstring
 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.
  \param precision number of decimal points to use for minutes
  \param useSuffix set to true to include a direction suffix (e.g., 'N'),
  set to false to use a "-" prefix for west and south coordinates
  \param padded set to true to force minutes to use two decimals,
  e.g., '05' instead of '5'.
 :rtype: str
%End


    QString wellKnownText() const;
%Docstring
 Return the well known text representation for the point.
 The wkt is created without an SRID.
 :return: Well known text in the form POINT(x y)
 :rtype: str
%End

    double sqrDist( double x, double y ) const;
%Docstring
 Returns the squared distance between this point a specified x, y coordinate.
.. seealso:: distance()
 :rtype: float
%End

    double sqrDist( const QgsPointXY &other ) const;
%Docstring
 Returns the squared distance between this point another point.
.. seealso:: distance()
 :rtype: float
%End

    double distance( double x, double y ) const;
%Docstring
 Returns the distance between this point and a specified x, y coordinate.
 \param x x-coordniate
 \param y y-coordinate
.. seealso:: sqrDist()
.. versionadded:: 2.16
 :rtype: float
%End

    double distance( const QgsPointXY &other ) const;
%Docstring
 Returns the distance between this point and another point.
 \param other other point
.. seealso:: sqrDist()
.. versionadded:: 2.16
 :rtype: float
%End

    double sqrDistToSegment( double x1, double y1, double x2, double y2, QgsPointXY &minDistPoint /Out/, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
%Docstring
Returns the minimum distance between this point and a segment
 :rtype: float
%End

    double azimuth( const QgsPointXY &other ) const;
%Docstring
Calculates azimuth between this point and other one (clockwise in degree, starting from north)
 :rtype: float
%End

    QgsPointXY project( double distance, double bearing ) const;
%Docstring
 Returns a new point which corresponds to this point projected by a specified distance
 in a specified bearing.
 \param distance distance to project
 \param bearing angle to project in, clockwise in degrees starting from north
.. versionadded:: 2.16
 :rtype: QgsPointXY
%End

    bool compare( const QgsPointXY &other, double epsilon = 4 * DBL_EPSILON ) const;
%Docstring
 Compares this point with another point with a fuzzy tolerance
 \param other point to compare with
 \param epsilon maximum difference for coordinates between the points
 :return: true if points are equal within specified tolerance
.. versionadded:: 2.9
 :rtype: bool
%End

    bool operator==( const QgsPointXY &other );

    bool operator!=( const QgsPointXY &other ) const;
%Docstring
Inequality operator
 :rtype: bool
%End

    void multiply( double scalar );
%Docstring
Multiply x and y by the given value
%End


    QgsVector operator-( const QgsPointXY &p ) const;
%Docstring
Calculates the vector obtained by subtracting a point from this point
 :rtype: QgsVector
%End

    QgsPointXY &operator+=( QgsVector v );
%Docstring
Adds a vector to this point in place
 :rtype: QgsPointXY
%End

    QgsPointXY &operator-=( QgsVector v );
%Docstring
Subtracts a vector from this point in place
 :rtype: QgsPointXY
%End

    QgsPointXY operator+( QgsVector v ) const;
%Docstring
Adds a vector to this point
 :rtype: QgsPointXY
%End

    QgsPointXY operator-( QgsVector v ) const;
%Docstring
Subtracts a vector from this point
 :rtype: QgsPointXY
%End

    QgsPointXY operator*( double scalar ) const;
%Docstring
Multiplies the coordinates in this point by a scalar quantity
 :rtype: QgsPointXY
%End

    QgsPointXY operator/( double scalar ) const;
%Docstring
Divides the coordinates in this point by a scalar quantity
 :rtype: QgsPointXY
%End

    QgsPointXY &operator*=( double scalar );
%Docstring
Multiplies the coordinates in this point by a scalar quantity in place
 :rtype: QgsPointXY
%End

    QgsPointXY &operator/=( double scalar );
%Docstring
Divides the coordinates in this point by a scalar quantity in place
 :rtype: QgsPointXY
%End

    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = "(" + QString::number( sipCpp->x() ) + "," + QString::number( sipCpp->y() ) + ")";
    //QString str("(%f,%f)").arg(sipCpp->x()).arg(sipCpp->y());
    sipRes = PyUnicode_FromString( str.toUtf8().data() );
%End

    int __len__();
%Docstring
 :rtype: int
%End
%MethodCode
    sipRes = 2;
%End


    SIP_PYOBJECT __getitem__( int );
%MethodCode
    if ( a0 == 0 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->x() );
    }
    else if ( a0 == 1 )
    {
      sipRes = Py_BuildValue( "d", sipCpp->y() );
    }
    else
    {
      QString msg = QString( "Bad index: %1" ).arg( a0 );
      PyErr_SetString( PyExc_IndexError, msg.toAscii().constData() );
    }
%End

    long __hash__() const;
%Docstring
 :rtype: long
%End
%MethodCode
    sipRes = qHash( *sipCpp );
%End

}; // class QgsPoint






/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgspoint.h                                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/