lily/staff-symbol-referencer.cc

   1 /*
   2   staff-symbol-referencer.cc -- implement Staff_symbol_referencer
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "staff-symbol-referencer.hh"
  10
  11 #include "staff-symbol.hh"
  12 #include "grob.hh"
  13 #include "output-def.hh"
  14 #include "libc-extension.hh"
  15
  16 int
  17 Staff_symbol_referencer::line_count (Grob *me)
  18 {
  19   Grob *st = get_staff_symbol (me);
  20   return st ? Staff_symbol::line_count (st) : 0;
  21 }
  22
  23 bool
  24 Staff_symbol_referencer::on_line (Grob *me)
  25 {
  26   return on_line (me, (int) rint (get_position (me)));
  27 }
  28
  29 bool
  30 Staff_symbol_referencer::on_staff_line (Grob *me)
  31 {
  32   return on_staff_line (me, (int) rint (get_position (me)));
  33 }
  34
  35 bool
  36 Staff_symbol_referencer::on_line (Grob *me, int pos)
  37 {
  38   int sz = line_count (me) - 1;
  39   return ((pos + sz) % 2) == 0;
  40 }
  41
  42 bool
  43 Staff_symbol_referencer::on_staff_line (Grob *me, int pos)
  44 {
  45   return on_line (me, pos) && abs (pos) <= 2 * staff_radius (me);
  46 }
  47
  48 Grob *
  49 Staff_symbol_referencer::get_staff_symbol (Grob *me)
  50 {
  51   if (Staff_symbol::has_interface (me))
  52     return me;
  53
  54   SCM st = me->get_object ("staff-symbol");
  55   return unsmob_grob (st);
  56 }
  57
  58 Real
  59 Staff_symbol_referencer::staff_space (Grob *me)
  60 {
  61   Grob *st = get_staff_symbol (me);
  62   if (st)
  63     return Staff_symbol::staff_space (st);
  64   return 1.0;
  65 }
  66
  67 Real
  68 Staff_symbol_referencer::line_thickness (Grob *me)
  69 {
  70   Grob *st = get_staff_symbol (me);
  71   if (st)
  72     return Staff_symbol::get_line_thickness (st);
  73   return me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
  74 }
  75
  76 Real
  77 Staff_symbol_referencer::get_position (Grob *me)
  78 {
  79   Real p = 0.0;
  80   Grob *st = get_staff_symbol (me);
  81   Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
  82   if (st && c)
  83     {
  84       Real y = me->relative_coordinate (c, Y_AXIS)
  85         - st->relative_coordinate (c, Y_AXIS);
  86
  87       p += 2.0 * y / Staff_symbol::staff_space (st);
  88       return p;
  89     }
  90   else if (!st)
  91     return me->relative_coordinate (me->get_parent (Y_AXIS), Y_AXIS) * 2;
  92   return robust_scm2double (me->get_property ("staff-position"), p);
  93 }
  94
  95
  96 Interval
  97 Staff_symbol_referencer::extent_in_staff (Grob *me)
  98 {
  99   Grob *st = get_staff_symbol (me);
 100   Grob *c = st ? me->common_refpoint (st, Y_AXIS) : 0;
 101
 102   Interval retval;
 103   if (st && c)
 104     {
 105       retval  = me->extent (c, Y_AXIS)
 106         - st->relative_coordinate (c, Y_AXIS);
 107     }
 108
 109   return retval;
 110 }
 111
 112
 113
 114 int
 115 Staff_symbol_referencer::get_rounded_position (Grob *me)
 116 {
 117   return int (rint (get_position (me)));
 118 }
 119
 120 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer, callback, 1);
 121 SCM
 122 Staff_symbol_referencer::callback (SCM smob)
 123 {
 124   Grob *me = unsmob_grob (smob);
 125
 126   SCM pos = me->get_property ("staff-position");
 127   Real off = 0.0;
 128   if (scm_is_number (pos))
 129     {
 130       Real space = Staff_symbol_referencer::staff_space (me);
 131       off = scm_to_double (pos) * space / 2.0;
 132     }
 133
 134   return scm_from_double (off);
 135 }
 136
 137 /*  This sets the position relative to the center of the staff symbol.
 138
 139 The function is hairy, because it can be called in two situations:
 140
 141 1. There is no staff yet; we must set staff-position
 142
 143 2. There is a staff, and perhaps someone even applied a
 144 translate_axis (). Then we must compensate for the translation
 145
 146 In either case, we set a callback to be sure that our new position
 147 will be extracted from staff-position */
 148
 149 void
 150 Staff_symbol_referencer::set_position (Grob *me, Real p)
 151 {
 152   Grob *st = get_staff_symbol (me);
 153   Real oldpos = 0.0;
 154   if (st && me->common_refpoint (st, Y_AXIS))
 155     {
 156       oldpos = get_position (me);
 157     }
 158
 159
 160   Real ss = Staff_symbol_referencer::staff_space (me);
 161   me->translate_axis ((p  - oldpos) * ss * 0.5, Y_AXIS);
 162 }
 163
 164 /* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
 165 Real
 166 Staff_symbol_referencer::staff_radius (Grob *me)
 167 {
 168   return (line_count (me) - 1) / 2.0;
 169 }
 170
 171 int
 172 compare_position (Grob *const &a, Grob *const &b)
 173 {
 174   return sign (Staff_symbol_referencer::get_position ((Grob *)a)
 175                - Staff_symbol_referencer::get_position ((Grob *) b));
 176 }
 177
 178 bool
 179 position_less (Grob *const &a, Grob *const &b)
 180 {
 181   return Staff_symbol_referencer::get_position (a)
 182     < Staff_symbol_referencer::get_position (b);
 183 }
 184
 185 ADD_INTERFACE (Staff_symbol_referencer,
 186                "An object whose Y@tie{}position is meant relative to a staff"
 187                " symbol.  These usually"
 188                " have @code{Staff_symbol_referencer::callback} in their"
 189                " @code{Y-offset-callbacks}.",
 190
 191                /* properties */
 192                "staff-position "
 193                );