2 slur.cc -- implement Slur
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 Jan Nieuwenhuizen <janneke@gnu.org>
12 * fix broken interstaff slurs
13 * begin and end should be treated as a/acknowledge Scripts.
14 * broken slur should have uniform trend
15 * smart changing of endings
16 * smart changing of (Y-?)offsets to avoid ugly beziers
20 #include "directional-element-interface.hh"
21 #include "group-interface.hh"
24 #include "paper-def.hh"
25 #include "note-column.hh"
27 #include "paper-column.hh"
28 #include "molecule.hh"
30 #include "slur-bezier-bow.hh"
32 #include "group-interface.hh"
33 #include "staff-symbol-referencer.hh"
38 Slur::set_interface (Score_element*me)
40 me->set_elt_property ("attachment", gh_cons (SCM_BOOL_F, SCM_BOOL_F));
41 me->set_interface (ly_symbol2scm ("slur-interface"));
45 Slur::add_column (Score_element*me, Score_element*n)
47 if (!gh_pair_p (n->get_elt_property ("note-heads")))
48 warning (_ ("Putting slur over rest. Ignoring."));
51 Pointer_group_interface (me, "note-columns").add_element (n);
52 me->add_dependency (n);
55 add_bound_item (dynamic_cast<Spanner*> (me), dynamic_cast<Item*>(n));
59 Slur::de_uglyfy (Score_element*me, Slur_bezier_bow* bb, Real default_height)
61 Real length = bb->curve_.control_[3][X_AXIS] ;
62 Real ff = bb->fit_factor ();
63 for (int i = 1; i < 3; i++)
65 Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS]
66 - bb->curve_.control_[i][X_AXIS]) / length;
67 Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
69 Real f = default_height / length;
70 SCM up = me->get_elt_property ("de-uglify-parameters");
72 Real c1 = gh_scm2double (gh_car (up));
73 Real c2 = gh_scm2double (gh_cadr (up));
74 Real c3 = gh_scm2double (gh_caddr (up));
80 else if (h > c2 + c3 * ind)
85 bb->curve_.control_[i][Y_AXIS] = h * length;
88 bb->curve_.assert_sanity ();
92 Slur::get_default_dir (Score_element*me)
94 Link_array<Score_element> encompass_arr =
95 Pointer_group_interface__extract_elements (me, (Score_element*)0, "note-columns");
98 for (int i=0; i < encompass_arr.size (); i ++)
100 if (Note_column::dir (encompass_arr[i]) < 0)
110 MAKE_SCHEME_CALLBACK (Slur, after_line_breaking);
112 Slur::after_line_breaking (SCM smob)
114 Score_element *me = unsmob_element (smob);
115 if (!scm_ilength (me->get_elt_property ("note-columns")))
118 return SCM_UNSPECIFIED;
120 set_extremities (me);
121 set_control_points (me);
122 return SCM_UNSPECIFIED;
126 Slur::set_extremities (Score_element*me)
128 if (!Directional_element_interface::get (me))
129 Directional_element_interface ::set (me,get_default_dir (me));
131 Direction dir = LEFT;
134 if (!gh_symbol_p (index_cell (me->get_elt_property ("attachment"), dir)))
137 // for (SCM s = get_elt_property ("slur-extremity-rules"); s != SCM_EOL; s = gh_cdr (s))
139 // FIXME: global GUILE scope used!
140 for (SCM s = scm_eval2 (ly_symbol2scm ("slur-extremity-rules"),
142 s != SCM_EOL; s = gh_cdr (s))
144 SCM r = gh_call2 (gh_caar (s), me->self_scm (),
145 gh_int2scm ((int)dir));
148 index_set_cell (me->get_elt_property ("attachment"), dir,
155 while (flip (&dir) != LEFT);
159 Slur::get_first_notecolumn_y (Score_element *me, Direction dir)
161 Score_element *col = dir == LEFT
162 ? unsmob_element (gh_car (scm_reverse (me->get_elt_property
165 (gh_car (me->get_elt_property ("note-columns")));
167 Score_element *common[] =
170 me->common_refpoint (col, Y_AXIS)
173 if (col == ((Spanner*)me)->get_bound (dir))
175 y = get_attachment (me, dir, common)[Y_AXIS];
179 y = encompass_offset (me, col, common)[Y_AXIS]
180 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
186 Slur::broken_trend_offset (Score_element *me, Direction dir)
189 A broken slur should maintain the same vertical trend
190 the unbroken slur would have had.
193 if (Spanner *mother = dynamic_cast<Spanner*> (me->original_l_))
195 for (int i = dir == LEFT ? 0 : mother->broken_into_l_arr_.size () - 1;
196 dir == LEFT ? i < mother->broken_into_l_arr_.size () : i > 0;
197 dir == LEFT ? i++ : i--)
199 if (mother->broken_into_l_arr_[i - dir] == me)
201 Score_element *neighbour = mother->broken_into_l_arr_[i];
203 neighbour->set_elt_property ("direction",
204 me->get_elt_property ("direction"));
205 Real neighbour_y = get_first_notecolumn_y (neighbour, dir);
206 Real y = get_first_notecolumn_y (me, -dir);
207 o = Offset (0, (y + neighbour_y) / 2);
216 Slur::get_attachment (Score_element*me,Direction dir,
217 Score_element **common)
219 SCM s = me->get_elt_property ("attachment");
220 if (!gh_symbol_p (index_cell (s, dir)))
222 set_extremities (me);
223 s = me->get_elt_property ("attachment");
225 SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
226 Spanner*sp = dynamic_cast<Spanner*>(me);
227 String str = ly_symbol2string (a);
228 Real ss = Staff_symbol_referencer::staff_space ((Score_element*)me);
232 Score_element *stem = 0;
233 if (Note_column::has_interface (sp->get_bound (dir)))
235 Score_element * n =sp->get_bound (dir);
236 if ((stem = Note_column::stem_l (n)))
241 o = Offset (0, Stem::head_positions (stem)
242 [Directional_element_interface::get (me)] * hs);
244 Default position is centered in X, on outer side of head Y
246 o += Offset (0.5 * n->extent (X_AXIS).length (),
247 0.5 * ss * Directional_element_interface::get (me));
249 else if (str == "alongside-stem")
251 o = Offset (0, Stem::chord_start_f (stem));
253 Default position is on stem X, on outer side of head Y
255 o += Offset (n->extent (X_AXIS).length ()
256 * (1 + Stem::get_direction (stem)),
257 0.5 * ss * Directional_element_interface::get (me));
259 else if (str == "stem")
261 o = Offset (0, Stem::stem_end_position (stem) * hs);
263 Default position is on stem X, at stem end Y
266 (n->extent (X_AXIS).length ()
267 - stem->extent (X_AXIS).length ())
268 * (1 + Stem::get_direction (stem)),
273 else if (str == "loose-end")
275 SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
276 if (ly_symbol2string (other_a) != "loose-end")
280 The braindead way: horizontal
282 o = Offset (0, get_attachment (me, -dir, common)[Y_AXIS]);
284 o = broken_trend_offset (me, dir);
294 int stemdir = stem ? Stem::get_direction (stem) : 1;
295 int slurdir = gh_scm2int (me->get_elt_property ("direction"));
298 gh_int2scm (stemdir * dir),
299 gh_int2scm (slurdir * dir),
301 scm_eval2 (ly_symbol2scm ("slur-extremity-offset-alist"), SCM_EOL));
305 o += ly_scm2offset (gh_cdr (l)) * ss * dir;
309 What if get_bound () is not a note-column?
311 if (str != "loose-end"
312 && sp->get_bound (dir)->common_refpoint (common[Y_AXIS], Y_AXIS) == common[Y_AXIS])
314 o[Y_AXIS] += sp->get_bound (dir)->relative_coordinate (common[Y_AXIS], Y_AXIS)
315 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
322 Slur::encompass_offset (Score_element*me,
324 Score_element **common)
327 Score_element* stem_l = unsmob_element (col->get_elt_property ("stem"));
329 Direction dir = Directional_element_interface::get (me);
333 warning (_ ("Slur over rest?"));
334 o[X_AXIS] = col->relative_coordinate (common[X_AXIS], X_AXIS);
335 o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS);
338 Direction stem_dir = Directional_element_interface::get (stem_l);
339 o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
342 Simply set x to middle of notehead
345 o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
347 if ((stem_dir == dir)
348 && !stem_l->extent (Y_AXIS).empty_b ())
350 o[Y_AXIS] = stem_l->relative_coordinate (common[Y_AXIS], Y_AXIS); // iuhg
351 o[Y_AXIS] += stem_l->extent (Y_AXIS)[dir];
355 o[Y_AXIS] = col->relative_coordinate (common[Y_AXIS], Y_AXIS); // ugh
356 o[Y_AXIS] += col->extent (Y_AXIS)[dir];
360 leave a gap: slur mustn't touch head/stem
362 o[Y_AXIS] += dir * gh_scm2double (me->get_elt_property ("y-free")) *
363 me->paper_l ()->get_var ("staffspace");
368 Slur::get_encompass_offset_arr (Score_element*me)
370 Spanner*sp = dynamic_cast<Spanner*>(me);
371 SCM eltlist = me->get_elt_property ("note-columns");
372 Score_element *common[] = {me->common_refpoint (eltlist,X_AXIS),
373 me->common_refpoint (eltlist,Y_AXIS)};
376 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (RIGHT), X_AXIS);
377 common[X_AXIS] = common[X_AXIS]->common_refpoint (sp->get_bound (LEFT), X_AXIS);
379 Link_array<Score_element> encompass_arr;
380 while (gh_pair_p (eltlist))
382 encompass_arr.push (unsmob_element (gh_car (eltlist)));
383 eltlist =gh_cdr (eltlist);
385 encompass_arr.reverse ();
388 Array<Offset> offset_arr;
390 Offset origin (me->relative_coordinate (common[X_AXIS], X_AXIS),
391 me->relative_coordinate (common[Y_AXIS], Y_AXIS));
394 int last = encompass_arr.size () - 2;
396 offset_arr.push (get_attachment (me, LEFT, common));
402 if (encompass_arr[0] != sp->get_bound (LEFT))
407 offset_arr[0][Y_AXIS] -=
408 encompass_arr[0]->relative_coordinate (common[Y_AXIS], Y_AXIS)
409 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
415 if (encompass_arr.top () != sp->get_bound (RIGHT))
420 for (int i = first; i <= last; i++)
422 Offset o (encompass_offset (me, encompass_arr[i], common));
423 offset_arr.push (o - origin);
426 offset_arr.push (Offset (sp->spanner_length (), 0) + get_attachment (me, RIGHT,common));
428 if (encompass_arr[0] != sp->get_bound (LEFT))
430 offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (common[Y_AXIS], Y_AXIS)
431 - me->relative_coordinate (common[Y_AXIS], Y_AXIS);
438 MAKE_SCHEME_CALLBACK(Slur,set_spacing_rods);
440 Slur::set_spacing_rods (SCM smob)
442 Score_element*me = unsmob_element (smob);
445 Spanner*sp = dynamic_cast<Spanner*>(me);
446 r.item_l_drul_[LEFT] = sp->get_bound (LEFT);
447 r.item_l_drul_[RIGHT] = sp->get_bound (RIGHT);
449 gh_scm2double (me->get_elt_property ("minimum-length"))
450 * me->paper_l ()->get_var ("staffspace");
453 return SCM_UNSPECIFIED;
458 Ugh should have dash-length + dash-period
460 MAKE_SCHEME_CALLBACK (Slur, brew_molecule);
462 Slur::brew_molecule (SCM smob)
464 Score_element * me = unsmob_element (smob);
465 if (!scm_ilength (me->get_elt_property ("note-columns")))
471 Real thick = me->paper_l ()->get_var ("stafflinethickness") *
472 gh_scm2double (me->get_elt_property ("thickness"));
473 Bezier one = get_curve (me);
476 SCM d = me->get_elt_property ("dashed");
478 a = me->lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
480 a = me->lookup_l ()->slur (one, Directional_element_interface::get (me) * thick, thick);
482 return a.create_scheme();
486 Slur::set_control_points (Score_element*me)
488 Real staff_space = Staff_symbol_referencer::staff_space ((Score_element*)me);
490 SCM details = me->get_elt_property ("details");
491 SCM h_inf_scm = scm_assq (ly_symbol2scm ("height-limit"), details);
492 SCM r_0_scm = scm_assq (ly_symbol2scm ("ratio"), details);
494 Real r_0 = gh_scm2double (gh_cdr (r_0_scm));
495 Real h_inf = staff_space * gh_scm2double (gh_cdr (h_inf_scm));
497 Slur_bezier_bow bb (get_encompass_offset_arr (me),
498 Directional_element_interface::get (me),
501 if (bb.fit_factor () > 1.0)
503 Real length = bb.curve_.control_[3][X_AXIS];
504 Real default_height = slur_height (length, h_inf, r_0);
506 SCM ssb = scm_assq (ly_symbol2scm ("beautiful"), details);
507 Real sb =gh_scm2double (gh_cdr (ssb));
509 bb.minimise_enclosed_area (me->paper_l(), sb);
510 SCM sbf = scm_assq (ly_symbol2scm ("force-blowfit"), details);
512 if (gh_pair_p (sbf) && gh_number_p (gh_cdr (sbf)))
513 bff = gh_scm2double (gh_cdr (sbf));
515 bb.curve_.control_[1][Y_AXIS] *= bff;
516 bb.curve_.control_[2][Y_AXIS] *= bff;
520 Real beautiful = length * default_height * sb;
521 Real area = bb.enclosed_area_f ();
524 Slurs that fit beautifully are not ugly
526 if (area > beautiful)
527 de_uglyfy (me, &bb, default_height);
530 Bezier b = bb.get_bezier ();
533 SCM controls = SCM_EOL;
536 controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
539 All these null control-points, where do they all come from?
541 if (i && b.control_[i][X_AXIS] == 0)
545 me->set_elt_property ("control-points", controls);
549 Slur::get_curve (Score_element*me)
554 if (!Directional_element_interface::get (me)
555 || ! gh_symbol_p (index_cell (me->get_elt_property ("attachment"), LEFT)))
556 set_extremities (me);
558 if (!gh_pair_p (me->get_elt_property ("control-points")))
559 set_control_points (me);
561 for (SCM s= me->get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
563 b.control_[i] = ly_scm2offset (gh_car (s));
567 Array<Offset> enc (get_encompass_offset_arr (me));
568 Direction dir = Directional_element_interface::get (me);
570 Real x1 = enc[0][X_AXIS];
571 Real x2 = enc.top ()[X_AXIS];
574 for (int i=1; i < enc.size ()-1; i++)
576 Real x = enc[i][X_AXIS];
579 Real y = b.get_other_coordinate (X_AXIS, x);
580 off = off >? dir * (enc[i][Y_AXIS] - y);
583 b.translate (Offset (0, dir * off));
589 Slur::has_interface (Score_element*me)
591 return me->has_interface (ly_symbol2scm ("slur-interface"));