3 collision.cc -- implement Collision
5 source file of the GNU LilyPond music typesetter
7 (c) 1997--2002 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_l= Note_column::first_head (cu);
56 Grob * nd_l = 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 filter out the 'o's in this configuration, since they're no part
96 Array<int> ups = Stem::note_head_positions (Note_column::stem_l (cu));
97 Array<int> dps = Stem::note_head_positions (Note_column::stem_l (cd));
100 they're too far apart to collide.
104 if (ups[0] > dps.top () + 1)
107 bool touch = (ups[0] - dps.top () >= 0);
109 bool merge_possible = (ups[0] >= dps[0]) && (ups.top () >= dps.top ());
112 don't merge whole notes (or longer, like breve, longa, maxima)
115 int upball_type = Note_head::balltype_i (nu_l);
116 int dnball_type = Note_head::balltype_i (nd_l);
118 merge_possible = merge_possible && (upball_type > 0);
120 if (!to_boolean (me->get_grob_property ("merge-differently-dotted")))
121 merge_possible = merge_possible && Rhythmic_head::dot_count (nu_l) == Rhythmic_head::dot_count (nd_l);
124 if (!to_boolean (me->get_grob_property ("merge-differently-headed")))
125 merge_possible = merge_possible &&
126 upball_type == dnball_type;
129 Can't merge quarter and half notes.
131 merge_possible = merge_possible &&
132 !((Rhythmic_head::duration_log (nu_l) == 1
133 && Rhythmic_head::duration_log (nd_l) == 2)
134 ||(Rhythmic_head::duration_log (nu_l) == 2
135 && Rhythmic_head::duration_log (nd_l) == 1));
138 while (i < ups.size () && j < dps.size ())
140 if (abs (ups[i] - dps[j]) == 1)
142 merge_possible = false;
144 close_half_collide = true;
146 distant_half_collide = true;
148 else if (ups[i]==dps[j])
150 else if (ups[i] >dps[0] && ups[i] < dps.top ())
151 merge_possible = false;
152 else if (dps[j] >ups[0] && dps[j] < ups.top ())
153 merge_possible = false;
157 else if (ups[i] > dps[j])
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;
177 for full collisions, the right hand head may obscure dots, so
178 make sure the dotted heads go to the right.
180 if ((Rhythmic_head::dot_count (nu_l) > Rhythmic_head::dot_count (nd_l)
185 TODO: these numbers are magic; should devise a set of grob props
186 to tune this behavior. */
193 if (upball_type < dnball_type)
195 else if (upball_type > dnball_type)
200 wipe_ball->set_grob_property ("transparent", SCM_BOOL_T);
201 wipe_ball->set_grob_property ("molecule", SCM_EOL);
204 else if (close_half_collide && !touch)
205 shift_amount *= 0.52;
206 else if (distant_half_collide && !touch)
208 else if (distant_half_collide || close_half_collide || full_collide)
214 else if (Rhythmic_head::dot_count (nu_l) || Rhythmic_head::dot_count (nd_l))
217 shift_amount *= 0.25;
222 for (int i=0; i < clash_groups[d].size (); i++)
223 (*offsets)[d][i] += d * shift_amount;
225 while ((flip (&d))!= UP);
229 Note_collision_interface::do_shifts (Grob* me)
231 Drul_array< Link_array <Grob> > cg = get_clash_groups (me);
233 SCM autos (automatic_shift (me, cg));
234 SCM hand (forced_shift (me));
245 wid = Note_column::first_head(h)->extent(h,X_AXIS).length() ;
249 while (flip (&d) != UP);
252 Link_array<Grob> done;
253 for (; gh_pair_p (hand); hand =ly_cdr (hand))
255 Grob * s = unsmob_grob (ly_caar (hand));
256 Real amount = gh_scm2double (ly_cdar (hand));
258 s->translate_axis (amount *wid, X_AXIS);
261 for (; gh_pair_p (autos); autos =ly_cdr (autos))
263 Grob * s = unsmob_grob (ly_caar (autos));
264 Real amount = gh_scm2double (ly_cdar (autos));
266 if (!done.find_l (s))
267 s->translate_axis (amount * wid, X_AXIS);
271 Drul_array< Link_array <Grob> >
272 Note_collision_interface::get_clash_groups (Grob *me)
274 Drul_array<Link_array<Grob> > clash_groups;
276 SCM s = me->get_grob_property ("elements");
277 for (; gh_pair_p (s); s = ly_cdr (s))
279 SCM car = ly_car (s);
281 Grob * se = unsmob_grob (car);
282 if (Note_column::has_interface (se))
283 clash_groups[Note_column::dir (se)].push (se);
289 Link_array<Grob> & clashes (clash_groups[d]);
290 clashes.sort (Note_column::shift_compare);
292 while ((flip (&d))!= UP);
297 /** This complicated routine moves note columns around horizontally to
298 ensure that notes don't clash.
300 This should be put into Scheme.
303 Note_collision_interface::automatic_shift (Grob *me,
304 Drul_array< Link_array <Grob> >
307 Drul_array<Array<int> > shifts;
314 Array<int> & shift (shifts[d]);
315 Link_array<Grob> & clashes (clash_groups[d]);
317 for (int i=0; i < clashes.size (); i++)
320 = clashes[i]->get_grob_property ("horizontal-shift");
322 if (gh_number_p (sh))
323 shift.push (gh_scm2int (sh));
328 for (int i=1; i < shift.size (); i++)
330 if (shift[i-1] == shift[i])
332 me->warning (_ ("Too many clashing notecolumns. Ignoring them."));
337 while ((flip (&d))!= UP);
339 Drul_array< Array < Slice > > extents;
340 Drul_array< Array < Real > > offsets;
344 for (int i=0; i < clash_groups[d].size (); i++)
346 Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
350 offsets[d].push (d * 0.5 * i);
353 while ((flip (&d))!= UP);
356 do horizontal shifts of each direction
366 for (int i=1; i < clash_groups[d].size (); i++)
368 Slice prev =extents[d][i-1];
369 prev.intersect (extents[d][i]);
370 if (prev.length ()> 0 ||
371 (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
372 for (int j = i; j < clash_groups[d].size (); j++)
373 offsets[d][j] += d * 0.5;
376 while ((flip (&d))!= UP);
380 Check if chords are meshing
383 check_meshing_chords (me, &offsets, extents, clash_groups);
387 for (int i=0; i < clash_groups[d].size (); i++)
388 tups = gh_cons (gh_cons (clash_groups[d][i]->self_scm (), gh_double2scm (offsets[d][i])),
391 while (flip (&d) != UP);
397 Note_collision_interface::forced_shift (Grob *me)
401 SCM s = me->get_grob_property ("elements");
402 for (; gh_pair_p (s); s = ly_cdr (s))
404 Grob * se = unsmob_grob (ly_car (s));
406 SCM force = se->remove_grob_property ("force-hshift");
407 if (gh_number_p (force))
409 tups = gh_cons (gh_cons (se->self_scm (), force),
417 Note_collision_interface::add_column (Grob*me,Grob* ncol_l)
419 ncol_l->add_offset_callback (Note_collision_interface::force_shift_callback_proc, X_AXIS);
420 Axis_group_interface::add_element (me, ncol_l);
421 me->add_dependency (ncol_l);
425 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
426 "An object that handles collisions between notes with different stem
427 directions and horizontal shifts. Most of the interesting properties
428 are to be set in @ref{note-column-interface}: these are
429 @code{force-hshift} and @code{horizontal-shift}.
431 "merge-differently-dotted merge-differently-headed collision-done");