2 slur.cc -- implement Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 * begin and end should be treated as a/acknowledge Scripts.
13 * broken slur should have uniform trend
16 #include "directional-element-interface.hh"
17 #include "group-interface.hh"
20 #include "paper-def.hh"
21 #include "note-column.hh"
23 #include "paper-column.hh"
24 #include "molecule.hh"
29 #include "cross-staff.hh"
30 #include "group-interface.hh"
34 set_elt_property ("note-columns", SCM_EOL);
38 Slur::add_column (Note_column*n)
40 if (!gh_pair_p (n->get_elt_property ("note-heads")))
41 warning (_ ("Putting slur over rest. Ignoring."));
44 Group_interface gi (this, "note-columns");
51 Slur::get_default_dir () const
53 Link_array<Note_column> encompass_arr =
54 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
57 for (int i=0; i < encompass_arr.size (); i ++)
59 if (encompass_arr[i]->dir () < 0)
69 Slur::do_add_processing ()
71 Link_array<Note_column> encompass_arr =
72 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
73 set_bounds (LEFT, encompass_arr[0]);
74 if (encompass_arr.size () > 1)
75 set_bounds (RIGHT, encompass_arr.top ());
79 Slur::do_pre_processing ()
81 // don't set directions
86 Slur::encompass_offset (Note_column const* col) const
89 Stem* stem_l = col->stem_l ();
90 Direction dir = directional_element (this).get ();
94 warning (_ ("Slur over rest?"));
95 o[X_AXIS] = col->hpos_f ();
96 o[Y_AXIS] = col->extent (Y_AXIS)[dir];
99 Direction stem_dir = directional_element (stem_l).get ();
100 o[X_AXIS] = stem_l->hpos_f ();
103 Simply set x to middle of notehead
106 o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
108 if ((stem_dir == dir)
109 && !stem_l->extent (Y_AXIS).empty_b ())
111 o[Y_AXIS] = stem_l->extent (Y_AXIS)[dir];
115 o[Y_AXIS] = col->extent (Y_AXIS)[dir];
119 leave a gap: slur mustn't touch head/stem
121 o[Y_AXIS] += dir * paper_l ()->get_var ("slur_y_free");
122 o[Y_AXIS] += calc_interstaff_dist (stem_l, this);
132 Slur::do_post_processing ()
134 Link_array<Note_column> encompass_arr =
135 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
138 if (!directional_element (this).get ())
139 directional_element (this).set (get_default_dir ());
142 Slur and tie placement [OSU]
145 * x = centre of head - d * x_gap_f
148 * y = length < 5ss : horizontal tangent + d * 0.25 ss
149 y = length >= 5ss : y next interline - d * 0.25 ss
152 Real staff_space = paper_l ()->get_var ("interline");
153 Real half_staff_space = staff_space / 2;
155 Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
156 Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
158 Drul_array<Note_column*> note_column_drul;
159 note_column_drul[LEFT] = encompass_arr[0];
160 note_column_drul[RIGHT] = encompass_arr.top ();
162 bool fix_broken_b = false;
164 Direction my_dir = directional_element (this).get ();
172 if ((note_column_drul[d] == spanned_drul_[d])
173 && note_column_drul[d]->first_head ()
174 && (note_column_drul[d]->stem_l ()))
176 Stem* stem_l = note_column_drul[d]->stem_l ();
178 side directly attached to note head;
179 no beam getting in the way
181 if ((stem_l->extent (Y_AXIS).empty_b ()
182 || !((stem_l->get_direction () == my_dir) && (my_dir != d)))
183 && !((my_dir == stem_l->get_direction ())
184 && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
186 dx_f_drul_[d] = spanned_drul_[d]->extent (X_AXIS).length () / 2;
187 dx_f_drul_[d] -= d * x_gap_f;
189 if (stem_l->get_direction () != my_dir)
191 dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[my_dir];
195 dy_f_drul_[d] = stem_l->chord_start_f ()
196 + my_dir * half_staff_space;
198 dy_f_drul_[d] += my_dir * y_gap_f;
201 side attached to (visible) stem
205 dx_f_drul_[d] = stem_l->hpos_f ()
206 - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
208 side attached to beamed stem
210 if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
212 dy_f_drul_[d] = stem_l->extent (Y_AXIS)[my_dir];
213 dy_f_drul_[d] += my_dir * 2 * y_gap_f;
216 side attached to notehead, with stem getting in the way
220 dx_f_drul_[d] -= d * x_gap_f;
222 dy_f_drul_[d] = stem_l->chord_start_f ()
223 + my_dir * half_staff_space;
224 dy_f_drul_[d] += my_dir * y_gap_f;
233 dx_f_drul_[d] = get_broken_left_end_align ();
236 broken: should get y from other piece, so that slur
237 continues up/down trend
239 for now: be horizontal..
244 while (flip (&d) != LEFT);
246 int cross_count = cross_staff_count ();
247 bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
249 Drul_array<Offset> info_drul;
250 Drul_array<Real> interstaff_interval;
254 info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
255 interstaff_interval[d] = calc_interstaff_dist (encompass_arr.boundary (d,0),
258 while (flip (&d) != LEFT);
260 Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
264 Direction d = (encompass_arr.top () != spanned_drul_[RIGHT]) ?
266 dy_f_drul_[d] = info_drul[d][Y_AXIS];
269 dy_f_drul_[d] -= interstaff_interval[d];
270 if (cross_count) // interstaff_i ?
272 dy_f_drul_[LEFT] += interstaff_interval[d];
273 dy_f_drul_[RIGHT] += interstaff_interval[d];
280 Now we've got a fine slur
281 Catch and correct some ugly cases
283 String infix = interstaff_b ? "interstaff_" : "";
284 Real height_damp_f = paper_l ()->get_var ("slur_"+infix +"height_damping");
285 Real slope_damp_f = paper_l ()->get_var ("slur_"+infix +"slope_damping");
286 Real snap_f = paper_l ()->get_var ("slur_"+infix +"snap_to_stem");
287 Real snap_max_dy_f = paper_l ()->get_var ("slur_"+infix +"snap_max_slope_change");
290 dy_f_drul_[RIGHT] += interstaff_f;
292 Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
294 dy_f -= interstaff_f;
295 Real dx_f = spanner_length ()+ dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
298 Avoid too steep slurs.
300 Real slope_ratio_f = abs (dy_f / dx_f);
301 if (slope_ratio_f > slope_damp_f)
303 Direction d = (Direction)(- my_dir * (sign (dy_f)));
306 Real damp_f = (slope_ratio_f - slope_damp_f) * dx_f;
308 must never change sign of dy
310 damp_f = damp_f <? abs (dy_f);
311 dy_f_drul_[d] += my_dir * damp_f;
317 Wierd slurs may look a lot better after they have been
319 So, we'll do this in 3 steps
321 for (int i = 0; i < 3; i++)
323 Real height_f = curve_extent (Y_AXIS).length ();
324 Real width_f = curve_extent (X_AXIS).length ();
326 dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
328 dy_f -= interstaff_f;
330 Real height_ratio_f = abs (height_f / width_f);
331 if (height_ratio_f > height_damp_f)
333 Direction d = (Direction)(- my_dir * (sign (dy_f)));
336 /* take third step */
337 Real damp_f = (height_ratio_f - height_damp_f) * width_f / 3;
339 if y positions at about the same height, correct both ends
341 if (abs (dy_f / dx_f ) < slope_damp_f)
343 dy_f_drul_[-d] += my_dir * damp_f;
344 dy_f_drul_[d] += my_dir * damp_f;
347 don't change slope too much, would have been catched by slope damping
351 damp_f = damp_f <? abs (dy_f/2);
352 dy_f_drul_[d] += my_dir * damp_f;
358 If, after correcting, we're close to stem-end...
360 Drul_array<Real> snapy_f_drul;
361 snapy_f_drul[LEFT] = snapy_f_drul[RIGHT] = 0;
362 Drul_array<Real> snapx_f_drul;
363 snapx_f_drul[LEFT] = snapx_f_drul[RIGHT] = 0;
364 Drul_array<bool> snapped_b_drul;
365 snapped_b_drul[LEFT] = snapped_b_drul[RIGHT] = false;
368 Note_column * nc = note_column_drul[d];
369 if (nc == spanned_drul_[d]
371 && nc->stem_l ()->get_direction () == my_dir
372 && abs (nc->stem_l ()->extent (Y_AXIS)[my_dir]
373 - dy_f_drul_[d] + (d == LEFT ? 0 : interstaff_f))
377 prepare to attach to stem-end
379 snapx_f_drul[d] = nc->stem_l ()->hpos_f ()
380 - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
382 snapy_f_drul[d] = nc->stem_l ()->extent (Y_AXIS)[my_dir]
383 + interstaff_interval[d]
384 + my_dir * 2 * y_gap_f;
386 snapped_b_drul[d] = true;
389 while (flip (&d) != LEFT);
392 only use snapped positions if sign (dy) will not change
393 and dy doesn't change too much
396 dy_f += interstaff_f;
402 More refactoring could be done.
404 Real maxsnap = abs (dy_f * snap_max_dy_f);
405 if (snapped_b_drul[LEFT] && snapped_b_drul[RIGHT]
406 && ((sign (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT]) == sign (dy_f)))
407 && (!dy_f || (abs (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT] - dy_f)
410 dy_f_drul_ = snapy_f_drul;
411 dx_f_drul_ = snapx_f_drul;
416 Direction od = (Direction)-d;
417 if (snapped_b_drul[d]
418 && d * sign (snapy_f_drul[d] - dy_f_drul_[od]) == sign (dy_f)
419 && (!dy_f || (abs (snapy_f_drul[d] - dy_f_drul_[od] - d * dy_f)
422 dy_f_drul_[d] = snapy_f_drul[d];
423 dx_f_drul_[d] = snapx_f_drul[d];
426 while (flip (&d) != LEFT);
431 Slur::cross_staff_count ()const
433 Link_array<Note_column> encompass_arr =
434 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
438 for (int i = 0; i < encompass_arr.size (); i++)
440 if (calc_interstaff_dist (encompass_arr[i], this))
448 Slur::get_encompass_offset_arr () const
450 Link_array<Note_column> encompass_arr =
451 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
453 Array<Offset> offset_arr;
456 check non-disturbed slur
457 FIXME: x of ends off by a tiny bit!!
459 offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
460 offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
464 Offset origin (relative_coordinate (0, X_AXIS), 0);
467 int last = encompass_arr.size () - 2;
469 offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
475 int cross_count = cross_staff_count ();
476 bool cross_b = cross_count && cross_count < encompass_arr.size ();
477 if (encompass_arr[0] != spanned_drul_[LEFT])
480 Real is = calc_interstaff_dist (encompass_arr[0], this);
482 offset_arr[0][Y_AXIS] += is;
488 if (encompass_arr.top () != spanned_drul_[RIGHT])
493 for (int i = first; i <= last; i++)
495 Offset o (encompass_offset (encompass_arr[i]));
496 offset_arr.push (o - origin);
499 offset_arr.push (Offset (spanner_length ()+ dx_f_drul_[RIGHT],
507 Slur::get_rods () const
511 r.item_l_drul_ = spanned_drul_;
512 r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");