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 set_elt_property ("attachment", gh_cons (SCM_BOOL_F, SCM_BOOL_F));
39 set_elt_pointer ("note-columns", SCM_EOL);
40 set_elt_property ("control-points", SCM_EOL);
44 Slur::add_column (Note_column*n)
46 if (!gh_pair_p (n->get_elt_pointer ("note-heads")))
47 warning (_ ("Putting slur over rest. Ignoring."));
50 Pointer_group_interface (this, "note-columns").add_element (n);
54 add_bound_item (this, n);
58 Slur::de_uglyfy (Slur_bezier_bow* bb, Real default_height)
60 Real length = bb->curve_.control_[3][X_AXIS] ;
61 Real ff = bb->fit_factor ();
62 for (int i = 1; i < 3; i++)
64 Real ind = abs (bb->curve_.control_[(i-1)*3][X_AXIS]
65 - bb->curve_.control_[i][X_AXIS]) / length;
66 Real h = bb->curve_.control_[i][Y_AXIS] * ff / length;
68 Real f = default_height / length;
69 Real c1 = paper_l ()->get_var ("bezier_control1");
70 Real c2 = paper_l ()->get_var ("bezier_control2");
71 Real c3 = paper_l ()->get_var ("bezier_control3");
76 else if (h > c2 + c3 * ind)
81 bb->curve_.control_[i][Y_AXIS] = h * length;
84 bb->curve_.assert_sanity ();
88 Slur::get_default_dir () const
90 Link_array<Note_column> encompass_arr =
91 Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
94 for (int i=0; i < encompass_arr.size (); i ++)
96 if (encompass_arr[i]->dir () < 0)
106 Slur::do_add_processing ()
109 Link_array<Note_column> encompass_arr =
110 Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
112 if (encompass_arr.size ())
114 set_bound (LEFT, encompass_arr[0]);
115 if (encompass_arr.size () > 1)
116 set_bound (RIGHT, encompass_arr.top ());
124 Slur::encompass_offset (Note_column const* col) const
127 Stem* stem_l = col->stem_l ();
128 Direction dir = Directional_element_interface (this).get ();
132 warning (_ ("Slur over rest?"));
133 o[X_AXIS] = col->relative_coordinate (0, X_AXIS);
134 o[Y_AXIS] = col->relative_coordinate (0, Y_AXIS);
137 Direction stem_dir = Directional_element_interface (stem_l).get ();
138 o[X_AXIS] = stem_l->relative_coordinate (0, X_AXIS);
141 Simply set x to middle of notehead
144 o[X_AXIS] -= 0.5 * stem_dir * col->extent (X_AXIS).length ();
146 if ((stem_dir == dir)
147 && !stem_l->extent (Y_AXIS).empty_b ())
149 o[Y_AXIS] = stem_l->relative_coordinate (0, Y_AXIS);
153 o[Y_AXIS] = col->relative_coordinate (0, Y_AXIS);
157 leave a gap: slur mustn't touch head/stem
159 o[Y_AXIS] += dir * paper_l ()->get_var ("slur_y_free");
163 GLUE_SCORE_ELEMENT(Slur,after_line_breaking);
166 Slur::member_after_line_breaking ()
169 set_control_points ();
170 return SCM_UNDEFINED;
174 slur_get_bound (SCM slur, SCM dir)
176 return ((Slur*)unsmob_element (slur))->get_bound (to_dir (dir))->self_scm_;
180 score_element_get_pointer (SCM se, SCM name)
182 SCM s = scm_assq (name, unsmob_element (se)->pointer_alist_);
183 return (s == SCM_BOOL_F) ? SCM_UNDEFINED : gh_cdr (s);
187 score_element_get_property (SCM se, SCM name)
189 SCM s = scm_assq (name, unsmob_element (se)->property_alist_);
190 return (s == SCM_BOOL_F) ? SCM_UNDEFINED : gh_cdr (s);
196 scm_make_gsubr ("get-pointer", 2 , 0, 0,
197 (SCM(*)(...)) score_element_get_pointer);
198 scm_make_gsubr ("get-property", 2 , 0, 0,
199 (SCM(*)(...)) score_element_get_property);
200 scm_make_gsubr ("get-bound", 2 , 0, 0,
201 (SCM(*)(...)) slur_get_bound);
204 ADD_SCM_INIT_FUNC (score_elt, init_score_elts);
207 Slur::set_extremities ()
209 if (!Directional_element_interface (this).get ())
210 Directional_element_interface (this).set (get_default_dir ());
212 Direction dir = LEFT;
215 if (!gh_symbol_p (index_cell (get_elt_property ("attachment"), dir)))
218 // for (SCM s = get_elt_property ("slur-extremity-rules"); s != SCM_EOL; s = gh_cdr (s))
219 for (SCM s = scm_eval (ly_symbol2scm ("slur-extremity-rules"));
220 s != SCM_EOL; s = gh_cdr (s))
222 SCM r = gh_call2 (gh_caar (s), this->self_scm_,
223 gh_int2scm ((int)dir));
226 index_set_cell (get_elt_property ("attachment"), dir,
233 while (flip (&dir) != LEFT);
237 Slur::get_attachment (Direction dir) const
239 SCM s = get_elt_property ("attachment");
240 SCM a = dir == LEFT ? gh_car (s) : gh_cdr (s);
241 String str = ly_symbol2string (a);
242 Real ss = Staff_symbol_referencer_interface (this).staff_space ();
245 if (Note_column* n = dynamic_cast<Note_column*> (get_bound (dir)))
247 if (Stem* st = dynamic_cast<Stem*> (n->stem_l ()))
251 o = Offset (0, st->chord_start_f ());
253 Default position is centered in X, on outer side of head Y
255 o += Offset (0.5 * n->extent (X_AXIS).length (),
256 0.5 * ss * Directional_element_interface (this).get ());
258 else if (str == "alongside-stem")
260 o = Offset (0, st->chord_start_f ());
262 Default position is on stem X, on outer side of head Y
264 o += Offset (n->extent (X_AXIS).length ()
265 * (1 + st->get_direction ()),
266 0.5 * ss * Directional_element_interface (this).get ());
268 else if (str == "stem")
270 o = Offset (0, st->stem_end_position () * hs);
272 Default position is on stem X, at stem end Y
275 (n->extent (X_AXIS).length ()
276 - st->extent (X_AXIS).length ())
277 * (1 + st->get_direction ()),
280 else if (str == "loose-end")
282 SCM other_a = dir == LEFT ? gh_cdr (s) : gh_car (s);
283 if (ly_symbol2string (other_a) != "loose-end")
285 o = Offset (0, get_attachment (-dir)[Y_AXIS]);
292 gh_int2scm (st->get_direction () * dir),
293 gh_int2scm (Directional_element_interface (this).get () * dir),
295 scm_eval (ly_symbol2scm ("slur-extremity-offset-alist")));
299 o += ly_scm2offset (gh_cdr (l)) * ss * dir;
304 if (str != "loose-end")
305 o += Offset (0, get_bound (dir)->relative_coordinate (0, Y_AXIS)
306 - relative_coordinate (0, Y_AXIS));
312 Slur::get_encompass_offset_arr () const
314 Link_array<Note_column> encompass_arr =
315 Pointer_group_interface__extract_elements (this, (Note_column*)0, "note-columns");
317 Array<Offset> offset_arr;
319 Offset origin (relative_coordinate (0, X_AXIS),
320 relative_coordinate (0, Y_AXIS));
323 int last = encompass_arr.size () - 2;
325 offset_arr.push (get_attachment (LEFT));
331 if (encompass_arr[0] != get_bound (LEFT))
334 offset_arr[0][Y_AXIS] -= encompass_arr[0]->relative_coordinate (0, Y_AXIS)
335 - relative_coordinate (0, Y_AXIS);
341 if (encompass_arr.top () != get_bound (RIGHT))
346 for (int i = first; i <= last; i++)
348 Offset o (encompass_offset (encompass_arr[i]));
349 offset_arr.push (o - origin);
352 offset_arr.push (Offset (spanner_length (), 0) + get_attachment (RIGHT));
354 if (encompass_arr[0] != get_bound (LEFT))
356 offset_arr.top ()[Y_AXIS] -= encompass_arr.top ()->relative_coordinate (0, Y_AXIS)
357 - relative_coordinate (0, Y_AXIS);
365 Slur::get_rods () const
370 r.item_l_drul_[LEFT] = get_bound (LEFT);
371 r.item_l_drul_[RIGHT] = get_bound (RIGHT);
372 r.distance_f_ = paper_l ()->get_var ("slur_x_minimum");
380 Ugh should have dash-length + dash-period
382 GLUE_SCORE_ELEMENT(Slur,brew_molecule);
384 Slur::member_brew_molecule () const
386 Real thick = paper_l ()->get_var ("slur_thickness");
387 Bezier one = get_curve ();
390 SCM d = get_elt_property ("dashed");
392 a = lookup_l ()->dashed_slur (one, thick, thick * gh_scm2double (d));
394 a = lookup_l ()->slur (one, Directional_element_interface (this).get () * thick, thick);
396 return a.create_scheme();
400 Slur::set_control_points ()
402 Slur_bezier_bow bb (get_encompass_offset_arr (),
403 Directional_element_interface (this).get ());
405 Real staff_space = Staff_symbol_referencer_interface (this).staff_space ();
406 Real h_inf = paper_l ()->get_var ("slur_height_limit_factor") * staff_space;
407 Real r_0 = paper_l ()->get_var ("slur_ratio");
409 bb.set_default_bezier (h_inf, r_0);
411 if (bb.fit_factor () > 1.0)
413 Real length = bb.curve_.control_[3][X_AXIS];
414 Real default_height = bb.get_default_height (h_inf, r_0, length);
415 bb.minimise_enclosed_area (paper_l(), default_height);
417 Real bff = paper_l ()->get_var ("slur_force_blowfit");
418 bb.curve_.control_[1][Y_AXIS] *= bff;
419 bb.curve_.control_[2][Y_AXIS] *= bff;
422 Real sb = paper_l ()->get_var ("slur_beautiful");
423 Real beautiful = length * default_height * sb;
424 Real area = bb.enclosed_area_f ();
427 Slurs that fit beautifully are not ugly
429 if (area > beautiful)
430 de_uglyfy (&bb, default_height);
433 Bezier b = bb.get_bezier ();
436 SCM controls = SCM_EOL;
438 controls = gh_cons ( ly_offset2scm (b.control_[i]), controls);
440 set_elt_property ("control-points", controls);
445 Slur::get_curve () const
450 if (!Directional_element_interface (this).get ()
451 || ! gh_symbol_p (index_cell (get_elt_property ("attachment"), LEFT)))
452 ((Slur*)this)->set_extremities ();
454 if (!gh_pair_p (get_elt_property ("control-points")))
455 ((Slur*)this)->set_control_points ();
458 for (SCM s= get_elt_property ("control-points"); s != SCM_EOL; s = gh_cdr (s))
460 b.control_[i] = ly_scm2offset (gh_car (s));
464 Array<Offset> enc (get_encompass_offset_arr ());
465 Direction dir = Directional_element_interface (this).get ();
467 Real x1 = enc[0][X_AXIS];
468 Real x2 = enc.top ()[X_AXIS];
471 for (int i=1; i < enc.size ()-1; i++)
473 Real x = enc[i][X_AXIS];
476 Real y = b.get_other_coordinate (X_AXIS, x);
477 off = off >? dir * (enc[i][Y_AXIS] - y);
480 b.translate (Offset (0, dir * off));