lily/stem.cc

   1 /*
   2   stem.cc -- implement Stem
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8   TODO: This is way too hairy
   9 */
  10
  11 #include "stem.hh"
  12 #include "debug.hh"
  13 #include "paper-def.hh"
  14 #include "note-head.hh"
  15 #include "lookup.hh"
  16 #include "molecule.hh"
  17 #include "p-col.hh"
  18 #include "misc.hh"
  19 #include "beam.hh"
  20 #include "rest.hh"
  21
  22 void
  23 Stem::set_direction (Direction d)
  24 {
  25   if  (!dir_)
  26     warning ("Stem direction set already!");
  27
  28   dir_ = d;
  29
  30   /*
  31     todo
  32   */
  33 }
  34
  35 Stem::Stem ()
  36 {
  37   beams_i_drul_[LEFT] = beams_i_drul_[RIGHT] = -1;
  38   yextent_drul_[DOWN] = yextent_drul_[UP] = 0;
  39   flag_i_ = 2;
  40   dir_ = CENTER;
  41   beam_l_ = 0;
  42 }
  43
  44 Interval_t<int>
  45 Stem::head_positions () const
  46 {
  47   /*
  48     Mysterious FreeBSD fix by John Galbraith.  Somehow, the empty intervals
  49     trigger FP exceptions on FreeBSD.  Fix: do not return infinity
  50
  51    */
  52   if (!head_l_arr_.size ())
  53     {
  54       return Interval_t<int> (100,-100);
  55     }
  56
  57   Interval_t<int> r;
  58   for (int i =0; i < head_l_arr_.size (); i++)
  59     {
  60       int p = head_l_arr_[i]->position_i_;
  61       r[BIGGER] = r[BIGGER] >? p;
  62       r[SMALLER] = r[SMALLER] <? p;
  63     }
  64   return r;
  65 }
  66
  67 void
  68 Stem::do_print () const
  69 {
  70 #ifndef NPRINT
  71   DOUT << "flag "<< flag_i_;
  72   if (beam_l_)
  73     DOUT << "beamed";
  74 #endif
  75 }
  76
  77 Real
  78 Stem::stem_length_f () const
  79 {
  80   return yextent_drul_[UP]-yextent_drul_[DOWN] ;
  81 }
  82
  83 Real
  84 Stem::stem_begin_f () const
  85 {
  86   return yextent_drul_[Direction(-dir_)];
  87 }
  88
  89 Real
  90 Stem::chord_start_f () const
  91 {
  92   return head_positions()[dir_] * staff_line_leading_f ()/2.0;
  93 }
  94
  95 Real
  96 Stem::stem_end_f () const
  97 {
  98   return yextent_drul_[dir_];
  99 }
 100
 101 void
 102 Stem::set_stemend (Real se)
 103 {
 104   // todo: margins
 105   if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
 106     warning (_ ("weird stem size; check for narrow beams"));
 107
 108
 109   yextent_drul_[dir_]  =  se;
 110   yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
 111 }
 112
 113 int
 114 Stem::type_i () const
 115 {
 116   return head_l_arr_[0]->balltype_i_;
 117 }
 118
 119 void
 120 Stem::add_head (Rhythmic_head *n)
 121 {
 122   n->add_dependency (this);     // ?
 123   if (Note_head *nh = dynamic_cast<Note_head *> (n))
 124     {
 125       head_l_arr_.push (nh);
 126     }
 127   else if (Rest *r = dynamic_cast<Rest *> (n))
 128     {
 129       rest_l_arr_.push (r);
 130     }
 131 }
 132
 133 bool
 134 Stem::invisible_b () const
 135 {
 136   return (!head_l_arr_.size () ||
 137     head_l_arr_[0]->balltype_i_ <= 0);
 138 }
 139
 140 int
 141 Stem::get_center_distance (Direction d) const
 142 {
 143   int staff_center = 0;
 144   int distance = d*(head_positions()[d] - staff_center);
 145   return distance >? 0;
 146 }
 147
 148 Direction
 149 Stem::get_default_dir () const
 150 {
 151   return (get_center_distance (UP) >
 152           get_center_distance (DOWN))
 153     ? DOWN
 154     : UP;
 155 }
 156
 157 Direction
 158 Stem::get_dir () const
 159 {
 160   return dir_;
 161 }
 162
 163 void
 164 Stem::set_default_dir ()
 165 {
 166   dir_ = get_default_dir ();
 167 }
 168
 169 void
 170 Stem::set_default_stemlen ()
 171 {
 172   Real internote_f = staff_line_leading_f ()/2.0;
 173   Real length_f = paper_l ()->get_var ("stem_length0") / internote_f;
 174   Real shorten_f = paper_l ()->get_var ("forced_stem_shorten0") / internote_f;
 175
 176   if (!dir_)
 177     set_default_dir ();
 178   /*
 179     stems in unnatural (forced) direction should be shortened,
 180     according to [Roush & Gourlay]
 181    */
 182   if (((int)chord_start_f ())
 183       && (dir_ != get_default_dir ()))
 184     length_f -= shorten_f;
 185
 186   if (flag_i_ >= 5)
 187     length_f += 2.0;
 188   if (flag_i_ >= 6)
 189     length_f += 1.0;
 190
 191   set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + length_f:
 192                head_positions()[SMALLER] - length_f);
 193
 194   if (dir_ * stem_end_f () < 0)
 195     set_stemend (0);
 196 }
 197
 198 //xxx
 199 void
 200 Stem::set_default_extents ()
 201 {
 202   if (!stem_length_f ())
 203     set_default_stemlen ();
 204
 205 }
 206
 207 void
 208 Stem::set_noteheads ()
 209 {
 210   if (!head_l_arr_.size ())
 211     return;
 212   head_l_arr_.sort (Note_head::compare);
 213   if (dir_ < 0)
 214     head_l_arr_.reverse ();
 215
 216   Note_head * beginhead =   head_l_arr_[0];
 217   beginhead->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 218   if  (beginhead !=   head_l_arr_.top ())
 219     head_l_arr_.top ()->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 220
 221   int parity=1;
 222   int lastpos = beginhead->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]->flip_around_stem (dir_);
 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   if (invisible_b ())
 247     {
 248       set_elt_property (transparent_scm_sym, SCM_BOOL_T);
 249     }
 250   set_empty (invisible_b ());
 251 }
 252
 253
 254 Interval
 255 Stem::do_width () const
 256 {
 257   Interval r (0, 0);
 258   if (beam_l_ || abs (flag_i_) <= 2)
 259     ;   // TODO!
 260   else
 261     {
 262       r = lookup_l ()->flag (flag_i_, dir_).dim_.x ();
 263       r += note_delta_f ();
 264     }
 265   return r;
 266 }
 267
 268
 269
 270
 271 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
 272
 273 Molecule*
 274 Stem::do_brew_molecule_p () const
 275 {
 276   Molecule *mol_p =new Molecule;
 277   Drul_array<Real> stem_y = yextent_drul_;
 278   Real dy = staff_line_leading_f ()/2.0;
 279
 280   Real head_wid = 0;
 281   if (head_l_arr_.size ())
 282     head_wid = head_l_arr_[0]->extent (X_AXIS).length ();
 283   stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
 284
 285   if (!invisible_b ())
 286     {
 287       Molecule ss =lookup_l ()->stem (stem_y[DOWN]*dy,
 288                                      stem_y[UP]*dy);
 289       mol_p->add_molecule (ss);
 290     }
 291
 292   if (!beam_l_ && abs (flag_i_) > 2)
 293     {
 294       Molecule fl = lookup_l ()->flag (flag_i_, dir_);
 295       fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
 296       mol_p->add_molecule (fl);
 297     }
 298
 299   if (head_l_arr_.size())
 300     {
 301       mol_p->translate_axis (note_delta_f (), X_AXIS);
 302     }
 303   return mol_p;
 304 }
 305
 306 Real
 307 Stem::note_delta_f () const
 308 {
 309   Real r=0;
 310   if (head_l_arr_.size())
 311     {
 312       Interval head_wid(0,  head_l_arr_[0]->extent (X_AXIS).length ());
 313       Real rule_thick(paper_l ()->rule_thickness ());
 314       Interval stem_wid(-rule_thick/2, rule_thick/2);
 315       if (dir_ == CENTER)
 316         r = head_wid.center ();
 317       else
 318         r = head_wid[dir_] - stem_wid[dir_];
 319     }
 320   return r;
 321 }
 322
 323 Real
 324 Stem::hpos_f () const
 325 {
 326   return note_delta_f () + Item::hpos_f ();
 327 }
 328
 329 void
 330 Stem::do_substitute_element_pointer (Score_element*o,Score_element*n)
 331 {
 332   if (Note_head*h=dynamic_cast<Note_head*> (o))
 333     head_l_arr_.substitute (h, dynamic_cast<Note_head*>(n));
 334   if (Rest *r=dynamic_cast<Rest*> (o))
 335     rest_l_arr_.substitute (r, dynamic_cast<Rest*>(n));
 336   if (Beam* b = dynamic_cast<Beam*> (o))
 337     {
 338       if (b == beam_l_)
 339         beam_l_ = dynamic_cast<Beam*> (n);
 340     }
 341   Staff_symbol_referencer::do_substitute_element_pointer (o,n);
 342 }