lily/slur.cc

   1 /*
   2   slur.cc -- implement  Slur
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,  1997--1999, 1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7     Jan Nieuwenhuizen <janneke@gnu.org>
   8 */
   9
  10 /*
  11   [TODO]
  12     * URG: share code with tie
  13     * begin and end should be treated as a Script.
  14     * damping
  15     * slur from notehead to stemend: c''()b''
  16  */
  17
  18 #include "slur.hh"
  19 #include "scalar.hh"
  20 #include "lookup.hh"
  21 #include "paper-def.hh"
  22 #include "note-column.hh"
  23 #include "stem.hh"
  24 #include "p-col.hh"
  25 #include "molecule.hh"
  26 #include "debug.hh"
  27 #include "box.hh"
  28 #include "bezier.hh"
  29 #include "encompass-info.hh"
  30 #include "main.hh"
  31
  32
  33 Slur::Slur ()
  34 {
  35 }
  36
  37 void
  38 Slur::add_column (Note_column*n)
  39 {
  40   if (!n->head_l_arr_.size ())
  41     warning (_ ("Putting slur over rest."));
  42   encompass_arr_.push (n);
  43   n->stem_l_->slur_l_ = this;
  44   add_dependency (n);
  45 }
  46
  47 void
  48 Slur::set_default_dir ()
  49 {
  50   dir_ = DOWN;
  51   for (int i=0; i < encompass_arr_.size (); i ++)
  52     {
  53       if (encompass_arr_[i]->dir_ < 0)
  54         {
  55           dir_ = UP;
  56           break;
  57         }
  58     }
  59 }
  60
  61 void
  62 Slur::do_add_processing ()
  63 {
  64   set_bounds (LEFT, encompass_arr_[0]);
  65   if (encompass_arr_.size () > 1)
  66     set_bounds (RIGHT, encompass_arr_.top ());
  67 }
  68
  69 void
  70 Slur::do_pre_processing ()
  71 {
  72   // don't set directions
  73 }
  74
  75 void
  76 Slur::do_substitute_dependency (Score_element*o, Score_element*n)
  77 {
  78   int i;
  79   while ((i = encompass_arr_.find_i (dynamic_cast<Note_column *> (o))) >=0)
  80     {
  81       if (n)
  82         encompass_arr_[i] = dynamic_cast<Note_column *> (n);
  83       else
  84         encompass_arr_.del (i);
  85     }
  86 }
  87
  88 static int
  89 Note_column_compare (Note_column *const&n1 , Note_column* const&n2)
  90 {
  91   return Item::left_right_compare (n1, n2);
  92 }
  93
  94 void
  95 Slur::do_post_processing ()
  96 {
  97   encompass_arr_.sort (Note_column_compare);
  98   if (!dir_)
  99     set_default_dir ();
 100
 101   Real interline_f = paper ()->interline_f ();
 102   Real internote_f = interline_f / 2;
 103   // URG
 104   Real notewidth_f = paper ()->note_width () * 0.8;
 105
 106   /*
 107    [OSU]: slur and tie placement
 108
 109    slurs:
 110    * x = centre of head (upside-down: inner raakpunt stem) - d * gap
 111
 112    * y = length < 5ss : horizontal raakpunt + d * 0.25 ss
 113      y = length >= 5ss : y next interline - d * 0.25 ss
 114      --> height <= 5 length ?? we use <= 3 length, now...
 115    */
 116
 117   Real gap_f = paper ()->get_var ("slur_x_gap");
 118
 119   Drul_array<Note_column*> extrema;
 120   extrema[LEFT] = encompass_arr_[0];
 121   extrema[RIGHT] = encompass_arr_.top ();
 122
 123   Direction d=LEFT;
 124
 125   do
 126     {
 127       /*
 128         broken slur
 129        */
 130       if (extrema[d] != spanned_drul_[d])
 131         {
 132           // ugh -- check if needed
 133           dx_f_drul_[d] = -d
 134             *(spanned_drul_[d]->extent (X_AXIS).length () - 0.5 * notewidth_f);
 135
 136           // prebreak
 137           if (d == RIGHT)
 138             {
 139               dx_f_drul_[LEFT] = spanned_drul_[LEFT]->extent (X_AXIS).length ();
 140
 141               // urg -- check if needed
 142               if (encompass_arr_.size () > 1)
 143                 dx_f_drul_[RIGHT] += notewidth_f;
 144             }
 145         }
 146       /*
 147         normal slur
 148        */
 149       else if (extrema[d]->stem_l_ && !extrema[d]->stem_l_->transparent_b_
 150                && extrema[d]->head_l_arr_.size ())
 151         {
 152           Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
 153           dy_f_drul_[d] = (int)rint (extrema[d]->stem_l_-> extent (Y_AXIS)[dir_]);
 154           dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
 155           if (dir_ == extrema[d]->stem_l_->dir_)
 156             {
 157               if (dir_ == d)
 158                 dx_f_drul_[d] += 0.5 * (dir_ * d) * d * notewidth_f;
 159               else
 160                 dx_f_drul_[d] += 0.25 * (dir_ * d) * d * notewidth_f;
 161             }
 162         }
 163         else
 164           {
 165             Real notewidth_f = extrema[d]->extent (X_AXIS).length ();
 166             dy_f_drul_[d] = (int)rint (extrema[d]->head_positions_interval ()
 167                                        [dir_]) * internote_f;
 168             dx_f_drul_[d] += 0.5 * notewidth_f - d * gap_f;
 169         }
 170         dy_f_drul_[d] += dir_ * interline_f;
 171         if (extrema[d]->stem_l_ && (dir_ == extrema[d]->stem_l_->dir_))
 172           dy_f_drul_[d] -= dir_ * internote_f;
 173       }
 174   while (flip(&d) != LEFT);
 175
 176   // now that both are set, do dependent
 177   do
 178     {
 179       /*
 180         broken slur
 181        */
 182       if (extrema[d] != spanned_drul_[d])
 183         {
 184           Direction u = d;
 185           flip(&u);
 186
 187           // postbreak
 188           if (d == LEFT)
 189             dy_f_drul_[u] += dir_ * internote_f;
 190
 191           dy_f_drul_[d] = dy_f_drul_[(Direction)-d];
 192         }
 193      }
 194   while (flip(&d) != LEFT);
 195
 196   /*
 197     Avoid too steep slurs.
 198       * slur from notehead to stemend: c''()b''
 199    */
 200   Real damp_f = paper ()->get_var ("slur_slope_damping");
 201   Offset d_off = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
 202     dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
 203   d_off.x () += extent (X_AXIS).length ();
 204
 205   Real ratio_f = abs (d_off.y () / d_off.x ());
 206   if (ratio_f > damp_f)
 207     dy_f_drul_[(Direction)(- dir_ * sign (d_off.y ()))] +=
 208       dir_ * (ratio_f - damp_f) * d_off.x ();
 209 }
 210
 211 Array<Offset>
 212 Slur::get_encompass_offset_arr () const
 213 {
 214   Real notewidth = paper ()->note_width () * 0.8;
 215   Real gap = paper ()->get_var ("slur_x_gap");
 216   Real internote = paper ()->internote_f ();
 217
 218   Offset left = Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]);
 219   left.x () += encompass_arr_[0]->stem_l_->hpos_f ();
 220
 221   /*
 222     <URG>
 223     i don't understand these two, but *must* for symmetry
 224     look at encompass array:
 225        lilypond -D input/test/slur-symmetry*.ly
 226        lilypond -D input/test/sleur.ly
 227
 228     do_post_processing should have calculated these into
 229     dx_f_drul_[], no??
 230
 231    */
 232
 233   if (dir_ != encompass_arr_[0]->stem_l_->dir_)
 234     left.x () += - 0.5 * notewidth * encompass_arr_[0]->stem_l_->dir_
 235       + gap;
 236   else if (encompass_arr_[0]->stem_l_->dir_ == UP)
 237     left.x () -= notewidth;
 238
 239   if ((dir_ == encompass_arr_[0]->stem_l_->dir_)
 240     && (encompass_arr_[0]->stem_l_->dir_ == DOWN))
 241     left.y () -= internote * encompass_arr_[0]->stem_l_->dir_;
 242   /* </URG> */
 243
 244   Offset d = Offset (dx_f_drul_[RIGHT] - dx_f_drul_[LEFT],
 245     dy_f_drul_[RIGHT] - dy_f_drul_[LEFT]);
 246   d.x () += extent (X_AXIS).length ();
 247
 248   int first = 1;
 249   int last = encompass_arr_.size () - 1;
 250
 251   // prebreak
 252   if (encompass_arr_.top () != spanned_drul_[RIGHT])
 253     last++;
 254
 255   // postbreak
 256   if (encompass_arr_[0] != spanned_drul_[LEFT])
 257     first--;
 258
 259   Array<Offset> notes;
 260   notes.push (Offset (0,0));
 261
 262   for (int i = first; i < last; i++)
 263     {
 264       Encompass_info info (encompass_arr_[i], dir_);
 265       notes.push (info.o_ - left);
 266     }
 267   Encompass_info info (encompass_arr_[encompass_arr_.size () - 1], dir_);
 268
 269   // urg:
 270   Slur* urg = (Slur*)this;
 271   urg->interstaff_f_ = info.interstaff_f_;
 272
 273   d.y () += interstaff_f_;
 274
 275   // prebreak
 276   if (interstaff_f_ && (encompass_arr_.top () != spanned_drul_[RIGHT]))
 277     {
 278       Encompass_info info (encompass_arr_[encompass_arr_.size () - 1], dir_);
 279       d.y () -= info.o_.y () - interstaff_f_;
 280     }
 281
 282   notes.push (d);
 283
 284   return notes;
 285 }
 286
 287 Interval
 288 Slur::do_width () const
 289 {
 290   Real min_f = paper ()->get_var ("slur_x_minimum");
 291   Interval width_int = Bow::do_width ();
 292   return width_int.length () < min_f ? Interval (0, min_f) : width_int;
 293 }
 294
 295 Array<Rod>
 296 Slur::get_rods () const
 297 {
 298   Array<Rod> a;
 299   Rod r;
 300   r.item_l_drul_ = spanned_drul_;
 301   r.distance_f_ = do_width ().length ();
 302   a.push (r);
 303   return a;
 304 }