2 align-interface.cc -- implement Align_interface
4 source file of the GNU LilyPond music typesetter
6 (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "align-interface.hh"
12 #include "axis-group-interface.hh"
13 #include "hara-kiri-group-spanner.hh"
14 #include "output-def.hh"
16 MAKE_SCHEME_CALLBACK (Align_interface,alignment_callback,2);
18 Align_interface::alignment_callback (SCM element_smob, SCM axis)
20 Grob * me = unsmob_grob (element_smob);
21 Axis ax = (Axis)scm_to_int (axis);
22 Grob * par = me->get_parent (ax);
23 if (par && !to_boolean (par->get_property ("positioning-done")))
25 Align_interface::align_elements_to_extents (par, ax);
27 return scm_make_real (0.0);
30 MAKE_SCHEME_CALLBACK (Align_interface,fixed_distance_alignment_callback,2);
32 Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
34 Grob * me = unsmob_grob (element_smob);
35 Axis ax = (Axis)scm_to_int (axis);
36 Grob * par = me->get_parent (ax);
37 if (par && !to_boolean (par->get_property ("positioning-done")))
39 Align_interface::align_to_fixed_distance (par, ax);
41 return scm_make_real (0.0);
45 merge with align-to-extents?
48 Align_interface::align_to_fixed_distance (Grob *me , Axis a)
50 me->set_property ("positioning-done", SCM_BOOL_T);
52 SCM d = me->get_property ("stacking-dir");
54 Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
58 Real dy = robust_scm2double (me->get_property ("forced-distance"),0.0);
60 Link_array<Grob> elems
61 = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
67 Array<Real> translates;
69 for (int j = elems.size (); j--; )
72 This is not very elegant, in that we need special support for
73 hara-kiri. Unfortunately, the generic wiring of
74 force_hara_kiri_callback () (extent and offset callback) is
75 such that we might get into a loop if we call extent () or
76 offset () the elements.
81 && Hara_kiri_group_spanner::has_interface (elems[j]))
82 Hara_kiri_group_spanner::consider_suicide (elems[j]);
84 if (!elems[j]->is_live ())
88 for (int j = 0; j < elems.size (); j++)
90 where_f += stacking_dir * dy;
91 translates.push (where_f);
92 v.unite (Interval (where_f, where_f));
96 TODO: support self-alignment-{Y,X}
98 for (int i = 0; i < translates.size (); i++)
100 elems[i]->translate_axis (translates[i] - v.center (), a);
105 Hairy function to put elements where they should be. Can be tweaked
106 from the outside by setting extra-space in its
109 We assume that the children the refpoints of the children are still
110 found at 0.0 -- we will fuck up with thresholds if children's
111 extents are already moved to locations such as (-16, -8), since the
112 dy needed to put things in a row doesn't relate to the distances
113 between original refpoints.
115 TODO: maybe we should rethink and throw out thresholding altogether.
116 The original function has been taken over by
117 align_to_fixed_distance ().
120 Align_interface::align_elements_to_extents (Grob * me, Axis a)
122 me->set_property ("positioning-done", SCM_BOOL_T);
124 SCM d = me->get_property ("stacking-dir");
126 Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
130 Interval threshold = robust_scm2interval (me->get_property ("threshold"),
131 Interval (0, Interval::infinity ()));
133 Array<Interval> dims;
135 Link_array<Grob> elems;
136 Link_array<Grob> all_grobs
137 = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
138 for (int i = 0; i < all_grobs.size (); i++)
140 Interval y = all_grobs[i]->extent (me, a);
143 Grob *e = dynamic_cast<Grob*> (all_grobs[i]);
152 Read self-alignment-X and self-alignment-Y. This may seem like
153 code duplication. (and really: it is), but this is necessary to
154 prevent ugly cyclic dependencies that arise when you combine
155 self-alignment on a child with alignment of children.
157 static SCM prop_syms[2];
161 prop_syms[X_AXIS] = ly_symbol2scm ("self-alignment-X");
162 prop_syms[Y_AXIS] = ly_symbol2scm ("self-alignment-Y");
165 SCM align (me->internal_get_property (prop_syms[a]));
167 Array<Real> translates ;
171 for (int j = 0 ; j < elems.size (); j++)
173 Real dy = - dims[j][-stacking_dir];
175 dy += dims[j-1][stacking_dir];
184 dy = (dy >? threshold[SMALLER])
185 <? threshold[BIGGER];
188 where_f += stacking_dir * dy;
189 total.unite (dims[j] + where_f);
190 translates.push (where_f);
194 Real center_offset = 0.0;
196 also move the grobs that were empty, to maintain spatial order.
198 Array<Real> all_translates;
199 if (translates.size ())
203 Real w = translates[0];
204 while (j < all_grobs.size ())
206 if (i < elems.size () && all_grobs[j] == elems[i])
210 all_translates.push (w);
216 FIXME: uncommenting freaks out the Y-alignment of
219 if (scm_is_number (align))
220 center_offset = total.linear_combination (scm_to_double (align));
222 for (int j = 0 ; j < all_grobs.size (); j++)
223 all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
227 Align_interface::axis (Grob*me)
229 return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
233 Align_interface::add_element (Grob*me,Grob* s, SCM cb)
235 s->add_offset_callback (cb, Align_interface::axis (me));
236 Axis_group_interface::add_element (me, s);
240 Align_interface::set_axis (Grob*me,Axis a)
242 Axis_group_interface::set_axes (me, a,a);
247 Find Y-axis parent of G that has a #'forced-distance property. This
248 has the effect of finding the piano-staff given an object in that
252 find_fixed_alignment_parent (Grob *g)
256 if (scm_is_number (g->get_property ("forced-distance")))
259 g = g->get_parent (Y_AXIS);
268 ADD_INTERFACE (Align_interface, "align-interface",
269 "Order grobs from top to bottom, left to right, right to left or bottom"
272 "forced-distance stacking-dir align-dir threshold positioning-done "
273 "center-element elements axes");
278 bool has_interface (Grob*);