2 collision.cc -- implement Collision
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "note-collision.hh"
11 #include "note-column.hh"
12 #include "note-head.hh"
13 #include "rhythmic-head.hh"
14 #include "paper-def.hh"
15 #include "axis-group-interface.hh"
18 #include "side-position-interface.hh"
19 #include "dot-column.hh"
21 MAKE_SCHEME_CALLBACK (Note_collision_interface,force_shift_callback,2);
24 Note_collision_interface::force_shift_callback (SCM element_smob, SCM axis)
26 Grob *me = unsmob_grob (element_smob);
27 Axis a = (Axis) gh_scm2int (axis);
30 me = me->get_parent (a);
32 if (! to_boolean (me->get_grob_property ("positioning-done")))
34 me->set_grob_property ("positioning-done", SCM_BOOL_T);
38 return gh_double2scm (0.0);
43 check_meshing_chords (Grob *me,
44 Drul_array< Array < Real > > *offsets,
45 Drul_array< Array < Slice > > const &extents,
46 Drul_array<Link_array<Grob> > const &clash_groups)
49 if (!extents[UP].size () || ! extents[DOWN].size ())
52 Grob *cu = clash_groups[UP][0];
53 Grob *cd = clash_groups[DOWN][0];
55 /* Every note column should have a stem, but avoid a crash. */
56 if (!Note_column::get_stem (cu) || !Note_column::get_stem (cd))
59 Grob *nu = Note_column::first_head (cu);
60 Grob *nd = Note_column::first_head (cd);
62 Array<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
63 Array<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
65 /* Too far apart to collide. */
66 if (ups[0] > dps.top () + 1)
69 // FIXME: what's this?
70 bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
72 int upball_type = Note_head::get_balltype (nu);
73 int dnball_type = Note_head::get_balltype (nd);
75 /* Do not merge whole notes (or longer, like breve, longa, maxima). */
76 if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
77 merge_possible = false;
80 && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
81 && !to_boolean (me->get_grob_property ("merge-differently-dotted")))
82 merge_possible = false;
84 /* Can only merge different heads if merge-differently-headed is
87 && upball_type != dnball_type
88 && !to_boolean (me->get_grob_property ("merge-differently-headed")))
89 merge_possible = false;
91 /* Should never merge quarter and half notes, as this would make
92 them indistinguishable. */
94 && ((Rhythmic_head::duration_log (nu) == 1
95 && Rhythmic_head::duration_log (nd) == 2)
96 || (Rhythmic_head::duration_log (nu) == 2
97 && Rhythmic_head::duration_log (nd) == 1)))
98 merge_possible = false;
102 this case (distant half collide),
109 the noteheads may be closer than this case (close half collide)
120 /* TODO: filter out the 'o's in this configuration, since they're no
121 part in the collision.
130 bool close_half_collide = false;
131 bool distant_half_collide = false;
132 bool full_collide = false;
135 while (i < ups.size () && j < dps.size ())
137 if (abs (ups[i] - dps[j]) == 1)
139 merge_possible = false;
141 close_half_collide = true;
143 distant_half_collide = true;
145 else if (ups[i]==dps[j])
147 else if (ups[i] >dps[0] && ups[i] < dps.top ())
148 merge_possible = false;
149 else if (dps[j] >ups[0] && dps[j] < ups.top ())
150 merge_possible = false;
154 else if (ups[i] > dps[j])
163 full_collide = full_collide || (close_half_collide
164 && distant_half_collide);
166 Drul_array<Real> center_note_shifts;
167 center_note_shifts[LEFT] = 0.0;
168 center_note_shifts[RIGHT] = 0.0;
171 Real shift_amount = 1;
173 bool touch = (ups[0] >= dps.top ());
177 /* For full collisions, the right hand head may obscure dots, so
178 make sure the dotted heads go to the right. */
179 bool stem_to_stem = false;
181 if (Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd))
183 else if (Rhythmic_head::dot_count (nu) < Rhythmic_head::dot_count (nd))
190 /* Wipe shortest head, or head with smallest amount of dots.
191 Note: when merging different heads, dots on shortest
194 Grob *wipe_ball = nu;
196 if (upball_type == dnball_type)
198 if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
201 else if (dnball_type > upball_type)
204 if (wipe_ball->live ())
206 wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
207 wipe_ball->set_grob_property ("stencil", SCM_EOL);
209 if (Grob *d = unsmob_grob (wipe_ball->get_grob_property ("dot")))
213 /* TODO: these numbers are magic; should devise a set of grob props
214 to tune this behavior. */
215 else if (stem_to_stem)
216 shift_amount *= -0.65;
217 else if (close_half_collide && !touch)
218 shift_amount *= 0.52;
219 else if (distant_half_collide && !touch)
221 else if (distant_half_collide || close_half_collide || full_collide)
225 else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
228 shift_amount *= 0.25;
230 /* For full or close half collisions, the right hand head may
231 obscure dots. Move dots to the right. */
232 if (abs (shift_amount) > 1e-6
233 && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
234 && (full_collide || close_half_collide))
236 Grob *d = unsmob_grob (nd->get_grob_property ("dot"));
237 Grob *parent = d->get_parent (X_AXIS);
238 if (Dot_column::has_interface (parent))
239 Side_position_interface::add_support (parent, nu);
245 for (int i=0; i < clash_groups[d].size (); i++)
246 (*offsets)[d][i] += d * shift_amount;
248 while ((flip (&d))!= UP);
252 Note_collision_interface::do_shifts (Grob* me)
254 Drul_array< Link_array <Grob> > cg = get_clash_groups (me);
256 SCM autos (automatic_shift (me, cg));
257 SCM hand (forced_shift (me));
268 wid = Note_column::first_head(h)->extent(h,X_AXIS).length() ;
272 while (flip (&d) != UP);
275 Link_array<Grob> done;
276 for (; gh_pair_p (hand); hand =ly_cdr (hand))
278 Grob * s = unsmob_grob (ly_caar (hand));
279 Real amount = gh_scm2double (ly_cdar (hand));
281 s->translate_axis (amount *wid, X_AXIS);
284 for (; gh_pair_p (autos); autos =ly_cdr (autos))
286 Grob * s = unsmob_grob (ly_caar (autos));
287 Real amount = gh_scm2double (ly_cdar (autos));
290 s->translate_axis (amount * wid, X_AXIS);
294 Drul_array< Link_array <Grob> >
295 Note_collision_interface::get_clash_groups (Grob *me)
297 Drul_array<Link_array<Grob> > clash_groups;
299 SCM s = me->get_grob_property ("elements");
300 for (; gh_pair_p (s); s = ly_cdr (s))
302 SCM car = ly_car (s);
304 Grob * se = unsmob_grob (car);
305 if (Note_column::has_interface (se))
306 clash_groups[Note_column::dir (se)].push (se);
312 Link_array<Grob> & clashes (clash_groups[d]);
313 clashes.sort (Note_column::shift_compare);
315 while ((flip (&d))!= UP);
320 /** This complicated routine moves note columns around horizontally to
321 ensure that notes don't clash.
323 This should be put into Scheme.
326 Note_collision_interface::automatic_shift (Grob *me,
327 Drul_array< Link_array <Grob> >
330 Drul_array<Array<int> > shifts;
337 Array<int> & shift (shifts[d]);
338 Link_array<Grob> & clashes (clash_groups[d]);
340 for (int i=0; i < clashes.size (); i++)
343 = clashes[i]->get_grob_property ("horizontal-shift");
345 if (gh_number_p (sh))
346 shift.push (gh_scm2int (sh));
351 for (int i=1; i < shift.size (); i++)
353 if (shift[i-1] == shift[i])
355 clashes[0]->warning (_ ("Too many clashing notecolumns. Ignoring them."));
360 while ((flip (&d))!= UP);
362 Drul_array< Array < Slice > > extents;
363 Drul_array< Array < Real > > offsets;
367 for (int i=0; i < clash_groups[d].size (); i++)
369 Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
373 offsets[d].push (d * 0.5 * i);
376 while ((flip (&d))!= UP);
379 do horizontal shifts of each direction
389 for (int i=1; i < clash_groups[d].size (); i++)
391 Slice prev =extents[d][i-1];
392 prev.intersect (extents[d][i]);
393 if (prev.length ()> 0 ||
394 (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
395 for (int j = i; j < clash_groups[d].size (); j++)
396 offsets[d][j] += d * 0.5;
399 while ((flip (&d))!= UP);
403 Check if chords are meshing
406 check_meshing_chords (me, &offsets, extents, clash_groups);
410 for (int i=0; i < clash_groups[d].size (); i++)
411 tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (),
412 gh_double2scm (offsets[d][i])),
415 while (flip (&d) != UP);
421 Note_collision_interface::forced_shift (Grob *me)
425 SCM s = me->get_grob_property ("elements");
426 for (; gh_pair_p (s); s = ly_cdr (s))
428 Grob * se = unsmob_grob (ly_car (s));
430 SCM force = se->get_grob_property ("force-hshift");
431 if (gh_number_p (force))
433 tups = gh_cons (gh_cons (se->self_scm (), force),
441 Note_collision_interface::add_column (Grob*me,Grob* ncol)
443 ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
444 Axis_group_interface::add_element (me, ncol);
445 me->add_dependency (ncol);
449 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
450 "An object that handles collisions between notes with different stem "
451 "directions and horizontal shifts. Most of the interesting properties "
452 "are to be set in @ref{note-column-interface}: these are "
453 "@code{force-hshift} and @code{horizontal-shift}. ",
454 "merge-differently-dotted merge-differently-headed positioning-done");