lily/beam-collision-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2011 Mike Solomon <mike@apollinemike.com>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "beam.hh"
  21 #include "engraver.hh"
  22 #include "item.hh"
  23 #include "note-head.hh"
  24 #include "pointer-group-interface.hh"
  25
  26 class Beam_collision_engraver : public Engraver
  27 {
  28 protected:
  29   vector<Grob *> active_beams_;
  30   vector<Grob *> signaled_beams_;
  31   vector<Grob *> end_beams_;
  32   vector<Grob *> covered_grobs_;
  33   vector<Grob *> covered_interior_grobs_;
  34
  35   DECLARE_ACKNOWLEDGER (note_head);
  36   DECLARE_ACKNOWLEDGER (accidental);
  37   DECLARE_ACKNOWLEDGER (clef);
  38   DECLARE_ACKNOWLEDGER (key_signature);
  39   DECLARE_ACKNOWLEDGER (time_signature);
  40   DECLARE_ACKNOWLEDGER (beam);
  41   DECLARE_END_ACKNOWLEDGER (beam);
  42   void stop_translation_timestep ();
  43 public:
  44   TRANSLATOR_DECLARATIONS (Beam_collision_engraver);
  45 };
  46
  47 void
  48 Beam_collision_engraver::stop_translation_timestep ()
  49 {
  50   for (vsize i = 0; i < covered_interior_grobs_.size (); i++)
  51     for (vsize j = 0; j < active_beams_.size (); j++)
  52       Pointer_group_interface::add_grob (active_beams_[j], ly_symbol2scm ("covered-grobs"), covered_interior_grobs_[i]);
  53
  54   covered_interior_grobs_.clear ();
  55
  56   for (vsize i = 0; i < active_beams_.size (); i++)
  57     for (vsize j = 0; j < signaled_beams_.size (); j++)
  58       if (active_beams_[i] == signaled_beams_[j])
  59         {
  60           signaled_beams_.erase (signaled_beams_.begin () + j);
  61           break;
  62         }
  63
  64   /*
  65     hack.
  66     in auto beaming, end beams are signaled with their beams at a later timestep.
  67     we need to scrub these.
  68   */
  69   for (vsize i = 0; i < end_beams_.size (); i++)
  70     for (vsize j = 0; j < signaled_beams_.size (); j++)
  71       if (end_beams_[i] == signaled_beams_[j])
  72         {
  73           signaled_beams_.erase (signaled_beams_.begin () + j);
  74           break;
  75         }
  76
  77   vsize orig_size = active_beams_.size ();
  78
  79   for (vsize i=0; i < signaled_beams_.size (); i++)
  80     active_beams_.push_back (signaled_beams_[i]);
  81
  82   for (vsize i = 0; i < covered_grobs_.size (); i++)
  83     for (vsize j = 0; j < active_beams_.size (); j++)
  84       {
  85         bool my_beam = false;
  86         if (Grob *stem = unsmob_grob (covered_grobs_[i]->get_object ("stem")))
  87           if (Grob *beam = unsmob_grob (stem->get_object ("beam")))
  88             if (beam == active_beams_.at (j))
  89               my_beam = true;
  90         if (!my_beam)
  91           Pointer_group_interface::add_grob (active_beams_.at (j), ly_symbol2scm ("covered-grobs"), covered_grobs_[i]);
  92       }
  93
  94   covered_grobs_.clear ();
  95
  96   for (vsize i = 0; i < signaled_beams_.size (); i++)
  97     for (vsize j = 0; j < orig_size; j++)
  98       Pointer_group_interface::add_grob (active_beams_[j], ly_symbol2scm ("covered-grobs"), signaled_beams_[i]);
  99
 100   signaled_beams_.clear ();
 101
 102   for (vsize i = 0; i < end_beams_.size (); i++)
 103     for (vsize j = 0; j < active_beams_.size (); j++)
 104       if (end_beams_[i] == active_beams_[j])
 105         {
 106           active_beams_.erase (active_beams_.begin () + j);
 107           break;
 108         }
 109
 110   end_beams_.clear ();
 111 }
 112
 113 Beam_collision_engraver::Beam_collision_engraver () {}
 114
 115 void
 116 Beam_collision_engraver::acknowledge_note_head (Grob_info i)
 117 {
 118   covered_grobs_.push_back (i.grob ());
 119 }
 120
 121 void
 122 Beam_collision_engraver::acknowledge_accidental (Grob_info i)
 123 {
 124   covered_grobs_.push_back (i.grob ());
 125 }
 126
 127 void
 128 Beam_collision_engraver::acknowledge_clef (Grob_info i)
 129 {
 130   covered_interior_grobs_.push_back (i.grob ());
 131 }
 132
 133 void
 134 Beam_collision_engraver::acknowledge_key_signature (Grob_info i)
 135 {
 136   covered_interior_grobs_.push_back (i.grob ());
 137 }
 138
 139 void
 140 Beam_collision_engraver::acknowledge_time_signature (Grob_info i)
 141 {
 142   covered_interior_grobs_.push_back (i.grob ());
 143 }
 144
 145 void
 146 Beam_collision_engraver::acknowledge_beam (Grob_info i)
 147 {
 148   signaled_beams_.push_back (i.grob ());
 149 }
 150
 151 void
 152 Beam_collision_engraver::acknowledge_end_beam (Grob_info i)
 153 {
 154   end_beams_.push_back (i.grob ());
 155 }
 156
 157 #include "translator.icc"
 158
 159 ADD_ACKNOWLEDGER (Beam_collision_engraver, note_head);
 160 ADD_ACKNOWLEDGER (Beam_collision_engraver, accidental);
 161 ADD_ACKNOWLEDGER (Beam_collision_engraver, clef);
 162 ADD_ACKNOWLEDGER (Beam_collision_engraver, key_signature);
 163 ADD_ACKNOWLEDGER (Beam_collision_engraver, time_signature);
 164 ADD_ACKNOWLEDGER (Beam_collision_engraver, beam);
 165 ADD_END_ACKNOWLEDGER (Beam_collision_engraver, beam);
 166
 167 ADD_TRANSLATOR (Beam_collision_engraver,
 168                 /* doc */
 169                 "Help beams avoid colliding with notes and clefs in other voices.",
 170
 171                 /* create */
 172                 "",
 173
 174                 /* read */
 175                 "",
 176
 177                 /* write */
 178                 ""
 179                 );