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