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");
137 if (!encompass_arr.size ())
139 set_elt_property ("transparent", SCM_BOOL_T);
145 if (!directional_element (this).get ())
146 directional_element (this).set (get_default_dir ());
149 Slur and tie placement [OSU]
152 * x = centre of head - d * x_gap_f
155 * y = length < 5ss : horizontal tangent + d * 0.25 ss
156 y = length >= 5ss : y next interline - d * 0.25 ss
159 Real staff_space = paper_l ()->get_var ("interline");
160 Real half_staff_space = staff_space / 2;
162 Real x_gap_f = paper_l ()->get_var ("slur_x_gap");
163 Real y_gap_f = paper_l ()->get_var ("slur_y_gap");
165 Drul_array<Note_column*> note_column_drul;
166 note_column_drul[LEFT] = encompass_arr[0];
167 note_column_drul[RIGHT] = encompass_arr.top ();
169 bool fix_broken_b = false;
171 Direction my_dir = directional_element (this).get ();
179 if ((note_column_drul[d] == spanned_drul_[d])
180 && note_column_drul[d]->first_head ()
181 && (note_column_drul[d]->stem_l ()))
183 Stem* stem_l = note_column_drul[d]->stem_l ();
185 side directly attached to note head;
186 no beam getting in the way
188 if ((stem_l->extent (Y_AXIS).empty_b ()
189 || !((stem_l->get_direction () == my_dir) && (my_dir != d)))
190 && !((my_dir == stem_l->get_direction ())
191 && stem_l->beam_l () && (stem_l->beam_count (-d) >= 1)))
193 dx_f_drul_[d] = spanned_drul_[d]->extent (X_AXIS).length () / 2;
194 dx_f_drul_[d] -= d * x_gap_f;
196 if (stem_l->get_direction () != my_dir)
198 dy_f_drul_[d] = note_column_drul[d]->extent (Y_AXIS)[my_dir];
202 dy_f_drul_[d] = stem_l->chord_start_f ()
203 + my_dir * half_staff_space;
205 dy_f_drul_[d] += my_dir * y_gap_f;
208 side attached to (visible) stem
212 dx_f_drul_[d] = stem_l->hpos_f ()
213 - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
215 side attached to beamed stem
217 if (stem_l->beam_l () && (stem_l->beam_count (-d) >= 1))
219 dy_f_drul_[d] = stem_l->extent (Y_AXIS)[my_dir];
220 dy_f_drul_[d] += my_dir * 2 * y_gap_f;
223 side attached to notehead, with stem getting in the way
227 dx_f_drul_[d] -= d * x_gap_f;
229 dy_f_drul_[d] = stem_l->chord_start_f ()
230 + my_dir * half_staff_space;
231 dy_f_drul_[d] += my_dir * y_gap_f;
240 dx_f_drul_[d] = get_broken_left_end_align ();
243 broken: should get y from other piece, so that slur
244 continues up/down trend
246 for now: be horizontal..
251 while (flip (&d) != LEFT);
253 int cross_count = cross_staff_count ();
254 bool interstaff_b = (0 < cross_count) && (cross_count < encompass_arr.size ());
256 Drul_array<Offset> info_drul;
257 Drul_array<Real> interstaff_interval;
261 info_drul[d] = encompass_offset (encompass_arr.boundary (d, 0));
262 interstaff_interval[d] = - calc_interstaff_dist (encompass_arr.boundary (d,0),
265 while (flip (&d) != LEFT);
267 Real interstaff_f = interstaff_interval[RIGHT] - interstaff_interval[LEFT];
271 Direction d = (encompass_arr.top () != spanned_drul_[RIGHT]) ?
273 dy_f_drul_[d] = info_drul[d][Y_AXIS];
276 dy_f_drul_[d] -= interstaff_interval[d];
277 if (cross_count) // interstaff_i ?
279 dy_f_drul_[LEFT] += interstaff_interval[d];
280 dy_f_drul_[RIGHT] += interstaff_interval[d];
287 Now we've got a fine slur
288 Catch and correct some ugly cases
290 String infix = interstaff_b ? "interstaff_" : "";
291 Real height_damp_f = paper_l ()->get_var ("slur_"+infix +"height_damping");
292 Real slope_damp_f = paper_l ()->get_var ("slur_"+infix +"slope_damping");
293 Real snap_f = paper_l ()->get_var ("slur_"+infix +"snap_to_stem");
294 Real snap_max_dy_f = paper_l ()->get_var ("slur_"+infix +"snap_max_slope_change");
297 dy_f_drul_[RIGHT] += interstaff_f;
299 Real dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
301 dy_f -= interstaff_f;
302 Real dx_f = spanner_length ()+ dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
305 Avoid too steep slurs.
307 Real slope_ratio_f = abs (dy_f / dx_f);
308 if (slope_ratio_f > slope_damp_f)
310 Direction d = (Direction)(- my_dir * (sign (dy_f)));
313 Real damp_f = (slope_ratio_f - slope_damp_f) * dx_f;
315 must never change sign of dy
317 damp_f = damp_f <? abs (dy_f);
318 dy_f_drul_[d] += my_dir * damp_f;
324 Wierd slurs may look a lot better after they have been
326 So, we'll do this in 3 steps
328 for (int i = 0; i < 3; i++)
330 Real height_f = curve_extent (Y_AXIS).length ();
331 Real width_f = curve_extent (X_AXIS).length ();
333 dy_f = dy_f_drul_[RIGHT] - dy_f_drul_[LEFT];
335 dy_f -= interstaff_f;
337 Real height_ratio_f = abs (height_f / width_f);
338 if (height_ratio_f > height_damp_f)
340 Direction d = (Direction)(- my_dir * (sign (dy_f)));
343 /* take third step */
344 Real damp_f = (height_ratio_f - height_damp_f) * width_f / 3;
346 if y positions at about the same height, correct both ends
348 if (abs (dy_f / dx_f ) < slope_damp_f)
350 dy_f_drul_[-d] += my_dir * damp_f;
351 dy_f_drul_[d] += my_dir * damp_f;
354 don't change slope too much, would have been catched by slope damping
358 damp_f = damp_f <? abs (dy_f/2);
359 dy_f_drul_[d] += my_dir * damp_f;
365 If, after correcting, we're close to stem-end...
367 Drul_array<Real> snapy_f_drul;
368 snapy_f_drul[LEFT] = snapy_f_drul[RIGHT] = 0;
369 Drul_array<Real> snapx_f_drul;
370 snapx_f_drul[LEFT] = snapx_f_drul[RIGHT] = 0;
371 Drul_array<bool> snapped_b_drul;
372 snapped_b_drul[LEFT] = snapped_b_drul[RIGHT] = false;
375 Note_column * nc = note_column_drul[d];
376 if (nc == spanned_drul_[d]
378 && nc->stem_l ()->get_direction () == my_dir
379 && abs (nc->stem_l ()->extent (Y_AXIS)[my_dir]
380 - dy_f_drul_[d] + (d == LEFT ? 0 : interstaff_f))
384 prepare to attach to stem-end
386 snapx_f_drul[d] = nc->stem_l ()->hpos_f ()
387 - spanned_drul_[d]->relative_coordinate (0, X_AXIS);
389 snapy_f_drul[d] = nc->stem_l ()->extent (Y_AXIS)[my_dir]
390 + interstaff_interval[d]
391 + my_dir * 2 * y_gap_f;
393 snapped_b_drul[d] = true;
396 while (flip (&d) != LEFT);
399 only use snapped positions if sign (dy) will not change
400 and dy doesn't change too much
403 dy_f += interstaff_f;
409 More refactoring could be done.
411 Real maxsnap = abs (dy_f * snap_max_dy_f);
412 if (snapped_b_drul[LEFT] && snapped_b_drul[RIGHT]
413 && ((sign (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT]) == sign (dy_f)))
414 && (!dy_f || (abs (snapy_f_drul[RIGHT] - snapy_f_drul[LEFT] - dy_f)
417 dy_f_drul_ = snapy_f_drul;
418 dx_f_drul_ = snapx_f_drul;
423 Direction od = (Direction)-d;
424 if (snapped_b_drul[d]
425 && d * sign (snapy_f_drul[d] - dy_f_drul_[od]) == sign (dy_f)
426 && (!dy_f || (abs (snapy_f_drul[d] - dy_f_drul_[od] - d * dy_f)
429 dy_f_drul_[d] = snapy_f_drul[d];
430 dx_f_drul_[d] = snapx_f_drul[d];
433 while (flip (&d) != LEFT);
438 Slur::cross_staff_count ()const
440 Link_array<Note_column> encompass_arr =
441 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
445 for (int i = 0; i < encompass_arr.size (); i++)
447 if (calc_interstaff_dist (encompass_arr[i], this))
455 Slur::get_encompass_offset_arr () const
457 Link_array<Note_column> encompass_arr =
458 Group_interface__extract_elements (this, (Note_column*)0, "note-columns");
460 Array<Offset> offset_arr;
463 check non-disturbed slur
464 FIXME: x of ends off by a tiny bit!!
466 offset_arr.push (Offset (0, dy_f_drul_[LEFT]));
467 offset_arr.push (Offset (0, dy_f_drul_[RIGHT]));
471 Offset origin (relative_coordinate (0, X_AXIS), 0);
474 int last = encompass_arr.size () - 2;
476 offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
482 int cross_count = cross_staff_count ();
483 bool cross_b = cross_count && cross_count < encompass_arr.size ();
484 if (encompass_arr[0] != spanned_drul_[LEFT])
487 Real is = calc_interstaff_dist (encompass_arr[0], this);
489 offset_arr[0][Y_AXIS] += is;
495 if (encompass_arr.top () != spanned_drul_[RIGHT])
500 for (int i = first; i <= last; i++)
502 Offset o (encompass_offset (encompass_arr[i]));
503 offset_arr.push (o - origin);
506 offset_arr.push (Offset (spanner_length ()+ dx_f_drul_[RIGHT],
514 Slur::get_rods () const
518 r.item_l_drul_ = spanned_drul_;
519 r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");