lily/staff-side.cc

   1 /*
   2   staff-side.cc --  implement Staff_side_element
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "staff-side.hh"
  11 #include "staff-symbol.hh"
  12 #include "debug.hh"
  13 #include "warn.hh"
  14 #include "dimensions.hh"
  15 #include "dimension-cache.hh"
  16
  17 Side_position_interface::Side_position_interface (Score_element *e)
  18 {
  19   elt_l_ = e;
  20 }
  21
  22
  23 void
  24 Side_position_interface::add_support (Score_element*e)
  25 {
  26   SCM sup = elt_l_->get_elt_property ("side-support");
  27   elt_l_->set_elt_property ("side-support",
  28                             gh_cons (e->self_scm_,sup));
  29 }
  30
  31
  32
  33 Direction
  34 Side_position_interface::get_direction () const
  35 {
  36   SCM d = elt_l_->get_elt_property ("direction");
  37   if (isdir_b (d))
  38     return to_dir (d) ? to_dir (d) : DOWN;
  39
  40   Direction relative_dir = UP;
  41   SCM reldir = elt_l_->get_elt_property ("side-relative-direction");    // should use a lambda.
  42   if (isdir_b (reldir))
  43     {
  44       relative_dir = to_dir (reldir);
  45     }
  46
  47   SCM other_elt = elt_l_->get_elt_property ("direction-source");
  48   if (SMOB_IS_TYPE_B (Score_element, other_elt))
  49     {
  50       Score_element * e = SMOB_TO_TYPE(Score_element,other_elt);
  51
  52       return relative_dir * Side_position_interface (e).get_direction ();
  53     }
  54
  55   return DOWN;
  56 }
  57
  58 /**
  59    Callback that does the aligning.
  60  */
  61 Real
  62 Side_position_interface::side_position (Dimension_cache const * c)
  63 {
  64   Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
  65
  66   Interval dim;
  67   Axis  axis = c->axis ();
  68   Score_element *common = me->parent_l (axis);
  69   SCM support = me->get_elt_property ("side-support");
  70   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  71     {
  72       if (!SMOB_IS_TYPE_B (Score_element, gh_car (s)))
  73         continue;
  74
  75       Score_element * e  = SMOB_TO_TYPE(Score_element, gh_car (s));
  76       common = common->common_refpoint (e, axis);
  77     }
  78
  79   for (SCM s = support; s != SCM_EOL; s = gh_cdr (s))
  80     {
  81       if (!SMOB_IS_TYPE_B (Score_element, gh_car (s)))
  82         continue;
  83
  84       Score_element * e  = SMOB_TO_TYPE(Score_element, gh_car (s));
  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 (pad != SCM_UNDEFINED)
 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 Real
 115 Side_position_interface::self_alignment (Dimension_cache const *c)
 116 {
 117   String s ("self-alignment-");
 118   Axis ax = c->axis ();
 119   s +=  (ax == X_AXIS) ? "X" : "Y";
 120   Score_element *elm = dynamic_cast<Score_element*> (c->element_l ());
 121   SCM align (elm->get_elt_property (s));
 122   if (isdir_b (align))
 123     {
 124       Direction d = to_dir (align);
 125       Interval ext(elm->extent (ax));
 126       if (d)
 127         {
 128           return - ext[d];
 129         }
 130       return - ext.center ();
 131     }
 132   else
 133     return 0.0;
 134 }
 135
 136
 137 Real
 138 directed_round (Real f, Direction d )
 139 {
 140   if (d < 0)
 141     return floor (f);
 142   else
 143     return ceil (f);
 144 }
 145
 146 Real
 147 Side_position_interface::quantised_position (Dimension_cache const *c)
 148 {
 149   Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
 150   Side_position_interface s(me);
 151   Direction d = s.get_direction ();
 152
 153   Staff_symbol_referencer *ref = dynamic_cast<Staff_symbol_referencer*> (me);
 154   if (ref)
 155     {
 156       Real p = ref->position_f ();
 157       Real rp = directed_round (d, p);
 158
 159       int ip = int  (p);
 160       if (!(ip % 2))
 161         {
 162           ip += d;
 163           rp += d;
 164         }
 165
 166       return (rp - p) * ref->staff_line_leading_f ();
 167     }
 168   return 0.0;
 169 }
 170
 171 Real
 172 Side_position_interface::aligned_side (Dimension_cache const *c)
 173 {
 174   Score_element * me = dynamic_cast<Score_element*> (c->element_l ());
 175   Side_position_interface s(me);
 176   Direction d = s.get_direction ();
 177   Axis ax = c->axis ();
 178   Real o = side_position (c);
 179
 180   Interval iv =  me->extent (ax);
 181
 182   if (!iv.empty_b ())
 183     {
 184       o += - iv[-d];
 185
 186       SCM pad = me->get_elt_property ("padding");
 187       if (gh_number_p (pad))
 188         o += d *gh_scm2double (pad) ;
 189     }
 190   return o;
 191 }
 192
 193
 194
 195
 196 void
 197 Side_position_interface::set_axis (Axis a)
 198 {
 199   // prop transparent ?
 200   if (elt_l_->get_elt_property ("side-support") == SCM_UNDEFINED)
 201     elt_l_->set_elt_property ("side-support" ,SCM_EOL);
 202
 203   elt_l_->dim_cache_[a]->off_callbacks_.push (aligned_side);
 204 }
 205
 206
 207 void
 208 Side_position_interface::set_quantised (Axis a)
 209 {
 210   Dimension_cache * c = elt_l_->dim_cache_[a];
 211   for (int i=0; i <  c->off_callbacks_.size (); i++)
 212     if (c->off_callbacks_[i] == aligned_side)
 213       c->off_callbacks_[i] = side_position ;
 214   c->off_callbacks_.push (quantised_position);
 215 }
 216
 217 Axis
 218 Side_position_interface::get_axis () const
 219 {
 220   Dimension_cache * c =  elt_l_->dim_cache_[X_AXIS];
 221   for (int i=0 ; i < c->off_callbacks_.size();i ++)
 222     if (c->off_callbacks_[i] == side_position
 223         ||c->off_callbacks_[i] == aligned_side)
 224       return X_AXIS;
 225
 226
 227   return Y_AXIS;
 228 }
 229
 230 void
 231 Side_position_interface::set_direction (Direction d)
 232 {
 233   elt_l_->set_elt_property ("direction", gh_int2scm (d));
 234 }
 235
 236 bool
 237 Side_position_interface::is_staff_side_b () const
 238 {
 239   return elt_l_->get_elt_property ("side-support") != SCM_UNDEFINED;
 240 }
 241
 242 bool
 243 Side_position_interface::supported_b () const
 244 {
 245   SCM s =elt_l_->get_elt_property  ("side-support");
 246   return s != SCM_UNDEFINED && s != SCM_EOL;
 247 }