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