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"
21 TODO: for vertical spacing, should also include a rod & spring
22 scheme of sorts into this: the alignment should default to a certain
23 distance between element refpoints, unless bbox force a bigger
27 MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1);
29 Align_interface::calc_positioning_done (SCM smob)
31 Grob *me = unsmob_grob (smob);
32 SCM axis = scm_car (me->get_property ("axes"));
33 Axis ax = Axis (scm_to_int (axis));
35 SCM force = me->get_property ("forced-distance");
36 if (scm_is_number (force))
37 Align_interface::align_to_fixed_distance (me, ax);
39 Align_interface::align_elements_to_extents (me, ax);
45 merge with align-to-extents?
47 MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
49 Align_interface::stretch_after_break (SCM grob)
51 Grob *me = unsmob_grob (grob);
53 Spanner *me_spanner = dynamic_cast<Spanner *> (me);
54 extract_grob_set (me, "elements", elems);
56 if (me_spanner && elems.size ())
58 Grob *common = common_refpoint_of_array (elems, me, Y_AXIS);
60 /* force position callbacks */
61 for (vsize i = 0; i < elems.size (); i++)
62 elems[i]->relative_coordinate (common, Y_AXIS);
64 SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
65 SCM extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details);
67 Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
68 ? scm_cdr (extra_space_handle)
72 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
74 Real delta = extra_space / elems.size() * stacking_dir;
75 for (vsize i = 0; i < elems.size (); i++)
76 elems[i]->translate_axis (i * delta, Y_AXIS);
79 return SCM_UNSPECIFIED;
83 merge with align-to-extents?
86 Align_interface::align_to_fixed_distance (Grob *me, Axis a)
88 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
91 Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
93 extract_grob_set (me, "elements", elem_source);
95 vector<Grob*> elems (elem_source); // writable..
101 vector<Real> translates;
103 for (vsize j = elems.size (); j--;)
106 This is not very elegant, in that we need special support for
107 hara-kiri. Unfortunately, the generic wiring of
108 force_hara_kiri_callback () (extent and offset callback) is
109 such that we might get into a loop if we call extent () or
110 offset () the elements.
113 && Hara_kiri_group_spanner::has_interface (elems[j]))
114 Hara_kiri_group_spanner::consider_suicide (elems[j]);
116 if (!elems[j]->is_live ())
117 elems.erase (elems.begin () + j);
120 for (vsize j = 0; j < elems.size (); j++)
122 where += stacking_dir * dy;
123 translates.push_back (where);
124 v.unite (Interval (where, where));
127 for (vsize i = 0; i < translates.size (); i++)
128 elems[i]->translate_axis (translates[i] - v.center (), a);
131 /* for each grob, find its upper and lower skylines. If the grob has
132 an empty extent, delete it from the list instead. If the extent is
133 non-empty but there is no skyline available (or pure is true), just
134 create a flat skyline from the bounding box */
136 get_skylines (Grob *me,
137 vector<Grob*> *const elements,
139 bool pure, int start, int end,
140 vector<Skyline_pair> *const ret)
142 /* each child's skyline was calculated according to the common refpoint of its
143 elements. Here we need all the skylines to be positioned with respect to
144 a single refpoint, so we need the common refpoint of the common refpoints
145 of the elements of the children */
146 vector<Grob*> child_refpoints;
147 for (vsize i = 0; i < elements->size (); i++)
149 Grob *elt = (*elements)[i];
150 Grob *child_common = unsmob_grob ((a == Y_AXIS)
151 ? elt->get_object ("X-common")
152 : elt->get_object ("Y-common"));
156 extract_grob_set (elt, "elements", child_elts);
157 child_common = common_refpoint_of_array (child_elts, elt, other_axis (a));
160 child_refpoints.push_back (child_common);
162 Grob *common_refpoint = common_refpoint_of_array (child_refpoints, me, other_axis (a));
164 for (vsize i = elements->size (); i--;)
166 Grob *g = (*elements)[i];
167 Interval extent = g->maybe_pure_extent (g, a, pure, start, end);
168 Interval other_extent = pure ? Interval (-infinity_f, infinity_f)
169 : g->extent (common_refpoint, other_axis (a));
172 b[other_axis (a)] = other_extent;
174 if (extent.is_empty ())
176 elements->erase (elements->begin () + i);
180 Skyline_pair skylines;
182 && Skyline_pair::unsmob (g->get_property ("skylines")))
183 skylines = *Skyline_pair::unsmob (g->get_property ("skylines"));
187 programming_error ("no skylines for alignment-child\n");
189 skylines = Skyline_pair (b, 0, other_axis (a));
192 /* each skyline is calculated relative to (potentially) a different other_axis
193 coordinate. In order to compare the skylines effectively, we need to shift them
194 to some absolute reference point */
197 /* this is perhaps an abuse of minimum-?-extent: maybe we should create
198 another property? But it seems that the only (current) use of
199 minimum-Y-extent is to separate vertically-aligned elements */
200 SCM min_extent = g->get_property (a == X_AXIS ? "minimum-X-extent" : "minimum-Y-extent");
201 if (is_number_pair (min_extent))
203 b[a] = ly_scm2interval (min_extent);
204 skylines.insert (b, 0, other_axis (a));
207 Real offset = child_refpoints[i]->relative_coordinate (common_refpoint, other_axis (a));
208 skylines.shift (offset);
212 ret->push_back (skylines);
218 Align_interface::get_extents_aligned_translates (Grob *me,
219 vector<Grob*> const &all_grobs,
221 bool pure, int start, int end)
223 Spanner *me_spanner = dynamic_cast<Spanner *> (me);
226 SCM line_break_details = SCM_EOL;
227 if (a == Y_AXIS && me_spanner)
230 line_break_details = get_root_system (me)->column (start)->get_property ("line-break-system-details");
232 line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
234 if (!me->get_system () && !pure)
235 me->warning (_ ("vertical alignment called before line-breaking.\n"
236 "Only do cross-staff spanners with PianoStaff."));
240 Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
243 vector<Grob*> elems (all_grobs); // writable copy
244 vector<Skyline_pair> skylines;
246 get_skylines (me, &elems, a, pure, start, end, &skylines);
249 SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details);
250 Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
251 ? scm_cdr (extra_space_handle)
255 Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
256 vector<Real> translates;
257 for (vsize j = 0; j < elems.size (); j++)
261 dy = skylines[j][-stacking_dir].max_height ();
263 dy = skylines[j-1][stacking_dir].distance (skylines[j][-stacking_dir]);
265 where += stacking_dir * max (0.0, dy + padding + extra_space / elems.size ());
266 translates.push_back (where);
269 SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
271 if (scm_is_pair (offsets_handle))
275 for (SCM s = scm_cdr (offsets_handle);
276 scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++)
278 if (scm_is_number (scm_car (s)))
279 translates[i] = scm_to_double (scm_car (s));
283 vector<Real> all_translates;
285 if (!translates.empty ())
287 Real w = translates[0];
288 for (vsize i = 0, j = 0; j < all_grobs.size (); j++)
290 if (i < elems.size () && all_grobs[j] == elems[i])
292 all_translates.push_back (w);
295 return all_translates;
299 Align_interface::align_elements_to_extents (Grob *me, Axis a)
301 extract_grob_set (me, "elements", all_grobs);
303 vector<Real> translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0);
304 if (translates.size ())
305 for (vsize j = 0; j < all_grobs.size (); j++)
306 all_grobs[j]->translate_axis (translates[j], a);
310 Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
312 extract_grob_set (me, "elements", all_grobs);
313 SCM dy_scm = me->get_property ("forced-distance");
315 if (scm_is_number (dy_scm))
317 Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN);
319 for (vsize i = 0; i < all_grobs.size (); i++)
321 if (all_grobs[i] == ch)
323 if (!Hara_kiri_group_spanner::has_interface (all_grobs[i])
324 || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end))
330 vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
332 if (translates.size ())
334 for (vsize i = 0; i < all_grobs.size (); i++)
335 if (all_grobs[i] == ch)
336 return translates[i];
342 programming_error (_ ("tried to get a translation for something that is no child of mine"));
347 Align_interface::axis (Grob *me)
349 return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
353 Align_interface::add_element (Grob *me, Grob *element)
355 Axis a = Align_interface::axis (me);
356 SCM sym = axis_offset_symbol (a);
357 SCM proc = axis_parent_positioning (a);
359 element->set_property (sym, proc);
360 Axis_group_interface::add_element (me, element);
364 Align_interface::set_ordered (Grob *me)
366 SCM ga_scm = me->get_object ("elements");
367 Grob_array *ga = unsmob_grob_array (ga_scm);
370 ga_scm = Grob_array::make_array ();
371 ga = unsmob_grob_array (ga_scm);
372 me->set_object ("elements", ga_scm);
375 ga->set_ordered (true);
379 Find Y-axis parent of G that has a #'forced-distance property. This
380 has the effect of finding the piano-staff given an object in that
384 find_fixed_alignment_parent (Grob *g)
388 if (scm_is_number (g->get_property ("forced-distance")))
391 g = g->get_parent (Y_AXIS);
397 ADD_INTERFACE (Align_interface,
399 "Order grobs from top to bottom, left to right, right to left or bottom "
401 "For vertical alignments of staves, the @code{break-system-details} of "
402 "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing "
403 "Set @code{alignment-extra-space} to add extra space for staves. Set "
404 "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart."