Angle.h

Go to the documentation of this file.

#ifndef Angle_h
#define Angle_h
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <QtGlobal>
#include <QGlobalStatic>
 
class QString;
 
namespace Isis {
 
  class Angle {
 
  public:
    enum Units {
      Degrees,
      Radians
    };
 
    Angle();
    Angle(double angle, Units unit);
    Angle(const Angle& angle);
    Angle(QString angle);
 
    virtual ~Angle();
 
    // Class member operator functions
    bool isValid() const;
    static Angle fullRotation();
 
    Angle& operator=(const Angle& angle2) {
      setAngle(angle2.radians(), Radians); return *this;
    }
 
 
    Angle operator+(const Angle& angle2) const;
    Angle operator-(const Angle& angle2) const;
    Angle operator*(double value) const;
    friend Angle operator *(double mult, Angle angle);
    Angle operator/(double value) const;
    double operator/(Angle value) const;
    bool operator<(const Angle& angle2) const;
    bool operator>(const Angle& angle2) const;
 
 
    void operator+=(const Angle&  angle2) {
      *this = *this + angle2;
    };
 
 
    void operator-=(const Angle& angle2) {
      *this = *this - angle2;
    };
 
 
    Angle operator*(int value) const {
      return *this * (double)value;
    }
 
 
    void operator*=(double value) {
      *this = *this * value;
    }
 
 
    Angle operator/(int value) const {
      return *this / (double)value;
    }
 
 
    void operator/=(double value) {
      *this = *this / value;
    }
 
    // Relational operator functions
 
    bool operator==(const Angle& angle2) const {
      return qFuzzyCompare(angle(Radians), angle2.angle(Radians));
    }
 
 
    bool operator!=(const Angle& angle2) const {
      return !(*this == angle2);
    }
 
 
    bool operator<=(const Angle& angle2) const {
      return *this < angle2 || *this == angle2;
    }
 
 
    bool operator>=(const Angle& angle2) const {
      return *this > angle2 || *this == angle2;
    }
 
 
    double radians() const { return angle(Radians); }
 
    double degrees() const { return angle(Degrees); }
 
    void setRadians(double radians) { setAngle(radians, Radians); }
 
    void setDegrees(double degrees) { setAngle(degrees, Degrees); }
 
    virtual QString toString(bool includeUnits = true) const;
    double unitWrapValue(const Units& unit) const;
    virtual double angle(const Units& unit) const;
    virtual void setAngle(const double &angle, const Units& unit);
 
  private:
    double m_radians;
  };
}
 
QDebug operator<<(QDebug dbg, const Isis::Angle &angleToPrint);
 
#endif