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_start_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
  88 void
  89 Stem::set_stemend (Real se)
  90 {
  91   // todo: margins
  92   if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
  93     warning (_("Weird stem size; check for narrow beams"));
  94
  95
  96   yextent_drul_[dir_]  =  se;
  97   yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
  98 }
  99
 100 int
 101 Stem::type_i () const
 102 {
 103   return head_l_arr_[0]->balltype_i_;
 104 }
 105
 106 void
 107 Stem::add (Rhythmic_head *n)
 108 {
 109   n->add_dependency (this);     // ?
 110   if (n->is_type_b (Note_head::static_name ()))
 111     {
 112       head_l_arr_.push ((Note_head*)n);
 113     }
 114   else if (n->is_type_b (Rest::static_name ()))
 115     {
 116       rest_l_arr_.push ((Rest*)n);
 117     }
 118 }
 119
 120 bool
 121 Stem::invisible_b () const
 122 {
 123   return (!head_l_arr_.size () ||
 124     head_l_arr_[0]->balltype_i_ <= 0);
 125 }
 126
 127 int
 128 Stem::get_center_distance (Direction d)
 129 {
 130   int staff_center = 0;
 131   int distance = d*(head_positions()[d] - staff_center);
 132   return distance >? 0;
 133 }
 134
 135 Direction
 136 Stem::get_default_dir ()
 137 {
 138   return (get_center_distance (UP) >=
 139           get_center_distance (DOWN))
 140     ? DOWN
 141     : UP;
 142 }
 143
 144
 145 void
 146 Stem::set_default_dir ()
 147 {
 148   dir_ = get_default_dir ();
 149 }
 150
 151 void
 152 Stem::set_default_stemlen ()
 153 {
 154   Real len = STEMLEN;
 155   Real dy = paper ()->interbeam_f ();
 156
 157   // ugh, should get nice *rule* for this
 158   if (abbrev_flag_i_ > 1)
 159     len += (abbrev_flag_i_ - 1)* dy / 2;
 160
 161
 162   if (!dir_)
 163     set_default_dir ();
 164
 165   /* If the stem points in the "wrong" direction, it should be
 166      shortened, according to [Roush & Gourlay].  Their suggestion to knock off
 167      a whole staffspace is a bit drastical though.
 168      */
 169   else if (dir_ != get_default_dir ())
 170     len  -= 1.0;
 171
 172   if (flag_i_ >= 5)
 173     len += 2.0;
 174   if (flag_i_ >= 6)
 175     len += 1.0;
 176
 177   set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + len :
 178                head_positions()[SMALLER] - len);
 179
 180
 181   if (dir_ * stem_end_f () < 0)
 182     {
 183       set_stemend (0);
 184     }
 185 }
 186
 187 void
 188 Stem::set_default_extents ()
 189 {
 190   if (!stem_length_f ())
 191     set_default_stemlen ();
 192
 193
 194   if (dir_ == UP)
 195     stem_xdir_ = RIGHT;
 196   if (invisible_b ())
 197     stem_xdir_ = CENTER;
 198 }
 199
 200 /*
 201   TODO
 202
 203   move into note_column.cc
 204
 205   */
 206 void
 207 Stem::set_noteheads ()
 208 {
 209   if (!head_l_arr_.size ())
 210     return;
 211   head_l_arr_.sort (Note_head::compare);
 212   if (dir_ < 0)
 213     head_l_arr_.reverse ();
 214
 215   head_l_arr_[0]->extremal_i_ = -1;
 216   head_l_arr_.top ()->extremal_i_ = 1;
 217   int parity=1;
 218   int lastpos = head_l_arr_[0]->position_i_;
 219   for (int i=1; i < head_l_arr_.size (); i ++)
 220     {
 221       int dy =abs (lastpos- head_l_arr_[i]->position_i_);
 222
 223       if (dy <= 1)
 224         {
 225           if (parity)
 226             head_l_arr_[i]->x_dir_ = (stem_xdir_ == LEFT) ? LEFT : RIGHT;
 227           parity = !parity;
 228         }
 229       else
 230         parity = 0;
 231       lastpos = head_l_arr_[i]->position_i_;
 232     }
 233 }
 234
 235 void
 236 Stem::do_pre_processing ()
 237 {
 238   if (yextent_drul_[DOWN]== yextent_drul_[UP])
 239     set_default_extents ();
 240   set_noteheads ();
 241   flag_i_ = flag_i_;
 242   transparent_b_ = invisible_b ();
 243   set_empty (invisible_b ());
 244 }
 245
 246
 247 Interval
 248 Stem::do_width () const
 249 {
 250   Interval r (0, 0);
 251   if (abbrev_flag_i_)
 252     {
 253       r = abbrev_mol ().extent ().x ();
 254     }
 255   else if (beam_l_ || abs (flag_i_) <= 2)
 256     ;   // TODO!
 257   else
 258     {
 259       Paper_def*p= paper ();
 260       r = p->lookup_l ()->flag (flag_i_, dir_).dim_.x ();
 261       r += note_delta_f ();
 262     }
 263   return r;
 264 }
 265
 266
 267
 268 Molecule
 269 Stem::abbrev_mol () const
 270 {
 271   Real dy = paper ()->interbeam_f ();
 272   Real w = 1.5 * paper ()->lookup_l ()->ball (2).dim_.x ().length ();
 273   Real beamdy = paper ()->interline_f () / 2;
 274
 275   int beams_i = 0;
 276   Real slope = paper ()->internote_f () / 4;
 277
 278   if (beam_l_) {
 279     // huh?
 280       slope = 2 * beam_l_->slope;
 281     // ugh, rather calc from Abbreviation_req
 282       beams_i = beams_right_i_ >? beams_left_i_;
 283   }
 284   paper ()->lookup_l ()->beam (slope, 20 PT);
 285
 286   Molecule beams;
 287   Atom a (paper ()->lookup_l ()->beam (slope, w));
 288   a.translate (Offset(- w / 2, stem_end_f () - (w / 2 * slope)));
 289
 290   // ugh
 291   if (!beams_i)
 292     a.translate_axis (dy + beamdy - dir_ * dy, Y_AXIS);
 293   else
 294     a.translate_axis (2 * beamdy - dir_ * (beamdy - dy), Y_AXIS);
 295
 296   for (int i = 0; i < abbrev_flag_i_; i++)
 297     {
 298       Atom b (a);
 299       b.translate_axis (-dir_ * dy * (beams_i + i), Y_AXIS);
 300       beams.add (b);
 301     }
 302
 303   return beams;
 304 }
 305
 306 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
 307
 308 Molecule*
 309 Stem::brew_molecule_p () const
 310 {
 311   Molecule *mol_p =new Molecule;
 312   Paper_def *p =paper ();
 313   Drul_array<Real> stem_y = yextent_drul_;
 314   Real dy = p->internote_f ();
 315
 316
 317   Real head_wid = 0;
 318   if (head_l_arr_.size ())
 319     head_wid = head_l_arr_[0]->width ().length ();
 320   stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
 321
 322   if (!invisible_b ())
 323     {
 324       Atom ss =p->lookup_l ()->stem (stem_y[DOWN]*dy,
 325                                      stem_y[UP]*dy);
 326       mol_p->add (Atom (ss));
 327     }
 328
 329   if (!beam_l_ &&abs (flag_i_) > 2)
 330     {
 331       Atom fl = p->lookup_l ()->flag (flag_i_, dir_);
 332       fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
 333       mol_p->add(fl);
 334       assert (!abbrev_flag_i_);
 335     }
 336
 337   if (abbrev_flag_i_)
 338     mol_p->add (abbrev_mol ());
 339
 340   if (head_l_arr_.size())
 341     {
 342       mol_p->translate_axis (note_delta_f (), X_AXIS);
 343     }
 344   return mol_p;
 345 }
 346
 347 Real
 348 Stem::note_delta_f () const
 349 {
 350   Real r=0;
 351   if (head_l_arr_.size())
 352     {
 353       Interval head_wid(0,  head_l_arr_[0]->width ().length ());
 354       Real rule_thick(paper ()->rule_thickness ());
 355       Interval stem_wid(-rule_thick/2, rule_thick/2);
 356       r = head_wid[stem_xdir_] - stem_wid[stem_xdir_];
 357     }
 358   return r;
 359 }
 360 Real
 361 Stem::hpos_f () const
 362 {
 363   return note_delta_f () +Item::hpos_f ();
 364 }
 365
 366 /*
 367   TODO:  head_l_arr_/rest_l_arr_ in  do_substitute_dependent ()
 368  */
 369 void
 370  Stem::do_substitute_dependency (Score_elem*o,Score_elem*n)
 371 {
 372   Item * o_l = o->item ();
 373   Item * n_l = n? n->item () : 0;
 374   head_l_arr_.substitute ((Note_head*)o_l, (Note_head*)n_l);
 375   rest_l_arr_.substitute ((Rest*)o_l, (Rest*)n_l);
 376 }