2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "self-alignment-interface.hh"
22 #include "directional-element-interface.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"
31 MAKE_SCHEME_CALLBACK (Self_alignment_interface, y_aligned_on_self, 1);
33 Self_alignment_interface::y_aligned_on_self (SCM element)
35 return aligned_on_self (unsmob_grob (element), Y_AXIS, false, 0, 0);
38 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_aligned_on_self, 1);
40 Self_alignment_interface::x_aligned_on_self (SCM element)
42 return aligned_on_self (unsmob_grob (element), X_AXIS, false, 0, 0);
45 MAKE_SCHEME_CALLBACK (Self_alignment_interface, pure_y_aligned_on_self, 3);
47 Self_alignment_interface::pure_y_aligned_on_self (SCM smob, SCM start, SCM end)
49 return aligned_on_self (unsmob_grob (smob), Y_AXIS, true, robust_scm2int (start, 0), robust_scm2int (end, INT_MAX));
53 Self_alignment_interface::aligned_on_self (Grob *me, Axis a, bool pure, int start, int end)
55 SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
56 : ly_symbol2scm ("self-alignment-Y");
58 SCM align (me->internal_get_property (sym));
59 if (scm_is_number (align))
61 Interval ext (me->maybe_pure_extent (me, a, pure, start, end));
63 programming_error ("cannot align on self: empty element");
65 return scm_from_double (- ext.linear_combination (scm_to_double (align)));
67 return scm_from_double (0.0);
71 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
73 return scm_from_double (robust_relative_extent (him, him, a).center ());
76 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
78 Self_alignment_interface::centered_on_x_parent (SCM smob)
80 return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
83 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_note_columns, 1);
85 Self_alignment_interface::centered_on_note_columns (SCM smob)
87 Item *it = unsmob_item (smob)->get_column ();
89 return scm_from_double (0.0);
91 extract_grob_set (it, "elements", elts);
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)));
98 if (centers.is_empty ())
99 return scm_from_double (0.0);
101 return scm_from_double (centers.center ());
104 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
106 Self_alignment_interface::centered_on_y_parent (SCM smob)
108 return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
111 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_centered_on_y_parent, 1);
113 Self_alignment_interface::x_centered_on_y_parent (SCM smob)
115 return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
118 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
120 Self_alignment_interface::aligned_on_x_parent (SCM smob)
122 return aligned_on_parent (unsmob_grob (smob), X_AXIS);
125 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
127 Self_alignment_interface::aligned_on_y_parent (SCM smob)
129 return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
133 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
135 Grob *him = me->get_parent (a);
136 if (Paper_column::has_interface (him))
137 return scm_from_double (0.0);
139 Interval he = him->extent (him, a);
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));
145 if (!scm_is_number (align_prop))
146 return scm_from_int (0);
149 Real align = scm_to_double (align_prop);
151 Interval ext (me->extent (me, a));
153 programming_error ("cannot align on self: empty element");
155 x -= ext.linear_combination (align);
158 x += he.linear_combination (align);
160 return scm_from_double (x);
163 MAKE_SCHEME_CALLBACK (Self_alignment_interface, avoid_x_colliding_grobs, 2);
165 Self_alignment_interface::avoid_x_colliding_grobs (SCM smob, SCM o)
167 SCM avoided = avoid_colliding_grobs (unsmob_grob (smob), X_AXIS, robust_scm2double (o, 0.0));
168 return scm_is_null (avoided) ? o : avoided;
171 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_colliding_grobs, 1);
173 Self_alignment_interface::x_colliding_grobs (SCM smob)
175 Grob *me = unsmob_grob (smob);
176 extract_grob_set (me, "potential-X-colliding-grobs", pot);
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]);
184 SCM grobs_scm = Grob_array::make_array ();
185 unsmob_grob_array (grobs_scm)->set_array (act);
191 Self_alignment_interface::avoid_colliding_grobs (Grob *me, Axis a, Real offset)
193 extract_grob_set (me, a == X_AXIS ? "X-colliding-grobs" : "Y-colliding-grobs", colls);
196 vector<Interval> ivs;
198 Item *refp = dynamic_cast<Item *> (common_refpoint_of_array (colls, me, a));
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));
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]);
210 Interval pos = minefield.feasible_placements ();
212 if (pos[LEFT] == pos[RIGHT])
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 ()))
221 return scm_from_double ((pos[col_dir] - (iv.length () / 2)
223 * robust_scm2double (me->get_property ("collision-padding"), 0.0)));
227 Self_alignment_interface::set_center_parent (Grob *me, Axis a)
229 add_offset_callback (me,
230 (a == X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
235 Self_alignment_interface::avoid_x_collisions (Grob *me)
237 chain_offset_callback (me, avoid_x_colliding_grobs_proc, X_AXIS);
241 Self_alignment_interface::set_align_self (Grob *me, Axis a)
243 add_offset_callback (me,
244 (a == X_AXIS) ? x_aligned_on_self_proc : y_aligned_on_self_proc,
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"
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"
265 "potential-X-colliding-grobs "