]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/beam.cc
* VERSION (MY_PATCH_LEVEL): make 1.7.0
[lilypond.git] / lily / beam.cc
index 8c06658d4a5ef99390e6a43e9e43b5f25cb282e2..3b76c373b96178950c25993a77d275764ecdc75f 100644 (file)
@@ -11,9 +11,6 @@
 /*
 TODO:
 
-
-  * Junk stem_info.
-
   * Use Number_pair i.s.o Interval to represent (yl, yr).
   
   - Determine auto knees based on positions if it's set by the user.
@@ -70,9 +67,17 @@ Beam::add_stem (Grob *me, Grob *s)
 }
 
 
-/*
-  this returns the translation between 2 adjoining beams.
- */
+Real
+Beam::get_thickness (Grob * me)
+{
+  SCM th = me->get_grob_property ("thickness");
+  if (gh_number_p (th))
+    return gh_scm2double (th)* Staff_symbol_referencer::staff_space (me);
+  else
+    return 0.0;
+}
+
+/* Return the translation between 2 adjoining beams. */
 Real
 Beam::get_beam_translation (Grob *me)
 {
@@ -81,18 +86,15 @@ Beam::get_beam_translation (Grob *me)
   return gh_scm2double (s);
 }
 
-/*
-  Maximum beam_count.
- */
+/* Maximum beam_count. */
 int
 Beam::get_beam_count (Grob *me) 
 {
   int m = 0;
   for (SCM s = me->get_grob_property ("stems"); gh_pair_p (s); s = ly_cdr (s))
     {
-      Grob *sc = unsmob_grob (ly_car (s));
-      
-      m = m >? (Stem::beam_multiplicity (sc).length () + 1);
+      Grob *stem = unsmob_grob (ly_car (s));
+      m = m >? (Stem::beam_multiplicity (stem).length () + 1);
     }
   return m;
 }
@@ -105,8 +107,7 @@ Beam::space_function (SCM smob, SCM beam_count)
   
   Real staff_space = Staff_symbol_referencer::staff_space (me);
   Real line = me->get_paper ()->get_var ("linethickness");
-  Real thickness = gh_scm2double (me->get_grob_property ("thickness"))
-    * staff_space;
+  Real thickness = get_thickness (me);
   
   Real beam_translation = gh_scm2int (beam_count) < 4
     ? (2*staff_space + line - thickness) / 2.0
@@ -146,7 +147,7 @@ Beam::before_line_breaking (SCM smob)
        {
          me->warning (_ ("Beam has less than two stems. Removing beam."));
 
-         unsmob_grob (gh_car (stems))->remove_grob_property ("beam");
+         unsmob_grob (gh_car (stems))->set_grob_property ("beam", SCM_EOL);
          me->suicide ();
 
          return SCM_UNSPECIFIED;
@@ -324,7 +325,7 @@ Beam::brew_molecule (SCM grob)
   Real dy = pos.delta ();
   Real dydx = dy && dx ? dy/dx : 0;
   
-  Real thick = gh_scm2double (me->get_grob_property ("thickness"));
+  Real thick = get_thickness (me);
   Real bdy = get_beam_translation (me);
 
   SCM last_beaming = SCM_EOL;;
@@ -539,25 +540,12 @@ Beam::set_stem_directions (Grob *me, Direction d)
   for (int i=0; i <stems.size (); i++)
     {
       Grob *s = stems[i];
-      /* For knees, non-forced stems should probably have their
-        natural direction. In any case, when knee, beam direction is
-        foe.
-        
-        TODO: for x staff knees, set direction pointing to 'the
-        other' staff, rather than natural.
-      */
-      if (knee_b(me))
-       {
-         Stem::get_direction (s); // this actually sets it, if necessary
-       }
-      else
-       {
-         SCM force = s->remove_grob_property ("dir-forced");
-         if (!gh_boolean_p (force) || !gh_scm2bool (force))
-           Directional_element_interface::set (s, d);
-       }
+  
+      SCM forcedir = s->get_grob_property ("direction");
+      if (!to_dir (forcedir))
+       Directional_element_interface::set (s, d);
     }
-} 
+}
 
 /*
   A union of intervals in the real line.
@@ -649,20 +637,25 @@ Beam::consider_auto_knees (Grob* me)
       Grob* stem = stems[i];
       if (Stem::invisible_b (stem))
        continue;
-      
 
       Interval hps = Stem::head_positions (stem);
-
       if(!hps.empty_b())
        {
          hps[LEFT] += -1;
          hps[RIGHT] += 1; 
          hps *= staff_space * 0.5 ;
+
+         /*
+           We could subtract beam Y position, but this routine only
+           sets stem directions, a constant shift does not have an
+           influence.
+           
+          */
          hps += stem->relative_coordinate (common, Y_AXIS);
-      
-         if (to_boolean (stem->get_grob_property ("dir-forced")))
+
+         if (to_dir (stem->get_grob_property ("direction")))
            {
-             Direction stemdir =Directional_element_interface::get (stem);
+             Direction stemdir = to_dir (stem->get_grob_property ("direction"));
              hps[-stemdir] = - stemdir * infinity_f;
            }
        }
@@ -707,12 +700,6 @@ Beam::consider_auto_knees (Grob* me)
            UP : DOWN ;
          
          stem->set_grob_property ("direction", scm_int2num (d));
-
-         /*
-           UGH. Check why we still need dir-forced; I think we can
-           junk it.
-          */
-         stem->set_grob_property ("dir-forced", SCM_BOOL_T);
          
          hps.intersect (max_gap);
          assert (hps.empty_b () || hps.length () < 1e-6 );
