]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/cluster.cc
* lily/dots.cc (print): replace -
[lilypond.git] / lily / cluster.cc
index 79c7cbf09ea26c571554ed60f789cab70a86a3fb..5eee6ee6db2bfd53413d507995c15b976aef6bdd 100644 (file)
@@ -3,61 +3,56 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2002--2003 Juergen Reuter <reuter@ipd.uka.de>
+  (c) 2002--2004 Juergen Reuter <reuter@ipd.uka.de>
 
   Han-Wen Nienhuys <hanwen@cs.uu.nl>
 
 */
 
-#include <stdio.h>
 #include "cluster.hh"
-#include "grob.hh"
+
+#include <cstdio>
+
 #include "spanner.hh"
 #include "item.hh"
 #include "pitch.hh"
 #include "staff-symbol-referencer.hh"
 #include "lookup.hh"
-#include "box.hh"
-#include "interval.hh"
-#include "paper-def.hh"
-#include "paper-column.hh"
-#include "note-column.hh"
+#include "output-def.hh"
+#include "warn.hh"
+
 
 /*
- * TODO: Add support for cubic spline segments.
+   TODO: Add support for cubic spline segments.
+
  */
-Molecule
+Stencil
 brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_points)
 {
-#if 0
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
-#else
   Real blotdiameter = Staff_symbol_referencer::staff_space (me)/2;
-#endif
 
-  Real padding;
-  SCM padding_scm = me->get_grob_property ("padding");
-  if (gh_number_p (padding_scm))
-    padding = gh_scm2double (padding_scm);
-  else
-    padding = 0.0;
+  Real padding = robust_scm2double ( me->get_property ("padding"), 0.0);
+
   Offset vpadding = Offset (0, padding);
   Offset hpadding = Offset (0.5 * blotdiameter, 0);
   Offset hvpadding = 0.5 * hpadding + vpadding;
 
-  SCM shape_scm = me->get_grob_property ("shape");
+  SCM shape_scm = me->get_property ("style");
   String shape;
-  if (gh_symbol_p (shape_scm))
+
+  if (scm_is_symbol (shape_scm))
     {
       shape = ly_symbol2string (shape_scm);
     }
   else
     {
-      shape = "leftsided-stairs";
+      programming_error ("#'style should be symbol.");
+      me->suicide ();
+      return  Stencil ();
     }
 
 
-  Molecule out = Molecule ();
+  Stencil out;
   Array<Offset> points;
   points.clear ();
   int size = bottom_points.size ();
@@ -67,9 +62,9 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
        {
          Box box;
          box.add_point (bottom_points[i] - hvpadding);
-         box.add_point (Offset(top_points[i + 1][X_AXIS],
+         box.add_point (Offset (top_points[i + 1][X_AXIS],
                                top_points[i][Y_AXIS]) + hvpadding);
-         out.add_molecule (Lookup::roundfilledbox (box, blotdiameter));
+         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
        }
     }
   else if (String::compare (shape, "rightsided-stairs") == 0)
@@ -77,10 +72,10 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
       for (int i = 0; i < size - 1; i++)
        {
          Box box;
-         box.add_point (Offset(bottom_points[i][X_AXIS],
+         box.add_point (Offset (bottom_points[i][X_AXIS],
                                bottom_points[i + 1][Y_AXIS]) - hvpadding);
          box.add_point (top_points[i + 1] + hvpadding);
-         out.add_molecule (Lookup::roundfilledbox (box, blotdiameter));
+         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
        }
     }
   else if (String::compare (shape, "centered-stairs") == 0)
@@ -95,7 +90,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
                         hvpadding);
          box.add_point (Offset (right_xmid, top_points[i][Y_AXIS]) +
                         hvpadding);
-         out.add_molecule (Lookup::roundfilledbox (box, blotdiameter));
+         out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
          left_xmid = right_xmid;
        }
       Real right_xmid = bottom_points[size - 1][X_AXIS];
@@ -104,7 +99,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
                     hvpadding);
       box.add_point (Offset (right_xmid, top_points[size - 1][Y_AXIS]) +
                     hvpadding);
-      out.add_molecule (Lookup::roundfilledbox (box, blotdiameter));
+      out.add_stencil (Lookup::round_filled_box (box, blotdiameter));
     }
   else if (String::compare (shape, "ramp") == 0)
     {
@@ -120,56 +115,63 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
          points.push (top_points[i] + vpadding);
        }
       points.push (top_points[0] + vpadding + hpadding);
-      out.add_molecule (Lookup::round_filled_polygon (points, blotdiameter));
+      out.add_stencil (Lookup::round_filled_polygon (points, blotdiameter));
     }
   else
     {
-      me->warning (_f ("unknown cluster shape `%s'", shape.to_str0 ()));
+      me->warning (_f ("unknown cluster style `%s'", shape.to_str0 ()));
     }
   return out;
 }
 
-MAKE_SCHEME_CALLBACK (Cluster,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Cluster,print,1);
 SCM
