2 rest-collision.cc -- implement Rest_collision
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "rest-collision.hh"
11 #include <cmath> // ceil.
14 #include "directional-element-interface.hh"
15 #include "duration.hh"
16 #include "international.hh"
17 #include "note-column.hh"
18 #include "output-def.hh"
19 #include "pointer-group-interface.hh"
21 #include "rhythmic-head.hh"
22 #include "staff-symbol-referencer.hh"
27 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
29 Rest_collision::force_shift_callback (SCM smob)
31 Grob *them = unsmob_grob (smob);
32 if (Note_column::has_rests (them))
34 Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
38 (void) collision->get_property ("positioning-done");
41 return scm_from_double (0.0);
44 MAKE_SCHEME_CALLBACK_WITH_OPTARGS (Rest_collision, force_shift_callback_rest, 2, 1);
46 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
48 Grob *rest_grob = unsmob_grob (rest);
49 Grob *parent = rest_grob->get_parent (X_AXIS);
52 translate REST; we need the result of this translation later on,
53 while the offset probably still is 0/calculation-in-progress.
55 if (scm_is_number (offset))
56 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
58 if (Note_column::has_interface (parent))
59 force_shift_callback (parent->self_scm ());
61 return scm_from_double (0.0);
65 Rest_collision::add_column (Grob *me, Grob *p)
67 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
70 only add callback for the rests, since we don't move anything
75 add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
76 p->set_object ("rest-collision", me->self_scm ());
78 Grob *rest = unsmob_grob (p->get_object ("rest"));
81 chain_offset_callback (rest,
82 Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
87 TODO: look at horizontal-shift to determine ordering between rests
88 for more than two voices.
90 MAKE_SCHEME_CALLBACK(Rest_collision, calc_positioning_done, 1);
92 Rest_collision::calc_positioning_done (SCM smob)
94 Grob *me = unsmob_grob (smob);
95 extract_grob_set (me, "elements", elts);
100 for (vsize i = 0; i < elts.size (); i++)
103 if (unsmob_grob (e->get_object ("rest")))
106 Ignore rests under beam.
108 Grob *st = unsmob_grob (e->get_object ("stem"));
109 if (st && unsmob_grob (st->get_object ("beam")))
119 handle rest-rest and rest-note collisions
122 * decide not to print rest if too crowded?
126 no partners to collide with
128 if (rests.size () + notes.size () < 2)
129 return SCM_UNSPECIFIED;
131 Real staff_space = Staff_symbol_referencer::staff_space (me);
139 This is incomplete: in case of an uneven number of rests, the
140 center one should be centered on the staff.
142 Drul_array<vector<Grob*> > ordered_rests;
143 for (vsize i = 0; i < rests.size (); i++)
145 Grob *r = Note_column::get_rest (rests[i]);
147 Direction d = get_grob_direction (r);
149 ordered_rests[d].push_back (rests[i]);
151 rests[d]->warning (_ ("cannot resolve rest collision: rest direction not set"));
156 vector_sort (ordered_rests[d], Note_column::shift_less);
157 while (flip (&d) != LEFT)
162 if (ordered_rests[d].size () < 1)
164 if (ordered_rests[-d].size () > 1)
165 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
167 return SCM_UNSPECIFIED;
170 while (flip (&d) != LEFT);
172 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
173 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
176 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
177 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
181 int amount_down = (int) ceil (diff / 2);
183 Note_column::translate_rests (ordered_rests[DOWN].back (),
186 Note_column::translate_rests (ordered_rests[UP].back (),
187 2 * int (ceil (diff)));
192 for (vsize i = ordered_rests[d].size () -1; i-- > 0;)
194 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
195 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
197 Real diff = d * ((last_y - y) / staff_space);
199 Note_column::translate_rests (ordered_rests[d][i], d * (int) ceil (diff) * 2);
202 while (flip (&d) != LEFT);
209 if (rests.size () > 1)
210 warning (_ ("too many colliding rests"));
212 Direction dir = CENTER;
214 for (vsize i = rests.size (); !rcol && i--;)
215 if (Note_column::dir (rests[i]))
218 dir = Note_column::dir (rcol);
222 return SCM_UNSPECIFIED;
224 Grob *rest = Note_column::get_rest (rcol);
225 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
227 Interval restdim = rcol->extent (common, Y_AXIS);
228 if (restdim.is_empty ())
229 return SCM_UNSPECIFIED;
231 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
232 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
235 for (vsize i = 0; i < notes.size (); i++)
236 notedim.unite (notes[i]->extent (common, Y_AXIS));
239 Real y = dir * max (0.0,
240 -dir * restdim[-dir] + dir * notedim[dir] + minimum_dist);
242 int stafflines = Staff_symbol_referencer::line_count (me);
245 programming_error ("no staff line count");
249 // move discretely by half spaces.
250 int discrete_y = dir * int (ceil (y / (0.5 * dir * staff_space)));
252 // move by whole spaces inside the staff.
253 if (fabs (Staff_symbol_referencer::get_position (rest)
254 + discrete_y) < stafflines + 1)
256 discrete_y = dir * int (ceil (dir * discrete_y / 2.0) * 2.0);
259 Note_column::translate_rests (rcol, discrete_y);
261 return SCM_UNSPECIFIED;
264 ADD_INTERFACE (Rest_collision,
265 "Move around ordinary rests (not multi-measure-rests) to avoid "