lily/self-alignment-interface.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "self-alignment-interface.hh"
  21
  22 #include "directional-element-interface.hh"
  23 #include "grob.hh"
  24 #include "grob-array.hh"
  25 #include "interval-minefield.hh"
  26 #include "note-column.hh"
  27 #include "paper-column.hh"
  28 #include "pointer-group-interface.hh"
  29 #include "warn.hh"
  30
  31 MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
  32 SCM
  33 Self_alignment_interface::y_aligned_on_self (SCM element)
  34 {
  35   return aligned_on_self (unsmob_grob (element), Y_AXIS, false, 0, 0);
  36 }
  37
  38 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_aligned_on_self, 1);
  39 SCM
  40 Self_alignment_interface::x_aligned_on_self (SCM element)
  41 {
  42   return aligned_on_self (unsmob_grob (element), X_AXIS, false, 0, 0);
  43 }
  44
  45 MAKE_SCHEME_CALLBACK (Self_alignment_interface, pure_y_aligned_on_self, 3);
  46 SCM
  47 Self_alignment_interface::pure_y_aligned_on_self (SCM smob, SCM start, SCM end)
  48 {
  49   return aligned_on_self (unsmob_grob (smob), Y_AXIS, true, robust_scm2int (start, 0), robust_scm2int (end, INT_MAX));
  50 }
  51
  52 SCM
  53 Self_alignment_interface::aligned_on_self (Grob *me, Axis a, bool pure, int start, int end)
  54 {
  55   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
  56             : ly_symbol2scm ("self-alignment-Y");
  57
  58   SCM align (me->internal_get_property (sym));
  59   if (scm_is_number (align))
  60     {
  61       Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
  62       if (ext.is_empty ())
  63         programming_error ("cannot align on self: empty element");
  64       else
  65         return scm_from_double (- ext.linear_combination (scm_to_double (align)));
  66     }
  67   return scm_from_double (0.0);
  68 }
  69
  70 SCM
  71 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
  72 {
  73   return scm_from_double (robust_relative_extent (him, him, a).center ());
  74 }
  75
  76 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
  77 SCM
  78 Self_alignment_interface::centered_on_x_parent (SCM smob)
  79 {
  80   return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
  81 }
  82
  83 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_note_columns, 1);
  84 SCM
  85 Self_alignment_interface::centered_on_note_columns (SCM smob)
  86 {
  87   Item *it = unsmob_item (smob)->get_column ();
  88   if (!it)
  89     return scm_from_double (0.0);
  90
  91   extract_grob_set (it, "elements", elts);
  92   vector<Grob *> ncs;
  93   Interval centers;
  94   for (vsize i = 0; i < elts.size (); i++)
  95     if (Note_column::has_interface (elts[i]))
  96       centers.add_point (scm_to_double (centered_on_object (elts[i], X_AXIS)));
  97
  98   if (centers.is_empty ())
  99     return scm_from_double (0.0);
 100
 101   return scm_from_double (centers.center ());
 102 }
 103
 104 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
 105 SCM
 106 Self_alignment_interface::centered_on_y_parent (SCM smob)
 107 {
 108   return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
 109 }
 110
 111 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_centered_on_y_parent, 1);
 112 SCM
 113 Self_alignment_interface::x_centered_on_y_parent (SCM smob)
 114 {
 115   return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
 116 }
 117
 118 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
 119 SCM
 120 Self_alignment_interface::aligned_on_x_parent (SCM smob)
 121 {
 122   return aligned_on_parent (unsmob_grob (smob), X_AXIS);
 123 }
 124
 125 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
 126 SCM
 127 Self_alignment_interface::aligned_on_y_parent (SCM smob)
 128 {
 129   return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
 130 }
 131
 132 SCM
 133 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
 134 {
 135   Grob *him = me->get_parent (a);
 136   if (Paper_column::has_interface (him))
 137     return scm_from_double (0.0);
 138
 139   Interval he = him->extent (him, a);
 140
 141   SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
 142             : ly_symbol2scm ("self-alignment-Y");
 143   SCM align_prop (me->internal_get_property (sym));
 144
 145   if (!scm_is_number (align_prop))
 146     return scm_from_int (0);
 147
 148   Real x = 0.0;
 149   Real align = scm_to_double (align_prop);
 150
 151   Interval ext (me->extent (me, a));
 152   if (ext.is_empty ())
 153     programming_error ("cannot align on self: empty element");
 154   else
 155     x -= ext.linear_combination (align);
 156
 157   if (!he.is_empty ())
 158     x += he.linear_combination (align);
 159
 160   return scm_from_double (x);
 161 }
 162
 163 MAKE_SCHEME_CALLBACK (Self_alignment_interface, avoid_x_colliding_grobs, 2);
 164 SCM
 165 Self_alignment_interface::avoid_x_colliding_grobs (SCM smob, SCM o)
 166 {
 167   SCM avoided = avoid_colliding_grobs (unsmob_grob (smob), X_AXIS, robust_scm2double (o, 0.0));
 168   return scm_is_null (avoided) ? o : avoided;
 169 }
 170
 171 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_colliding_grobs, 1);
 172 SCM
 173 Self_alignment_interface::x_colliding_grobs (SCM smob)
 174 {
 175   Grob *me = unsmob_grob (smob);
 176   extract_grob_set (me, "potential-X-colliding-grobs", pot);
 177   vector<Grob *> act;
 178   Direction d = get_grob_direction (me->get_parent (Y_AXIS));
 179   for (vsize i = 0; i < pot.size (); i++)
 180     if (d == get_grob_direction (pot[i])
 181         && to_boolean (pot[i]->get_property ("cross-staff")))
 182       act.push_back (pot[i]);
 183
 184   SCM grobs_scm = Grob_array::make_array ();
 185   unsmob_grob_array (grobs_scm)->set_array (act);
 186
 187   return grobs_scm;
 188 }
 189
 190 SCM
 191 Self_alignment_interface::avoid_colliding_grobs (Grob *me, Axis a, Real offset)
 192 {
 193   extract_grob_set (me, a == X_AXIS ? "X-colliding-grobs" : "Y-colliding-grobs", colls);
 194   if (!colls.size ())
 195     return SCM_EOL;
 196   vector<Interval> ivs;
 197
 198   Item *refp = dynamic_cast<Item *> (common_refpoint_of_array (colls, me, a));
 199   if (!refp)
 200     return SCM_EOL;
 201
 202   Interval iv = me->extent (me, a) + offset;
 203   for (vsize i = 0; i < colls.size (); i++)
 204     ivs.push_back (colls[i]->extent (refp, a));
 205
 206   Interval_minefield minefield (Interval (iv.center (), iv.center ()), iv.length ());
 207   for (vsize i = 0; i < ivs.size (); i++)
 208     minefield.add_forbidden_interval (ivs[i]);
 209   minefield.solve ();
 210   Interval pos = minefield.feasible_placements ();
 211
 212   if (pos[LEFT] == pos[RIGHT])
 213     return SCM_EOL;
 214
 215   Direction col_dir = ((abs (pos[LEFT] - iv.center ())
 216                         + robust_scm2double (me->get_property ("collision-bias"), 0.0))
 217                        > abs (pos[RIGHT] - iv.center ()))
 218                       ? RIGHT
 219                       : LEFT;
 220
 221   return scm_from_double ((pos[col_dir] - (iv.length () / 2)
 222                           + col_dir
 223                           * robust_scm2double (me->get_property ("collision-padding"), 0.0)));
 224 }
 225
 226 void
 227 Self_alignment_interface::set_center_parent (Grob *me, Axis a)
 228 {
 229   add_offset_callback (me,
 230                        (a == X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
 231                        a);
 232 }
 233
 234 void
 235 Self_alignment_interface::avoid_x_collisions (Grob *me)
 236 {
 237   chain_offset_callback (me, avoid_x_colliding_grobs_proc, X_AXIS);
 238 }
 239
 240 void
 241 Self_alignment_interface::set_align_self (Grob *me, Axis a)
 242 {
 243   add_offset_callback (me,
 244                        (a == X_AXIS) ? x_aligned_on_self_proc : y_aligned_on_self_proc,
 245                        a);
 246 }
 247
 248 ADD_INTERFACE (Self_alignment_interface,
 249                "Position this object on itself and/or on its parent.  To this"
 250                " end, the following functions are provided:\n"
 251                "\n"
 252                "@table @code\n"
 253                "@item Self_alignment_interface::[xy]_aligned_on_self\n"
 254                "Align self on reference point, using"
 255                " @code{self-alignment-X} and @code{self-alignment-Y}."
 256                "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
 257                "@item Self_alignment_interface::centered_on_[xy]_parent\n"
 258                "Shift the object so its own reference point is centered on"
 259                " the extent of the parent\n"
 260                "@end table\n",
 261
 262                /* properties */
 263                "collision-bias "
 264                "collision-padding "
 265                "potential-X-colliding-grobs "
 266                "self-alignment-X "
 267                "self-alignment-Y "
 268                "X-colliding-grobs "
 269                "Y-colliding-grobs "
 270               );