3 collision.cc -- implement Collision
5 source file of the GNU LilyPond music typesetter
7 (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "note-collision.hh"
12 #include "note-column.hh"
13 #include "note-head.hh"
14 #include "rhythmic-head.hh"
15 #include "paper-def.hh"
16 #include "axis-group-interface.hh"
20 MAKE_SCHEME_CALLBACK (Note_collision_interface,force_shift_callback,2);
23 Note_collision_interface::force_shift_callback (SCM element_smob, SCM axis)
25 Grob *me = unsmob_grob (element_smob);
26 Axis a = (Axis) gh_scm2int (axis);
29 me = me->get_parent (a);
31 if (! to_boolean (me->get_grob_property ("collision-done")))
33 me->set_grob_property ("collision-done", SCM_BOOL_T);
37 return gh_double2scm (0.0);
42 check_meshing_chords (Grob*me,
43 Drul_array< Array < Real > > *offsets,
44 Drul_array< Array < Slice > > const &extents,
45 Drul_array<Link_array<Grob> > const &clash_groups)
48 if (!extents[UP].size () || ! extents[DOWN].size ())
52 Grob *cu =clash_groups[UP][0];
53 Grob *cd =clash_groups[DOWN][0];
55 Grob * nu= Note_column::first_head (cu);
56 Grob * nd = Note_column::first_head (cd);
61 this case (distant half collide),
68 the noteheads may be closer than this case (close half collide)
79 bool close_half_collide = false;
80 bool distant_half_collide = false;
81 bool full_collide = false;
86 if (!Note_column::get_stem (cu)
87 || !Note_column::get_stem (cd))
94 filter out the 'o's in this configuration, since they're no part
104 Array<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
105 Array<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
108 they're too far apart to collide.
112 if (ups[0] > dps.top () + 1)
115 bool touch = (ups[0] - dps.top () >= 0);
117 bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
120 don't merge whole notes (or longer, like breve, longa, maxima)
123 int upball_type = Note_head::get_balltype (nu);
124 int dnball_type = Note_head::get_balltype (nd);
126 merge_possible = merge_possible && (upball_type > 0);
128 if (!to_boolean (me->get_grob_property ("merge-differently-dotted")))
129 merge_possible = merge_possible && Rhythmic_head::dot_count (nu) == Rhythmic_head::dot_count (nd);
132 if (!to_boolean (me->get_grob_property ("merge-differently-headed")))
133 merge_possible = merge_possible &&
134 upball_type == dnball_type;
137 Can't merge quarter and half notes.
139 merge_possible = merge_possible &&
140 !((Rhythmic_head::duration_log (nu) == 1
141 && Rhythmic_head::duration_log (nd) == 2)
142 ||(Rhythmic_head::duration_log (nu) == 2
143 && Rhythmic_head::duration_log (nd) == 1));
146 while (i < ups.size () && j < dps.size ())
148 if (abs (ups[i] - dps[j]) == 1)
150 merge_possible = false;
152 close_half_collide = true;
154 distant_half_collide = true;
156 else if (ups[i]==dps[j])
158 else if (ups[i] >dps[0] && ups[i] < dps.top ())
159 merge_possible = false;
160 else if (dps[j] >ups[0] && dps[j] < ups.top ())
161 merge_possible = false;
165 else if (ups[i] > dps[j])
174 Drul_array<Real> center_note_shifts;
175 center_note_shifts[LEFT] = 0.0;
176 center_note_shifts[RIGHT] = 0.0;
179 Real shift_amount = 1;
185 for full collisions, the right hand head may obscure dots, so
186 make sure the dotted heads go to the right.
188 if ((Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd)
193 TODO: these numbers are magic; should devise a set of grob props
194 to tune this behavior. */
201 if (upball_type < dnball_type)
203 else if (upball_type > dnball_type)
206 if (wipe_ball && wipe_ball->live ())
208 wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
209 wipe_ball->set_grob_property ("molecule", SCM_EOL);
211 if (Grob *d = unsmob_grob (wipe_ball->get_grob_property ("dot")))
216 && unsmob_grob (nd->get_grob_property ("dot")))
218 unsmob_grob (nd->get_grob_property ("dot"))->suicide ();
221 else if (close_half_collide && !touch)
222 shift_amount *= 0.52;
223 else if (distant_half_collide && !touch)
225 else if (distant_half_collide || close_half_collide || full_collide)
231 else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
234 shift_amount *= 0.25;
239 for (int i=0; i < clash_groups[d].size (); i++)
240 (*offsets)[d][i] += d * shift_amount;
242 while ((flip (&d))!= UP);
246 Note_collision_interface::do_shifts (Grob* me)
248 Drul_array< Link_array <Grob> > cg = get_clash_groups (me);
250 SCM autos (automatic_shift (me, cg));
251 SCM hand (forced_shift (me));
262 wid = Note_column::first_head(h)->extent(h,X_AXIS).length() ;
266 while (flip (&d) != UP);
269 Link_array<Grob> done;
270 for (; gh_pair_p (hand); hand =ly_cdr (hand))
272 Grob * s = unsmob_grob (ly_caar (hand));
273 Real amount = gh_scm2double (ly_cdar (hand));
275 s->translate_axis (amount *wid, X_AXIS);
278 for (; gh_pair_p (autos); autos =ly_cdr (autos))
280 Grob * s = unsmob_grob (ly_caar (autos));
281 Real amount = gh_scm2double (ly_cdar (autos));
284 s->translate_axis (amount * wid, X_AXIS);
288 Drul_array< Link_array <Grob> >
289 Note_collision_interface::get_clash_groups (Grob *me)
291 Drul_array<Link_array<Grob> > clash_groups;
293 SCM s = me->get_grob_property ("elements");
294 for (; gh_pair_p (s); s = ly_cdr (s))
296 SCM car = ly_car (s);
298 Grob * se = unsmob_grob (car);
299 if (Note_column::has_interface (se))
300 clash_groups[Note_column::dir (se)].push (se);
306 Link_array<Grob> & clashes (clash_groups[d]);
307 clashes.sort (Note_column::shift_compare);
309 while ((flip (&d))!= UP);
314 /** This complicated routine moves note columns around horizontally to
315 ensure that notes don't clash.
317 This should be put into Scheme.
320 Note_collision_interface::automatic_shift (Grob *me,
321 Drul_array< Link_array <Grob> >
324 Drul_array<Array<int> > shifts;
331 Array<int> & shift (shifts[d]);
332 Link_array<Grob> & clashes (clash_groups[d]);
334 for (int i=0; i < clashes.size (); i++)
337 = clashes[i]->get_grob_property ("horizontal-shift");
339 if (gh_number_p (sh))
340 shift.push (gh_scm2int (sh));
345 for (int i=1; i < shift.size (); i++)
347 if (shift[i-1] == shift[i])
349 clashes[0]->warning (_ ("Too many clashing notecolumns. Ignoring them."));
354 while ((flip (&d))!= UP);
356 Drul_array< Array < Slice > > extents;
357 Drul_array< Array < Real > > offsets;
361 for (int i=0; i < clash_groups[d].size (); i++)
363 Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
367 offsets[d].push (d * 0.5 * i);
370 while ((flip (&d))!= UP);
373 do horizontal shifts of each direction
383 for (int i=1; i < clash_groups[d].size (); i++)
385 Slice prev =extents[d][i-1];
386 prev.intersect (extents[d][i]);
387 if (prev.length ()> 0 ||
388 (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
389 for (int j = i; j < clash_groups[d].size (); j++)
390 offsets[d][j] += d * 0.5;
393 while ((flip (&d))!= UP);
397 Check if chords are meshing
400 check_meshing_chords (me, &offsets, extents, clash_groups);
404 for (int i=0; i < clash_groups[d].size (); i++)
405 tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (), gh_double2scm (offsets[d][i])),
408 while (flip (&d) != UP);
414 Note_collision_interface::forced_shift (Grob *me)
418 SCM s = me->get_grob_property ("elements");
419 for (; gh_pair_p (s); s = ly_cdr (s))
421 Grob * se = unsmob_grob (ly_car (s));
423 SCM force = se->get_grob_property ("force-hshift");
424 if (gh_number_p (force))
426 tups = gh_cons (gh_cons (se->self_scm (), force),
434 Note_collision_interface::add_column (Grob*me,Grob* ncol)
436 ncol->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
437 Axis_group_interface::add_element (me, ncol);
438 me->add_dependency (ncol);
442 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
443 "An object that handles collisions between notes with different stem "
444 "directions and horizontal shifts. Most of the interesting properties "
445 "are to be set in @ref{note-column-interface}: these are "
446 "@code{force-hshift} and @code{horizontal-shift}. ",
447 "merge-differently-dotted merge-differently-headed collision-done");