Issue 4961/2: Add offset_directed (Real)

[lilypond.git] / flower / include / offset.hh

diff --git a/flower/include/offset.hh b/flower/include/offset.hh
index a782eb0507d5a85843d4923248c50690c6af25f4..c6c166cc428037cb1883363a5601a90d2ff68785 100644 (file)
--- a/flower/include/offset.hh
+++ b/flower/include/offset.hh
@@ -1,18 +1,28 @@
 /*
-  offset.hh -- part of GNU LilyPond
+  This file is part of LilyPond, the GNU music typesetter.
 
-  (c) 1996--2005 Han-Wen Nienhuys
+  Copyright (C) 1996--2015 Han-Wen Nienhuys
+
+  LilyPond 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 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef OFFSET_HH
 #define OFFSET_HH
 
-#include "axes.hh"
-#include "string.hh"
-
-Offset complex_multiply (Offset, Offset);
-Offset complex_divide (Offset, Offset);
-Offset complex_exp (Offset);
+#include "axis.hh"
+#include "std-string.hh"
+#include "real.hh"
 
 /*
   This is a mixture a 2D vector. Sometimes it can
@@ -24,24 +34,24 @@ class Offset
 public:
   Real coordinate_a_[NO_AXES];
 
-  Real &operator[] (Axis i)
+  Real &operator [] (Axis i)
   {
     return coordinate_a_[i];
   }
 
-  Real operator[] (Axis i) const
+  Real operator [] (Axis i) const
   {
     return coordinate_a_[i];
   }
 
-  Offset &operator+= (Offset o)
+  Offset &operator += (Offset o)
   {
     (*this)[X_AXIS] += o[X_AXIS];
     (*this)[Y_AXIS] += o[Y_AXIS];
     return *this;
   }
 
-  Offset operator- () const
+  Offset operator - () const
   {
     Offset o = *this;
 
@@ -50,7 +60,7 @@ public:
     return o;
   }
 
-  Offset &operator-= (Offset o)
+  Offset &operator -= (Offset o)
   {
     (*this)[X_AXIS] -= o[X_AXIS];
     (*this)[Y_AXIS] -= o[Y_AXIS];
@@ -66,7 +76,13 @@ public:
     return *this;
   }
 
-  Offset &operator*= (Real a)
+  Offset &operator /= (Real a)
+  {
+    (*this) *= 1 / a;
+    return *this;
+  }
+
+  Offset &operator *= (Real a)
   {
     (*this)[X_AXIS] *= a;
     (*this)[Y_AXIS] *= a;
@@ -76,47 +92,65 @@ public:
 
   Offset (Real ix, Real iy)
   {
-    coordinate_a_[X_AXIS] =ix;
-    coordinate_a_[Y_AXIS] =iy;
+    coordinate_a_[X_AXIS] = ix;
+    coordinate_a_[Y_AXIS] = iy;
   }
 
   Offset ()
   {
-    coordinate_a_[X_AXIS] = coordinate_a_[Y_AXIS]= 0.0;
+    coordinate_a_[X_AXIS] = coordinate_a_[Y_AXIS] = 0.0;
   }
 
-  String to_string () const;
+  string to_string () const;
 
   Offset &mirror (Axis a)
   {
     coordinate_a_[a] = -coordinate_a_[a];
     return *this;
   }
+  Offset direction () const;
+  Offset swapped () const;
 
   Real arg () const;
+  Real angle_degrees () const;
   Real length () const;
-
-  Offset operator*= (Offset z2)
-  {
-    *this = complex_multiply (*this, z2);
-    return *this;
-  }
-
+  bool is_sane () const;
+  Offset operator *= (Offset z2);
 };
 
+#include "arithmetic-operator.hh"
 IMPLEMENT_ARITHMETIC_OPERATOR (Offset, +);
 IMPLEMENT_ARITHMETIC_OPERATOR (Offset, -);
 IMPLEMENT_ARITHMETIC_OPERATOR (Offset, *);
 
+Offset complex_multiply (Offset, Offset);
+Offset complex_divide (Offset, Offset);
+Offset complex_exp (Offset);
+Offset offset_directed (Real);
+
 inline Offset
-operator* (Real o1, Offset o2)
+Offset::operator *= (Offset z2)
+{
+  *this = complex_multiply (*this, z2);
+  return *this;
+}
+
+inline Offset
+operator * (Real o1, Offset o2)
 {
   o2 *= o1;
   return o2;
 }
 
 inline Offset
-operator* (Offset o1, Real o2)
+operator / (Offset o1, Real a)
+{
+  o1 /= a;
+  return o1;
+}
+
+inline Offset
+operator * (Offset o1, Real o2)
 {
   o1 *= o2;
   return o1;
@@ -136,5 +170,13 @@ dot_product (Offset o1, Offset o2)
   return o1[X_AXIS] * o2[X_AXIS] + o1[Y_AXIS] * o2[Y_AXIS];
 }
 
+inline
+Real
+cross_product (Offset o1, Offset o2)
+{
+  return o1[X_AXIS] * o2[Y_AXIS] - o1[Y_AXIS] * o2[X_AXIS];
+}
+
+
 #endif /* OFFSET_HH */