/*
- ledger-line-spanner.cc -- implement Ledger_line_spanner
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 2004--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 <map>
{
DECLARE_SCHEME_CALLBACK (print, (SCM));
DECLARE_SCHEME_CALLBACK (set_spacing_rods, (SCM));
- static Stencil brew_ledger_lines (Grob *me,
- int pos,
- Interval,
- Real, Real,
- Interval x_extent,
- Real left_shorten);
-
- DECLARE_GROB_INTERFACE ();
};
-Stencil
-Ledger_line_spanner::brew_ledger_lines (Grob *staff,
- int pos,
- Interval staff_extent,
- Real halfspace,
- Real ledgerlinethickness,
- Interval x_extent,
- Real left_shorten)
-{
- int line_count = (staff_extent.contains (pos)
- ? 0
- : sign (pos) * int (rint (pos - staff_extent[Direction (sign (pos))])) / 2);
- Stencil stencil;
- if (line_count)
- {
- Real blotdiameter = ledgerlinethickness;
- Interval y_extent
- = Interval (-0.5 * (ledgerlinethickness),
- +0.5 * (ledgerlinethickness));
- Stencil proto_ledger_line
- = Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
-
- x_extent[LEFT] += left_shorten;
- Stencil proto_first_line
- = Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
-
- Direction dir = (Direction)sign (pos);
- Real offs = (Staff_symbol_referencer::on_line (staff, pos))
- ? 0.0
- : -dir * halfspace;
-
- offs += pos * halfspace;
- for (int i = 0; i < line_count; i++)
- {
- Stencil ledger_line ((i == 0)
- ? proto_first_line
- : proto_ledger_line);
- ledger_line.translate_axis (-dir * halfspace * i * 2 + offs, Y_AXIS);
- stencil.add_stencil (ledger_line);
- }
- }
-
- return stencil;
-}
-
static void
set_rods (Drul_array<Interval> const ¤t_extents,
- Drul_array<Interval> const &previous_extents,
- Item *current_column,
- Item *previous_column,
- Real min_length_fraction)
+ Drul_array<Interval> const &previous_extents,
+ Item *current_column,
+ Item *previous_column,
+ Real min_length)
{
- Direction d = UP;
- do
+ for (UP_and_DOWN (d))
{
if (!current_extents[d].is_empty ()
- && !previous_extents[d].is_empty ())
- {
- Real total_head_length = previous_extents[d].length ()
- + current_extents[d].length ();
-
- Rod rod;
- rod.distance_ = total_head_length
- * (3 / 2 * min_length_fraction)
- /*
- we go from right to left.
- */
- - previous_extents[d][LEFT]
- + current_extents[d][RIGHT];
-
- rod.item_drul_[LEFT] = current_column;
- rod.item_drul_[RIGHT] = previous_column;
- rod.add_to_cols ();
- }
+ && !previous_extents[d].is_empty ())
+ {
+ Rod rod;
+ rod.distance_ = 2 * min_length
+ /*
+ we go from right to left.
+ */
+ - previous_extents[d][LEFT]
+ + current_extents[d][RIGHT];
+
+ rod.item_drul_[LEFT] = current_column;
+ rod.item_drul_[RIGHT] = previous_column;
+ rod.add_to_cols ();
+ }
}
- while (flip (&d) != DOWN);
}
MAKE_SCHEME_CALLBACK (Ledger_line_spanner, set_spacing_rods, 1);
SCM
Ledger_line_spanner::set_spacing_rods (SCM smob)
{
- Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
+ Spanner *me = unsmob<Spanner> (smob);
// find size of note heads.
Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
Drul_array<Interval> current_extents;
Drul_array<Interval> previous_extents;
+ Real current_head_width = 0.0;
Item *previous_column = 0;
Item *current_column = 0;
Interval staff_extent = staff->extent (staff, Y_AXIS);
staff_extent *= 1 / halfspace;
-
+
/*
Run through heads using a loop. Since Ledger_line_spanner can
contain a lot of noteheads, superlinear performance is too slow.
Item *h = heads[i];
int pos = Staff_symbol_referencer::get_rounded_position (h);
- if (staff_extent.contains (pos))
- continue;
+ if (Staff_symbol::ledger_positions (staff, pos).empty ())
+ continue;
+
+ /* Ambitus heads can appear out-of-order in heads[],
+ * but as part of prefatory matter, they need no rods */
+ if (h->internal_has_interface (ly_symbol2scm ("ambitus-interface")))
+ continue;
Item *column = h->get_column ();
if (current_column != column)
- {
- set_rods (current_extents, previous_extents,
- current_column, previous_column,
- min_length_fraction);
+ {
+ set_rods (current_extents, previous_extents,
+ current_column, previous_column,
+ current_head_width * min_length_fraction);
- previous_column = current_column;
- current_column = column;
- previous_extents = current_extents;
+ previous_column = current_column;
+ current_column = column;
+ previous_extents = current_extents;
- current_extents[DOWN].set_empty ();
- current_extents[UP].set_empty ();
- }
+ current_extents[DOWN].set_empty ();
+ current_extents[UP].set_empty ();
+ current_head_width = 0.0;
+ }
Interval head_extent = h->extent (column, X_AXIS);
Direction vdir = Direction (sign (pos));
if (!vdir)
- continue;
+ continue;
current_extents[vdir].unite (head_extent);
+ current_head_width = max (current_head_width, head_extent.length ());
}
if (previous_column && current_column)
set_rods (current_extents, previous_extents,
- current_column, previous_column,
- min_length_fraction);
+ current_column, previous_column,
+ current_head_width * min_length_fraction);
return SCM_UNSPECIFIED;
}
-struct Ledger_request
+struct Head_data
{
- Interval ledger_extent_;
- Interval head_extent_;
int position_;
- bool excentric_;
- Ledger_request ()
+ vector<Real> ledger_positions_;
+ Interval head_extent_;
+ Interval ledger_extent_;
+ Interval accidental_extent_;
+ Head_data ()
{
- ledger_extent_.set_empty ();
head_extent_.set_empty ();
- position_ = 0;
+ ledger_extent_.set_empty ();
+ accidental_extent_.set_empty ();
+ }
+};
+
+struct Ledger_request
+{
+ Interval max_ledger_extent_;
+ Interval max_head_extent_;
+ int max_position_;
+ vector <Head_data> heads_;
+ // The map's keys are vertical ledger line positions. The values are
+ // vectors of the x-extents of ledger lines.
+ map <Real, vector <Interval> > ledger_extents_;
+ Ledger_request ()
+ {
+ max_ledger_extent_.set_empty ();
+ max_head_extent_.set_empty ();
+ max_position_ = 0;
}
};
SCM
Ledger_line_spanner::print (SCM smob)
{
- Spanner *me = dynamic_cast<Spanner *> (unsmob_grob (smob));
+ Spanner *me = unsmob<Spanner> (smob);
+ // Generate ledger requests from note head properties, etc.
extract_grob_set (me, "note-heads", heads);
if (heads.empty ())
return SCM_EOL;
- // find size of note heads.
Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
if (!staff)
return SCM_EOL;
Interval staff_extent = staff->extent (staff, Y_AXIS);
staff_extent *= 1 / halfspace;
-
+
Real length_fraction
= robust_scm2double (me->get_property ("length-fraction"), 0.25);
- Stencil ledgers;
- Stencil default_ledger;
-
- Grob *common[NO_AXES];
-
- for (int i = X_AXIS; i < NO_AXES; i++)
+ Grob *common_x = common_refpoint_of_array (heads, me, X_AXIS);
+ for (vsize i = heads.size (); i--;)
{
- Axis a = Axis (i);
- common[a] = common_refpoint_of_array (heads, me, a);
- for (vsize i = heads.size (); i--;)
- if (Grob *g = unsmob_grob (me->get_object ("accidental-grob")))
- common[a] = common[a]->common_refpoint (g, a);
+ if (Grob *g = unsmob<Grob> (heads[i]->get_object ("accidental-grob")))
+ common_x = common_x->common_refpoint (g, X_AXIS);
}
Ledger_requests reqs;
for (vsize i = heads.size (); i--;)
{
Item *h = dynamic_cast<Item *> (heads[i]);
-
int pos = Staff_symbol_referencer::get_rounded_position (h);
- if (pos && !staff_extent.contains (pos))
- {
- Interval head_extent = h->extent (common[X_AXIS], X_AXIS);
- Interval ledger_extent = head_extent;
- ledger_extent.widen (length_fraction * head_extent.length ());
-
- Direction vdir = Direction (sign (pos));
- int rank = h->get_column ()->get_rank ();
-
- reqs[rank][vdir].ledger_extent_.unite (ledger_extent);
- reqs[rank][vdir].head_extent_.unite (head_extent);
- reqs[rank][vdir].position_
- = vdir * max (vdir * reqs[rank][vdir].position_, vdir * pos);
- }
+ vector<Real> ledger_positions =
+ Staff_symbol::ledger_positions (staff, pos, h);
+
+ // We work with all notes that produce ledgers and any notes that
+ // fall outside the staff that do not produce ledgers, such as
+ // notes in the first space just beyond the staff.
+ if (ledger_positions.size () != 0 || !staff_extent.contains (pos))
+ {
+ Interval head_extent = h->extent (common_x, X_AXIS);
+ Interval ledger_extent = head_extent;
+ ledger_extent.widen (length_fraction * head_extent.length ());
+
+ Direction vdir = Direction (sign (pos != 0 ? pos : 1));
+ int rank = h->get_column ()->get_rank ();
+
+ reqs[rank][vdir].max_ledger_extent_.unite (ledger_extent);
+ reqs[rank][vdir].max_head_extent_.unite (head_extent);
+ reqs[rank][vdir].max_position_
+ = vdir * max (vdir * reqs[rank][vdir].max_position_,
+ vdir * pos);
+ Head_data hd;
+ hd.position_ = pos;
+ hd.ledger_positions_ = ledger_positions;
+ hd.ledger_extent_ = ledger_extent;
+ hd.head_extent_ = head_extent;
+ if (Grob *g = unsmob<Grob> (h->get_object ("accidental-grob")))
+ hd.accidental_extent_ = g->extent (common_x, X_AXIS);
+ reqs[rank][vdir].heads_.push_back(hd);
+ }
}
- // determine maximum size for non-colliding ledger.
+ if (reqs.size () == 0)
+ return SCM_EOL;
+
+ // Iterate through ledger requests and when ledger lines will be
+ // too close together horizontally, shorten max_ledger_extent to
+ // produce more space between them.
Real gap = robust_scm2double (me->get_property ("gap"), 0.1);
Ledger_requests::iterator last (reqs.end ());
for (Ledger_requests::iterator i (reqs.begin ());
i != reqs.end (); last = i++)
{
if (last == reqs.end ())
- continue;
-
- Direction d = DOWN;
- do
- {
- if (!staff_extent.contains (last->second[d].position_)
- && !staff_extent.contains (i->second[d].position_))
- {
- Real center
- = (last->second[d].head_extent_[RIGHT]
- + i->second[d].head_extent_[LEFT]) / 2;
-
- Direction which = LEFT;
- do
- {
- Ledger_request &lr = ((which == LEFT) ? * last : *i).second[d];
-
- // due tilt of quarter note-heads
- /* FIXME */
- bool both
- = (!staff_extent.contains (last->second[d].position_
- - sign (last->second[d].position_))
- && !staff_extent.contains (i->second[d].position_
- - sign (i->second[d].position_)));
- Real limit = (center + (both ? which * gap / 2 : 0));
- lr.ledger_extent_.at (-which)
- = which * max (which * lr.ledger_extent_[-which], which * limit);
- }
- while (flip (&which) != LEFT);
- }
- }
- while (flip (&d) != DOWN);
+ continue;
+
+ for (DOWN_and_UP (d))
+ {
+ // Some rank--> vdir--> reqs will be 'empty' because notes
+ // will not be above AND below the staff for a given rank.
+ if (!staff_extent.contains (last->second[d].max_position_)
+ && !staff_extent.contains (i->second[d].max_position_))
+ {
+ // Midpoint between the furthest bounds of the two heads.
+ Real center
+ = (last->second[d].max_head_extent_[RIGHT]
+ + i->second[d].max_head_extent_[LEFT]) / 2;
+
+ // Do both reqs have notes further than the first space
+ // beyond the staff?
+ // (due tilt of quarter note-heads)
+ /* FIXME */
+ bool both
+ = (!staff_extent.contains (last->second[d].max_position_
+ - sign (last->second[d].max_position_))
+ && !staff_extent.contains (i->second[d].max_position_
+ - sign (i->second[d].max_position_)));
+
+ for (LEFT_and_RIGHT (which))
+ {
+ Ledger_request &lr = ((which == LEFT) ? * last : *i).second[d];
+
+ Real limit = (center + (both ? which * gap / 2 : 0));
+ lr.max_ledger_extent_.at (-which)
+ = which * max (which * lr.max_ledger_extent_[-which],
+ which * limit);
+ }
+ }
+ }
}
- // create ledgers for note heads
- Real ledgerlinethickness
- = Staff_symbol::get_ledger_line_thickness (staff);
- for (vsize i = heads.size (); i--;)
+ // Iterate through ledger requests and the data they have about each
+ // note head to generate the final extents for all ledger lines.
+ // Note heads of different widths produce different ledger extents.
+ for (Ledger_requests::iterator i (reqs.begin ());
+ i != reqs.end (); i++)
{
- Item *h = dynamic_cast<Item *> (heads[i]);
-
- int pos = Staff_symbol_referencer::get_rounded_position (h);
- if (!staff_extent.contains (pos - sign (pos)))
- {
- Interval head_size = h->extent (common[X_AXIS], X_AXIS);
- Interval ledger_size = head_size;
- ledger_size.widen (ledger_size.length () * length_fraction);
-
- Interval max_size = reqs[h->get_column ()->get_rank ()]
- [Direction (sign (pos))].ledger_extent_;
-
- ledger_size.intersect (max_size);
- Real left_shorten = 0.0;
- if (Grob *g = unsmob_grob (h->get_object ("accidental-grob")))
- {
- Interval accidental_size = g->extent (common[X_AXIS], X_AXIS);
- Real d
- = linear_combination (Drul_array<Real> (accidental_size[RIGHT],
- head_size[LEFT]),
- 0.0);
-
- left_shorten = max (-ledger_size[LEFT] + d, 0.0);
-
- /*
- TODO: shorten 2 ledger lines for the case natural +
- downstem.
- */
- }
-
- ledgers.add_stencil (brew_ledger_lines (staff, pos, staff_extent,
- halfspace,
- ledgerlinethickness,
- ledger_size,
- left_shorten));
- }
+ for (DOWN_and_UP (d))
+ {
+ Ledger_request &lr = i->second[d];
+ for (vsize h = 0; h < lr.heads_.size (); h++)
+ {
+ vector<Real> &ledger_posns = lr.heads_[h].ledger_positions_;
+ Interval &ledger_size = lr.heads_[h].ledger_extent_;
+ Interval &head_size = lr.heads_[h].head_extent_;
+ Interval &acc_extent = lr.heads_[h].accidental_extent_;
+
+ // Limit ledger extents to a maximum to preserve space
+ // between ledgers when note heads get close.
+ if (!lr.max_ledger_extent_.is_empty ())
+ ledger_size.intersect (lr.max_ledger_extent_);
+
+ // Iterate through the ledgers for a given note head.
+ for (vsize l = 0; l < ledger_posns.size (); l++)
+ {
+ Real lpos = ledger_posns[l];
+ Interval x_extent = ledger_size;
+
+ // Notes with accidental signs get shorter ledgers.
+ // (Only happens for the furthest note in the column.)
+ if (l == 0 && !acc_extent.is_empty ())
+ {
+ Real dist
+ = linear_combination (Drul_array<Real> (acc_extent[RIGHT],
+ head_size[LEFT]),
+ 0.0);
+
+ Real left_shorten = max (-ledger_size[LEFT] + dist, 0.0);
+ x_extent[LEFT] += left_shorten;
+ /*
+ TODO: shorten 2 ledger lines for the case
+ natural + downstem.
+ */
+ }
+ // When the extents of two ledgers at the same
+ // vertical position overlap horizontally, we merge
+ // them together to produce a single stencil. In rare
+ // cases they do not overlap and we do not merge them.
+
+ if (lr.ledger_extents_.find (lpos) == lr.ledger_extents_.end ())
+ // Found nothing for this lpos.
+ lr.ledger_extents_[lpos].push_back(x_extent);
+ else
+ {
+ vector<Interval> &extents = lr.ledger_extents_.find (lpos)->second;
+ for (vsize e = 0; e < extents.size (); e++)
+ {
+ if (intersection (extents[e], x_extent).is_empty ())
+ extents.push_back (x_extent);
+ else
+ extents[e].unite (x_extent);
+ }
+ }
+ }
+ }
+ }
}
- ledgers.translate_axis (-me->relative_coordinate (common[X_AXIS], X_AXIS),
- X_AXIS);
+ // Create the stencil for the ledger line spanner by iterating
+ // through the ledger requests and their data on ledger extents.
+ Stencil ledgers;
+ Real thickness = Staff_symbol::get_ledger_line_thickness (staff);
+ Real half_thickness = thickness * 0.5;
+ Interval y_extent = Interval (-half_thickness, half_thickness);
+ for (Ledger_requests::iterator i (reqs.begin ()); i != reqs.end (); i++)
+ {
+ for (DOWN_and_UP (d))
+ {
+ map<Real, vector<Interval> > &lex = i->second[d].ledger_extents_;
+ for (map<Real, vector<Interval> >::iterator k = lex.begin ();
+ k != lex.end (); k++)
+ {
+ Real lpos = k->first;
+ vector<Interval> &x_extents = k->second;
+
+ for (vsize n = 0; n < x_extents.size (); n++)
+ {
+ // thickness (ledger line thickness) is the blot diameter
+ Stencil line = Lookup::round_filled_box (Box (x_extents[n], y_extent),
+ thickness);
+
+ line.translate_axis (lpos * halfspace, Y_AXIS);
+ ledgers.add_stencil (line);
+ }
+ }
+ }
+ }
+ ledgers.translate_axis (-me->relative_coordinate (common_x, X_AXIS), X_AXIS);
return ledgers.smobbed_copy ();
}
ADD_INTERFACE (Ledger_line_spanner,
-
- "This spanner draws the ledger lines of a staff.\n"
- "This is a separate grob because it has to process\n"
- "all potential collisions between all note heads.",
-
- /* properties */
- "gap "
- "length-fraction "
- "minimum-length-fraction "
- "note-heads "
- "thickness "
- );
+ "This spanner draws the ledger lines of a staff. This is a"
+ " separate grob because it has to process all potential"
+ " collisions between all note heads. The thickness of ledger"
+ " lines is controlled by the @code{ledger-line-thickness}"
+ " property of the @ref{StaffSymbol} grob.",
+
+ /* properties */
+ "gap "
+ "length-fraction "
+ "minimum-length-fraction "
+ "note-heads "
+ );
struct Ledgered_interface
{
- DECLARE_GROB_INTERFACE ();
};
ADD_INTERFACE (Ledgered_interface,
+ "Objects that need ledger lines, typically note heads. See"
+ " also @ref{ledger-line-spanner-interface}.",
- "Objects that need ledger lines, typically "
- "note heads. See also @ref{ledger-line-spanner-interface}.",
-
- "no-ledgers");
+ /* properties */
+ "no-ledgers "
+ );
projects / lilypond.git / blobdiff