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   Direction dir = Side_position_interface (me).get_direction ();
  97
  98   Real off =  me->parent_l (axis)->relative_coordinate (common, axis);
  99   SCM minimum = me->remove_elt_property ("minimum-space");
 100
 101   Real total_off = dim[dir] + off;
 102   SCM padding = me->remove_elt_property ("padding");
 103   if (gh_number_p (padding))
 104     {
 105       total_off += gh_scm2double (padding) * dir;
 106     }
 107   if (gh_number_p (minimum) && total_off * dir < gh_scm2double (minimum))
 108     {
 109       total_off = gh_scm2double (minimum) * dir;
 110     }
 111   if (fabs (total_off) > 100 CM)
 112     programming_error ("Huh ? Improbable staff side dim.");
 113
 114   return total_off;
 115 }
 116
 117 /**
 118   callback that centers the element on itself
 119  */
 120 Real
 121 Side_position_interface::aligned_on_self (Dimension_cache const *c)
 122 {
 123   String s ("self-alignment-");
 124   Axis ax = c->axis ();
 125   s +=  (ax == X_AXIS) ? "X" : "Y";
 126   Score_element *elm = c->element_l ();
 127   SCM align (elm->get_elt_property (s));
 128   if (isdir_b (align))
 129     {
 130       Direction d = to_dir (align);
 131       Interval ext(elm->extent (ax));
 132
 133       if (ext.empty_b ())
 134         {
 135           programming_error ("I'm empty. Can't align on self");
 136           return 0.0;
 137         }
 138       else if (d)
 139         {
 140           return - ext[d];
 141         }
 142       return - ext.center ();
 143     }
 144   else
 145     return 0.0;
 146 }
 147
 148
 149
 150 Real
 151 directed_round (Real f, Direction d)
 152 {
 153   if (d < 0)
 154     return floor (f);
 155   else
 156     return ceil (f);
 157 }
 158
 159 /*
 160   Callback that quantises in staff-spaces, rounding in the direction
 161   of the elements "direction" elt property. */
 162 Real
 163 Side_position_interface::quantised_position (Dimension_cache const *c)
 164 {
 165   Score_element * me =  (c->element_l ());
 166   Side_position_interface s(me);
 167   Direction d = s.get_direction ();
 168   Staff_symbol_referencer_interface si (me);
 169
 170   if (si.has_interface_b ())
 171     {
 172       Real p = si.position_f ();
 173       Real rp = directed_round (p, d);
 174
 175       int ip = int  (rp);
 176       if ((ip % 2) == 0)
 177         {
 178           ip += d;
 179           rp += d;
 180         }
 181
 182       return (rp - p) * si.staff_space () / 2.0;
 183     }
 184   return 0.0;
 185 }
 186
 187 /*
 188   Position next to support, taking into account my own dimensions and padding.
 189  */
 190 Real
 191 Side_position_interface::aligned_side (Dimension_cache const *c)
 192 {
 193   Score_element * me =  (c->element_l ());
 194   Side_position_interface s(me);
 195   Direction d = s.get_direction ();
 196   Axis ax = c->axis ();
 197   Real o = side_position (c);
 198
 199   Interval iv =  me->extent (ax);
 200
 201   if (!iv.empty_b ())
 202     {
 203       o += - iv[-d];
 204
 205       SCM pad = me->get_elt_property ("padding");
 206       if (gh_number_p (pad))
 207         o += d *gh_scm2double (pad) ;
 208     }
 209   return o;
 210 }
 211
 212 /*
 213   Position centered on parent.
 214  */
 215 Real
 216 Side_position_interface::centered_on_parent (Dimension_cache const *c)
 217 {
 218
 219   Score_element *me = c->element_l ();
 220   Axis a = c->axis ();
 221   Score_element *him = me->parent_l (a);
 222
 223   return him->extent (a).center ();
 224 }
 225
 226
 227 void
 228 Side_position_interface::add_staff_support ()
 229 {
 230   Staff_symbol_referencer_interface si (elt_l_);
 231   if (si.staff_symbol_l ())
 232     {
 233       add_support (si.staff_symbol_l ());
 234     }
 235 }
 236
 237 void
 238 Side_position_interface::set_axis (Axis a)
 239 {
 240   // prop transparent ?
 241   if (elt_l_->get_elt_property ("side-support") == SCM_UNDEFINED)
 242     elt_l_->set_elt_property ("side-support" ,SCM_EOL);
 243
 244   if (!elt_l_->has_offset_callback_b (aligned_side, a))
 245     elt_l_->add_offset_callback (aligned_side, a);
 246 }
 247
 248
 249 void
 250 Side_position_interface::set_quantised (Axis a)
 251 {
 252   elt_l_->add_offset_callback (quantised_position, a);
 253 }
 254
 255 Axis
 256 Side_position_interface::get_axis () const
 257 {
 258   if (elt_l_->has_offset_callback_b (&side_position, X_AXIS)
 259       || elt_l_->has_offset_callback_b (&aligned_side , X_AXIS))
 260     return X_AXIS;
 261
 262
 263   return Y_AXIS;
 264 }
 265
 266 void
 267 Side_position_interface::set_direction (Direction d)
 268 {
 269   elt_l_->set_elt_property ("direction", gh_int2scm (d));
 270 }
 271
 272 void
 273 Side_position_interface::set_minimum_space (Real m)
 274 {
 275   elt_l_->set_elt_property ("minimum-space", gh_double2scm (m));
 276 }
 277
 278 void
 279 Side_position_interface::set_padding (Real p)
 280 {
 281   elt_l_->set_elt_property ("padding", gh_double2scm (p));
 282 }
 283
 284 bool
 285 Side_position_interface::has_interface_b () const
 286 {
 287   return elt_l_->get_elt_property ("side-support") != SCM_UNDEFINED;
 288 }
 289
 290 bool
 291 Side_position_interface::supported_b () const
 292 {
 293   SCM s =elt_l_->get_elt_property  ("side-support");
 294   return s != SCM_UNDEFINED && s != SCM_EOL;
 295 }
 296
 297
 298 Side_position_interface
 299 side_position (Score_element* e)
 300 {
 301   Side_position_interface si (e);
 302   return si;
 303 }