Refactor Canvas and add some helpers.

[simgear.git] / simgear / math / SGMisc.hxx

diff --git a/simgear/math/SGMisc.hxx b/simgear/math/SGMisc.hxx
index 9540dd0343259ab751c5b7522513631deff9faa4..8eaa124e27704eca149bf7f8c912fcd661670aba 100644 (file)
--- a/simgear/math/SGMisc.hxx
+++ b/simgear/math/SGMisc.hxx
@@ -18,12 +18,12 @@
 #ifndef SGMisc_H
 #define SGMisc_H
 
-#include <cmath>
-
 template<typename T>
 class SGMisc {
 public:
   static T pi() { return T(3.1415926535897932384626433832795029L); }
+  static T twopi() { return 2*T(3.1415926535897932384626433832795029L); }
+
   static T min(const T& a, const T& b)
   { return a < b ? a : b; }
   static T min(const T& a, const T& b, const T& c)
@@ -36,6 +36,11 @@ public:
   { return max(max(a, b), c); }
   static T max(const T& a, const T& b, const T& c, const T& d)
   { return max(max(max(a, b), c), d); }
+
+  // clip the value of a to be in the range between and including _min and _max
+  static T clip(const T& a, const T& _min, const T& _max)
+  { return max(_min, min(_max, a)); }
+
   static int sign(const T& a)
   {
     if (a < -SGLimits<T>::min())
@@ -51,7 +56,42 @@ public:
   static T deg2rad(const T& val)
   { return val*pi()/180; }
 
-#ifndef NDEBUG
+  // normalize the value to be in a range between [min, max[
+  static T
+  normalizePeriodic(const T& min, const T& max, const T& value)
+  {
+    T range = max - min;
+    if (range < SGLimits<T>::min())
+      return min;
+    T normalized = value - range*floor((value - min)/range);
+    // two security checks that can only happen due to roundoff
+    if (normalized <= min)
+      return min;
+    if (max <= normalized)
+      return min;
+    return normalized;
+  }
+
+  // normalize the angle to be in a range between [-pi, pi[
+  static T
+  normalizeAngle(const T& angle)
+  { return normalizePeriodic(-pi(), pi(), angle); }
+
+  // normalize the angle to be in a range between [0, 2pi[
+  static T
+  normalizeAngle2(const T& angle)
+  { return normalizePeriodic(0, twopi(), angle); }
+
+  static T round(const T& v)
+  { return floor(v + T(0.5)); }
+  static int roundToInt(const T& v)
+  { return int(round(v)); }
+
+  // Linear interpolation between two arbitrary typed values
+  template<typename S>
+  static S lerp(const S& val0, const S& val1, const T& t)
+  { return val0*(T(1) - t) + val1*t; }
+
   /// Returns true if v is a NaN value
   /// Use with care: allways code that you do not need to use that!
   static bool isNaN(const T& v)
@@ -68,10 +108,6 @@ public:
     return !(v == v);
 #endif
   }
-#endif
 };
 
-typedef SGMisc<float> SGMiscf;
-typedef SGMisc<double> SGMiscd;
-
 #endif