]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/align-interface.cc
Doc-de: updates for Usage
[lilypond.git] / lily / align-interface.cc
index d985a869c51673bc15329bf1d4e0428fc26a820b..cf957449ec784ecff5f384376c48b930e35fd7cb 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2000--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2000--2011 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
@@ -143,21 +143,55 @@ get_skylines (Grob *me,
   reverse (*ret);
 }
 
-// If include_fixed_spacing is true, the manually fixed spacings
-// induced by stretchable=0 or alignment-distances are included
-// in the minimum translations here.  If you want to find the minimum
-// height of a system, include_fixed_spacing should be true.  If you
-// want to actually lay out the page, then it should be false (or
-// else centered dynamics will break when there is a fixed alignment).
 vector<Real>
 Align_interface::get_minimum_translations (Grob *me,
                                           vector<Grob*> const &all_grobs,
-                                          Axis a,
-                                          bool include_fixed_spacing,
-                                          bool pure, int start, int end)
+                                          Axis a)
+{
+  return internal_get_minimum_translations (me, all_grobs, a, true, false, 0, 0);
+}
+
+vector<Real>
+Align_interface::get_pure_minimum_translations (Grob *me,
+                                               vector<Grob*> const &all_grobs,
+                                               Axis a, int start, int end)
+{
+  return internal_get_minimum_translations (me, all_grobs, a, true, true, start, end);
+}
+
+vector<Real>
+Align_interface::get_minimum_translations_without_min_dist (Grob *me,
+                                                           vector<Grob*> const &all_grobs,
+                                                           Axis a)
+{
+  return internal_get_minimum_translations (me, all_grobs, a, false, false, 0, 0);
+}
+
+// If include_fixed_spacing is false, the only constraints that will be measured
+// here are those that result from collisions (+ padding) and minimum-distance
+// between adjacent staves.
+// If include_fixed_spacing is true, constraints from line-break-system-details,
+// basic-distance+stretchable=0, and staff-staff-spacing of spaceable staves
+// with loose lines in between, are included as well.
+// - If you want to find the minimum height of a system, include_fixed_spacing should be true.
+// - If you're going to actually lay out the page, then it should be false (or
+//   else centered dynamics will break when there is a fixed alignment).
+vector<Real>
+Align_interface::internal_get_minimum_translations (Grob *me,
+                                                   vector<Grob*> const &all_grobs,
+                                                   Axis a,
+                                                   bool include_fixed_spacing,
+                                                   bool pure, int start, int end)
 {
   if (!pure && a == Y_AXIS && dynamic_cast<Spanner*> (me) && !me->get_system ())
     me->programming_error ("vertical alignment called before line-breaking");
+
+  // If include_fixed_spacing is true, we look at things like system-system-spacing
+  // and alignment-distances, which only make sense for the toplevel VerticalAlignment.
+  // If we aren't toplevel, we're working on something like BassFigureAlignment
+  // and so we definitely don't want to include alignment-distances!
+  if (!dynamic_cast<System*> (me->get_parent (Y_AXIS)))
+    include_fixed_spacing = false;
   
   Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
                                           DOWN);
