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 <QtGlobal>

class CORE_EXPORT QgsVector
{

  public:

    QgsVector() = default;

    QgsVector( double x, double y );

    QgsVector operator-() const;

    QgsVector operator*( double scalar ) const;

    QgsVector operator/( double scalar ) const;

    double operator*( QgsVector v ) const;

    QgsVector operator+( QgsVector other ) const;

    QgsVector &operator+=( QgsVector other );

    QgsVector operator-( QgsVector other ) const;

    QgsVector &operator-=( QgsVector other );

    double length() const;

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

    double x() const;

    double y() const;

    QgsVector perpVector() const;

    double angle() const;

    double angle( QgsVector v ) const;

    double crossProduct( QgsVector v ) const;

    QgsVector rotateBy( double rot ) const;

    QgsVector normalized() const;

    bool operator==( QgsVector other ) const;

    bool operator!=( QgsVector other ) const;


    QString toString( int precision = 17 ) const
    {
      QString str = "Vector (";
      str += qgsDoubleToString( mX, precision );
      str += ", ";
      str += qgsDoubleToString( mY, precision );
      str += ')';
      return str;
    }

#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = QStringLiteral( "<QgsVector: %1>" ).arg( sipCpp->toString() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif

  private:
    double mX = 0.0, mY = 0.0;

};

Q_DECLARE_TYPEINFO( QgsVector, Q_MOVABLE_TYPE );

#endif // QGSVECTOR_H