qgspoint.h

Go to the documentation of this file.

/***************************************************************************
                          qgspoint.h  -  description
                             -------------------
    begin                : Sat Jun 22 2002
    copyright            : (C) 2002 by Gary E.Sherman
    email                : sherman at mrcc.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSPOINT_H
#define QGSPOINT_H

#include <qgis.h>

#include <iostream>
#include <QString>
#include <QPoint>

class CORE_EXPORT QgsVector
{

  public:

    QgsVector();

    QgsVector( double x, double y );

    QgsVector operator-() const;

    QgsVector operator*( double scalar ) const;

    QgsVector operator/( double scalar ) const;

    double operator*( QgsVector v ) const;

    double length() const;

    double x() const;

    double y() const;

    QgsVector perpVector() const;

    double angle() const;

    double angle( QgsVector v ) const;

    QgsVector rotateBy( double rot ) const;

    Q_DECL_DEPRECATED QgsVector normal() const;

    QgsVector normalized() const;

  private:

    double mX, mY;

};

class CORE_EXPORT QgsPoint
{
  public:
    QgsPoint()
        : m_x( 0.0 )
        , m_y( 0.0 )
    {}

    QgsPoint( const QgsPoint& p );

    QgsPoint( double x, double y )
        : m_x( x )
        , m_y( y )
    {}

    QgsPoint( QPointF point )
        : m_x( point.x() )
        , m_y( point.y() )
    {}

    QgsPoint( QPoint point )
        : m_x( point.x() )
        , m_y( point.y() )
    {}

    ~QgsPoint()
    {}

    void setX( double x )
    {
      m_x = x;
    }

    void setY( double y )
    {
      m_y = y;
    }

    void set( double x, double y )
    {
      m_x = x;
      m_y = y;
    }

    double x() const
    {
      return m_x;
    }

    double y() const
    {
      return m_y;
    }

    QPointF toQPointF() const;

    QString toString() const;

    QString toString( int thePrecision ) const;

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

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


    QString wellKnownText() const;

    double sqrDist( double x, double y ) const;

    double sqrDist( const QgsPoint& other ) const;

    double distance( double x, double y ) const;

    double distance( const QgsPoint& other ) const;

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

    double azimuth( const QgsPoint& other ) const;

    QgsPoint project( double distance, double bearing ) const;

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

    bool operator==( const QgsPoint &other );

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

    void multiply( double scalar );

    int onSegment( const QgsPoint& a, const QgsPoint& b ) const;

    QgsPoint & operator=( const QgsPoint &other );

    QgsVector operator-( const QgsPoint& p ) const { return QgsVector( m_x - p.m_x, m_y - p.m_y ); }

    QgsPoint &operator+=( QgsVector v ) { *this = *this + v; return *this; }

    QgsPoint &operator-=( QgsVector v ) { *this = *this - v; return *this; }

    QgsPoint operator+( QgsVector v ) const { return QgsPoint( m_x + v.x(), m_y + v.y() ); }

    QgsPoint operator-( QgsVector v ) const { return QgsPoint( m_x - v.x(), m_y - v.y() ); }

    QgsPoint operator*( double scalar ) const { return QgsPoint( m_x * scalar, m_y * scalar ); }

    QgsPoint operator/( double scalar ) const { return QgsPoint( m_x / scalar, m_y / scalar ); }

    QgsPoint &operator*=( double scalar ) { m_x *= scalar; m_y *= scalar; return *this; }

    QgsPoint &operator/=( double scalar ) { m_x /= scalar; m_y /= scalar; return *this; }

  private:

    double m_x;

    double m_y;

    friend uint qHash( const QgsPoint& pnt );

}; // class QgsPoint


inline bool operator==( const QgsPoint &p1, const QgsPoint &p2 )
{
  if ( qgsDoubleNear( p1.x(), p2.x() ) && qgsDoubleNear( p1.y(), p2.y() ) )
    { return true; }
  else
    { return false; }
}

inline std::ostream& operator << ( std::ostream& os, const QgsPoint &p )
{
  // Use Local8Bit for printouts
  os << p.toString().toLocal8Bit().data();
  return os;
}

inline uint qHash( const QgsPoint& p )
{
  uint hash;
  uint h1 = qHash( static_cast< quint64 >( p.m_x ) );
  uint h2 = qHash( static_cast< quint64 >( p.m_y ) );
  hash = h1 ^( h2 << 1 );
  return hash;
}

#endif //QGSPOINT_H