2 align-interface.cc -- implement Align_interface
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "align-interface.hh"
12 #include "axis-group-interface.hh"
13 #include "pointer-group-interface.hh"
14 #include "hara-kiri-group-spanner.hh"
15 #include "grob-array.hh"
16 #include "international.hh"
20 TODO: for vertical spacing, should also include a rod & spring
21 scheme of sorts into this: the alignment should default to a certain
22 distance between element refpoints, unless bbox force a bigger
26 MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1);
28 Align_interface::calc_positioning_done (SCM smob)
30 Grob *me = unsmob_grob (smob);
31 SCM axis = scm_car (me->get_property ("axes"));
32 Axis ax = Axis (scm_to_int (axis));
34 SCM force = me->get_property ("forced-distance");
35 if (scm_is_number (force))
36 Align_interface::align_to_fixed_distance (me, ax);
38 Align_interface::align_elements_to_extents (me, ax);
44 merge with align-to-extents?
46 MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
48 Align_interface::stretch_after_break (SCM grob)
50 Grob *me = unsmob_grob (grob);
52 Spanner *me_spanner = dynamic_cast<Spanner *> (me);
53 extract_grob_set (me, "elements", elems);
55 if (me_spanner && elems.size ())
57 Grob *common = common_refpoint_of_array (elems, me, Y_AXIS);
59 /* force position callbacks */
60 for (vsize i = 0; i < elems.size (); i++)
61 elems[i]->relative_coordinate (common, Y_AXIS);
63 SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
64 SCM extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details);
66 Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
67 ? scm_cdr (extra_space_handle)
71 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
73 Real delta = extra_space / elems.size() * stacking_dir;
74 for (vsize i = 0; i < elems.size (); i++)
75 elems[i]->translate_axis (i * delta, Y_AXIS);
78 return SCM_UNSPECIFIED;
82 merge with align-to-extents?
85 Align_interface::align_to_fixed_distance (Grob *me, Axis a)
87 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
90 Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
92 extract_grob_set (me, "elements", elem_source);
94 vector<Grob*> elems (elem_source); // writable..
100 vector<Real> translates;
102 for (vsize j = elems.size (); j--;)
105 This is not very elegant, in that we need special support for
106 hara-kiri. Unfortunately, the generic wiring of
107 force_hara_kiri_callback () (extent and offset callback) is
108 such that we might get into a loop if we call extent () or
109 offset () the elements.
112 && Hara_kiri_group_spanner::has_interface (elems[j]))
113 Hara_kiri_group_spanner::consider_suicide (elems[j]);
115 if (!elems[j]->is_live ())
116 elems.erase (elems.begin () + j);
119 for (vsize j = 0; j < elems.size (); j++)
121 where += stacking_dir * dy;
122 translates.push_back (where);
123 v.unite (Interval (where, where));
126 for (vsize i = 0; i < translates.size (); i++)
127 elems[i]->translate_axis (translates[i] - v.center (), a);
130 /* for each grob, find its upper and lower skylines. If the grob has
131 an empty extent, delete it from the list instead. If the extent is
132 non-empty but there is no skyline available (or pure is true), just
133 create a flat skyline from the bounding box */
135 get_skylines (Grob *me,
136 vector<Grob*> *const elements,
138 bool pure, int start, int end,
139 vector<Skyline_pair> *const ret)
141 Grob *other_axis_common = common_refpoint_of_array (*elements, me, other_axis (a));
142 for (vsize i = elements->size (); i--;)
144 Grob *g = (*elements)[i];
145 Interval extent = g->maybe_pure_extent (g, a, pure, start, end);
146 Interval other_extent = pure ? Interval (-infinity_f, infinity_f)
147 : g->extent (other_axis_common, other_axis (a));
148 Box b = (a == X_AXIS) ? Box (extent, other_extent) : Box (other_extent, extent);
150 if (extent.is_empty ())
152 elements->erase (elements->begin () + i);
156 Skyline_pair skylines;
158 && Skyline_pair::unsmob (g->get_property ("skylines")))
159 skylines = *Skyline_pair::unsmob (g->get_property ("skylines"));
163 programming_error ("no skylines for alignment-child\n");
165 skylines = Skyline_pair (b, 0, other_axis (a));
168 /* each skyline is calculated relative to (potentially) a different other_axis
169 coordinate. In order to compare the skylines effectively, we need to shift them
170 to some absolute reference point */
173 /* this is perhaps an abuse of minimum-?-extent: maybe we should create
174 another property? But it seems that the only (current) use of
175 minimum-Y-extent is to separate vertically-aligned elements */
176 SCM min_extent = g->get_property (a == X_AXIS ? "minimum-X-extent" : "minimum-Y-extent");
177 if (is_number_pair (min_extent))
179 b[a] = ly_scm2interval (min_extent);
180 skylines.insert (b, 0, other_axis (a));
182 Real offset = g->relative_coordinate (other_axis_common, other_axis (a));
183 skylines.shift (-offset);
187 ret->push_back (skylines);
193 Align_interface::get_extents_aligned_translates (Grob *me,
194 vector<Grob*> const &all_grobs,
196 bool pure, int start, int end)
198 Spanner *me_spanner = dynamic_cast<Spanner *> (me);
201 SCM line_break_details = SCM_EOL;
202 if (a == Y_AXIS && me_spanner)
204 line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
206 if (!me->get_system () && !pure)
207 me->warning (_ ("vertical alignment called before line-breaking.\n"
208 "Only do cross-staff spanners with PianoStaff."));
212 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
215 vector<Grob*> elems (all_grobs); // writable copy
216 vector<Skyline_pair> skylines;
218 get_skylines (me, &elems, a, pure, start, end, &skylines);
221 SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details);
222 Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
223 ? scm_cdr (extra_space_handle)
227 Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
228 vector<Real> translates;
229 for (vsize j = 0; j < elems.size (); j++)
233 dy = skylines[j][-stacking_dir].max_height ();
235 dy = skylines[j-1][stacking_dir].distance (skylines[j][-stacking_dir]);
237 where += stacking_dir * (dy + padding + extra_space / elems.size ());
238 translates.push_back (where);
241 SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
243 if (scm_is_pair (offsets_handle))
247 for (SCM s = scm_cdr (offsets_handle);
248 scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++)
250 if (scm_is_number (scm_car (s)))
251 translates[i] = scm_to_double (scm_car (s));
255 vector<Real> all_translates;
257 if (!translates.empty ())
259 Real w = translates[0];
260 for (vsize i = 0, j = 0; j < all_grobs.size (); j++)
262 if (i < elems.size () && all_grobs[j] == elems[i])
264 all_translates.push_back (w);
267 return all_translates;
271 Align_interface::align_elements_to_extents (Grob *me, Axis a)
273 extract_grob_set (me, "elements", all_grobs);
275 vector<Real> translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0);
276 if (translates.size ())
277 for (vsize j = 0; j < all_grobs.size (); j++)
278 all_grobs[j]->translate_axis (translates[j], a);
282 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
284 extract_grob_set (me, "elements", all_grobs);
285 SCM dy_scm = me->get_property ("forced-distance");
287 if (scm_is_number (dy_scm))
289 Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
291 for (vsize i = 0; i < all_grobs.size (); i++)
293 if (all_grobs[i] == ch)
295 if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
296 || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
302 vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
304 if (translates.size ())
306 for (vsize i = 0; i < all_grobs.size (); i++)
307 if (all_grobs[i] == ch)
308 return translates[i];
314 programming_error (_ ("tried to get a translation for something that isn't my child"));
319 Align_interface::axis (Grob *me)
321 return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
325 Align_interface::add_element (Grob *me, Grob *element)
327 Axis a = Align_interface::axis (me);
328 SCM sym = axis_offset_symbol (a);
329 SCM proc = axis_parent_positioning (a);
331 element->set_property (sym, proc);
332 Axis_group_interface::add_element (me, element);
336 Align_interface::set_ordered (Grob *me)
338 SCM ga_scm = me->get_object ("elements");
339 Grob_array *ga = unsmob_grob_array (ga_scm);
342 ga_scm = Grob_array::make_array ();
343 ga = unsmob_grob_array (ga_scm);
344 me->set_object ("elements", ga_scm);
347 ga->set_ordered (true);
351 Find Y-axis parent of G that has a #'forced-distance property. This
352 has the effect of finding the piano-staff given an object in that
356 find_fixed_alignment_parent (Grob *g)
360 if (scm_is_number (g->get_property ("forced-distance")))
363 g = g->get_parent (Y_AXIS);
369 ADD_INTERFACE (Align_interface,
371 "Order grobs from top to bottom, left to right, right to left or bottom "
373 "For vertical alignments of staves, the @code{break-system-details} of "
374 "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
375 "Set @code{alignment-extra-space} to add extra space for staves. Set "
376 "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."