/*
This file is part of LilyPond, the GNU music typesetter.
- Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
LilyPond is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include "stem.hh"
#include "warn.hh"
-void
+Real
check_meshing_chords (Grob *me,
- Drul_array<vector<Real> > *offsets,
- Drul_array<vector<Slice> > const &extents,
- Drul_array<vector<Grob *> > const &clash_groups)
+ Grob *clash_up, Grob *clash_down)
{
- if (!extents[UP].size () || !extents[DOWN].size ())
- return;
-
- Grob *clash_up = clash_groups[UP][0];
- Grob *clash_down = clash_groups[DOWN][0];
-
/* Every note column should have a stem, but avoid a crash. */
if (!Note_column::get_stem (clash_up) || !Note_column::get_stem (clash_down))
- return;
+ return 0.0;
Drul_array<Grob *> stems (Note_column::get_stem (clash_down),
Note_column::get_stem (clash_up));
Grob *head_up = Note_column::first_head (clash_up);
Grob *head_down = Note_column::first_head (clash_down);
- vector<int> ups = Stem::note_head_positions (Note_column::get_stem (clash_up));
- vector<int> dps = Stem::note_head_positions (Note_column::get_stem (clash_down));
+ Interval extent_up = head_up->extent (head_up, X_AXIS);
+ Interval extent_down = head_down->extent (head_down, X_AXIS);
+
+ /* Staff-positions of all noteheads on each stem */
+ vector<int> ups = Stem::note_head_positions (stems[UP]);
+ vector<int> dps = Stem::note_head_positions (stems[DOWN]);
+
+ int threshold = robust_scm2int (me->get_property ("note-collision-threshold"), 1);
/* Too far apart to collide. */
- if (ups[0] > dps.back () + 1)
- return;
+ if (ups[0] > dps.back () + threshold)
+ return 0.0;
+
+ /* If the chords just 'touch' their extreme noteheads,
+ then we can align their stems.
+ */
+ bool touch = false;
+ if (ups[0] >= dps.back ()
+ && (dps.size () < 2 || ups[0] >= dps[dps.size () - 2] + threshold + 1)
+ && (ups.size () < 2 || ups[1] >= dps.back () + threshold + 1))
+ touch = true;
+
+ /* Filter out the 'o's in this configuration, since they're no
+ * part in the collision.
+ *
+ * |
+ * x|o
+ * x|o
+ * x
+ *
+ */
+ ups = Stem::note_head_positions (stems[UP], true);
+ dps = Stem::note_head_positions (stems[DOWN], true);
/* Merge heads if the notes lie the same line, or if the "stem-up-note" is
above the "stem-down-note". */
*
*/
- /* TODO: filter out the 'o's in this configuration, since they're no
- * part in the collision.
- *
- * |
- * x|o
- * x|o
- * x
- *
- */
-
bool close_half_collide = false;
bool distant_half_collide = false;
bool full_collide = false;
for (vsize i = 0, j = 0; i < ups.size () && j < dps.size ();)
{
- if (abs (ups[i] - dps[j]) == 1)
+ if (ups[i] == dps[j])
+ full_collide = true;
+ else if (abs (ups[i] - dps[j]) <= threshold)
{
merge_possible = false;
if (ups[i] > dps[j])
else
distant_half_collide = true;
}
- else if (ups[i] == dps[j])
- full_collide = true;
else if (ups[i] > dps[0] && ups[i] < dps.back ())
merge_possible = false;
else if (dps[j] > ups[0] && dps[j] < ups.back ())
}
full_collide = full_collide || (close_half_collide
- && distant_half_collide);
-
- /* If the only collision is in the extreme noteheads,
- then their stems can line up and the chords just 'touch'.
- A half collision with the next note along the chord prevents touching.
- */
- bool touch = false;
- if (ups[0] >= dps.back ()
- && (dps.size () < 2 || ups[0] >= dps[dps.size () - 2] + 2)
- && (ups.size () < 2 || ups[1] >= dps.back () + 2))
- touch = true;
+ && distant_half_collide)
+ || ( distant_half_collide // like full_ for wholes and longer
+ && (up_ball_type <= 0 || down_ball_type <= 0));
/* Determine which chord goes on the left, and which goes right.
Up-stem usually goes on the right, but if chords just 'touch' we can put
SCM up_style = head_up->get_property ("style");
SCM down_style = head_down->get_property ("style");
if (merge_possible
- && (up_style == ly_symbol2scm ("fa") || up_style == ly_symbol2scm ("faThin"))
- && (down_style == ly_symbol2scm ("fa") || down_style == ly_symbol2scm ("faThin")))
+ && (scm_is_eq (up_style, ly_symbol2scm ("fa"))
+ || scm_is_eq (up_style, ly_symbol2scm ("faThin")))
+ && (scm_is_eq (down_style, ly_symbol2scm ("fa"))
+ || scm_is_eq (down_style, ly_symbol2scm ("faThin"))))
{
Offset att = Offset (0.0, -1.0);
head_up->set_property ("stem-attachment", ly_offset2scm (att));
/* If possible, don't wipe any heads. Else, wipe shortest head,
or head with smallest amount of dots. Note: when merging
- different heads, dots on the smaller one disappear. */
+ different heads, dots on the smaller one disappear; and when
+ merging identical heads, dots on the down-stem head disappear */
Grob *wipe_ball = 0;
Grob *dot_wipe_head = head_up;
wipe_ball = head_up;
}
else
- dot_wipe_head = head_up;
+ dot_wipe_head = head_down;
}
else if (down_ball_type > up_ball_type)
{
*/
if (Stem::duration_log (stems[DOWN]) == 1
&& Stem::duration_log (stems[UP]) >= 3)
- shift_amount = (1 - head_up->extent (head_up, X_AXIS).length ()
- / head_down->extent (head_down, X_AXIS).length ()) * 0.5;
+ shift_amount = (1 - extent_up[RIGHT] / extent_down[RIGHT]) * 0.5;
}
if (dot_wipe_head)
{
- if (Grob *d = unsmob_grob (dot_wipe_head->get_object ("dot")))
+ if (Grob *d = unsmob<Grob> (dot_wipe_head->get_object ("dot")))
d->suicide ();
}
else
shift_amount *= 0.17;
- /*
- */
- if (full_collide
- && down_ball_type *up_ball_type == 0)
+ /* The offsets computed in this routine are multiplied,
+ in calc_positioning_done(), by the width of the downstem note.
+ The shift required to clear collisions, however, depends on the extents
+ of the note heads on the sides that interfere. */
+ if (shift_amount < 0.0) // Down-stem shifts right.
+ shift_amount *= (extent_up[RIGHT] - extent_down[LEFT]) / extent_down.length ();
+ else // Up-stem shifts right.
+ shift_amount *= (extent_down[RIGHT] - extent_up[LEFT]) / extent_down.length ();
+
+ /* If any dotted notes ended up on the left,
+ tell the Dot_Columnn to avoid the note heads on the right.
+ */
+ if (shift_amount < -1e-6
+ && Rhythmic_head::dot_count (head_up))
{
- if (up_ball_type == 0 && down_ball_type == 1)
- shift_amount *= 1.25;
- else if (up_ball_type == 0 && down_ball_type == 2)
- shift_amount *= 1.35;
- else if (down_ball_type == 0 && up_ball_type == 1)
- shift_amount *= 0.7;
- else if (down_ball_type == 0 && up_ball_type == 2)
- shift_amount *= 0.75;
+ Grob *d = unsmob<Grob> (head_up->get_object ("dot"));
+ Grob *parent = d->get_parent (X_AXIS);
+ if (has_interface<Dot_column> (parent))
+ Side_position_interface::add_support (parent, head_down);
+ }
+ else if (Rhythmic_head::dot_count (head_down))
+ {
+ Grob *d = unsmob<Grob> (head_down->get_object ("dot"));
+ Grob *parent = d->get_parent (X_AXIS);
+ if (has_interface<Dot_column> (parent))
+ {
+ Grob *stem = unsmob<Grob> (head_up->get_object ("stem"));
+ // Loop over all heads on an up-pointing-stem to see if dots
+ // need to clear any heads suspended on its right side.
+ extract_grob_set (stem, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
+ Side_position_interface::add_support (parent, heads[i]);
+ }
}
- /* If the dotted notes ended up on the left, and there are collisions,
- tell the Dot_Columnn to avoid the notes on the right.
- */
- if (full_collide || close_half_collide || distant_half_collide)
+ // In meshed chords with dots on the left, adjust dot direction
+ if (shift_amount > 1e-6
+ && Rhythmic_head::dot_count (head_down))
{
- if (shift_amount < -1e-6
- && Rhythmic_head::dot_count (head_up)
- && !Rhythmic_head::dot_count (head_down))
+ Grob *dot_down = unsmob<Grob> (head_down->get_object ("dot"));
+ Grob *col_down = dot_down->get_parent (X_AXIS);
+ Direction dir = UP;
+ if (Rhythmic_head::dot_count (head_up))
{
- Grob *d = unsmob_grob (head_up->get_object ("dot"));
- Grob *parent = d->get_parent (X_AXIS);
- if (Dot_column::has_interface (parent))
- Side_position_interface::add_support (parent, head_down);
+ Grob *dot_up = unsmob<Grob> (head_up->get_object ("dot"));
+ Grob *col_up = dot_up->get_parent (X_AXIS);
+ if (col_up == col_down) // let the common DotColumn arrange dots
+ dir = CENTER;
+ else // conform to the dot direction on the up-stem chord
+ dir = robust_scm2dir (dot_up->get_property ("direction"), UP);
}
- else if (Rhythmic_head::dot_count (head_down)
- && !Rhythmic_head::dot_count (head_up))
+ if (dir != CENTER)
{
- Grob *d = unsmob_grob (head_down->get_object ("dot"));
- Grob *parent = d->get_parent (X_AXIS);
- if (Dot_column::has_interface (parent))
- {
- Grob *stem = unsmob_grob (head_up->get_object ("stem"));
- extract_grob_set (stem, "note-heads", heads);
- for (vsize i = 0; i < heads.size (); i++)
- Side_position_interface::add_support (parent, heads[i]);
- }
+ Grob *stem = unsmob<Grob> (head_down->get_object ("stem"));
+ extract_grob_set (stem, "note-heads", heads);
+ for (vsize i = 0; i < heads.size (); i++)
+ if (Grob *dot = unsmob<Grob> (heads[i]->get_object ("dot")))
+ dot->set_property ("direction", scm_from_int (dir));
}
}
- Direction d = UP;
- do
- {
- for (vsize i = 0; i < clash_groups[d].size (); i++)
- (*offsets)[d][i] += d * shift_amount;
- }
- while ((flip (&d)) != UP);
+ return shift_amount;
}
MAKE_SCHEME_CALLBACK (Note_collision_interface, calc_positioning_done, 1)
SCM
Note_collision_interface::calc_positioning_done (SCM smob)
{
- Grob *me = unsmob_grob (smob);
+ Grob *me = unsmob<Grob> (smob);
me->set_property ("positioning-done", SCM_BOOL_T);
Drul_array<vector<Grob *> > clash_groups = get_clash_groups (me);
- Direction d = UP;
- do
+ for (UP_and_DOWN (d))
{
for (vsize i = clash_groups[d].size (); i--;)
{
clash_groups[d][i]->extent (me, X_AXIS);
}
}
- while (flip (&d) != UP);
SCM autos (automatic_shift (me, clash_groups));
SCM hand (forced_shift (me));
Real wid = 0.0;
- do
+ for (UP_and_DOWN (d))
{
if (clash_groups[d].size ())
{
wid = fh->extent (h, X_AXIS).length ();
}
}
- while (flip (&d) != UP);
vector<Grob *> done;
- Real left_most = 1e6;
+ Real left_most = 0.0;
vector<Real> amounts;
for (; scm_is_pair (hand); hand = scm_cdr (hand))
{
- Grob *s = unsmob_grob (scm_caar (hand));
+ Grob *s = unsmob<Grob> (scm_caar (hand));
Real amount = scm_to_double (scm_cdar (hand)) * wid;
done.push_back (s);
amounts.push_back (amount);
- if (amount < left_most)
- left_most = amount;
}
for (; scm_is_pair (autos); autos = scm_cdr (autos))
{
- Grob *s = unsmob_grob (scm_caar (autos));
+ Grob *s = unsmob<Grob> (scm_caar (autos));
Real amount = scm_to_double (scm_cdar (autos)) * wid;
vsize x = find (done, s) - done.begin ();
for (vsize i = 0; i < elements.size (); i++)
{
Grob *se = elements[i];
- if (Note_column::has_interface (se))
+ if (has_interface<Note_column> (se))
{
if (!Note_column::dir (se))
se->programming_error ("note-column has no direction");
}
}
- Direction d = UP;
- do
+ for (UP_and_DOWN (d))
{
vector<Grob *> &clashes (clash_groups[d]);
vector_sort (clashes, Note_column::shift_less);
}
- while ((flip (&d)) != UP);
return clash_groups;
}
Note_collision_interface::automatic_shift (Grob *me,
Drul_array<vector<Grob *> > clash_groups)
{
- Drul_array < vector<int> > shifts;
SCM tups = SCM_EOL;
- Direction d = UP;
- do
- {
- vector<int> &shift (shifts[d]);
- vector<Grob *> &clashes (clash_groups[d]);
-
- for (vsize i = 0; i < clashes.size (); i++)
- {
- SCM sh
- = clashes[i]->get_property ("horizontal-shift");
-
- if (scm_is_number (sh))
- shift.push_back (scm_to_int (sh));
- else
- shift.push_back (0);
- }
-
- for (vsize i = 1; i < shift.size (); i++)
- {
- if (shift[i - 1] == shift[i])
- {
- clashes[0]->warning (_ ("ignoring too many clashing note columns"));
- return tups;
- }
- }
- }
- while ((flip (&d)) != UP);
-
Drul_array<vector<Slice> > extents;
- Drul_array<vector<Real> > offsets;
- d = UP;
- do
+ Drul_array<Slice> extent_union;
+ Drul_array<vector<Grob *> > stems;
+ for (UP_and_DOWN (d))
{
for (vsize i = 0; i < clash_groups[d].size (); i++)
{
s[LEFT]--;
s[RIGHT]++;
extents[d].push_back (s);
- offsets[d].push_back (d * 0.5 * i);
+ extent_union[d].unite (s);
+ stems[d].push_back (Note_column::get_stem (clash_groups[d][i]));
}
}
- while ((flip (&d)) != UP);
- /*
- do horizontal shifts of each direction
+ Real inner_offset
+ = (clash_groups[UP].size () && clash_groups[DOWN].size ())
+ ? check_meshing_chords (me, clash_groups[UP][0], clash_groups[DOWN][0])
+ : 0.0;
- |
- x||
- x||
- x|
+ /*
+ * do horizontal shifts of each direction
+ *
+ * |
+ * x||
+ * x||
+ * x|
*/
-
- do
+ Drul_array<vector<Real> > offsets;
+ for (UP_and_DOWN (d))
{
- for (vsize i = 1; i < clash_groups[d].size (); i++)
+ Real offset = inner_offset;
+ vector<int> shifts;
+ for (vsize i = 0; i < clash_groups[d].size (); i++)
{
- Slice prev = extents[d][i - 1];
- prev.intersect (extents[d][i]);
- if (prev.length () > 0
- || (extents[-d].size () && d * (extents[d][i][-d] - extents[-d][0][d]) < 0))
- for (vsize j = i; j < clash_groups[d].size (); j++)
- offsets[d][j] += d * 0.5;
+ Grob *col = clash_groups[d][i];
+ SCM sh = col->get_property ("horizontal-shift");
+ shifts.push_back (robust_scm2int (sh, 0));
+
+ if (i == 0)
+ offset = inner_offset;
+ else
+ {
+ bool explicit_shift = scm_is_number (sh);
+ if (!explicit_shift)
+ col->warning (_ ("this Voice needs a \\voiceXx or \\shiftXx setting"));
+
+ if (explicit_shift && shifts[i] == shifts[i - 1])
+ ; // Match the previous notecolumn offset
+ else if (extents[d][i][UP] > extents[d][i - 1][DOWN]
+ && extents[d][i][DOWN] < extents[d][i - 1][UP])
+ offset += 1.0; // fully clear the previous-notecolumn heads
+ else if (d * extents[d][i][-d] >= d * extents[d][i - 1][d])
+ offset += Stem::is_valid_stem (stems[d][i - 1])
+ ? 1.0 : 0.5; // we cross the previous notecolumn
+ else if (Stem::is_valid_stem (stems[d][i]))
+ offset += 0.5;
+
+ // check if we cross the opposite-stemmed voices
+ if (d * extents[d][i][-d] < d * extent_union[-d][d])
+ offset = max (offset, 0.5);
+ if (extents[-d].size ()
+ && extents[d][i][UP] > extents[-d][0][DOWN]
+ && extents[d][i][DOWN] < extents[-d][0][UP])
+ offset = max (offset, 1.0);
+ }
+ offsets[d].push_back (d * offset);
}
}
- while ((flip (&d)) != UP);
/*
see input/regression/dot-up-voice-collision.ly
if (dc)
for (vsize j = i + 1; j < clash_groups[UP].size (); j++)
- {
- Grob *stem = Note_column::get_stem (clash_groups[UP][j]);
- Side_position_interface::add_support (dc, stem);
- }
+ Side_position_interface::add_support (dc, stems[UP][j]);
}
- /*
- Check if chords are meshing
- */
-
- check_meshing_chords (me, &offsets, extents, clash_groups);
-
- do
+ for (UP_and_DOWN (d))
{
for (vsize i = 0; i < clash_groups[d].size (); i++)
tups = scm_cons (scm_cons (clash_groups[d][i]->self_scm (),
scm_from_double (offsets[d][i])),
tups);
}
- while (flip (&d) != UP);
return tups;
}
Axis_group_interface::add_element (me, ncol);
}
+vector<int>
+Note_collision_interface::note_head_positions (Grob *me)
+{
+ vector<int> out;
+ extract_grob_set (me, "elements", elts);
+ for (vsize i = 0; i < elts.size (); i++)
+ if (Grob *stem = unsmob<Grob> (elts[i]->get_object ("stem")))
+ {
+ vector<int> nhp = Stem::note_head_positions (stem);
+ out.insert (out.end (), nhp.begin (), nhp.end ());
+ }
+
+ vector_sort (out, less<int> ());
+ return out;
+}
+
ADD_INTERFACE (Note_collision_interface,
"An object that handles collisions between notes with"
" different stem directions and horizontal shifts. Most of"
/* properties */
"merge-differently-dotted "
"merge-differently-headed "
+ "note-collision-threshold "
"positioning-done "
"prefer-dotted-right "
);