@@ -172,6 +206,7 @@ Align_interface::get_minimum_translations (Grob *me,
   Skyline down_skyline (stacking_dir);
   Real last_spaceable_element_pos = 0;
   Grob *last_spaceable_element = 0;
+  Skyline last_spaceable_skyline (stacking_dir);
   int spaceable_count = 0;
   for (vsize j = 0; j < elems.size (); j++)
     {
@@ -179,23 +214,19 @@ Align_interface::get_minimum_translations (Grob *me,
       Real padding = default_padding;
 
       if (j == 0)
-       dy = skylines[j][-stacking_dir].max_height ();
+       dy = skylines[j][-stacking_dir].max_height () + padding;
       else
        {
-         down_skyline.merge (skylines[j-1][stacking_dir]);
-         dy = down_skyline.distance (skylines[j][-stacking_dir]);
-
          SCM spec = Page_layout_problem::get_spacing_spec (elems[j-1], elems[j], pure, start, end);
          Page_layout_problem::read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
 
+         dy = down_skyline.distance (skylines[j][-stacking_dir]) + padding;
+
          Real min_distance = 0;
          if (Page_layout_problem::read_spacing_spec (spec, &min_distance, ly_symbol2scm ("minimum-distance")))
            dy = max (dy, min_distance);
 
-         if (include_fixed_spacing)
-           dy = max (dy, Page_layout_problem::get_fixed_spacing (elems[j-1], elems[j], spaceable_count, pure, start, end));
-
-         if (Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element)
+         if (include_fixed_spacing && Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element)
            {
              // Spaceable staves may have
              // constraints coming from the previous spaceable staff
@@ -205,25 +236,26 @@ Align_interface::get_minimum_translations (Grob *me,
              Page_layout_problem::read_spacing_spec (spec,
                                                      &spaceable_padding,
                                                      ly_symbol2scm ("padding"));
-             padding = max (padding, spaceable_padding);
+             dy = max(dy, (last_spaceable_skyline.distance (skylines[j][-stacking_dir])
+                           + stacking_dir*(last_spaceable_element_pos - where) + spaceable_padding));
 
-             Real min_distance = 0;
+             Real spaceable_min_distance = 0;
              if (Page_layout_problem::read_spacing_spec (spec,
-                                                         &min_distance,
+                                                         &spaceable_min_distance,
                                                          ly_symbol2scm ("minimum-distance")))
-               dy = max (dy, min_distance + stacking_dir*(last_spaceable_element_pos - where));
+               dy = max (dy, spaceable_min_distance + stacking_dir*(last_spaceable_element_pos - where));
 
-             if (include_fixed_spacing)
-               dy = max (dy, Page_layout_problem::get_fixed_spacing (last_spaceable_element, elems[j], spaceable_count,
-                                                                     pure, start, end));
+             dy = max (dy, Page_layout_problem::get_fixed_spacing (last_spaceable_element, elems[j], spaceable_count,
+                                                                   pure, start, end));
            }
        }
 
       if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
        dy = 0.0;
 
-      dy = max (0.0, dy + padding);
+      dy = max (0.0, dy);
       down_skyline.raise (-stacking_dir * dy);
+      down_skyline.merge (skylines[j][stacking_dir]);
       where += stacking_dir * dy;
       translates.push_back (where);
 
@@ -232,6 +264,7 @@ Align_interface::get_minimum_translations (Grob *me,
          spaceable_count++;
          last_spaceable_element = elems[j];
          last_spaceable_element_pos = where;
+         last_spaceable_skyline = down_skyline;
        }
     }
 
@@ -258,7 +291,7 @@ Align_interface::align_elements_to_ideal_distances (Grob *me)
   System *sys = me->get_system ();
   if (sys)
     {
-      Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()));
+      Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()), 0);
       layout.solution (true);
     }
   else
@@ -270,7 +303,7 @@ Align_interface::align_elements_to_minimum_distances (Grob *me, Axis a)
 {
   extract_grob_set (me, "elements", all_grobs);
 
-  vector<Real> translates = get_minimum_translations (me, all_grobs, a, true, false, 0, 0);
+  vector<Real> translates = get_minimum_translations (me, all_grobs, a);
   if (translates.size ())
     for (vsize j = 0; j < all_grobs.size (); j++)
       all_grobs[j]->translate_axis (translates[j], a);
@@ -280,7 +313,7 @@ Real
 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
 {
   extract_grob_set (me, "elements", all_grobs);
-  vector<Real> translates = get_minimum_translations (me, all_grobs, Y_AXIS, true, true, start, end);
+  vector<Real> translates = get_pure_minimum_translations (me, all_grobs, Y_AXIS, start, end);
 
   if (translates.size ())
     {