lily/stem.cc

   1 /*
   2   stem.cc -- implement Stem
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996,1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7
   8   TODO: This is way too hairy
   9 */
  10
  11 #include "stem.hh"
  12 #include "dimen.hh"
  13 #include "debug.hh"
  14 #include "paper-def.hh"
  15 #include "note-head.hh"
  16 #include "lookup.hh"
  17 #include "molecule.hh"
  18 #include "p-col.hh"
  19 #include "misc.hh"
  20 #include "beam.hh"
  21 #include "rest.hh"
  22
  23 const int STEMLEN=7;
  24
  25 IMPLEMENT_IS_TYPE_B1 (Stem,Item);
  26
  27 Stem::Stem ()
  28 {
  29   /*
  30     TODO: staff-size
  31     */
  32   abbrev_flag_i_ = 0;
  33   beam_l_ = 0;
  34   beams_left_i_ = 0;
  35   beams_right_i_ = 0;
  36
  37   yextent_drul_[DOWN] = yextent_drul_[UP] = 0;
  38   flag_i_ = 2;
  39   dir_ = CENTER;
  40   stem_xdir_ = LEFT;
  41   staff_size_i_ = 8;
  42
  43   beam_gap_i_ = 0;
  44 }
  45
  46 Interval_t<int>
  47 Stem::head_positions () const
  48 {
  49   Interval_t<int> r;
  50   for (int i =0; i < head_l_arr_.size (); i++)
  51     {
  52       int p = head_l_arr_[i]->position_i_;
  53       r[BIGGER] = r[BIGGER] >? p;
  54       r[SMALLER] = r[SMALLER] <? p;
  55     }
  56   return r;
  57 }
  58
  59 void
  60 Stem::do_print () const
  61 {
  62 #ifndef NPRINT
  63   DOUT << "flag "<< flag_i_ << "abbrev_flag_i_" << abbrev_flag_i_;
  64   if (beam_l_)
  65     DOUT << "beamed";
  66 #endif
  67 }
  68
  69 Real
  70 Stem::stem_length_f () const
  71 {
  72   return yextent_drul_[UP]-yextent_drul_[DOWN] ;
  73 }
  74
  75 Real
  76 Stem::stem_begin_f () const
  77 {
  78   return yextent_drul_[Direction(-dir_)];
  79 }
  80
  81 Real
  82 Stem::stem_end_f () const
  83 {
  84   return yextent_drul_[dir_];
  85 }
  86
  87 void
  88 Stem::set_stemend (Real se)
  89 {
  90   // todo: margins
  91   if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
  92     warning (_("Weird stem size; check for narrow beams"));
  93
  94
  95   yextent_drul_[dir_]  =  se;
  96   yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
  97 }
  98
  99 int
 100 Stem::type_i () const
 101 {
 102   return head_l_arr_[0]->balltype_i_;
 103 }
 104
 105 void
 106 Stem::add (Rhythmic_head *n)
 107 {
 108   n->add_dependency (this);     // ?
 109   if (n->is_type_b (Note_head::static_name ()))
 110     {
 111       head_l_arr_.push ((Note_head*)n);
 112     }
 113   else if (n->is_type_b (Rest::static_name ()))
 114     {
 115       rest_l_arr_.push ((Rest*)n);
 116     }
 117 }
 118
 119 bool
 120 Stem::invisible_b () const
 121 {
 122   return (!head_l_arr_.size () ||
 123     head_l_arr_[0]->balltype_i_ <= 0);
 124 }
 125
 126 int
 127 Stem::get_center_distance (Direction d)
 128 {
 129   int staff_center = 0;
 130   int distance = d*(head_positions()[d] - staff_center);
 131   return distance >? 0;
 132 }
 133
 134 Direction
 135 Stem::get_default_dir ()
 136 {
 137   return (get_center_distance (UP) >=
 138           get_center_distance (DOWN))
 139     ? DOWN
 140     : UP;
 141 }
 142
 143 Direction
 144 Stem::get_dir ()
 145 {
 146   return dir_;
 147 }
 148
 149 void
 150 Stem::set_default_dir ()
 151 {
 152   dir_ = get_default_dir ();
 153 }
 154
 155 void
 156 Stem::set_default_stemlen ()
 157 {
 158   Real len = STEMLEN;
 159   Real dy = paper ()->interbeam_f ();
 160
 161   // ugh, should get nice *rule* for this
 162   if (abbrev_flag_i_ > 1)
 163     len += (abbrev_flag_i_ - 1)* dy / 2;
 164
 165
 166   if (!dir_)
 167     set_default_dir ();
 168
 169   /* If the stem points in the "wrong" direction, it should be
 170      shortened, according to [Roush & Gourlay].  Their suggestion to knock off
 171      a whole staffspace is a bit drastical though.
 172      */
 173   else if (dir_ != get_default_dir ())
 174     len  -= 1.0;
 175
 176   if (flag_i_ >= 5)
 177     len += 2.0;
 178   if (flag_i_ >= 6)
 179     len += 1.0;
 180
 181   set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + len :
 182                head_positions()[SMALLER] - len);
 183
 184
 185   if (dir_ * stem_end_f () < 0)
 186     {
 187       set_stemend (0);
 188     }
 189 }
 190
 191 void
 192 Stem::set_default_extents ()
 193 {
 194   if (!stem_length_f ())
 195     set_default_stemlen ();
 196
 197
 198   if (dir_ == UP)
 199     stem_xdir_ = RIGHT;
 200   if (invisible_b ())
 201     stem_xdir_ = CENTER;
 202 }
 203
 204 /*
 205   TODO
 206
 207   move into note_column.cc
 208
 209   */
 210 void
 211 Stem::set_noteheads ()
 212 {
 213   if (!head_l_arr_.size ())
 214     return;
 215   head_l_arr_.sort (Note_head::compare);
 216   if (dir_ < 0)
 217     head_l_arr_.reverse ();
 218
 219   head_l_arr_[0]->extremal_i_ = -1;
 220   head_l_arr_.top ()->extremal_i_ = 1;
 221   int parity=1;
 222   int lastpos = head_l_arr_[0]->position_i_;
 223   for (int i=1; i < head_l_arr_.size (); i ++)
 224     {
 225       int dy =abs (lastpos- head_l_arr_[i]->position_i_);
 226
 227       if (dy <= 1)
 228         {
 229           if (parity)
 230             head_l_arr_[i]->x_dir_ = (stem_xdir_ == LEFT) ? LEFT : RIGHT;
 231           parity = !parity;
 232         }
 233       else
 234         parity = 1;
 235       lastpos = head_l_arr_[i]->position_i_;
 236     }
 237 }
 238
 239 void
 240 Stem::do_pre_processing ()
 241 {
 242   if (yextent_drul_[DOWN]== yextent_drul_[UP])
 243     set_default_extents ();
 244   set_noteheads ();
 245   flag_i_ = flag_i_;
 246   transparent_b_ = invisible_b ();
 247   set_empty (invisible_b ());
 248 }
 249
 250
 251 Interval
 252 Stem::do_width () const
 253 {
 254   Interval r (0, 0);
 255   if (abbrev_flag_i_)
 256     {
 257       r = abbrev_mol ().extent ().x ();
 258     }
 259   else if (beam_l_ || abs (flag_i_) <= 2)
 260     ;   // TODO!
 261   else
 262     {
 263       Paper_def*p= paper ();
 264       r = p->lookup_l ()->flag (flag_i_, dir_).dim_.x ();
 265       r += note_delta_f ();
 266     }
 267   return r;
 268 }
 269
 270
 271
 272 Molecule
 273 Stem::abbrev_mol () const
 274 {
 275   Real dy = paper ()->interbeam_f ();
 276   Real w = 1.5 * paper ()->lookup_l ()->ball (2).dim_.x ().length ();
 277   Real interline_f = paper ()->interline_f ();
 278   Real beamdy = interline_f/2;
 279
 280   int beams_i = 0;
 281   Real slope_f = paper ()->internote_f () / 4;
 282
 283   if (beam_l_) {
 284     // huh?
 285       slope_f = 2 * beam_l_->slope_f_;
 286     // ugh, rather calc from Abbreviation_req
 287       beams_i = beams_right_i_ >? beams_left_i_;
 288   }
 289   paper ()->lookup_l ()->beam (slope_f, 20 PT, 1 PT);
 290
 291   Molecule beams;
 292   Atom a (paper ()->lookup_l ()->beam (slope_f, w, .48 * interline_f));
 293   a.translate (Offset(- w / 2, stem_end_f () - (w / 2 * slope_f)));
 294
 295   // ugh
 296   if (!beams_i)
 297     a.translate_axis (dy + beamdy - dir_ * dy, Y_AXIS);
 298   else
 299     a.translate_axis (2 * beamdy - dir_ * (beamdy - dy), Y_AXIS);
 300
 301   for (int i = 0; i < abbrev_flag_i_; i++)
 302     {
 303       Atom b (a);
 304       b.translate_axis (-dir_ * dy * (beams_i + i), Y_AXIS);
 305       beams.add (b);
 306     }
 307
 308   return beams;
 309 }
 310
 311 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
 312
 313 Molecule*
 314 Stem::brew_molecule_p () const
 315 {
 316   Molecule *mol_p =new Molecule;
 317   Paper_def *p =paper ();
 318   Drul_array<Real> stem_y = yextent_drul_;
 319   Real dy = p->internote_f ();
 320
 321
 322   Real head_wid = 0;
 323   if (head_l_arr_.size ())
 324     head_wid = head_l_arr_[0]->width ().length ();
 325   stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
 326
 327   if (!invisible_b ())
 328     {
 329       Atom ss =p->lookup_l ()->stem (stem_y[DOWN]*dy,
 330                                      stem_y[UP]*dy);
 331       mol_p->add (Atom (ss));
 332     }
 333
 334   if (!beam_l_ &&abs (flag_i_) > 2)
 335     {
 336       Atom fl = p->lookup_l ()->flag (flag_i_, dir_);
 337       fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
 338       mol_p->add(fl);
 339       assert (!abbrev_flag_i_);
 340     }
 341
 342   if (abbrev_flag_i_)
 343     mol_p->add (abbrev_mol ());
 344
 345   if (head_l_arr_.size())
 346     {
 347       mol_p->translate_axis (note_delta_f (), X_AXIS);
 348     }
 349   return mol_p;
 350 }
 351
 352 Real
 353 Stem::note_delta_f () const
 354 {
 355   Real r=0;
 356   if (head_l_arr_.size() && stem_xdir_ != CENTER)
 357     {
 358       Interval head_wid(0,  head_l_arr_[0]->width ().length ());
 359       Real rule_thick(paper ()->rule_thickness ());
 360       Interval stem_wid(-rule_thick/2, rule_thick/2);
 361       r = head_wid[stem_xdir_] - stem_wid[stem_xdir_];
 362     }
 363   return r;
 364 }
 365 Real
 366 Stem::hpos_f () const
 367 {
 368   return note_delta_f () +Item::hpos_f ();
 369 }
 370
 371 /*
 372   TODO:  head_l_arr_/rest_l_arr_ in  do_substitute_dependent ()
 373  */
 374 void
 375  Stem::do_substitute_dependency (Score_elem*o,Score_elem*n)
 376 {
 377   Item * o_l = o->item ();
 378   Item * n_l = n? n->item () : 0;
 379   head_l_arr_.substitute ((Note_head*)o_l, (Note_head*)n_l);
 380   rest_l_arr_.substitute ((Rest*)o_l, (Rest*)n_l);
 381 }