]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stencil.cc
Lilypond-book: Rewrite docs for MusicXML snippets
[lilypond.git] / lily / stencil.cc
index 12bbf4ea128f0f573a41ae1e9b7d1f6cabd5fbe4..25c7e15cf58c82592202100702659028e04ec166 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  stencil.cc -- implement Stencil
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  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/>.
 */
 
 #include "stencil.hh"
@@ -57,8 +68,8 @@ bool
 Stencil::is_empty () const
 {
   return (expr_ == SCM_EOL
-         || dim_[X_AXIS].is_empty ()
-         || dim_[Y_AXIS].is_empty ());
+          || dim_[X_AXIS].is_empty ()
+          || dim_[Y_AXIS].is_empty ());
 }
 
 SCM
@@ -76,45 +87,68 @@ Stencil::extent_box () const
 void
 Stencil::rotate (Real a, Offset off)
 {
-  rotate_degrees (a *180/M_PI, off); 
+  rotate_degrees (a * 180 / M_PI, off);
 }
 
 /*
-  Rotate this stencil around the point [x, y]
+  Rotate this stencil around the point ABSOLUTE_OFF.
+
  */
 void
-Stencil::rotate_degrees (Real a, Offset off)
+Stencil::rotate_degrees_absolute (Real a, Offset absolute_off)
 {
-  const Real x_cen = extent (X_AXIS).center ();
-  const Real y_cen = extent (Y_AXIS).center ();
-
-  /*
-   * Calculate the center of rotation
-   */
-  const Real x = x_cen + off[X_AXIS] * x_cen;
-  const Real y = y_cen + off[Y_AXIS] * y_cen;
+  const Real x = absolute_off[X_AXIS];
+  const Real y = absolute_off[Y_AXIS];
 
   /*
    * Build scheme expression (processed in stencil-interpret.cc)
    */
+  /* TODO: by hanwenn 2008/09/10 14:38:56:
+   * in effect, this copies the underlying expression.  It might be a
+   * little bit nicer to mirror this in the api, ie. make a
+   *         Stencil::rotated()
+   * and have Stencil::rotate be an abbrev of
+   *         *this = rotated()
+   */
+
   expr_ = scm_list_n (ly_symbol2scm ("rotate-stencil"),
-                     scm_list_2 (scm_from_double (a),
-                     scm_cons (scm_from_double (x), scm_from_double (y))),
-                     expr_, SCM_UNDEFINED);
+                      scm_list_2 (scm_from_double (a),
+                                  scm_cons (scm_from_double (x), scm_from_double (y))),
+                      expr_, SCM_UNDEFINED);
 
   /*
    * Calculate the new bounding box
    */
+  Box shifted_box = extent_box ();
+  shifted_box.translate (-absolute_off);
+
   vector<Offset> pts;
-  pts.push_back (Offset (-x_cen, -y_cen));
-  pts.push_back (Offset (x_cen, -y_cen));
-  pts.push_back (Offset (x_cen, y_cen));
-  pts.push_back (Offset (-x_cen, y_cen));
+  pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (DOWN)));
+  pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (DOWN)));
+  pts.push_back (Offset (shifted_box.x ().at (RIGHT), shifted_box.y ().at (UP)));
+  pts.push_back (Offset (shifted_box.x ().at (LEFT), shifted_box.y ().at (UP)));
 
   const Offset rot = complex_exp (Offset (0, a * M_PI / 180.0));
   dim_.set_empty ();
   for (vsize i = 0; i < pts.size (); i++)
-    dim_.add_point (pts[i] * rot + Offset (x_cen, y_cen));
+    dim_.add_point (pts[i] * rot + absolute_off);
+}
+
+/*
+  Rotate this stencil around the point RELATIVE_OFF.
+
+  RELATIVE_OFF is measured in terms of the extent of the stencil, so
+  -1 = LEFT/DOWN edge, 1 = RIGHT/UP edge.
+ */
+void
+Stencil::rotate_degrees (Real a, Offset relative_off)
+{
+  /*
+   * Calculate the center of rotation
+   */
+  const Real x = extent (X_AXIS).linear_combination (relative_off[X_AXIS]);
+  const Real y = extent (Y_AXIS).linear_combination (relative_off[Y_AXIS]);
+  rotate_degrees_absolute (a, Offset (x, y));
 }
 
 void
@@ -124,24 +158,24 @@ Stencil::translate (Offset o)
   while (a < NO_AXES)
     {
       if (isinf (o[a])
-         || isnan (o[a])
-
-         // ugh, hardcoded. 
-         || fabs (o[a]) > 1e6)
-       {
-         programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
-                            + "\n"
-                            + "Setting to zero.");
-         o[a] = 0.0;
-         if (strict_infinity_checking)
-           scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
-       }
+          || isnan (o[a])
+
+          // ugh, hardcoded.
+          || fabs (o[a]) > 1e6)
+        {
+          programming_error (String_convert::form_string ("Improbable offset for stencil: %f staff space", o[a])
+                             + "\n"
+                             + "Setting to zero.");
+          o[a] = 0.0;
+          if (strict_infinity_checking)
+            scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
+        }
       incr (a);
     }
 
   expr_ = scm_list_n (ly_symbol2scm ("translate-stencil"),
-                     ly_offset2scm (o),
-                     expr_, SCM_UNDEFINED);
+                      ly_offset2scm (o),
+                      expr_, SCM_UNDEFINED);
   if (!is_empty ())
     dim_.translate (o);
 }
@@ -154,6 +188,17 @@ Stencil::translate_axis (Real x, Axis a)
   translate (o);
 }
 
+void
+Stencil::scale (Real x, Real y)
+{
+  expr_ = scm_list_3 (ly_symbol2scm ("scale-stencil"),
+                      scm_list_2 (scm_from_double (x),
+                                  scm_from_double (y)),
+                      expr_);
+  dim_[X_AXIS] *= x;
+  dim_[Y_AXIS] *= y;
+}
+
 void
 Stencil::add_stencil (Stencil const &s)
 {
@@ -195,14 +240,14 @@ Stencil::add_at_edge (Axis a, Direction d, Stencil const &s, Real padding)
   Real his_extent;
   if (i.is_empty ())
     {
-      programming_error ("Stencil::moved_to_edge: adding empty stencil.");
+      programming_error ("Stencil::add_at_edge: adding empty stencil.");
       his_extent = 0.0;
     }
   else
     his_extent = i[-d];
 
   Real offset = (my_extent.is_empty () ? 0.0 : my_extent[d] - his_extent)
-    + d * padding;
+                + d * padding;
 
   Stencil toadd (s);
   toadd.translate_axis (offset, a);
@@ -213,11 +258,11 @@ Stencil
 Stencil::in_color (Real r, Real g, Real b) const
 {
   Stencil new_stencil (extent_box (),
-                      scm_list_3 (ly_symbol2scm ("color"),
-                                  scm_list_3 (scm_from_double (r),
-                                              scm_from_double (g),
-                                              scm_from_double (b)),
-                                  expr ()));
+                       scm_list_3 (ly_symbol2scm ("color"),
+                                   scm_list_3 (scm_from_double (r),
+                                               scm_from_double (g),
+                                               scm_from_double (b)),
+                                   expr ()));
   return new_stencil;
 }