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