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