-Cluster::brew_molecule (SCM smob)
+Cluster::print (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
 
   Spanner *spanner = dynamic_cast<Spanner*> (me);
   if (!spanner)
     {
-      me->programming_error ("Cluster::brew_molecule(): not a spanner");
+      me->programming_error ("Cluster::print (): not a spanner");
       return SCM_EOL;
     }
 
   Item *left_bound = spanner->get_bound (LEFT);
   Item *right_bound = spanner->get_bound (RIGHT);
 
-  Grob *common = left_bound->common_refpoint (right_bound, X_AXIS);
-  SCM cols  =me->get_grob_property ("columns");
-  if (!gh_pair_p (cols))
+  Grob *commonx = left_bound->common_refpoint (right_bound, X_AXIS);
+  SCM cols  = me->get_property ("columns");
+
+  if (!scm_is_pair (cols))
     {
       me->warning ("junking empty cluster");
       me->suicide ();
       
       return SCM_EOL;
     }
-  common = common_refpoint_of_list (cols, common, X_AXIS);
+  
+  commonx = common_refpoint_of_list (cols, commonx, X_AXIS);
+  Grob * commony = common_refpoint_of_list (cols, me, Y_AXIS);
   Array<Offset> bottom_points;
   Array<Offset> top_points;
 
 
-  Real left_coord = left_bound->relative_coordinate (common, X_AXIS);
+  Real left_coord = left_bound->relative_coordinate (commonx, X_AXIS);
 
-  for (SCM s = cols; gh_pair_p (s); s = ly_cdr (s))
+  /*
+    TODO: should we move the cluster a little to the right to be in
+    line with the center of the note heads?
+    
+   */
+  for (SCM s = cols; scm_is_pair (s); s = scm_cdr (s))
     {
-      Grob * col = unsmob_grob (ly_car (s));
-      Slice s = Note_column::head_positions_interval (col);
-      Grob * h = Note_column::first_head (col);
+      Grob * col = unsmob_grob (scm_car (s));
+      Interval yext = col->extent (commony, Y_AXIS);
 
-      Real x = h->relative_coordinate (common, X_AXIS) - left_coord;
-      bottom_points.push (Offset (x, s[DOWN] *0.5));
-      top_points.push (Offset (x, s[UP] * 0.5));
+      Real x = col->relative_coordinate (commonx, X_AXIS) - left_coord;
+      bottom_points.push (Offset (x, yext[DOWN]));
+      top_points.push (Offset (x, yext[UP]));
     }
 
   /*
@@ -179,18 +181,20 @@ Cluster::brew_molecule (SCM smob)
     {
       Spanner *orig = dynamic_cast<Spanner*> (spanner->original_);
       
-      if (spanner->break_index_ < orig->broken_intos_.size()-1)
+      if (spanner->get_break_index () < orig->broken_intos_.size ()-1)
        {
-         Spanner * next = orig->broken_intos_[spanner->break_index_+1];
-         SCM cols = next->get_grob_property ("columns");
-         if (gh_pair_p (cols))
+         Spanner * next = orig->broken_intos_[spanner->get_break_index () + 1];
+         SCM cols = next->get_property ("columns");
+         if (scm_is_pair (cols))
            {
-             Grob * col = unsmob_grob (ly_car (scm_last_pair (cols)));
-             Slice s = Note_column::head_positions_interval (col);
-             Real x = right_bound->relative_coordinate (common,X_AXIS) - left_coord;
+             Grob *next_commony = common_refpoint_of_list (cols, next, Y_AXIS);
+             Grob * col = unsmob_grob (scm_car (scm_last_pair (cols)));
+
+             Interval v = col->extent (next_commony, Y_AXIS);
+             Real x = right_bound->relative_coordinate (commonx, X_AXIS) - left_coord;
              
-             bottom_points.insert (Offset (x, s[DOWN] * 0.5),0);
-             top_points.insert (Offset (x, s[UP] * 0.5),0);
+             bottom_points.insert (Offset (x, v[DOWN]),0);
+             top_points.insert (Offset (x, v[UP]),0);
            }
        }
     }
@@ -198,10 +202,45 @@ Cluster::brew_molecule (SCM smob)
   bottom_points.reverse ();
   top_points.reverse ();
 
-  Molecule out = brew_cluster_piece (me, bottom_points, top_points);
+  Stencil out = brew_cluster_piece (me, bottom_points, top_points);
+  out.translate_axis (- me->relative_coordinate (commony, Y_AXIS), Y_AXIS);
   return out.smobbed_copy ();
 }
 
 ADD_INTERFACE (Cluster,"cluster-interface",
-  "A graphically drawn musical cluster.",
-  "shape padding columns");
+              "A graphically drawn musical cluster. " 
+              "\n\n"
+              "@code{padding} adds to the vertical extent of the shape (top and "
+              "bottom). \n\n"
+              "The property @code{style} controls the shape of cluster segments.  Valid values "
+              "include @code{leftsided-stairs}, @code{rightsided-stairs}, @code{centered-stairs}, "
+              "and @code{ramp}.\n"
+,
+  "style padding columns");
+
+
+
+struct Cluster_beacon
+{
+public:
+  DECLARE_SCHEME_CALLBACK (height, (SCM, SCM));
+  static bool has_interface (Grob *);
+};
+
+MAKE_SCHEME_CALLBACK (Cluster_beacon,height,2);
+SCM
+Cluster_beacon::height (SCM g, SCM)
+{
+  Grob *me = unsmob_grob (g);
+  Interval v = robust_scm2interval (me->get_property ("positions"),
+                                   Interval (0,0));
+  return ly_interval2scm (Staff_symbol_referencer::staff_space (me) * 0.5 * v);
+}
+
+
+
+ADD_INTERFACE(Cluster_beacon,
+             "cluster-beacon-interface",
+             "A place holder for the cluster spanner to determine the vertical "
+             "extents of a cluster spanner at this X position.",
+             "positions");