/*
- align-interface.cc -- implement Align_interface
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2000--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2000--2009 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
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "align-interface.hh"
{
assert (a == Y_AXIS);
Interval extent = g->pure_height (g, start, end);
- if (!extent.is_empty ())
- {
- Box b;
- b[a] = extent;
- b[other_axis (a)] = Interval (0, infinity_f);
- skylines.insert (b, 0, other_axis (a));
- }
// This is a hack to get better accuracy on the pure-height of VerticalAlignment.
// It's quite common for a treble clef to be the highest element of one system
if (Axis_group_interface::has_interface (g)
&& !Hara_kiri_group_spanner::request_suicide (g, start, end))
{
+ extent = Axis_group_interface::rest_of_line_pure_height (g, start, end);
Interval begin_of_line_extent = Axis_group_interface::begin_of_line_pure_height (g, start);
if (!begin_of_line_extent.is_empty ())
{
skylines.insert (b, 0, other_axis (a));
}
}
+
+ if (!extent.is_empty ())
+ {
+ Box b;
+ b[a] = extent;
+ b[other_axis (a)] = Interval (0, infinity_f);
+ skylines.insert (b, 0, other_axis (a));
+ }
}
if (skylines.is_empty ())
vector<Real>
Align_interface::get_minimum_translations (Grob *me,
vector<Grob*> const &all_grobs,
- Axis a,
- 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 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::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);
get_skylines (me, &elems, a, pure, start, end, &skylines);
- SCM forced_distances = ly_assoc_get (ly_symbol2scm ("alignment-distances"),
- Page_layout_problem::get_details (me),
- SCM_EOL);
-
Real where = 0;
Real default_padding = robust_scm2double (me->get_property ("padding"), 0.0);
vector<Real> translates;
Skyline down_skyline (stacking_dir);
- SCM last_spaceable_element_details = SCM_EOL;
Real last_spaceable_element_pos = 0;
- bool found_spaceable_element = false;
+ Grob *last_spaceable_element = 0;
+ int spaceable_count = 0;
for (vsize j = 0; j < elems.size (); j++)
{
Real dy = 0;
{
down_skyline.merge (skylines[j-1][stacking_dir]);
dy = down_skyline.distance (skylines[j][-stacking_dir]);
- }
- if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
- dy = 0.0;
+ 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"));
- if (Page_layout_problem::is_spaceable (elems[j]))
- {
Real min_distance = 0;
- Page_layout_problem::read_spacing_spec (last_spaceable_element_details,
- &padding,
- ly_symbol2scm ("padding"));
- if (Page_layout_problem::read_spacing_spec (last_spaceable_element_details,
- &min_distance,
- ly_symbol2scm ("minimum-distance")))
- dy = max (dy, min_distance + stacking_dir*(last_spaceable_element_pos - where));
-
- if (found_spaceable_element && scm_is_pair (forced_distances))
- {
- SCM forced_dist = scm_car (forced_distances);
- forced_distances = scm_cdr (forced_distances);
+ 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 (scm_is_number (forced_dist))
- dy = scm_to_double (forced_dist) + stacking_dir * (last_spaceable_element_pos - where);
+ if (Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element)
+ {
+ // Spaceable staves may have
+ // constraints coming from the previous spaceable staff
+ // as well as from the previous staff.
+ spec = Page_layout_problem::get_spacing_spec (last_spaceable_element, elems[j], pure, start, end);
+ Real spaceable_padding = 0;
+ Page_layout_problem::read_spacing_spec (spec,
+ &spaceable_padding,
+ ly_symbol2scm ("padding"));
+ padding = max (padding, spaceable_padding);
+
+ Real min_distance = 0;
+ if (Page_layout_problem::read_spacing_spec (spec,
+ &min_distance,
+ ly_symbol2scm ("minimum-distance")))
+ dy = max (dy, 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));
}
- last_spaceable_element_details = elems[j]->get_property ("next-staff-spacing");
- found_spaceable_element = true;
- }
- else
- {
- // TODO: provide support for min-distance and padding for non-spaceable elements also.
}
+ if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
+ dy = 0.0;
+
dy = max (0.0, dy + padding);
down_skyline.raise (-stacking_dir * dy);
where += stacking_dir * dy;
translates.push_back (where);
if (Page_layout_problem::is_spaceable (elems[j]))
- last_spaceable_element_pos = where;
+ {
+ spaceable_count++;
+ last_spaceable_element = elems[j];
+ last_spaceable_element_pos = where;
+ }
}
// So far, we've computed the translates for all the non-empty elements.
Align_interface::align_elements_to_ideal_distances (Grob *me)
{
System *sys = me->get_system ();
- Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()));
-
- layout.solution (true);
+ if (sys)
+ {
+ Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()));
+ layout.solution (true);
+ }
+ else
+ programming_error ("vertical alignment called before line breaking");
}
void
{
extract_grob_set (me, "elements", all_grobs);
- vector<Real> translates = get_minimum_translations (me, all_grobs, a, 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);
Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
{
extract_grob_set (me, "elements", all_grobs);
- SCM dy_scm = me->get_property ("forced-distance");
+ vector<Real> translates = get_pure_minimum_translations (me, all_grobs, Y_AXIS, start, end);
- if (scm_is_number (dy_scm))
+ if (translates.size ())
{
- Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
- Real pos = 0;
for (vsize i = 0; i < all_grobs.size (); i++)
- {
- if (all_grobs[i] == ch)
- return pos;
- if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
- || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
- pos += dy;
- }
+ if (all_grobs[i] == ch)
+ return translates[i];
}
else
- {
- vector<Real> translates = get_minimum_translations (me, all_grobs, Y_AXIS, true, start, end);
-
- if (translates.size ())
- {
- for (vsize i = 0; i < all_grobs.size (); i++)
- if (all_grobs[i] == ch)
- return translates[i];
- }
- else
- return 0;
- }
+ return 0;
programming_error ("tried to get a translation for something that is no child of mine");
return 0;
" or bottom to top. For vertical alignments of staves, the"
" @code{break-system-details} of the left"
" @rinternals{NonMusicalPaperColumn} may be set to tune"
- " vertical spacing. Set @code{alignment-extra-space} to add"
- " extra space for staves. Set"
- " @code{fixed-alignment-extra-space} to force staves in"
- " @code{PianoStaff}s further apart.",
+ " vertical spacing.",
/* properties */
"align-dir "
"padding "
"positioning-done "
"stacking-dir "
- "threshold "
);