2 collision.cc -- implement Collision
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "note-collision.hh"
11 #include "axis-group-interface.hh"
12 #include "dot-column.hh"
13 #include "international.hh"
14 #include "note-column.hh"
15 #include "note-head.hh"
16 #include "output-def.hh"
17 #include "pointer-group-interface.hh"
18 #include "rhythmic-head.hh"
19 #include "side-position-interface.hh"
25 check_meshing_chords (Grob *me,
26 Drul_array<vector<Real> > *offsets,
27 Drul_array<vector<Slice> > const &extents,
28 Drul_array<vector<Grob*> > const &clash_groups)
31 if (!extents[UP].size () || ! extents[DOWN].size ())
34 Grob *cu = clash_groups[UP][0];
35 Grob *cd = clash_groups[DOWN][0];
37 /* Every note column should have a stem, but avoid a crash. */
38 if (!Note_column::get_stem (cu) || !Note_column::get_stem (cd))
41 Grob *nu = Note_column::first_head (cu);
42 Grob *nd = Note_column::first_head (cd);
44 vector<int> ups = Stem::note_head_positions (Note_column::get_stem (cu));
45 vector<int> dps = Stem::note_head_positions (Note_column::get_stem (cd));
47 /* Too far apart to collide. */
48 if (ups[0] > dps.back () + 1)
51 /* Merge heads if the notes lie the same line, or if the "stem-up-note" is
52 above the "stem-down-note". */
53 bool merge_possible = (ups[0] >= dps[0]) && (ups.back () >= dps.back ());
55 /* Do not merge notes typeset in different style. */
56 if (!ly_is_equal (nu->get_property ("style"),
57 nd->get_property ("style")))
58 merge_possible = false;
60 int upball_type = Note_head::get_balltype (nu);
61 int dnball_type = Note_head::get_balltype (nd);
63 /* Do not merge whole notes (or longer, like breve, longa, maxima). */
64 if (merge_possible && (upball_type <= 0 || dnball_type <= 0))
65 merge_possible = false;
68 && Rhythmic_head::dot_count (nu) != Rhythmic_head::dot_count (nd)
69 && !to_boolean (me->get_property ("merge-differently-dotted")))
70 merge_possible = false;
72 /* Can only merge different heads if merge-differently-headed is
75 && upball_type != dnball_type
76 && !to_boolean (me->get_property ("merge-differently-headed")))
77 merge_possible = false;
80 && nu->get_property ("style") == ly_symbol2scm ("fa")
81 && nd->get_property ("style") == ly_symbol2scm ("fa"))
83 Interval uphead_size = nu->extent (nu, Y_AXIS);
84 Offset att = Offset (0.0, -1.0);
85 nu->set_property ("stem-attachment", ly_offset2scm (att));
86 nu->set_property ("transparent", SCM_BOOL_T);
89 /* Should never merge quarter and half notes, as this would make
90 them indistinguishable. */
92 && ((Rhythmic_head::duration_log (nu) == 1
93 && Rhythmic_head::duration_log (nd) == 2)
94 || (Rhythmic_head::duration_log (nu) == 2
95 && Rhythmic_head::duration_log (nd) == 1)))
96 merge_possible = false;
99 this case (distant half collide),
106 the noteheads may be closer than this case (close half collide)
117 /* TODO: filter out the 'o's in this configuration, since they're no
118 part in the collision.
127 bool close_half_collide = false;
128 bool distant_half_collide = false;
129 bool full_collide = false;
131 for (vsize i = 0, j = 0; i < ups.size () && j < dps.size (); )
133 if (abs (ups[i] - dps[j]) == 1)
135 merge_possible = false;
137 close_half_collide = true;
139 distant_half_collide = true;
141 else if (ups[i] == dps[j])
143 else if (ups[i] > dps[0] && ups[i] < dps.back ())
144 merge_possible = false;
145 else if (dps[j] > ups[0] && dps[j] < ups.back ())
146 merge_possible = false;
150 else if (ups[i] > dps[j])
159 full_collide = full_collide || (close_half_collide
160 && distant_half_collide);
162 Drul_array<Real> center_note_shifts;
163 center_note_shifts[LEFT] = 0.0;
164 center_note_shifts[RIGHT] = 0.0;
166 Real shift_amount = 1;
168 bool touch = (ups[0] >= dps.back ());
172 /* For full collisions, the right hand head may obscure dots, so
173 make sure the dotted heads go to the right. */
174 bool stem_to_stem = false;
176 if (Rhythmic_head::dot_count (nu) > Rhythmic_head::dot_count (nd))
178 else if (Rhythmic_head::dot_count (nu) < Rhythmic_head::dot_count (nd))
185 /* If possible, don't wipe any heads. Else, wipe shortest head,
186 or head with smallest amount of dots. Note: when merging
187 different heads, dots on the smaller one disappear. */
189 Grob *dot_wipe_head = nu;
191 if (upball_type == dnball_type)
193 if (Rhythmic_head::dot_count (nd) < Rhythmic_head::dot_count (nu))
198 else if (Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu))
206 else if (dnball_type > upball_type)
211 else if (dnball_type < upball_type)
219 if (Grob *d = unsmob_grob (dot_wipe_head->get_object ("dot")))
223 if (wipe_ball && wipe_ball->is_live ())
225 wipe_ball->set_property ("transparent", SCM_BOOL_T);
228 /* TODO: these numbers are magic; should devise a set of grob props
229 to tune this behavior. */
230 else if (stem_to_stem)
231 shift_amount = -abs (shift_amount) * 0.65;
232 else if (close_half_collide && !touch)
233 shift_amount *= 0.52;
234 else if (distant_half_collide && !touch)
236 else if (distant_half_collide || close_half_collide || full_collide)
240 else if (Rhythmic_head::dot_count (nu) || Rhythmic_head::dot_count (nd))
243 shift_amount *= 0.17;
245 /* For full or close half collisions, the right hand head may
246 obscure dots. Move dots to the right. */
247 if (abs (shift_amount) > 1e-6
248 && Rhythmic_head::dot_count (nd) > Rhythmic_head::dot_count (nu)
249 && (full_collide || close_half_collide))
251 Grob *d = unsmob_grob (nd->get_object ("dot"));
252 Grob *parent = d->get_parent (X_AXIS);
262 the . is put right of o which is erroneous o force-shifted
265 if (Dot_column::has_interface (parent))
266 Side_position_interface::add_support (parent, nu);
272 for (vsize i = 0; i < clash_groups[d].size (); i++)
273 (*offsets)[d][i] += d * shift_amount;
275 while ((flip (&d)) != UP);
279 MAKE_SCHEME_CALLBACK(Note_collision_interface, calc_positioning_done, 1)
281 Note_collision_interface::calc_positioning_done (SCM smob)
283 Grob *me = unsmob_grob (smob);
284 Drul_array<vector<Grob*> > cg = get_clash_groups (me);
289 for (vsize i = cg[d].size(); i--; )
294 cg[d][i]->extent (me, X_AXIS);
297 while (flip (&d) != UP);
299 SCM autos (automatic_shift (me, cg));
300 SCM hand (forced_shift (me));
308 Grob *fh = Note_column::first_head (h);
310 wid = fh->extent (h, X_AXIS).length ();
313 while (flip (&d) != UP);
316 Real left_most = 1e6;
318 vector<Real> amounts;
319 for (; scm_is_pair (hand); hand = scm_cdr (hand))
321 Grob *s = unsmob_grob (scm_caar (hand));
322 Real amount = scm_to_double (scm_cdar (hand)) * wid;
325 amounts.push_back (amount);
326 if (amount < left_most)
329 for (; scm_is_pair (autos); autos = scm_cdr (autos))
331 Grob *s = unsmob_grob (scm_caar (autos));
332 Real amount = scm_to_double (scm_cdar (autos)) * wid;
334 vsize x = find (done, s) - done.begin ();
335 if (x == VPOS || x >= done.size ())
338 amounts.push_back (amount);
339 if (amount < left_most)
344 for (vsize i = 0; i < amounts.size (); i++)
345 done[i]->translate_axis (amounts[i] - left_most, X_AXIS);
350 Drul_array < vector<Grob*> >
351 Note_collision_interface::get_clash_groups (Grob *me)
353 Drul_array<vector<Grob*> > clash_groups;
355 extract_grob_set (me, "elements", elements);
356 for (vsize i = 0; i < elements.size (); i++)
358 Grob *se = elements[i];
359 if (Note_column::has_interface (se))
361 if (!Note_column::dir (se))
363 se->programming_error ("note-column has no direction");
366 clash_groups[Note_column::dir (se)].push_back (se);
373 vector<Grob*> &clashes (clash_groups[d]);
374 vector_sort (clashes, Note_column::shift_compare);
376 while ((flip (&d)) != UP);
381 /** This complicated routine moves note columns around horizontally to
382 ensure that notes don't clash.
384 This should be put into Scheme.
387 Note_collision_interface::automatic_shift (Grob *me,
388 Drul_array < vector<Grob*>
391 Drul_array < vector<int> > shifts;
397 vector<int> &shift (shifts[d]);
398 vector<Grob*> &clashes (clash_groups[d]);
400 for (vsize i = 0; i < clashes.size (); i++)
403 = clashes[i]->get_property ("horizontal-shift");
405 if (scm_is_number (sh))
406 shift.push_back (scm_to_int (sh));
411 for (vsize i = 1; i < shift.size (); i++)
413 if (shift[i - 1] == shift[i])
415 clashes[0]->warning (_ ("ignoring too many clashing note columns"));
420 while ((flip (&d)) != UP);
422 Drul_array<vector<Slice> > extents;
423 Drul_array<vector<Real> > offsets;
427 for (vsize i = 0; i < clash_groups[d].size (); i++)
429 Slice s (Note_column::head_positions_interval (clash_groups[d][i]));
432 extents[d].push_back (s);
433 offsets[d].push_back (d * 0.5 * i);
436 while ((flip (&d)) != UP);
439 do horizontal shifts of each direction
449 for (vsize i = 1; i < clash_groups[d].size (); i++)
451 Slice prev = extents[d][i - 1];
452 prev.intersect (extents[d][i]);
453 if (prev.length () > 0
454 || (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
455 for (vsize j = i; j < clash_groups[d].size (); j++)
456 offsets[d][j] += d * 0.5;
459 while ((flip (&d)) != UP);
462 Check if chords are meshing
465 check_meshing_chords (me, &offsets, extents, clash_groups);
469 for (vsize i = 0; i < clash_groups[d].size (); i++)
470 tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
471 scm_from_double (offsets[d][i])),
474 while (flip (&d) != UP);
480 Note_collision_interface::forced_shift (Grob *me)
484 extract_grob_set (me, "elements", elements);
485 for (vsize i = 0; i < elements.size (); i++)
487 Grob *se = elements[i];
489 SCM force = se->get_property ("force-hshift");
490 if (scm_is_number (force))
492 tups = scm_cons (scm_cons (se->self_scm (), force),
500 Note_collision_interface::add_column (Grob *me, Grob *ncol)
502 ncol->set_property ("X-offset", Grob::x_parent_positioning_proc);
503 Axis_group_interface::add_element (me, ncol);
506 ADD_INTERFACE (Note_collision_interface, "note-collision-interface",
507 "An object that handles collisions between notes with different stem "
508 "directions and horizontal shifts. Most of the interesting properties "
509 "are to be set in @ref{note-column-interface}: these are "
510 "@code{force-hshift} and @code{horizontal-shift}.",
513 "merge-differently-dotted "
514 "merge-differently-headed "