qgsvector.h

Go to the documentation of this file.

/***************************************************************************
  qgsvector.h - QgsVector
 
 ---------------------
 begin                : 24.2.2017
 copyright            : (C) 2017 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSVECTOR_H
#define QGSVECTOR_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QString>
#include <QtGlobal>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsVector
{
  public:
    QgsVector() = default;

    QgsVector( double x, double y )
      : mX( x )
      , mY( y )
    {}
 
    // clang-format off
    QgsVector operator-() const SIP_HOLDGIL
      // clang-format on
    {
      return QgsVector( -mX, -mY );
    }

    QgsVector operator*( double scalar ) const SIP_HOLDGIL
    {
      return QgsVector( mX * scalar, mY * scalar );
    }

    QgsVector operator/( double scalar ) const SIP_HOLDGIL
    {
      return *this * ( 1.0 / scalar );
    }

    double operator*( QgsVector v ) const SIP_HOLDGIL
    {
      return mX * v.mX + mY * v.mY;
    }

    QgsVector operator+( QgsVector other ) const SIP_HOLDGIL
    {
      return QgsVector( mX + other.mX, mY + other.mY );
    }

    QgsVector &operator+=( QgsVector other ) SIP_HOLDGIL
    {
      mX += other.mX;
      mY += other.mY;
      return *this;
    }

    QgsVector operator-( QgsVector other ) const SIP_HOLDGIL
    {
      return QgsVector( mX - other.mX, mY - other.mY );
    }

    QgsVector &operator-=( QgsVector other ) SIP_HOLDGIL
    {
      mX -= other.mX;
      mY -= other.mY;
      return *this;
    }

    double length() const SIP_HOLDGIL
    {
      return std::sqrt( mX * mX + mY * mY );
    }

    double lengthSquared() const SIP_HOLDGIL
    {
      return mX * mX + mY * mY;
    }

    double x() const SIP_HOLDGIL
    {
      return mX;
    }

    double y() const SIP_HOLDGIL
    {
      return mY;
    }

    QgsVector perpVector() const SIP_HOLDGIL
    {
      return QgsVector( -mY, mX );
    }

    double angle() const SIP_HOLDGIL
    {
      const double angle = std::atan2( mY, mX );
      return angle < 0.0 ? angle + 2.0 * M_PI : angle;
    }

    double angle( QgsVector v ) const SIP_HOLDGIL
    {
      return v.angle() - angle();
    }

    double crossProduct( QgsVector v ) const SIP_HOLDGIL
    {
      return mX * v.y() - mY * v.x();
    }

    QgsVector rotateBy( double rot ) const SIP_HOLDGIL;

    QgsVector normalized() const SIP_THROW( QgsException );
 
    bool operator==( QgsVector other ) const SIP_HOLDGIL
    {
      return qgsDoubleNear( mX, other.mX ) && qgsDoubleNear( mY, other.mY );
    }
 
    bool operator!=( QgsVector other ) const
    {
      return !qgsDoubleNear( mX, other.mX ) || !qgsDoubleNear( mY, other.mY );
    }

    QString toString( int precision = 17 ) const SIP_HOLDGIL
    {
      QString str = "Vector (";
      str += qgsDoubleToString( mX, precision );
      str += ", ";
      str += qgsDoubleToString( mY, precision );
      str += ')';
      return str;
    }
 
#ifdef SIP_RUN
// clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsVector: %1>"_s.arg( sipCpp->toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
  private:
    double mX = 0.0;
    double mY = 0.0;
 
};
 
Q_DECLARE_TYPEINFO( QgsVector, Q_MOVABLE_TYPE );
 
#endif // QGSVECTOR_H