2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
23 #include "note-head.hh"
24 #include "staff-symbol-referencer.hh"
25 #include "staff-symbol.hh"
28 #include "pointer-group-interface.hh"
29 #include "paper-column.hh"
31 struct Ledger_line_spanner
33 DECLARE_SCHEME_CALLBACK (print, (SCM));
34 DECLARE_SCHEME_CALLBACK (set_spacing_rods, (SCM));
38 set_rods (Drul_array<Interval> const ¤t_extents,
39 Drul_array<Interval> const &previous_extents,
41 Item *previous_column,
46 if (!current_extents[d].is_empty ()
47 && !previous_extents[d].is_empty ())
50 rod.distance_ = 2 * min_length
52 we go from right to left.
54 - previous_extents[d][LEFT]
55 + current_extents[d][RIGHT];
57 rod.item_drul_[LEFT] = current_column;
58 rod.item_drul_[RIGHT] = previous_column;
64 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, set_spacing_rods, 1);
66 Ledger_line_spanner::set_spacing_rods (SCM smob)
68 Spanner *me = unsmob<Spanner> (smob);
70 // find size of note heads.
71 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
78 Real min_length_fraction
79 = robust_scm2double (me->get_property ("minimum-length-fraction"), 0.15);
81 Drul_array<Interval> current_extents;
82 Drul_array<Interval> previous_extents;
83 Real current_head_width = 0.0;
84 Item *previous_column = 0;
85 Item *current_column = 0;
87 Real halfspace = Staff_symbol::staff_space (staff) / 2;
89 Interval staff_extent = staff->extent (staff, Y_AXIS);
90 staff_extent *= 1 / halfspace;
93 Run through heads using a loop. Since Ledger_line_spanner can
94 contain a lot of noteheads, superlinear performance is too slow.
96 extract_item_set (me, "note-heads", heads);
97 for (vsize i = heads.size (); i--;)
101 int pos = Staff_symbol_referencer::get_rounded_position (h);
102 if (Staff_symbol::ledger_positions (staff, pos).empty ())
105 /* Ambitus heads can appear out-of-order in heads[],
106 * but as part of prefatory matter, they need no rods */
107 if (h->internal_has_interface (ly_symbol2scm ("ambitus-interface")))
110 Item *column = h->get_column ();
111 if (current_column != column)
113 set_rods (current_extents, previous_extents,
114 current_column, previous_column,
115 current_head_width * min_length_fraction);
117 previous_column = current_column;
118 current_column = column;
119 previous_extents = current_extents;
121 current_extents[DOWN].set_empty ();
122 current_extents[UP].set_empty ();
123 current_head_width = 0.0;
126 Interval head_extent = h->extent (column, X_AXIS);
127 Direction vdir = Direction (sign (pos));
131 current_extents[vdir].unite (head_extent);
132 current_head_width = max (current_head_width, head_extent.length ());
135 if (previous_column && current_column)
136 set_rods (current_extents, previous_extents,
137 current_column, previous_column,
138 current_head_width * min_length_fraction);
140 return SCM_UNSPECIFIED;
143 struct Ledger_request
145 Interval ledger_extent_;
146 Interval head_extent_;
150 ledger_extent_.set_empty ();
151 head_extent_.set_empty ();
156 typedef map < int, Drul_array<Ledger_request> > Ledger_requests;
159 TODO: ledger share a lot of info. Lots of room to optimize away
160 common use of objects/variables.
162 MAKE_SCHEME_CALLBACK (Ledger_line_spanner, print, 1);
164 Ledger_line_spanner::print (SCM smob)
166 Spanner *me = unsmob<Spanner> (smob);
168 extract_grob_set (me, "note-heads", heads);
173 // find size of note heads.
174 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
178 Real halfspace = Staff_symbol::staff_space (staff) / 2;
180 Interval staff_extent = staff->extent (staff, Y_AXIS);
181 staff_extent *= 1 / halfspace;
184 = robust_scm2double (me->get_property ("length-fraction"), 0.25);
188 Grob *common[NO_AXES];
190 for (int i = X_AXIS; i < NO_AXES; i++)
193 common[a] = common_refpoint_of_array (heads, me, a);
194 for (vsize i = heads.size (); i--;)
195 if (Grob *g = unsmob<Grob> (me->get_object ("accidental-grob")))
196 common[a] = common[a]->common_refpoint (g, a);
199 Ledger_requests reqs;
200 for (vsize i = heads.size (); i--;)
202 Item *h = dynamic_cast<Item *> (heads[i]);
204 int pos = Staff_symbol_referencer::get_rounded_position (h);
205 if (pos && !staff_extent.contains (pos))
207 Interval head_extent = h->extent (common[X_AXIS], X_AXIS);
208 Interval ledger_extent = head_extent;
209 ledger_extent.widen (length_fraction * head_extent.length ());
211 Direction vdir = Direction (sign (pos));
212 int rank = h->get_column ()->get_rank ();
214 reqs[rank][vdir].ledger_extent_.unite (ledger_extent);
215 reqs[rank][vdir].head_extent_.unite (head_extent);
216 reqs[rank][vdir].position_
217 = vdir * max (vdir * reqs[rank][vdir].position_, vdir * pos);
221 // determine maximum size for non-colliding ledger.
222 Real gap = robust_scm2double (me->get_property ("gap"), 0.1);
223 Ledger_requests::iterator last (reqs.end ());
224 for (Ledger_requests::iterator i (reqs.begin ());
225 i != reqs.end (); last = i++)
227 if (last == reqs.end ())
230 for (DOWN_and_UP (d))
232 if (!staff_extent.contains (last->second[d].position_)
233 && !staff_extent.contains (i->second[d].position_))
236 = (last->second[d].head_extent_[RIGHT]
237 + i->second[d].head_extent_[LEFT]) / 2;
239 for (LEFT_and_RIGHT (which))
241 Ledger_request &lr = ((which == LEFT) ? * last : *i).second[d];
243 // due tilt of quarter note-heads
246 = (!staff_extent.contains (last->second[d].position_
247 - sign (last->second[d].position_))
248 && !staff_extent.contains (i->second[d].position_
249 - sign (i->second[d].position_)));
250 Real limit = (center + (both ? which * gap / 2 : 0));
251 lr.ledger_extent_.at (-which)
252 = which * max (which * lr.ledger_extent_[-which], which * limit);
258 // create ledgers for note heads
259 Real ledgerlinethickness
260 = Staff_symbol::get_ledger_line_thickness (staff);
261 for (vsize i = heads.size (); i--;)
263 Item *h = dynamic_cast<Item *> (heads[i]);
265 int pos = Staff_symbol_referencer::get_rounded_position (h);
266 vector<Real> ledger_positions = Staff_symbol::ledger_positions (staff, pos);
267 if (!ledger_positions.empty ())
269 int ledger_count = ledger_positions.size ();
270 Interval head_size = h->extent (common[X_AXIS], X_AXIS);
271 Interval ledger_size = head_size;
272 ledger_size.widen (ledger_size.length () * length_fraction);
274 if (pos && !staff_extent.contains (pos))
276 Interval max_size = reqs[h->get_column ()->get_rank ()]
277 [Direction (sign (pos))].ledger_extent_;
279 if (!max_size.is_empty ())
280 ledger_size.intersect (max_size);
283 for (int i = 0; i < ledger_count; i++)
285 Real lpos = ledger_positions[i];
286 Interval x_extent = ledger_size;
289 if (Grob *g = unsmob<Grob> (h->get_object ("accidental-grob")))
291 Interval accidental_size = g->extent (common[X_AXIS], X_AXIS);
293 = linear_combination (Drul_array<Real> (accidental_size[RIGHT],
297 Real left_shorten = max (-ledger_size[LEFT] + d, 0.0);
299 x_extent[LEFT] += left_shorten;
301 TODO: shorten 2 ledger lines for the case natural +
306 Real blotdiameter = ledgerlinethickness;
308 = Interval (-0.5 * (ledgerlinethickness),
309 +0.5 * (ledgerlinethickness));
311 = Lookup::round_filled_box (Box (x_extent, y_extent), blotdiameter);
313 ledger_line.translate_axis ( lpos * halfspace, Y_AXIS);
314 ledgers.add_stencil (ledger_line);
319 ledgers.translate_axis (-me->relative_coordinate (common[X_AXIS], X_AXIS),
322 return ledgers.smobbed_copy ();
325 ADD_INTERFACE (Ledger_line_spanner,
326 "This spanner draws the ledger lines of a staff. This is a"
327 " separate grob because it has to process all potential"
328 " collisions between all note heads. The thickness of ledger"
329 " lines is controlled by the @code{ledger-line-thickness}"
330 " property of the @ref{StaffSymbol} grob.",
335 "minimum-length-fraction "
339 struct Ledgered_interface
343 ADD_INTERFACE (Ledgered_interface,
344 "Objects that need ledger lines, typically note heads. See"
345 " also @ref{ledger-line-spanner-interface}.",