@@ -741,19 +728,19 @@ Beam::set_stem_shorten (Grob *me)
   if (knee_b(me))
     return ;
   
-  Real forced_fraction = forced_stem_count (me) / visible_stem_count (me);
+  Real forced_fraction = 1.0 * forced_stem_count (me)
+    / visible_stem_count (me);
 
   int beam_count = get_beam_count (me);
 
-  SCM shorten = me->get_grob_property ("beamed-stem-shorten");
-  if (shorten == SCM_EOL)
+  SCM shorten_list = me->get_grob_property ("beamed-stem-shorten");
+  if (shorten_list == SCM_EOL)
     return;
 
-  int sz = scm_ilength (shorten);
-  
   Real staff_space = Staff_symbol_referencer::staff_space (me);
-  SCM shorten_elt = scm_list_ref (shorten,
-                                 scm_int2num (beam_count <? (sz - 1)));
+  
+  SCM shorten_elt =
+    robust_list_ref (beam_count -1, shorten_list);
   Real shorten_f = gh_scm2double (shorten_elt) * staff_space;
 
   /* your similar cute comment here */
@@ -817,9 +804,9 @@ Beam::least_squares (SCM smob)
   Grob *fvs  = first_visible_stem (me);
   Grob *lvs  = last_visible_stem (me);
   
-  Interval ideal (Stem::calc_stem_info (fvs).ideal_y_
+  Interval ideal (Stem::get_stem_info (fvs).ideal_y_
                  + fvs->relative_coordinate (commony, Y_AXIS) -my_y,
-                 Stem::calc_stem_info (lvs).ideal_y_
+                 Stem::get_stem_info (lvs).ideal_y_
                  + lvs->relative_coordinate (commony, Y_AXIS) - my_y);
   
   Real x0 = first_visible_stem (me)->relative_coordinate (commonx, X_AXIS);
@@ -841,23 +828,18 @@ Beam::least_squares (SCM smob)
       Interval chord (Stem::chord_start_y (first_visible_stem (me)),
                      Stem::chord_start_y (last_visible_stem (me)));
 
+      /* Simple beams (2 stems) on middle line should be allowed to be
+        slightly sloped.
+        
+        However, if both stems reach middle line,
+        ideal[LEFT] == ideal[RIGHT] and ideal.delta () == 0.
 
-      /*
-       TODO -- use scoring for this.
-
-       complicated, because we take stem-info.ideal for determining
-       beam slopes.
-       */
-      /* Make simple beam on middle line have small tilt */
+        For that case, we apply artificial slope */
       if (!ideal[LEFT] && chord.delta () && count == 2)
        {
-
-         /*
-           FIXME. -> UP
-         */
+         /* FIXME. -> UP */
          Direction d = (Direction) (sign (chord.delta ()) * UP);
          pos[d] = gh_scm2double (me->get_grob_property ("thickness")) / 2;
-         //                * dir;
          pos[-d] = - pos[d];
        }
       else
@@ -878,7 +860,7 @@ Beam::least_squares (SCM smob)
          if (Stem::invisible_b (s))
            continue;
          ideals.push (Offset (x_posns[i],
-                              Stem::calc_stem_info (s).ideal_y_
+                              Stem::get_stem_info (s).ideal_y_
                               + s->relative_coordinate (commony, Y_AXIS)
                               - my_y));
        }
@@ -954,7 +936,7 @@ Beam::shift_region_to_valid (SCM grob)
       Direction d = Stem::get_direction (s);
 
       Real left_y =
-       Stem::calc_stem_info (s).shortest_y_
+       Stem::get_stem_info (s).shortest_y_
        - dydx * x_posns [i];
 
       /*
@@ -1171,10 +1153,8 @@ where_are_the_whole_beams(SCM beaming)
   return l;
 }
 
-/*
-  Calculate the Y position of the stem-end, given the Y-left, Y-right
-  in POS for stem S. This Y position is relative to S.
- */
+/* Return the Y position of the stem-end, given the Y-left, Y-right
+   in POS for stem S.  This Y position is relative to S. */
 Real
 Beam::calc_stem_y (Grob *me, Grob* s, Grob ** common,
                   Real xl, Real xr,
@@ -1243,8 +1223,7 @@ Beam::set_stem_lengths (Grob *me)
       &&gh_scm2double (me->get_grob_property ("gap")))
   {
     gap = true;
-    thick = gh_scm2double (me->get_grob_property ("thickness"))
-      * Staff_symbol_referencer::staff_space(me);
+    thick = get_thickness(me);
   }
       
   // ugh -> use commonx
@@ -1321,7 +1300,9 @@ Beam::forced_stem_count (Grob *me)
       if (Stem::invisible_b (s))
        continue;
 
-      if (((int)Stem::chord_start_y (s)) 
+      /* I can imagine counting those boundaries as a half forced stem,
+        but let's count them full for now. */
+      if (abs (Stem::chord_start_y (s)) > 0.1
         && (Stem::get_direction (s) != Stem::get_default_dir (s)))
         f++;
     }
@@ -1506,6 +1487,6 @@ the ideal slope, how close the result is to the ideal stems, etc.). We
 take the best scoring combination.
 
 ",
-  "french-beaming position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");
+  "knee french-beaming position-callbacks concaveness-gap concaveness-threshold dir-function quant-score auto-knee-gap gap chord-tremolo beamed-stem-shorten shorten least-squares-dy damping flag-width-function neutral-direction positions space-function thickness");