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"
26 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback, 1);
28 Rest_collision::force_shift_callback (SCM smob)
30 Grob *them = unsmob_grob (smob);
31 if (Note_column::has_rests (them))
33 Grob *collision = unsmob_grob (them->get_object ("rest-collision"));
37 (void) collision->get_property ("positioning-done");
40 return scm_from_double (0.0);
43 MAKE_SCHEME_CALLBACK (Rest_collision, force_shift_callback_rest, 2);
45 Rest_collision::force_shift_callback_rest (SCM rest, SCM offset)
47 Grob *rest_grob = unsmob_grob (rest);
48 Grob *parent = rest_grob->get_parent (X_AXIS);
51 translate REST; we need the result of this translation later on,
52 while the offset probably still is 0/calculation-in-progress.
54 rest_grob->translate_axis (scm_to_double (offset), Y_AXIS);
56 if (Note_column::has_interface (parent))
57 force_shift_callback (parent->self_scm ());
59 return scm_from_double (0.0);
63 Rest_collision::add_column (Grob *me, Grob *p)
65 Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), p);
68 only add callback for the rests, since we don't move anything
73 add_offset_callback (p, Rest_collision::force_shift_callback_proc, Y_AXIS);
74 p->set_object ("rest-collision", me->self_scm ());
76 Grob *rest = unsmob_grob (p->get_object ("rest"));
79 chain_offset_callback (rest,
80 Rest_collision::force_shift_callback_rest_proc, Y_AXIS);
85 TODO: look at horizontal-shift to determine ordering between rests
86 for more than two voices.
88 MAKE_SCHEME_CALLBACK(Rest_collision, calc_positioning_done, 1);
90 Rest_collision::calc_positioning_done (SCM smob)
92 Grob *me = unsmob_grob (smob);
93 extract_grob_set (me, "elements", elts);
98 for (vsize i = 0; i < elts.size (); i++)
101 if (unsmob_grob (e->get_object ("rest")))
104 Ignore rests under beam.
106 Grob *st = unsmob_grob (e->get_object ("stem"));
107 if (st && unsmob_grob (st->get_object ("beam")))
117 handle rest-rest and rest-note collisions
120 * decide not to print rest if too crowded?
124 no partners to collide with
126 if (rests.size () + notes.size () < 2)
127 return SCM_UNSPECIFIED;
129 Real staff_space = Staff_symbol_referencer::staff_space (me);
137 This is incomplete: in case of an uneven number of rests, the
138 center one should be centered on the staff.
140 Drul_array<vector<Grob*> > ordered_rests;
141 for (vsize i = 0; i < rests.size (); i++)
143 Grob *r = Note_column::get_rest (rests[i]);
145 Direction d = get_grob_direction (r);
147 ordered_rests[d].push_back (rests[i]);
149 rests[d]->warning (_ ("can't resolve rest collision: rest direction not set"));
154 vector_sort (ordered_rests[d], Note_column::shift_compare);
155 while (flip (&d) != LEFT)
160 if (ordered_rests[d].size () < 1)
162 if (ordered_rests[-d].size () > 1)
163 ordered_rests[-d][0]->warning (_ ("too many colliding rests"));
165 return SCM_UNSPECIFIED;
168 while (flip (&d) != LEFT);
170 Grob *common = common_refpoint_of_array (ordered_rests[DOWN], me, Y_AXIS);
171 common = common_refpoint_of_array (ordered_rests[UP], common, Y_AXIS);
174 = (ordered_rests[DOWN].back ()->extent (common, Y_AXIS)[UP]
175 - ordered_rests[UP].back ()->extent (common, Y_AXIS)[DOWN]) / staff_space;
179 int amount_down = (int) ceil (diff / 2);
181 Note_column::translate_rests (ordered_rests[DOWN].back (),
184 Note_column::translate_rests (ordered_rests[UP].back (),
185 2 * int (ceil (diff)));
190 for (vsize i = ordered_rests[d].size () -1; i-- > 0;)
192 Real last_y = ordered_rests[d][i + 1]->extent (common, Y_AXIS)[d];
193 Real y = ordered_rests[d][i]->extent (common, Y_AXIS)[-d];
195 Real diff = d * ((last_y - y) / staff_space);
197 Note_column::translate_rests (ordered_rests[d][i], d * (int) ceil (diff) * 2);
200 while (flip (&d) != LEFT);
207 if (rests.size () > 1)
208 warning (_ ("too many colliding rests"));
210 Direction dir = CENTER;
212 for (vsize i = rests.size (); !rcol && i--;)
213 if (Note_column::dir (rests[i]))
215 dir = Note_column::dir (rests[i]);
220 return SCM_UNSPECIFIED;
222 Grob *common = common_refpoint_of_array (notes, rcol, Y_AXIS);
224 Interval restdim = rcol->extent (common, Y_AXIS);
225 if (restdim.is_empty ())
226 return SCM_UNSPECIFIED;
228 Real staff_space = Staff_symbol_referencer::staff_space (rcol);
229 Real minimum_dist = robust_scm2double (me->get_property ("minimum-distance"), 1.0) * staff_space;
232 for (vsize i = 0; i < notes.size (); i++)
233 notedim.unite (notes[i]->extent (common, Y_AXIS));
236 = minimum_dist + dir * max (notedim[dir] - restdim[-dir], 0.0);
238 int stafflines = Staff_symbol_referencer::line_count (me);
241 programming_error ("no staff line count");
245 // move discretely by half spaces.
246 int discrete_dist = int (ceil (dist / (0.5 * staff_space)));
248 // move by whole spaces inside the staff.
249 if (discrete_dist < stafflines + 1)
250 discrete_dist = int (ceil (discrete_dist / 2.0) * 2.0);
252 Note_column::translate_rests (rcol, dir * discrete_dist);
254 return SCM_UNSPECIFIED;
257 ADD_INTERFACE (Rest_collision, "rest-collision-interface",
258 "Move around ordinary rests (not multi-measure-rests) to avoid "