lily/tuplet-spanner.cc

   1 /*
   2   plet-spanner.cc -- implement Tuplet_spanner
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2000 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9
  10 #include "beam.hh"
  11 #include "box.hh"
  12 #include "debug.hh"
  13 #include "lookup.hh"
  14 #include "molecule.hh"
  15 #include "paper-column.hh"
  16 #include "paper-def.hh"
  17 #include "tuplet-spanner.hh"
  18 #include "stem.hh"
  19 #include "note-column.hh"
  20 #include "dimensions.hh"
  21 #include "group-interface.hh"
  22 #include "directional-element-interface.hh"
  23
  24
  25 Tuplet_spanner::Tuplet_spanner ()
  26 {
  27   set_elt_property ("beams", SCM_EOL);
  28   set_elt_property ("columns", SCM_EOL);
  29 }
  30
  31 /*
  32   TODO.
  33  */
  34 Molecule
  35 Tuplet_spanner::do_brew_molecule () const
  36 {
  37   Molecule  mol;
  38
  39   // Default behaviour: number always, bracket when no beam!
  40   bool par_beam = to_boolean (get_elt_property ("parallel-beam"));
  41   bool bracket_visibility = !par_beam;
  42   bool number_visibility = true;
  43
  44   SCM bracket = get_elt_property ("tuplet-bracket-visibility");
  45   if (gh_boolean_p (bracket))
  46     {
  47       bracket_visibility = gh_scm2bool (bracket);
  48     }
  49   else if (bracket == ly_symbol2scm ("if-no-beam"))
  50     bracket_visibility = !par_beam;
  51
  52   SCM numb = get_elt_property ("tuplet-number-visibility");
  53   if (gh_boolean_p (numb))
  54     {
  55       number_visibility = gh_scm2bool (numb);
  56     }
  57   else if (bracket == ly_symbol2scm ("if-no-beam"))
  58     number_visibility = !par_beam;
  59
  60   if (gh_pair_p (get_elt_property ("columns")))
  61     {
  62       Link_array<Note_column> column_arr=
  63         Group_interface__extract_elements (this, (Note_column*)0, "columns");
  64
  65       Real ncw = column_arr.top ()->extent(X_AXIS).length ();
  66       Real w = spanner_length () + ncw;
  67
  68
  69       Real staff_space = paper_l ()->get_var ("interline");
  70       Direction dir = directional_element (this).get ();
  71       Real dy = gh_scm2double (get_elt_property ("delta-y"));
  72       SCM number = get_elt_property ("text");
  73       if (gh_string_p (number) && number_visibility)
  74         {
  75           Molecule
  76             num (lookup_l ()->text ("italic",
  77                                     ly_scm2string (number), paper_l ()));
  78           num.align_to (X_AXIS, CENTER);
  79           num.translate_axis (w/2, X_AXIS);
  80           num.align_to (Y_AXIS, CENTER);
  81           num.translate_axis (dir * staff_space, Y_AXIS);
  82
  83           num.translate_axis (dy/2, Y_AXIS);
  84
  85           mol.add_molecule (num);
  86         }
  87
  88       Real thick = paper_l ()->get_var ("tuplet_thick");
  89       if (bracket_visibility)
  90         {
  91           Real gap = paper_l () -> get_var ("tuplet_spanner_gap");
  92           Real height = staff_space;
  93           SCM at =gh_list(ly_symbol2scm ("tuplet"),
  94                                        gh_double2scm (height),
  95                                        gh_double2scm (gap),
  96                                        gh_double2scm (w),
  97                                        gh_double2scm (dy),
  98                                        gh_double2scm (thick),
  99                                        gh_int2scm (dir),
 100                                        SCM_UNDEFINED);
 101
 102           Box b;
 103           mol.add_molecule (Molecule (b, at));
 104         }
 105
 106       mol.translate_axis (dir * staff_space, Y_AXIS);
 107     }
 108   return mol;
 109 }
 110
 111 void
 112 Tuplet_spanner::do_add_processing ()
 113 {
 114   if (gh_pair_p (get_elt_property ("columns")))
 115     {
 116       Link_array<Note_column> column_arr=
 117         Group_interface__extract_elements (this, (Note_column*)0, "columns");
 118
 119       set_bound (LEFT, column_arr[0]);
 120       set_bound (RIGHT, column_arr.top ());
 121     }
 122 }
 123
 124
 125
 126 /*
 127   use first -> last note for slope, and then correct for disturbing
 128   notes in between.  */
 129 void
 130 Tuplet_spanner::calc_position_and_height (Real *offset, Real * dy) const
 131 {
 132   Link_array<Note_column> column_arr=
 133     Group_interface__extract_elements (this, (Note_column*)0, "columns");
 134
 135
 136   Direction d = directional_element (this).get ();
 137
 138   /*
 139     Use outer non-rest columns to determine slope
 140    */
 141   int l = 0;
 142   while (l <column_arr.size() && column_arr[l]->rest_b())
 143     l ++;
 144
 145   int r = column_arr.size ()- 1;
 146   while (r >= l && column_arr[r]->rest_b())
 147     r--;
 148
 149   if (l < r)
 150     {
 151       *dy = column_arr[r]->extent (Y_AXIS) [d]
 152         - column_arr[l]->extent (Y_AXIS) [d];
 153     }
 154   else
 155     * dy = 0;
 156
 157
 158   *offset = - d * infinity_f;
 159
 160   Real x0 = column_arr[0]->hpos_f ();
 161   Real x1 = column_arr.top ()->hpos_f ();
 162
 163   Real factor = column_arr.size () > 1 ? 1/(x1 - x0) : 1.0;
 164
 165   for (int i = 0; i < column_arr.size ();  i++)
 166     {
 167       Real notey = column_arr[i]->extent (Y_AXIS)[d];
 168       Real x = column_arr[i]->hpos_f () - x0;
 169       Real tuplety =  *dy * x * factor;
 170
 171       if (notey * d > (*offset + tuplety) * d)
 172         *offset = notey - tuplety;
 173     }
 174 }
 175
 176 /*
 177   use first -> last note for slope,
 178 */
 179 void
 180 Tuplet_spanner::calc_dy (Real * dy) const
 181 {
 182   Link_array<Note_column> column_arr=
 183     Group_interface__extract_elements (this, (Note_column*)0, "columns");
 184
 185
 186   Direction d = directional_element (this).get ();
 187   *dy = column_arr.top ()->extent (Y_AXIS) [d]
 188     - column_arr[0]->extent (Y_AXIS) [d];
 189 }
 190
 191 void
 192 Tuplet_spanner::after_line_breaking ()
 193 {
 194   Link_array<Note_column> column_arr=
 195     Group_interface__extract_elements (this, (Note_column*)0, "columns");
 196
 197   if (!column_arr.size ())
 198     {
 199       set_elt_property ("transparent", SCM_BOOL_T);
 200       set_empty (X_AXIS);
 201       set_empty (Y_AXIS);
 202     }
 203
 204   Direction d =   directional_element (this).get ();
 205   if (!d)
 206     {
 207       d = get_default_dir ();
 208       directional_element (this).set (d);
 209
 210     }
 211   Real dy, offset;
 212
 213 calc_position_and_height  (&offset,&dy);
 214   // calc_position (&offset, dy);
 215
 216   set_elt_property ("delta-y", gh_double2scm (dy));
 217
 218   translate_axis (offset, Y_AXIS);
 219
 220   if (scm_ilength (get_elt_property ("beams")) == 1)
 221     {
 222       SCM bs = get_elt_property ("beams");
 223       Score_element *b = unsmob_element (gh_car (bs));
 224       Beam * beam_l = dynamic_cast<Beam*> (b);
 225       if (!broken_b ()
 226           && get_bound (LEFT)->column_l () == beam_l->get_bound (LEFT)->column_l ()
 227           && get_bound (RIGHT)->column_l () == beam_l->get_bound (RIGHT)->column_l ())
 228         set_elt_property ("parallel-beam", SCM_BOOL_T);
 229     }
 230 }
 231
 232
 233 Direction
 234 Tuplet_spanner::get_default_dir () const
 235 {
 236   Direction d = UP;
 237   SCM dir_sym =get_elt_property ("dir-forced");
 238   if (isdir_b (dir_sym))
 239     {
 240       d= to_dir (dir_sym);
 241       if (d != CENTER)
 242         return d;
 243     }
 244
 245   d = UP ;
 246   for (SCM s = get_elt_property ("columns"); gh_pair_p (s); s = gh_cdr (s))
 247     {
 248       Score_element * sc = unsmob_element (gh_car (s));
 249       Note_column * nc = dynamic_cast<Note_column*> (sc);
 250       if (nc->dir () < 0)
 251         {
 252           d = DOWN;
 253           break;
 254         }
 255     }
 256
 257   return d;
 258 }
 259
 260 void
 261 Tuplet_spanner::add_beam (Beam *b)
 262 {
 263   add_dependency (b);
 264   Group_interface gi (this, "beams");
 265   gi.add_element (b);
 266 }
 267
 268 void
 269 Tuplet_spanner::add_column (Note_column*n)
 270 {
 271   Group_interface gi (this, "columns");
 272   gi.add_element (n);
 273
 274   add_dependency (n);
 275 }
 276
 277