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 "debug.hh"
  13 #include "warn.hh"
  14 #include "dimensions.hh"
  15
  16 #include "staff-symbol-referencer.hh"
  17 #include "group-interface.hh"
  18
  19 void
  20 Side_position::add_support (Score_element*me, Score_element*e)
  21 {
  22   Pointer_group_interface (me, "side-support-elements").add_element (e);
  23 }
  24
  25
  26
  27 Direction
  28 Side_position::get_direction (Score_element*me)
  29 {
  30   SCM d = me->get_elt_property ("direction");
  31   if (isdir_b (d))
  32     return to_dir (d) ? to_dir (d) : DOWN;
  33
  34   Direction relative_dir = UP;
  35   SCM reldir = me->get_elt_property ("side-relative-direction");        // should use a lambda.
  36   if (isdir_b (reldir))
  37     {
  38       relative_dir = to_dir (reldir);
  39     }
  40
  41   SCM other_elt = me->get_elt_property ("direction-source");
  42   Score_element * e = unsmob_element(other_elt);
  43   if (e)
  44     {
  45       return (Direction)(relative_dir * Side_position::get_direction (e));
  46     }
  47
  48   return DOWN;
  49 }
  50
  51 /*
  52    Callback that does the aligning. Puts the element next to the support
  53  */
  54
  55 Real
  56 Side_position::side_position (Score_element *cme, Axis axis)
  57 {
  58   Score_element* me = (Score_element*)cme;
  59   Score_element *common = me->parent_l (axis);
  60   SCM support = me->get_elt_property ("side-support-elements");
  61   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  62     {
  63       Score_element * e  = unsmob_element (gh_car (s));
  64       if (e)
  65         common = common->common_refpoint (e, axis);
  66     }
  67
  68   Interval dim;
  69   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  70     {
  71
  72       Score_element * e  = unsmob_element ( gh_car (s));
  73       if (e)
  74         {
  75           Real coord = e->relative_coordinate (common, axis);
  76
  77           dim.unite (coord + e->extent (axis));
  78         }
  79     }
  80
  81   if (dim.empty_b ())
  82     {
  83       dim = Interval(0,0);
  84     }
  85
  86   Direction dir = Side_position::get_direction (me);
  87
  88   Real off =  me->parent_l (axis)->relative_coordinate (common, axis);
  89   SCM minimum = me->remove_elt_property ("minimum-space");
  90
  91   Real total_off = dim[dir] + off;
  92   SCM padding = me->remove_elt_property ("padding");
  93   if (gh_number_p (padding))
  94     {
  95       total_off += gh_scm2double (padding) * dir;
  96     }
  97   if (gh_number_p (minimum) && total_off * dir < gh_scm2double (minimum))
  98     {
  99       total_off = gh_scm2double (minimum) * dir;
 100     }
 101   if (fabs (total_off) > 100 CM)
 102     programming_error ("Huh ? Improbable staff side dim.");
 103
 104   return total_off;
 105 }
 106
 107 /**
 108   callback that centers the element on itself
 109  */
 110 Real
 111 Side_position::aligned_on_self (Score_element *elm, Axis ax)
 112 {
 113   String s ("self-alignment-");
 114
 115   s +=  (ax == X_AXIS) ? "X" : "Y";
 116
 117   SCM align (elm->get_elt_property (s.ch_C()));
 118   if (isdir_b (align))
 119     {
 120       Direction d = to_dir (align);
 121       Interval ext(elm->extent (ax));
 122
 123       if (ext.empty_b ())
 124         {
 125           programming_error ("I'm empty. Can't align on self");
 126           return 0.0;
 127         }
 128       else if (d)
 129         {
 130           return - ext[d];
 131         }
 132       return - ext.center ();
 133     }
 134   else
 135     return 0.0;
 136 }
 137
 138
 139
 140 Real
 141 directed_round (Real f, Direction d)
 142 {
 143   if (d < 0)
 144     return floor (f);
 145   else
 146     return ceil (f);
 147 }
 148
 149 /*
 150   Callback that quantises in staff-spaces, rounding in the direction
 151   of the elements "direction" elt property.
 152
 153   Only rounds when we're inside the staff, as determined by
 154   Staff_symbol_referencer::staff_radius() */
 155 Real
 156 Side_position::quantised_position (Score_element *me, Axis )
 157 {
 158   Direction d = Side_position::get_direction (me);
 159
 160   if (Staff_symbol_referencer::has_interface (me))
 161     {
 162       Real p = Staff_symbol_referencer::position_f (me);
 163       Real rp = directed_round (p, d);
 164       Real rad = Staff_symbol_referencer::staff_radius (me) *2 ;
 165       int ip = int  (rp);
 166
 167       if (abs (ip) < rad && (ip % 2) == 0)
 168         {
 169           ip += d;
 170           rp += d;
 171         }
 172
 173       return (rp - p) * Staff_symbol_referencer::staff_space (me) / 2.0;
 174     }
 175   return 0.0;
 176 }
 177
 178 /*
 179   Position next to support, taking into account my own dimensions and padding.
 180  */
 181 Real
 182 Side_position::aligned_side (Score_element *me, Axis ax)
 183 {
 184
 185   Direction d = Side_position ::get_direction (me);
 186   Real o = side_position (me,ax);
 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::centered_on_parent (Score_element * me, Axis a)
 206 {
 207   Score_element *him = me->parent_l (a);
 208
 209   return him->extent (a).center ();
 210 }
 211
 212
 213 void
 214 Side_position::add_staff_support (Score_element*me)
 215 {
 216   Score_element* st = Staff_symbol_referencer::staff_symbol_l (me);
 217   if (st)
 218     {
 219       add_support (me,st);
 220     }
 221 }
 222
 223 void
 224 Side_position::set_axis (Score_element*me, Axis a)
 225 {
 226   if (!me->has_offset_callback_b (aligned_side, a))
 227     me->add_offset_callback (aligned_side, a);
 228 }
 229
 230
 231
 232
 233 Axis
 234 Side_position::get_axis (Score_element*me)
 235 {
 236   if (me->has_offset_callback_b (&side_position, X_AXIS)
 237       || me->has_offset_callback_b (&aligned_side , X_AXIS))
 238     return X_AXIS;
 239
 240
 241   return Y_AXIS;
 242 }
 243
 244 void
 245 Side_position::set_direction (Score_element*me, Direction d)
 246 {
 247   me->set_elt_property ("direction", gh_int2scm (d));
 248 }
 249
 250 void
 251 Side_position::set_minimum_space (Score_element*me, Real m)
 252 {
 253   me->set_elt_property ("minimum-space", gh_double2scm (m));
 254 }
 255
 256 void
 257 Side_position::set_padding (Score_element*me, Real p)
 258 {
 259   me->set_elt_property ("padding", gh_double2scm (p));
 260 }
 261
 262 bool
 263 Side_position::has_interface (Score_element*me)
 264 {
 265   return me->has_interface (ly_symbol2scm ("side-position-interface"));
 266 }
 267
 268 bool
 269 Side_position::supported_b (Score_element*me)
 270 {
 271   SCM s = me->get_elt_property  ("side-support-elements");
 272   return gh_pair_p(s);
 273 }
 274
 275