]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-spacing.cc
Run `make grand-replace'.
[lilypond.git] / lily / staff-spacing.cc
index 2919602843f32ccdc15bff7de1ea719211d93da3..4e92bfce649282b51dc61a12bfa015b2ace7096a 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2007  Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2001--2008  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "staff-spacing.hh"
@@ -19,39 +19,17 @@ using namespace std;
 #include "staff-symbol-referencer.hh"
 #include "note-column.hh"
 #include "stem.hh"
+#include "spacing-interface.hh"
 #include "accidental-placement.hh"
 #include "pointer-group-interface.hh"
 #include "directional-element-interface.hh"
 
-Real
-Staff_spacing::left_stickout (Grob *me, Grob *g)
-{
-  if (!g || !Note_column::has_interface (g))
-    return 0;
-
-  Item *col = dynamic_cast<Item *> (g)->get_column ();
-  Real ret = max (0., (- g->extent (col, X_AXIS)[LEFT]));
-
-  /*
-    Duh. If this gets out of hand, we should invent something more generic.
-  */
-  Grob *accs = Note_column::accidentals (g);
-  if (accs)
-    {
-      Interval v;
-      if (Accidental_placement::has_interface (accs))
-       v = Accidental_placement::get_relevant_accidental_extent (accs, col, me);
-      else
-       v = accs->extent (col, X_AXIS);
-      
-      ret = max (ret, (- v[LEFT]));
-    }
-  Grob *arpeggio = unsmob_grob (g->get_object ("arpeggio"));
-  if (arpeggio)
-    ret = max (ret, - arpeggio->extent (col, X_AXIS)[LEFT]);
+/* A stem following a bar-line creates an optical illusion similar to the
+   one mentioned in note-spacing.cc. We correct for it here.
 
-  return ret;
-}
+   TODO: should we still correct if there are accidentals/arpeggios before
+   the stem?
+*/
 
 Real
 Staff_spacing::optical_correction (Grob *me, Grob *g, Interval bar_height)
@@ -113,83 +91,38 @@ Staff_spacing::bar_y_positions (Grob *bar_grob)
   return bar_size;
 }
 
-/*
-  Do corrections for the following notes.
-
-  This is slightly convoluted, since the staffspacing grob gets
-  pointers to the separation-items, not the note-columns or
-  note-spacings.
-*/
-
 Real
 Staff_spacing::next_notes_correction (Grob *me,
-                                     Grob *last_grob,
-                                     Real current_fixed,
-                                     Real right_stickout)
+                                     Grob *last_grob)
 {
   Interval bar_size = bar_y_positions (last_grob);
   Grob *orig = me->original () ? me->original () : me;
+  vector<Item*> note_columns = Spacing_interface::right_note_columns (orig);
 
-  extract_grob_set (orig, "right-items", right_items);
-
-  Real max_left_stickout = 0.0;
   Real max_optical = 0.0;
 
-  for (vsize i = right_items.size (); i--;)
-    {
-      Grob *g = right_items[i];
-      if (Note_column::has_interface (right_items[i]))
-       {
-         max_left_stickout = max (max_left_stickout, left_stickout (me, g));
-         max_optical = max (max_optical, optical_correction (me, g, bar_size));
-       }
-      else
-       {
-         extract_grob_set (g, "elements", elts);
-         for (vsize j = elts.size (); j--;)
-           {
-             max_left_stickout = max (max_left_stickout, left_stickout (me, elts[j]));
-             max_optical = max (max_optical, optical_correction (me, g, bar_size));
-           }
-       }
-    }
+  for (vsize i = 0; i < note_columns.size (); i++)
+    max_optical = max (max_optical, optical_correction (me, note_columns[i], bar_size));
 
-  /* we put a minimum distance of 0.3 between the right edge of the left grob and
-     the left edge of the right grob */
-  max_left_stickout = max (0.0, max_left_stickout + right_stickout + 0.3 - current_fixed);
-  return max (max_left_stickout, max_optical);
+  return max_optical;
 }
 
-/* This routine does not impose any minimum distances between columns; it only
-   affects springs. As such, the FIXED variable does not refer to a minimum
-   distance between columns, but instead to a minimum desired distance between
-   columns -- this ends up affecting the stiffness of a spring. In fact, FIXED
-   will be the distance between columns if there is a compression force of 1.0
-   applied to the line. */
+/* We calculate three things here: the ideal distance, the minimum distance
+   (which is the distance at which collisions will occur) and the "fixed"
+   distance, which is the distance at which things start to look really bad.
+   We arrange things so that the fixed distance will be attained when the
+   line is compressed with a force of 1.0 */
 Spring
-Staff_spacing::get_spacing_params (Grob *me)
+Staff_spacing::get_spacing (Grob *me, Grob *right_col)
 {
-  Grob *separation_item = 0;
   Item *me_item = dynamic_cast<Item *> (me);
-
-  extract_grob_set (me, "left-items", items);
-  for (vsize i = items.size (); i--;)
-    {
-      Grob *cand = items[i];
-      if (cand && Separation_item::has_interface (cand))
-       separation_item = cand;
-    }
-
-  //  printf ("doing col %d\n" , Paper_column::get_rank (left_col));
-  if (!separation_item)
-    {
-      programming_error ("no sep item");
-      return Spring ();
-    }
+  Grob *left_col = me_item->get_column ();
 
   Interval last_ext;
-  Grob *last_grob = Separation_item::extremal_break_aligned_grob (separation_item, RIGHT,
-                                                                 &last_ext);
+  Direction break_dir = me_item->break_status_dir ();
+  Grob *last_grob = Spacing_interface::extremal_break_aligned_grob (me, LEFT,
+                                                                   break_dir,
+                                                                   &last_ext);
   if (!last_grob)
     {
       /*
@@ -251,21 +184,26 @@ Staff_spacing::get_spacing_params (Grob *me)
       ideal = fixed;
     }
 
-  Real correction = next_notes_correction (me, last_grob, fixed, last_ext[RIGHT]);
+
+  Real optical_correction = next_notes_correction (me, last_grob);
+  Real min_dist = Paper_column::minimum_distance (left_col, right_col);
+
+  /* ensure that the "fixed" distance will leave a gap of at least 0.3 ss. */
+  Real min_dist_correction = max (0.0, 0.3 + min_dist - fixed);
+  Real correction = max (optical_correction, min_dist_correction);
+
   fixed += correction;
   ideal += correction;
 
-  Spring ret;
-  ret.min_distance_ = 0.0;
-  ret.distance_ = ideal;
-  ret.inverse_stretch_strength_ = ret.inverse_compress_strength_ = ideal - fixed;
+  Spring ret (ideal, min_dist);
+  ret.set_inverse_stretch_strength (max (0.0, ideal - fixed));
   return ret;
 }
 
 ADD_INTERFACE (Staff_spacing,
-              "This object calculates spacing details from a "
-              " breakable symbol (left) to another object. For example, it takes care "
-              " of  optical spacing from  a bar lines to a note.",
+              "This object calculates spacing details from a breakable"
+              " symbol (left) to another object.  For example, it takes care"
+              " of optical spacing from a bar line to a note.",
 
               /* properties */
               "stem-spacing-correction "