/*
- separation-item.cc -- implement Separation_item
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1998--2007 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 "separation-item.hh"
Real
Separation_item::set_distance (Item *l, Item *r, Real padding)
{
- Drul_array<Skyline_pair*> lines (Skyline_pair::unsmob (l->get_property ("horizontal-skylines")),
- Skyline_pair::unsmob (r->get_property ("horizontal-skylines")));
+ Drul_array<Skyline_pair *> lines (unsmob<Skyline_pair> (l->get_property ("horizontal-skylines")),
+ unsmob<Skyline_pair> (r->get_property ("horizontal-skylines")));
Skyline right = conditional_skyline (r, l);
right.merge ((*lines[RIGHT])[LEFT]);
-
+
Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
if (dist > 0)
{
Rod rod;
- rod.item_drul_ = Drul_array<Item*> (l, r);
+ rod.item_drul_ = Drul_array<Item *> (l, r);
rod.distance_ = dist;
rod.add_to_cols ();
bool
Separation_item::is_empty (Grob *me)
{
- Skyline_pair *sky = Skyline_pair::unsmob (me->get_property ("horizontal-skylines"));
+ Skyline_pair *sky = unsmob<Skyline_pair> (me->get_property ("horizontal-skylines"));
return (!sky || sky->is_empty ());
}
Separation_item::conditional_skyline (Grob *me, Grob *left)
{
vector<Box> bs = boxes (me, left);
- return Skyline (bs, 0.1, Y_AXIS, LEFT);
+ return Skyline (bs, Y_AXIS, LEFT);
}
-
-MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines,1);
+MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines, 1);
SCM
Separation_item::calc_skylines (SCM smob)
{
- Item *me = unsmob_item (smob);
+ Item *me = unsmob<Item> (smob);
vector<Box> bs = boxes (me, 0);
- /* todo: the horizon_padding is somewhat arbitrary */
- return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
+ Skyline_pair sp (bs, Y_AXIS);
+ /*
+ TODO: We need to decide if padding is 'intrinsic'
+ to a skyline or if it is something that is only added on in
+ distance calculations. Here, we make it intrinsic, which copies
+ the behavior from the old code but no longer corresponds to how
+ vertical skylines are handled (where padding is not built into
+ the skyline).
+ */
+ Real vp = robust_scm2double (me->get_property ("skyline-vertical-padding"), 0.0);
+ sp[LEFT] = sp[LEFT].padded (vp);
+ sp[RIGHT] = sp[RIGHT].padded (vp);
+ return sp.smobbed_copy ();
}
-/* if left is non-NULL, get the boxes corresponding to the
- conditional-elements (conditioned on the grob LEFT). This
- sounds more general than it is: conditional-elements are
- always accidentals attached to a tied note.
+/*
+ If left is non-NULL, get the boxes corresponding to the
+ conditional-elements (conditioned on the grob LEFT).
+ Conditional elements are, for now, arpeggios and accidental
+ placements. Based on the left grob, the accidentals will
+ be printed or not, so we filter using
+ Accidental_placement::get_relevant_accidentals.
*/
vector<Box>
Separation_item::boxes (Grob *me, Grob *left)
Paper_column *pc = item->get_column ();
vector<Box> out;
extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts);
- vector<Grob*> elts;
+ vector<Grob *> elts;
if (left)
- elts = Accidental_placement::get_relevant_accidentals (read_only_elts, left);
- else
{
- elts = read_only_elts;
-
- /* This is a special-case for NoteColumn: we want to include arpeggio in its
- skyline (so spacing takes it into account) but we don't want to include it
- in the NoteColumn's extent because some spanners (eg. Hairpin) bound themselves
- on the NoteColumn and we don't want them to include arpeggios in their bounds.
- */
- if (Grob *a = Note_column::arpeggio (me)) {
- elts.push_back (a);
- }
+ vector<Grob *> accidental_elts;
+ vector<Grob *> other_elts; // for now only arpeggios
+ for (vsize i = 0; i < read_only_elts.size (); i++)
+ {
+ if (has_interface<Accidental_placement> (read_only_elts[i]))
+ accidental_elts.push_back (read_only_elts[i]);
+ else
+ other_elts.push_back (read_only_elts[i]);
+ }
+ elts = Accidental_placement::get_relevant_accidentals (accidental_elts, left);
+ elts.insert (elts.end (), other_elts.begin (), other_elts.end ());
}
+ else
+ elts = read_only_elts;
Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
-
+
for (vsize i = 0; i < elts.size (); i++)
{
Item *il = dynamic_cast<Item *> (elts[i]);
if (pc != il->get_column ())
- continue;
+ continue;
/* ugh. We want to exclude groups of grobs (so that we insert each grob
- individually into the skyline instead of adding a single box that
- bounds all of them). However, we can't exclude an axis-group that
- adds to its childrens' stencil. Currently, this is just TrillPitchGroup;
- hence the check for note-head-interface. */
- if (Axis_group_interface::has_interface (il)
- && !Note_head::has_interface (il))
- continue;
-
- Interval y (il->pure_height (ycommon, 0, very_large));
+ individually into the skyline instead of adding a single box that
+ bounds all of them). However, we can't exclude an axis-group that
+ adds to its childrens' stencil. Currently, this is just TrillPitchGroup;
+ hence the check for note-head-interface. */
+ if (has_interface<Axis_group_interface> (il)
+ && !has_interface<Note_head> (il))
+ continue;
+
+ Interval y (il->pure_y_extent (ycommon, 0, very_large));
Interval x (il->extent (pc, X_AXIS));
Interval extra_width = robust_scm2interval (elts[i]->get_property ("extra-spacing-width"),
- Interval (-0.1, 0.1));
+ Interval (-0.1, 0.1));
Interval extra_height = robust_scm2interval (elts[i]->get_property ("extra-spacing-height"),
- Interval (-0.1, 0.1));
+ Interval (0.0, 0.0));
+
+ // The conventional empty extent is (+inf.0 . -inf.0)
+ // but (-inf.0 . +inf.0) is used as extra-spacing-height
+ // on items that must not overlap other note-columns.
+ // If these two uses of inf combine, leave the empty extent.
+
+ if (!isinf (x[LEFT]))
+ x[LEFT] += extra_width[LEFT];
+ if (!isinf (x[RIGHT]))
+ x[RIGHT] += extra_width[RIGHT];
+ if (!isinf (y[DOWN]))
+ y[DOWN] += extra_height[DOWN];
+ if (!isinf (y[UP]))
+ y[UP] += extra_height[UP];
- x[LEFT] += extra_width[LEFT];
- x[RIGHT] += extra_width[RIGHT];
- y[DOWN] += extra_height[DOWN];
- y[UP] += extra_height[UP];
-
if (!x.is_empty () && !y.is_empty ())
- out.push_back (Box (x, y));
+ out.push_back (Box (x, y));
}
- return out;
+ return out;
}
-MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
+MAKE_DOCUMENTED_SCHEME_CALLBACK (Separation_item, print, 1,
+ "Optional stencil for @code{PaperColumn} or"
+ "@code{NonMusicalPaperColumn}.\n"
+ "Draws the @code{horizontal-skylines} of each"
+ " @code{PaperColumn}, showing the shapes used"
+ " to determine the minimum distances between"
+ " @code{PaperColumns} at the note-spacing step,"
+ " before staves have been spaced (vertically)"
+ " on the page.")
SCM
Separation_item::print (SCM smob)
{
if (!debug_skylines)
return SCM_BOOL_F;
- Grob *me = unsmob_grob (smob);
+ Grob *me = unsmob<Grob> (smob);
Stencil ret;
- if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")))
+ if (Skyline_pair *s = unsmob<Skyline_pair> (me->get_property ("horizontal-skylines")))
{
ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[LEFT].to_points (Y_AXIS)).in_color (255, 255, 0));
ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[RIGHT].to_points (Y_AXIS)).in_color (0, 255, 255));
}
ADD_INTERFACE (Separation_item,
- "Item that computes widths to generate spacing rods.",
-
- /* properties */
- "X-extent "
- "conditional-elements "
- "elements "
- "padding "
- "horizontal-skylines "
- );
+ "Item that computes widths to generate spacing rods.",
+
+ /* properties */
+ "X-extent "
+ "conditional-elements "
+ "elements "
+ "padding "
+ "horizontal-skylines "
+ "skyline-vertical-padding "
+ );