lily/side-position-interface.cc

   1 /*
   2   staff-side.cc --  implement Staff_side_element
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9 #include <math.h>               // ceil.
  10
  11 #include "side-position-interface.hh"
  12 #include "staff-symbol.hh"
  13 #include "debug.hh"
  14 #include "warn.hh"
  15 #include "dimensions.hh"
  16 #include "dimension-cache.hh"
  17 #include "staff-symbol-referencer.hh"
  18
  19 Side_position_interface::Side_position_interface (Score_element const *e)
  20 {
  21   elt_l_ = (Score_element*)e;
  22 }
  23
  24
  25 void
  26 Side_position_interface::add_support (Score_element*e)
  27 {
  28   SCM sup = elt_l_->get_elt_property ("side-support");
  29   elt_l_->set_elt_property ("side-support",
  30                             gh_cons (e->self_scm_,sup));
  31 }
  32
  33
  34
  35 Direction
  36 Side_position_interface::get_direction () const
  37 {
  38   SCM d = elt_l_->get_elt_property ("direction");
  39   if (isdir_b (d))
  40     return to_dir (d) ? to_dir (d) : DOWN;
  41
  42   Direction relative_dir = UP;
  43   SCM reldir = elt_l_->get_elt_property ("side-relative-direction");    // should use a lambda.
  44   if (isdir_b (reldir))
  45     {
  46       relative_dir = to_dir (reldir);
  47     }
  48
  49   SCM other_elt = elt_l_->get_elt_property ("direction-source");
  50   Score_element * e = unsmob_element(other_elt);
  51   if (e)
  52     {
  53       return (Direction)(relative_dir * Side_position_interface (e).get_direction ());
  54     }
  55
  56   return DOWN;
  57 }
  58
  59 /*
  60    Callback that does the aligning. Puts the element next to the support
  61  */
  62
  63 Real
  64 Side_position_interface::side_position (Dimension_cache const * c)
  65 {
  66   Score_element * me =  (c->element_l ());
  67
  68   Interval dim;
  69   Axis  axis = c->axis ();
  70   Score_element *common = me->parent_l (axis);
  71   SCM support = me->get_elt_property ("side-support");
  72   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  73     {
  74       Score_element * e  = unsmob_element ( gh_car (s));
  75       if (e)
  76         common = common->common_refpoint (e, axis);
  77     }
  78
  79   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  80     {
  81
  82       Score_element * e  = unsmob_element ( gh_car (s));
  83       if (e)
  84         {
  85           Real coord = e->relative_coordinate (common, axis);
  86
  87           dim.unite (coord + e->extent (axis));
  88         }
  89     }
  90
  91   if (dim.empty_b ())
  92     {
  93       dim = Interval(0,0);
  94     }
  95
  96   Real off =  me->parent_l (axis)->relative_coordinate (common, axis);
  97
  98
  99   Direction dir = Side_position_interface (me).get_direction ();
 100
 101   SCM pad = me->remove_elt_property ("padding");
 102   if (gh_number_p (pad))
 103     {
 104       off += gh_scm2double (pad) * dir;
 105     }
 106   Real total_off = dim[dir] + off;
 107
 108   if (fabs (total_off) > 100 CM)
 109     programming_error ("Huh ? Improbable staff side dim.");
 110
 111   return total_off;
 112 }
 113
 114 /**
 115   callback that centers the element on itself
 116  */
 117 Real
 118 Side_position_interface::aligned_on_self (Dimension_cache const *c)
 119 {
 120   String s ("self-alignment-");
 121   Axis ax = c->axis ();
 122   s +=  (ax == X_AXIS) ? "X" : "Y";
 123   Score_element *elm = c->element_l ();
 124   SCM align (elm->get_elt_property (s));
 125   if (isdir_b (align))
 126     {
 127       Direction d = to_dir (align);
 128       Interval ext(elm->extent (ax));
 129       if (d)
 130         {
 131           return - ext[d];
 132         }
 133       return - ext.center ();
 134     }
 135   else
 136     return 0.0;
 137 }
 138
 139 Real
 140 directed_round (Real f, Direction d)
 141 {
 142   if (d < 0)
 143     return floor (f);
 144   else
 145     return ceil (f);
 146 }
 147
 148 /*
 149   Callback that quantises in staff-spaces, rounding in the direction
 150   of the elements "direction" elt property. */
 151 Real
 152 Side_position_interface::quantised_position (Dimension_cache const *c)
 153 {
 154   Score_element * me =  (c->element_l ());
 155   Side_position_interface s(me);
 156   Direction d = s.get_direction ();
 157   Staff_symbol_referencer_interface si (me);
 158
 159   if (si.has_interface_b ())
 160     {
 161       Real p = si.position_f ();
 162       Real rp = directed_round (p, d);
 163
 164       int ip = int  (rp);
 165       if ((ip % 2) == 0)
 166         {
 167           ip += d;
 168           rp += d;
 169         }
 170
 171       return (rp - p) * si.staff_space () / 2.0;
 172     }
 173   return 0.0;
 174 }
 175
 176 /*
 177   Position next to support, taking into account my own dimensions and padding.
 178  */
 179 Real
 180 Side_position_interface::aligned_side (Dimension_cache const *c)
 181 {
 182   Score_element * me =  (c->element_l ());
 183   Side_position_interface s(me);
 184   Direction d = s.get_direction ();
 185   Axis ax = c->axis ();
 186   Real o = side_position (c);
 187
 188   Interval iv =  me->extent (ax);
 189
 190   if (!iv.empty_b ())
 191     {
 192       o += - iv[-d];
 193
 194       SCM pad = me->get_elt_property ("padding");
 195       if (gh_number_p (pad))
 196         o += d *gh_scm2double (pad) ;
 197     }
 198   return o;
 199 }
 200
 201 /*
 202   Position centered on parent.
 203  */
 204 Real
 205 Side_position_interface::centered_on_parent (Dimension_cache const *c)
 206 {
 207
 208   Score_element *me = c->element_l ();
 209   Axis a = c->axis ();
 210   Score_element *him = me->parent_l (a);
 211
 212   return him->extent (a).center ();
 213 }
 214
 215
 216 void
 217 Side_position_interface::add_staff_support ()
 218 {
 219   Staff_symbol_referencer_interface si (elt_l_);
 220   if (si.staff_symbol_l ())
 221     {
 222       add_support (si.staff_symbol_l ());
 223     }
 224 }
 225
 226 void
 227 Side_position_interface::set_axis (Axis a)
 228 {
 229   // prop transparent ?
 230   if (elt_l_->get_elt_property ("side-support") == SCM_UNDEFINED)
 231     elt_l_->set_elt_property ("side-support" ,SCM_EOL);
 232
 233   elt_l_->add_offset_callback (aligned_side, a);
 234 }
 235
 236
 237 void
 238 Side_position_interface::set_quantised (Axis a)
 239 {
 240   elt_l_->add_offset_callback (quantised_position, a);
 241 }
 242
 243 Axis
 244 Side_position_interface::get_axis () const
 245 {
 246   if (elt_l_->has_offset_callback_b (&side_position, X_AXIS)
 247       || elt_l_->has_offset_callback_b (&aligned_side , X_AXIS))
 248     return X_AXIS;
 249
 250
 251   return Y_AXIS;
 252 }
 253
 254 void
 255 Side_position_interface::set_direction (Direction d)
 256 {
 257   elt_l_->set_elt_property ("direction", gh_int2scm (d));
 258 }
 259
 260 bool
 261 Side_position_interface::has_interface_b () const
 262 {
 263   return elt_l_->get_elt_property ("side-support") != SCM_UNDEFINED;
 264 }
 265
 266 bool
 267 Side_position_interface::supported_b () const
 268 {
 269   SCM s =elt_l_->get_elt_property  ("side-support");
 270   return s != SCM_UNDEFINED && s != SCM_EOL;
 271 }
 272
 273
 274 Side_position_interface
 275 side_position (Score_element* e)
 276 {
 277   Side_position_interface si (e);
 278   return si;
 279 }