2 staff-symbol-referencer.cc -- implement Staff_symbol_referencer
4 source file of the GNU LilyPond music typesetter
6 (c) 1999--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "staff-symbol-referencer.hh"
12 #include "staff-symbol.hh"
13 #include "paper-def.hh"
14 #include "libc-extension.hh"
18 Staff_symbol_referencer::line_count (Grob*me)
20 Grob *st = get_staff_symbol (me);
21 return st ? Staff_symbol::line_count (st) : 0;
25 Staff_symbol_referencer::on_staffline (Grob*me)
27 return on_staffline (me, (int) rint (get_position (me)));
31 Staff_symbol_referencer::on_staffline (Grob*me, int pos)
33 int sz = line_count (me)-1;
34 return ((pos + sz) % 2) == 0;
38 Staff_symbol_referencer::get_staff_symbol (Grob*me)
40 SCM st = me->get_grob_property ("staff-symbol");
41 return unsmob_grob (st);
45 Staff_symbol_referencer::staff_space (Grob*me)
47 Grob * st = get_staff_symbol (me);
49 return Staff_symbol::staff_space (st);
55 Staff_symbol_referencer::get_position (Grob*me)
58 Grob * st = get_staff_symbol (me);
59 Grob * c = st ? me->common_refpoint (st, Y_AXIS) : 0;
62 Real y = me->relative_coordinate (c, Y_AXIS)
63 - st->relative_coordinate (c, Y_AXIS);
65 p += 2.0 * y / Staff_symbol::staff_space (st);
69 SCM pos = me->get_grob_property ("staff-position");
70 if (gh_number_p (pos))
71 return gh_scm2double (pos);
78 LY_DEFINE(ly_grob_staff_position,
79 "ly:grob-staff-position",
81 "Return the Y-position of this grob relative to the staff.")
83 Grob * g = unsmob_grob (sg);
85 SCM_ASSERT_TYPE (g, sg, SCM_ARG1, __FUNCTION__, "grob");
86 Real pos = Staff_symbol_referencer::get_position (g);
88 if (fabs (rint (pos) -pos) < 1e-6) // ugh.
90 lrint has issues with various glibcs.
92 return gh_int2scm ((int) round (pos));
94 return gh_double2scm (pos);
99 should use offset callback!
101 MAKE_SCHEME_CALLBACK (Staff_symbol_referencer,callback,2);
103 Staff_symbol_referencer::callback (SCM element_smob, SCM)
105 Grob *me = unsmob_grob (element_smob);
108 SCM pos = me->get_grob_property ("staff-position");
110 if (gh_number_p (pos))
112 Real space = Staff_symbol_referencer::staff_space (me);
113 off = gh_scm2double (pos) * space/2.0;
114 me->set_grob_property ("staff-position", gh_int2scm (0));
117 return gh_double2scm (off);
122 This sets the position relative to the center of the staff symbol.
124 The function is hairy, because it can be callled in two situations:
126 1. There is no staff yet; we must set staff-position
128 2. There is a staff, and perhaps someone even applied a
129 translate_axis (). Then we must compensate for the translation
131 In either case, we set a callback to be sure that our new position
132 will be extracted from staff-position
136 Staff_symbol_referencer::set_position (Grob*me,Real p)
138 Grob * st = get_staff_symbol (me);
139 if (st && me->common_refpoint (st, Y_AXIS))
141 Real oldpos = get_position (me);
142 me->set_grob_property ("staff-position", gh_double2scm (p - oldpos));
146 me->set_grob_property ("staff-position",
151 if (me->has_offset_callback_b (Staff_symbol_referencer::callback_proc, Y_AXIS))
154 me->add_offset_callback (Staff_symbol_referencer::callback_proc, Y_AXIS);
158 Half of the height, in staff space, i.e. 2.0 for a normal staff.
161 Staff_symbol_referencer::staff_radius (Grob*me)
163 return (line_count (me) -1) / 2.0;
168 compare_position (Grob *const &a, Grob * const &b)
170 return sign (Staff_symbol_referencer::get_position ((Grob*)a) -
171 Staff_symbol_referencer::get_position ((Grob*)b));
174 ADD_INTERFACE (Staff_symbol_referencer,"staff-symbol-referencer-interface",
175 "Object whose Y position is meaning with reference to a staff "
176 "symbol. Objects that have this interface should include "
177 "Staff_symbol_referencer::callback in their Y-offset-callback. "