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 return scm_from_double (- ext.linear_combination (scm_to_double (align)));
65 return scm_from_double (0.0);
69 Self_alignment_interface::centered_on_object (Grob *him, Axis a)
71 return scm_from_double (robust_relative_extent (him, him, a).center ());
74 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_x_parent, 1);
76 Self_alignment_interface::centered_on_x_parent (SCM smob)
78 return centered_on_object (unsmob_grob (smob)->get_parent (X_AXIS), X_AXIS);
81 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_note_columns, 1);
83 Self_alignment_interface::centered_on_note_columns (SCM smob)
85 Item *it = unsmob_item (smob)->get_column ();
87 return scm_from_double (0.0);
89 extract_grob_set (it, "elements", elts);
92 for (vsize i = 0; i < elts.size (); i++)
93 if (Note_column::has_interface (elts[i]))
94 centers.add_point (scm_to_double (centered_on_object (elts[i], X_AXIS)));
96 if (centers.is_empty ())
97 return scm_from_double (0.0);
99 return scm_from_double (centers.center ());
102 MAKE_SCHEME_CALLBACK (Self_alignment_interface, centered_on_y_parent, 1);
104 Self_alignment_interface::centered_on_y_parent (SCM smob)
106 return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), Y_AXIS);
109 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_centered_on_y_parent, 1);
111 Self_alignment_interface::x_centered_on_y_parent (SCM smob)
113 return centered_on_object (unsmob_grob (smob)->get_parent (Y_AXIS), X_AXIS);
116 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_x_parent, 1);
118 Self_alignment_interface::aligned_on_x_parent (SCM smob)
120 return aligned_on_parent (unsmob_grob (smob), X_AXIS);
123 MAKE_SCHEME_CALLBACK (Self_alignment_interface, aligned_on_y_parent, 1);
125 Self_alignment_interface::aligned_on_y_parent (SCM smob)
127 return aligned_on_parent (unsmob_grob (smob), Y_AXIS);
131 Self_alignment_interface::aligned_on_parent (Grob *me, Axis a)
133 Grob *him = me->get_parent (a);
134 if (Paper_column::has_interface (him))
135 return scm_from_double (0.0);
137 Interval he = him->extent (him, a);
139 SCM sym = (a == X_AXIS) ? ly_symbol2scm ("self-alignment-X")
140 : ly_symbol2scm ("self-alignment-Y");
141 SCM align_prop (me->internal_get_property (sym));
143 if (!scm_is_number (align_prop))
144 return scm_from_int (0);
147 Real align = scm_to_double (align_prop);
149 Interval ext (me->extent (me, a));
151 programming_error ("cannot align on self: empty element");
153 x -= ext.linear_combination (align);
156 x += he.linear_combination (align);
158 return scm_from_double (x);
161 MAKE_SCHEME_CALLBACK (Self_alignment_interface, avoid_x_colliding_grobs, 2);
163 Self_alignment_interface::avoid_x_colliding_grobs (SCM smob, SCM o)
165 SCM avoided = avoid_colliding_grobs (unsmob_grob (smob), X_AXIS, robust_scm2double (o, 0.0));
166 return scm_is_null (avoided) ? o : avoided;
169 MAKE_SCHEME_CALLBACK (Self_alignment_interface, x_colliding_grobs, 1);
171 Self_alignment_interface::x_colliding_grobs (SCM smob)
173 Grob *me = unsmob_grob (smob);
174 extract_grob_set (me, "potential-X-colliding-grobs", pot);
176 Direction d = get_grob_direction (me->get_parent (Y_AXIS));
177 for (vsize i = 0; i < pot.size (); i++)
178 if (d == get_grob_direction (pot[i])
179 && to_boolean (pot[i]->get_property ("cross-staff")))
180 act.push_back (pot[i]);
182 SCM grobs_scm = Grob_array::make_array ();
183 unsmob_grob_array (grobs_scm)->set_array (act);
189 Self_alignment_interface::avoid_colliding_grobs (Grob *me, Axis a, Real offset)
191 extract_grob_set (me, a == X_AXIS ? "X-colliding-grobs" : "Y-colliding-grobs", colls);
194 vector<Interval> ivs;
196 Item *refp = dynamic_cast<Item *> (common_refpoint_of_array (colls, me, a));
200 Interval iv = me->extent (me, a) + offset;
201 for (vsize i = 0; i < colls.size (); i++)
203 int my_vai = Grob::get_vertical_axis_group_index (colls[i]);
204 Direction dir = get_grob_direction (colls[i]);
205 // if coll is cross staff but extremal and pointing in the
206 // direction of the extrema, we don't take it into consideration
207 if (Grob *beam = unsmob_grob (colls[i]->get_object ("beam")))
209 Interval_t<int> vais;
210 extract_grob_set (beam, "normal-stems", stems);
211 for (vsize j = 0; j < stems.size (); j++)
212 vais.add_point (Grob::get_vertical_axis_group_index (stems[j]));
213 // ugh...up and down are different for VerticalAxisGroup order...
214 if ((my_vai == vais[DOWN] && dir == UP)
215 || (my_vai == vais[UP] && dir == DOWN))
218 ivs.push_back (colls[i]->extent (refp, a));
221 Interval_minefield minefield (Interval (iv.center (), iv.center ()), iv.length ());
222 for (vsize i = 0; i < ivs.size (); i++)
223 minefield.add_forbidden_interval (ivs[i]);
225 Interval pos = minefield.feasible_placements ();
227 if (pos[LEFT] == pos[RIGHT])
230 Direction col_dir = ((abs (pos[LEFT] - iv.center ())
231 + robust_scm2double (me->get_property ("collision-bias"), 0.0))
232 > abs (pos[RIGHT] - iv.center ()))
236 return scm_from_double ((pos[col_dir] - (iv.length () / 2)
238 * robust_scm2double (me->get_property ("collision-padding"), 0.0)));
242 Self_alignment_interface::set_center_parent (Grob *me, Axis a)
244 add_offset_callback (me,
245 (a == X_AXIS) ? centered_on_x_parent_proc : centered_on_y_parent_proc,
250 Self_alignment_interface::avoid_x_collisions (Grob *me)
252 chain_offset_callback (me, avoid_x_colliding_grobs_proc, X_AXIS);
256 Self_alignment_interface::set_align_self (Grob *me, Axis a)
258 add_offset_callback (me,
259 (a == X_AXIS) ? x_aligned_on_self_proc : y_aligned_on_self_proc,
263 ADD_INTERFACE (Self_alignment_interface,
264 "Position this object on itself and/or on its parent. To this"
265 " end, the following functions are provided:\n"
268 "@item Self_alignment_interface::[xy]_aligned_on_self\n"
269 "Align self on reference point, using"
270 " @code{self-alignment-X} and @code{self-alignment-Y}."
271 "@item Self_alignment_interface::aligned_on_[xy]_parent\n"
272 "@item Self_alignment_interface::centered_on_[xy]_parent\n"
273 "Shift the object so its own reference point is centered on"
274 " the extent of the parent\n"
280 "potential-X-colliding-grobs "