lily/separation-item.cc

   1 /*
   2   separation-item.cc -- implement Separation_item
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "separation-item.hh"
  10
  11 #include "axis-group-interface.hh"
  12 #include "lookup.hh"
  13 #include "stencil.hh"
  14 #include "skyline.hh"
  15 #include "paper-column.hh"
  16 #include "warn.hh"
  17 #include "pointer-group-interface.hh"
  18 #include "accidental-placement.hh"
  19
  20 void
  21 Separation_item::add_item (Grob *s, Item *i)
  22 {
  23   assert (i);
  24   Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"), i);
  25 }
  26
  27 void
  28 Separation_item::add_conditional_item (Grob *me, Grob *e)
  29 {
  30   Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
  31 }
  32
  33 void
  34 Separation_item::set_distance (Drul_array<Item *> items,
  35                                        Real padding)
  36 {
  37   Drul_array<Skyline_pair*> lines (Skyline_pair::unsmob (items[LEFT]->get_property ("horizontal-skylines")),
  38                                    Skyline_pair::unsmob (items[RIGHT]->get_property ("horizontal-skylines")));
  39   Skyline right = conditional_skyline (items[RIGHT], items[LEFT]);
  40   right.merge ((*lines[RIGHT])[LEFT]);
  41
  42   Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
  43   if (dist > 0)
  44     {
  45       Rod rod;
  46
  47       rod.item_drul_ = items;
  48
  49       rod.distance_ = dist;
  50       rod.add_to_cols ();
  51     }
  52 }
  53
  54 bool
  55 Separation_item::is_empty (Grob *me)
  56 {
  57   Skyline_pair *sky = Skyline_pair::unsmob (me->get_property ("horizontal-skylines"));
  58   return (!sky || sky->is_empty ());
  59 }
  60
  61 /*
  62   Return the width of ME given that we are considering the object on
  63   the LEFT.
  64 */
  65 Skyline
  66 Separation_item::conditional_skyline (Grob *me, Grob *left)
  67 {
  68   vector<Box> bs = boxes (me, left);
  69   return Skyline (bs, 0.1, Y_AXIS, LEFT);
  70 }
  71
  72
  73 MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines,1);
  74 SCM
  75 Separation_item::calc_skylines (SCM smob)
  76 {
  77   Item *me = unsmob_item (smob);
  78   vector<Box> bs = boxes (me, 0);
  79   /* todo: the horizon_padding is somewhat arbitrary */
  80   return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
  81 }
  82
  83 /* if left is non-NULL, get the boxes corresponding to the
  84    conditional-elements (conditioned on the grob LEFT). This
  85    sounds more general than it is: conditional-elements are
  86    always accidentals attached to a tied note.
  87 */
  88 vector<Box>
  89 Separation_item::boxes (Grob *me, Grob *left)
  90 {
  91   Item *item = dynamic_cast<Item *> (me);
  92
  93   int very_large = INT_MAX;
  94   Paper_column *pc = item->get_column ();
  95   vector<Box> out;
  96   extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts);
  97   vector<Grob*> elts;
  98
  99   if (left)
 100     elts = Accidental_placement::get_relevant_accidentals (read_only_elts, left);
 101   else
 102     elts = read_only_elts;
 103
 104   Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
 105
 106   for (vsize i = 0; i < elts.size (); i++)
 107     {
 108       Item *il = dynamic_cast<Item *> (elts[i]);
 109       if (pc != il->get_column ())
 110         continue;
 111       if (Axis_group_interface::has_interface (il))
 112         continue;
 113
 114       Interval y (il->pure_height (ycommon, 0, very_large));
 115       Interval x (il->extent (pc, X_AXIS));
 116
 117       Interval extra = robust_scm2interval (elts[i]->get_property ("extra-spacing-width"),
 118                                             Interval (-0.1, 0.1));
 119       x[LEFT] += extra[LEFT];
 120       x[RIGHT] += extra[RIGHT];
 121       if (to_boolean (elts[i]->get_property ("infinite-spacing-height")))
 122         y = Interval (-infinity_f, infinity_f);
 123
 124       if (!x.is_empty () && !y.is_empty ())
 125       out.push_back (Box (x, y));
 126     }
 127
 128   return out;
 129 }
 130
 131 extern bool debug_skylines;
 132 MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
 133 SCM
 134 Separation_item::print (SCM smob)
 135 {
 136   if (!debug_skylines)
 137     return SCM_BOOL_F;
 138
 139   Grob *me = unsmob_grob (smob);
 140   Stencil ret;
 141   if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")))
 142     {
 143       ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[LEFT].to_points (Y_AXIS)).in_color (255, 255, 0));
 144       ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[RIGHT].to_points (Y_AXIS)).in_color (0, 255, 255));
 145     }
 146   return ret.smobbed_copy ();
 147 }
 148
 149 ADD_INTERFACE (Separation_item,
 150                "Item that computes widths to generate spacing rods. "
 151                ,
 152
 153                "X-extent "
 154                "conditional-elements "
 155                "elements "
 156                "padding "
 157                "horizontal-skylines "
 158                );