]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/cluster.cc
* mf/GNUmakefile: always trace pfa fonts.
[lilypond.git] / lily / cluster.cc
index 79c7cbf09ea26c571554ed60f789cab70a86a3fb..a6caf0a7d5b15fa9c91bd9156e2b9939b2af4b8a 100644 (file)
@@ -10,8 +10,8 @@
 */
 
 #include <stdio.h>
+
 #include "cluster.hh"
-#include "grob.hh"
 #include "spanner.hh"
 #include "item.hh"
 #include "pitch.hh"
 #include "box.hh"
 #include "interval.hh"
 #include "paper-def.hh"
-#include "paper-column.hh"
-#include "note-column.hh"
+#include "warn.hh"
+
 
 /*
- * TODO: Add support for cubic spline segments.
+   TODO: Add support for cubic spline segments.
+
  */
 Molecule
 brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_points)
 {
 #if 0
-  Real blotdiameter = me->get_paper ()->get_var ("blotdiameter");
+  Real blotdiameter = me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
 #else
   Real blotdiameter = Staff_symbol_referencer::staff_space (me)/2;
 #endif
@@ -45,15 +46,18 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
   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_grob_property ("style");
   String shape;
+
   if (gh_symbol_p (shape_scm))
     {
       shape = ly_symbol2string (shape_scm);
     }
   else
     {
-      shape = "leftsided-stairs";
+      programming_error ("#'style should be symbol.");
+      me->suicide();
+      return  Molecule();
     }
 
 
@@ -69,7 +73,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
          box.add_point (bottom_points[i] - hvpadding);
          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_molecule (Lookup::round_filled_box (box, blotdiameter));
        }
     }
   else if (String::compare (shape, "rightsided-stairs") == 0)
@@ -80,7 +84,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
          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_molecule (Lookup::round_filled_box (box, blotdiameter));
        }
     }
   else if (String::compare (shape, "centered-stairs") == 0)
@@ -95,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[i][Y_AXIS]) +
                         hvpadding);
-         out.add_molecule (Lookup::roundfilledbox (box, blotdiameter));
+         out.add_molecule (Lookup::round_filled_box (box, blotdiameter));
          left_xmid = right_xmid;
        }
       Real right_xmid = bottom_points[size - 1][X_AXIS];
@@ -104,7 +108,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_molecule (Lookup::round_filled_box (box, blotdiameter));
     }
   else if (String::compare (shape, "ramp") == 0)
     {
@@ -124,7 +128,7 @@ brew_cluster_piece (Grob *me, Array<Offset> bottom_points, Array<Offset> top_poi
     }
   else
     {
-      me->warning (_f ("unknown cluster shape `%s'", shape.to_str0 ()));
+      me->warning (_f ("unknown cluster style `%s'", shape.to_str0 ()));
     }
   return out;
 }
@@ -147,6 +151,7 @@ Cluster::brew_molecule (SCM smob)
 
   Grob *common = left_bound->common_refpoint (right_bound, X_AXIS);
   SCM cols  =me->get_grob_property ("columns");
+
   if (!gh_pair_p (cols))
     {
       me->warning ("junking empty cluster");
@@ -161,15 +166,27 @@ Cluster::brew_molecule (SCM smob)
 
   Real left_coord = left_bound->relative_coordinate (common, X_AXIS);
 
+  Real unit = Staff_symbol_referencer::staff_space (me) *0.5;
+
+  /*
+    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; gh_pair_p (s); s = ly_cdr (s))
     {
       Grob * col = unsmob_grob (ly_car (s));
-      Slice s = Note_column::head_positions_interval (col);
-      Grob * h = Note_column::first_head (col);
 
-      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));
+      SCM posns = col->get_grob_property ("positions");
+      
+      Slice s (0,0);
+      if (is_number_pair (posns))
+       s = Slice (gh_scm2int (gh_car (posns)),
+                  gh_scm2int (gh_cdr (posns)));
+
+      Real x = col->relative_coordinate (common, X_AXIS) - left_coord;
+      bottom_points.push (Offset (x, s[DOWN] *unit));
+      top_points.push (Offset (x, s[UP] * unit));
     }
 
   /*
@@ -186,11 +203,17 @@ Cluster::brew_molecule (SCM smob)
          if (gh_pair_p (cols))
            {
              Grob * col = unsmob_grob (ly_car (scm_last_pair (cols)));
-             Slice s = Note_column::head_positions_interval (col);
+             SCM posns = col->get_grob_property ("positions");
+      
+             Slice s (0,0);
+             if (is_number_pair (posns))
+               s = Slice (gh_scm2int (gh_car (posns)),
+                          gh_scm2int (gh_cdr (posns)));
+
              Real x = right_bound->relative_coordinate (common,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, s[DOWN] * unit),0);
+             top_points.insert (Offset (x, s[UP] * unit),0);
            }
        }
     }
@@ -203,5 +226,16 @@ Cluster::brew_molecule (SCM smob)
 }
 
 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) and is expressed in units of staffspace.  Since the pitch "
+"range of a single pitch is infinitely small, if padding is set to "
+"@code{0.0}, this possibly results in an invisible shape, if you,for "
+"example, say @code{c-\\startCluster d e-\\endCluster}.  The default "
+"value for @code{padding} therefore is @code{0.25}, such that a single "
+"pitch roughly shows the same height as a note head. "
+"\n\n"
+"@code{style} controls the shape of cluster segments.  Valid values include 'leftsided-stairs', 'rightsided-stairs', 'centered-stairs', and 'ramp'.\n"
+,
+  "style padding columns");