2 side-position-interface.cc -- implement Side_position_interface
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "side-position-interface.hh"
11 #include <cmath> // ceil.
15 #include "note-head.hh"
18 #include "staff-symbol-referencer.hh"
19 #include "pointer-group-interface.hh"
20 #include "directional-element-interface.hh"
21 #include "staff-symbol-referencer.hh"
22 #include "staff-symbol.hh"
23 #include "string-convert.hh"
27 Side_position_interface::add_support (Grob *me, Grob *e)
29 Pointer_group_interface::add_grob (me, ly_symbol2scm ("side-support-elements"), e);
33 Side_position_interface::get_direction (Grob *me)
35 Direction relative_dir = Direction (1);
36 SCM reldir = me->get_property ("side-relative-direction");
37 if (is_direction (reldir))
38 relative_dir = to_dir (reldir);
40 SCM other_elt = me->get_object ("direction-source");
41 Grob *e = unsmob_grob (other_elt);
43 return (Direction) (relative_dir * get_grob_direction (e));
48 /* Put the element next to the support, optionally taking in
49 account the extent of the support. */
51 Side_position_interface::general_side_position (Grob *me, Axis a, bool use_extents)
53 Real ss = Staff_symbol_referencer::staff_space (me);
55 extract_grob_set (me, "side-support-elements", support);
57 Grob *common = common_refpoint_of_array (support, me->get_parent (a), a);
58 Grob *staff_symbol = Staff_symbol_referencer::get_staff_symbol (me);
62 && scm_is_number (me->get_property ("staff-padding"))
63 && !to_boolean (me->get_property ("quantize-position"));
66 Interval staff_extents;
69 common = staff_symbol->common_refpoint (common, Y_AXIS);
70 staff_extents = staff_symbol->extent (common, Y_AXIS);
73 dim.unite (staff_extents);
76 for (vsize i = 0; i < support.size (); i++)
81 dim.unite (e->extent (common, a));
84 Real x = e->relative_coordinate (common, a);
85 dim.unite (Interval (x, x));
90 dim = Interval (0, 0);
92 Direction dir = get_grob_direction (me);
94 Real off = me->get_parent (a)->relative_coordinate (common, a);
95 Real minimum_space = ss * robust_scm2double (me->get_property ("minimum-space"), -1);
97 Real total_off = dim.linear_combination (dir) - off;
98 total_off += dir * ss * robust_scm2double (me->get_property ("padding"), 0);
100 if (minimum_space >= 0
102 && total_off * dir < minimum_space)
103 total_off = minimum_space * dir;
105 /* FIXME: 1000 should relate to paper size. */
106 if (fabs (total_off) > 1000)
109 = String_convert::form_string ("Improbable offset for grob %s: %f",
110 me->name ().c_str (), total_off);
112 programming_error (msg);
113 if (strict_infinity_checking)
114 scm_misc_error (__FUNCTION__, "Improbable offset.", SCM_EOL);
116 return scm_from_double (total_off);
120 MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_on_support_refpoints, 1);
122 Side_position_interface::y_aligned_on_support_refpoints (SCM smob)
124 return general_side_position (unsmob_grob (smob), Y_AXIS, false);
130 Position next to support, taking into account my own dimensions and padding.
133 MAKE_SCHEME_CALLBACK (Side_position_interface, x_aligned_side, 1);
135 Side_position_interface::x_aligned_side (SCM smob)
137 return aligned_side (unsmob_grob (smob), X_AXIS);
140 MAKE_SCHEME_CALLBACK (Side_position_interface, y_aligned_side, 1);
142 Side_position_interface::y_aligned_side (SCM smob)
144 return aligned_side (unsmob_grob (smob), Y_AXIS);
148 Side_position_interface::aligned_side (Grob *me, Axis a)
150 Direction dir = get_grob_direction (me);
152 Real o = scm_to_double (general_side_position (me, a, true));
153 Interval iv = me->extent (me, a);
159 programming_error ("direction unknown, but aligned-side wanted");
166 Maintain a minimum distance to the staff. This is similar to side
167 position with padding, but it will put adjoining objects on a row if
168 stuff sticks out of the staff a little.
170 Grob *staff = Staff_symbol_referencer::get_staff_symbol (me);
171 if (staff && a == Y_AXIS)
173 if (to_boolean (me->get_property ("quantize-position")))
175 Grob *common = me->common_refpoint (staff, Y_AXIS);
176 Real my_off = me->relative_coordinate (common, Y_AXIS);
177 Real staff_off = staff->relative_coordinate (common, Y_AXIS);
178 Real ss = Staff_symbol::staff_space (staff);
179 Real position = 2 * (my_off + o - staff_off) / ss;
180 Real rounded = directed_round (position, dir);
181 Grob *head = me->get_parent (X_AXIS);
183 if (rounded <= 2 * Staff_symbol_referencer::staff_radius (me)
184 || (Note_head::has_interface (head)
185 && sign (Staff_symbol_referencer::get_position (head)) == - dir))
187 o += (rounded - position) * 0.5 * ss;
188 if (Staff_symbol_referencer::on_line (me, int (rounded)))
192 else if (scm_is_number (me->get_property ("staff-padding")))
195 = Staff_symbol_referencer::staff_space (me)
196 * scm_to_double (me->get_property ("staff-padding"));
198 Grob *common = me->common_refpoint (staff, Y_AXIS);
200 Interval staff_size = staff->extent (common, Y_AXIS);
201 Real diff = dir*staff_size[dir] + padding - dir * (o + iv[-dir]);
202 o += dir * max (diff, 0.0);
205 return scm_from_double (o);
209 Side_position_interface::set_axis (Grob *me, Axis a)
211 if (!scm_is_number (me->get_property ("side-axis")))
213 me->set_property ("side-axis", scm_from_int (a));
214 add_offset_callback (me,
216 ? x_aligned_side_proc
217 : y_aligned_side_proc,
222 Side_position_interface::get_axis (Grob *me)
224 if (scm_is_number (me->get_property ("side-axis")))
225 return Axis (scm_to_int (me->get_property ("side-axis")));
227 me->programming_error ("side-axis not set.");
231 ADD_INTERFACE (Side_position_interface, "side-position-interface",
232 "Position a victim object (this one) next to other objects (the "
233 "support). The property @code{direction} signifies where to put the "
234 "victim object relative to the support (left or right, up or down?)\n\n "
235 "The routine also takes the size the staff into account if "
236 "@code{staff-padding} is set. If undefined, the staff symbol is ignored.",
245 "side-relative-direction "
246 "side-support-elements "