2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2010 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 "staff-symbol-referencer.hh"
22 #include "staff-symbol.hh"
24 #include "output-def.hh"
25 #include "libc-extension.hh"
28 Staff_symbol_referencer::line_count (Grob
*me
)
30 Grob
*st
= get_staff_symbol (me
);
31 return st
? Staff_symbol::line_count (st
) : 0;
35 Staff_symbol_referencer::on_line (Grob
*me
, int pos
)
37 Grob
*st
= get_staff_symbol (me
);
38 return st
? Staff_symbol::on_line (st
, pos
) : false;
42 Staff_symbol_referencer::on_staff_line (Grob
*me
, int pos
)
44 return on_line (me
, pos
) && abs (pos
) <= 2 * staff_radius (me
);
48 Staff_symbol_referencer::get_staff_symbol (Grob
*me
)
50 if (Staff_symbol::has_interface (me
))
53 SCM st
= me
->get_object ("staff-symbol");
54 return unsmob_grob (st
);
58 Staff_symbol_referencer::staff_space (Grob
*me
)
60 Grob
*st
= get_staff_symbol (me
);
62 return Staff_symbol::staff_space (st
);
67 Staff_symbol_referencer::line_thickness (Grob
*me
)
69 Grob
*st
= get_staff_symbol (me
);
71 return Staff_symbol::get_line_thickness (st
);
72 return me
->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
76 Staff_symbol_referencer::get_position (Grob
*me
)
79 Grob
*st
= get_staff_symbol (me
);
80 Grob
*c
= st
? me
->common_refpoint (st
, Y_AXIS
) : 0;
83 Real y
= me
->relative_coordinate (c
, Y_AXIS
)
84 - st
->relative_coordinate (c
, Y_AXIS
);
86 p
+= 2.0 * y
/ Staff_symbol::staff_space (st
);
90 return me
->relative_coordinate (me
->get_parent (Y_AXIS
), Y_AXIS
) * 2;
91 return robust_scm2double (me
->get_property ("staff-position"), p
);
96 Staff_symbol_referencer::extent_in_staff (Grob
*me
)
98 Grob
*st
= get_staff_symbol (me
);
99 Grob
*c
= st
? me
->common_refpoint (st
, Y_AXIS
) : 0;
104 retval
= me
->extent (c
, Y_AXIS
)
105 - st
->relative_coordinate (c
, Y_AXIS
);
112 Staff_symbol_referencer::get_rounded_position (Grob
*me
)
114 return int (rint (get_position (me
)));
117 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer
, callback
, 1);
119 Staff_symbol_referencer::callback (SCM smob
)
121 Grob
*me
= unsmob_grob (smob
);
123 SCM pos
= me
->get_property ("staff-position");
125 if (scm_is_number (pos
))
127 Real space
= Staff_symbol_referencer::staff_space (me
);
128 off
= scm_to_double (pos
) * space
/ 2.0;
131 return scm_from_double (off
);
134 /* This sets the position relative to the center of the staff symbol.
136 The function is hairy, because it can be called in two situations:
138 1. There is no staff yet; we must set staff-position
140 2. There is a staff, and perhaps someone even applied a
141 translate_axis (). Then we must compensate for the translation
143 In either case, we set a callback to be sure that our new position
144 will be extracted from staff-position */
147 Staff_symbol_referencer::set_position (Grob
*me
, Real p
)
149 Grob
*st
= get_staff_symbol (me
);
151 if (st
&& me
->common_refpoint (st
, Y_AXIS
))
153 oldpos
= get_position (me
);
157 Real ss
= Staff_symbol_referencer::staff_space (me
);
158 me
->translate_axis ((p
- oldpos
) * ss
* 0.5, Y_AXIS
);
161 /* Half of the height, in staff space, i.e. 2.0 for a normal staff. */
163 Staff_symbol_referencer::staff_radius (Grob
*me
)
165 return (line_count (me
) - 1) / 2.0;
169 compare_position (Grob
*const &a
, Grob
*const &b
)
171 return sign (Staff_symbol_referencer::get_position ((Grob
*)a
)
172 - Staff_symbol_referencer::get_position ((Grob
*) b
));
176 position_less (Grob
*const &a
, Grob
*const &b
)
178 return Staff_symbol_referencer::get_position (a
)
179 < Staff_symbol_referencer::get_position (b
);
182 ADD_INTERFACE (Staff_symbol_referencer
,
183 "An object whose Y@tie{}position is meant relative to a staff"
184 " symbol. These usually"
185 " have @code{Staff_symbol_referencer::callback} in their"
186 " @code{Y-offset-callbacks}.",