2 plet-spanner.cc -- implement Tuplet_bracket
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2002 Jan Nieuwenhuizen <janneke@gnu.org>
14 #include "font-interface.hh"
15 #include "molecule.hh"
16 #include "paper-column.hh"
17 #include "paper-def.hh"
18 #include "text-item.hh"
19 #include "tuplet-bracket.hh"
21 #include "note-column.hh"
22 #include "dimensions.hh"
23 #include "group-interface.hh"
24 #include "directional-element-interface.hh"
26 #include "staff-symbol-referencer.hh"
31 in the case that there is no bracket, but there is a (single) beam,
32 follow beam precisely for determining tuplet number location.
37 MAKE_SCHEME_CALLBACK (Tuplet_bracket,brew_molecule,1);
39 Tuplet_bracket::brew_molecule (SCM smob)
41 Grob *me= unsmob_grob (smob);
43 Link_array<Grob> column_arr=
44 Pointer_group_interface__extract_grobs (me, (Grob*)0, "columns");
47 if (!column_arr.size ())
48 return mol.smobbed_copy ();
51 Grob *b1 = Note_column::stem_l (column_arr[0]);
52 Grob *b2 = Note_column::stem_l (column_arr.top());
54 b1 = b1 ? Stem::beam_l (b1) : 0;
55 b2 = b2 ? Stem::beam_l (b2) : 0;
58 Spanner*sp = dynamic_cast<Spanner*> (me);
60 // Default behaviour: number always, bracket when no beam!
61 bool par_beam = b1 && (b1 == b2) && !sp->broken_b() ;
63 bool bracket_visibility = !par_beam;
64 bool number_visibility = true;
66 SCM bracket = me->get_grob_property ("tuplet-bracket-visibility");
67 if (gh_boolean_p (bracket))
69 bracket_visibility = gh_scm2bool (bracket);
71 else if (bracket == ly_symbol2scm ("if-no-beam"))
72 bracket_visibility = !par_beam;
74 SCM numb = me->get_grob_property ("tuplet-number-visibility");
75 if (gh_boolean_p (numb))
77 number_visibility = gh_scm2bool (numb);
79 else if (numb == ly_symbol2scm ("if-no-beam"))
80 number_visibility = !par_beam;
83 Real ncw = column_arr.top ()->extent (column_arr.top (), X_AXIS).length ();
84 Real w = sp->spanner_length () + ncw;
86 Direction dir = Directional_element_interface::get (me);
87 Real dy = gh_scm2double (me->get_grob_property ("delta-y"));
88 SCM number = me->get_grob_property ("text");
89 if (gh_string_p (number) && number_visibility)
91 SCM properties = Font_interface::font_alist_chain (me);
92 Molecule num = Text_item::text2molecule (me, number, properties);
93 num.align_to (X_AXIS, CENTER);
94 num.translate_axis (w/2, X_AXIS);
95 num.align_to (Y_AXIS, CENTER);
97 num.translate_axis (dy/2, Y_AXIS);
99 mol.add_molecule (num);
102 if (bracket_visibility)
104 Real lt = me->paper_l ()->get_var ("stafflinethickness");
106 SCM thick = me->get_grob_property ("thick");
107 SCM gap = me->get_grob_property ("number-gap");
109 SCM at =scm_list_n (ly_symbol2scm ("tuplet"),
114 gh_double2scm (gh_scm2double (thick)* lt),
119 mol.add_molecule (Molecule (b, at));
122 return mol.smobbed_copy ();
129 use first -> last note for slope, and then correct for disturbing
132 Tuplet_bracket::calc_position_and_height (Grob*me,Real *offset, Real * dy)
134 Link_array<Grob> column_arr=
135 Pointer_group_interface__extract_grobs (me, (Grob*)0, "columns");
138 Grob * commony = me->common_refpoint (me->get_grob_property ("columns"), Y_AXIS);
139 Grob * commonx = me->common_refpoint (me->get_grob_property ("columns"), X_AXIS);
141 Direction d = Directional_element_interface::get (me);
144 Use outer non-rest columns to determine slope
147 while (l <column_arr.size () && Note_column::rest_b (column_arr[l]))
150 int r = column_arr.size ()- 1;
151 while (r >= l && Note_column::rest_b (column_arr[r]))
156 *dy = column_arr[r]->extent (commony, Y_AXIS) [d]
157 - column_arr[l]->extent (commony, Y_AXIS) [d] ;
163 *offset = - d * infinity_f;
165 if (!column_arr.size ())
168 Real x0 = column_arr[0]->relative_coordinate (commonx, X_AXIS);
169 Real x1 = column_arr.top ()->relative_coordinate (commonx, X_AXIS);
171 Real factor = column_arr.size () > 1 ? 1/ (x1 - x0) : 1.0;
173 for (int i = 0; i < column_arr.size (); i++)
175 Real notey = column_arr[i]->extent (commony, Y_AXIS)[d]
176 - me->relative_coordinate (commony, Y_AXIS);
178 Real x = column_arr[i]->relative_coordinate (commonx, X_AXIS) - x0;
179 Real tuplety = *dy * x * factor;
181 if (notey * d > (*offset + tuplety) * d)
182 *offset = notey - tuplety;
190 horizontal brackets should not collide with staff lines.
196 // quantize, then do collision check.
197 Real ss= Staff_symbol_referencer::staff_space (me);
200 *offset = rint (*offset);
201 if (Staff_symbol_referencer::on_staffline (me, (int) rint (*offset)))
210 use first -> last note for slope,
213 Tuplet_bracket::calc_dy (Grob*me,Real * dy)
215 Link_array<Grob> column_arr=
216 Pointer_group_interface__extract_grobs (me, (Grob*)0, "columns");
221 Direction d = Directional_element_interface::get (me);
222 *dy = column_arr.top ()->extent (column_arr.top (), Y_AXIS) [d]
223 - column_arr[0]->extent (column_arr[0], Y_AXIS) [d];
225 MAKE_SCHEME_CALLBACK (Tuplet_bracket,after_line_breaking,1);
228 Tuplet_bracket::after_line_breaking (SCM smob)
230 Grob * me = unsmob_grob (smob);
231 Link_array<Note_column> column_arr=
232 Pointer_group_interface__extract_grobs (me, (Note_column*)0, "columns");
234 if (!column_arr.size ())
237 return SCM_UNSPECIFIED;
240 Direction d = Directional_element_interface::get (me);
243 d = Tuplet_bracket::get_default_dir (me);
244 Directional_element_interface::set (me, d);
249 calc_position_and_height (me,&offset,&dy);
251 if (!gh_number_p (me->get_grob_property ("delta-y")))
252 me->set_grob_property ("delta-y", gh_double2scm (dy));
254 me->translate_axis (offset, Y_AXIS);
255 return SCM_UNSPECIFIED;
260 Tuplet_bracket::get_default_dir (Grob*me)
263 SCM dir_sym =me->get_grob_property ("dir-forced");
264 if (ly_dir_p (dir_sym))
272 for (SCM s = me->get_grob_property ("columns"); gh_pair_p (s); s = ly_cdr (s))
274 Grob * nc = unsmob_grob (ly_car (s));
275 if (Note_column::dir (nc) < 0)
286 Tuplet_bracket::add_column (Grob*me, Item*n)
288 Pointer_group_interface::add_grob (me, ly_symbol2scm ("columns"), n);
289 me->add_dependency (n);
291 add_bound_item (dynamic_cast<Spanner*> (me), n);
296 Tuplet_bracket::has_interface (Grob*me)
298 return me->has_interface (ly_symbol2scm ("tuplet-bracket-interface"));
304 ADD_INTERFACE (Tuplet_bracket,"tuplet-bracket-interface",
305 "A bracket with a number in the middle, used for tuplets.",
306 "columns number-gap delta-y tuplet-bracket-visibility tuplet-number-visibility thick direction");