Files
OpenSpace/modules/globebrowsing/geometry/angle.h
Alexander Bock 8456087cf5 Add a style check that checks whether the correct GLM header is used
Adapted files to use the correct GLM headers
2017-02-14 13:12:59 -05:00

138 lines
4.9 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2017 *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
* software and associated documentation files (the "Software"), to deal in the Software *
* without restriction, including without limitation the rights to use, copy, modify, *
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
* permit persons to whom the Software is furnished to do so, subject to the following *
* conditions: *
* *
* The above copyright notice and this permission notice shall be included in all copies *
* or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
****************************************************************************************/
#ifndef __OPENSPACE_MODULE_GLOBEBROWSING___ANGLE___H__
#define __OPENSPACE_MODULE_GLOBEBROWSING___ANGLE___H__
#include <ghoul/glm.h>
#include <memory>
#include <math.h>
namespace openspace {
namespace globebrowsing {
template <typename T>
class Angle {
public:
static const T PI;
static const T EPSILON;
/** = 0 radians = 0 degrees = no revolution */
static const Angle<T> ZERO;
/** = PI/2 radians = 90 degrees = quarter of a revolution */
static const Angle<T> QUARTER;
/** = PI radians = 180 degrees = half a revolution */
static const Angle<T> HALF;
/** = 2PI radians = 360 degrees = a full revolution */
static const Angle<T> FULL;
static Angle<T> fromRadians(T radians);
static Angle<T> fromDegrees(T degrees);
static Angle<T> fromRevolutions(T revs);
public:
/** Copy constructor */
Angle<T>(const Angle<T>& other);
private:
/** Private constructor. Use factory methods to avoid unit confusion */
Angle<T>(T rad);
public:
inline T asRadians() const;
inline T asDegrees() const;
inline T asRevolutions() const;
Angle<T> operator+(const Angle<T>& rhs) const;
Angle<T> operator-(const Angle<T>& rhs) const;
Angle<T> operator*(T rhs) const;
Angle<T> operator/(T rhs) const;
Angle<T> operator-() const;
void operator+=(const Angle<T>& rhs);
void operator-=(const Angle<T>& rhs);
void operator*=(T rhs);
void operator/=(T rhs);
bool operator<(const Angle<T>& rhs) const;
bool operator<=(const Angle<T>& rhs) const;
bool operator>(const Angle<T>& rhs) const;
bool operator>=(const Angle<T>& rhs) const;
bool operator==(const Angle<T>& rhs) const;
bool operator!=(const Angle<T>& rhs) const;
/**
* Normalizes the angle to the interval [0, 2pi[
*/
Angle<T>& normalize();
/**
* Normalizes the angle to the interval [center - pi, center + pi[
*/
Angle<T>& normalizeAround(const Angle<T>& center);
/**
* Clamps the angle to the interval [min, max].
* Default arguments are [0, 2pi].
*/
Angle<T>& clamp(const Angle<T>& min = ZERO, const Angle<T>& max = FULL);
Angle<T>& abs();
/**
* Returns a new angle normalized to the interval [0, 2pi[
*/
Angle<T> getNormalized() const;
/**
* Returns a new angle normalized to the interval [center - pi, center + pi[
*/
Angle<T> getNormalizedAround(const Angle<T>& center) const;
/**
* Returns a new angle clamped to the interval [min, max].
* Default arguments are [0, 2pi].
*/
Angle<T> getClamped(const Angle<T>& min = ZERO, const Angle<T>& max = FULL) const;
Angle<T> getAbs() const;
private:
T _radians;
};
using dAngle = Angle<double>;
using fAngle = Angle<float>;
} // namespace globebrowsing
} // namespace openspace
#include <modules/globebrowsing/geometry/angle.inl>
#endif // __OPENSPACE_MODULE_GLOBEBROWSING___ANGLE___H__