lily/fingering-column.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2012 Mike Solomon <mike@mikesolomon.org>
   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 "grob.hh"
  21 #include "fingering-column.hh"
  22 #include "box-quarantine.hh"
  23 #include "pointer-group-interface.hh"
  24 #include "staff-symbol-referencer.hh"
  25 #include "item.hh"
  26 #include "paper-column.hh"
  27
  28 #include <map>
  29
  30 // The sorting algorithm may not preserve the order of the
  31 // original fingerings. We use Fingering_position_info to retain
  32 // this order.
  33
  34 struct Fingering_position_info {
  35   Box box_;
  36   vsize idx_;
  37   Fingering_position_info (Box, vsize);
  38 };
  39
  40 Fingering_position_info::Fingering_position_info (Box box, vsize idx)
  41   : box_ (box), idx_ (idx)
  42 {
  43 }
  44
  45 bool
  46 fingering_position_less (Fingering_position_info fpi0, Fingering_position_info fpi1)
  47 {
  48   return Interval::left_less (fpi0.box_[Y_AXIS], fpi1.box_[Y_AXIS]);
  49 }
  50
  51 MAKE_SCHEME_CALLBACK (Fingering_column, calc_positioning_done, 1);
  52 SCM
  53 Fingering_column::calc_positioning_done (SCM smob)
  54 {
  55   Grob *me = unsmob_grob (smob);
  56   if (!me->is_live ())
  57     return SCM_BOOL_T;
  58
  59   map<Grob *, bool> shifted;
  60
  61   me->set_property ("positioning-done", SCM_BOOL_T);
  62
  63   extract_grob_set (me, "fingerings", const_fingerings);
  64
  65   if (const_fingerings.size () < 2)
  66     {
  67       me->programming_error ("This FingeringColumn should have never been created.");
  68       return SCM_BOOL_T;
  69     }
  70
  71   vector<Grob *> fingerings;
  72   for (vsize i = 0; i < const_fingerings.size (); i++)
  73     fingerings.push_back (const_fingerings[i]);
  74
  75
  76   Grob *common[2] = {common_refpoint_of_array (fingerings, me, X_AXIS),
  77                      common_refpoint_of_array (fingerings, me, Y_AXIS)};
  78
  79   Real padding = robust_scm2double (me->get_property ("padding"), 0.2);
  80   Box_quarantine bq (padding, Y_AXIS);
  81   vector<Fingering_position_info> origs;
  82   for (vsize i = 0; i < fingerings.size (); i++)
  83     {
  84       Interval x_ext = fingerings[i]->extent (common[X_AXIS], X_AXIS);
  85       // center on Y parent
  86       fingerings[i]->translate_axis (-fingerings[i]->extent (fingerings[i], Y_AXIS).length () / 2.0, Y_AXIS);
  87       Interval y_ext = fingerings[i]->extent (fingerings[i], Y_AXIS)
  88                        + fingerings[i]->get_parent (Y_AXIS)
  89                          ->relative_coordinate (common[Y_AXIS], Y_AXIS);
  90       origs.push_back(Fingering_position_info (Box (x_ext, y_ext), i));
  91     }
  92
  93   // order the fingerings from bottom to top
  94   vector_sort (origs, fingering_position_less);
  95
  96   for (vsize i = 0; i < origs.size (); i++)
  97     bq.add_box_to_quarantine (Box (origs[i].box_));
  98
  99   bq.solve ();
 100   vector<Box> news (bq.quarantined_boxes ());
 101
 102   for (vsize i = 0; i < origs.size (); i++)
 103     fingerings[origs[i].idx_]->translate_axis (news[i][Y_AXIS][DOWN] - origs[i].box_[Y_AXIS][DOWN], Y_AXIS);
 104
 105   return SCM_BOOL_T;
 106 }
 107
 108 void
 109 Fingering_column::add_fingering (Grob *fc, Grob *f)
 110 {
 111   Pointer_group_interface::add_grob (fc, ly_symbol2scm ("fingerings"), f);
 112   f->set_parent (fc, X_AXIS);
 113   f->set_property ("Y-offset", Grob::x_parent_positioning_proc);
 114 }
 115
 116 ADD_INTERFACE (Fingering_column,
 117                "Makes sure that fingerings placed laterally"
 118                " do not collide.",
 119
 120                /* properties */
 121                "padding "
 122                "positioning-done "
 123               );