2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--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 "note-column.hh"
22 #include <cmath> // ceil
25 #include "accidental-placement.hh"
26 #include "axis-group-interface.hh"
27 #include "directional-element-interface.hh"
28 #include "international.hh"
30 #include "note-head.hh"
31 #include "output-def.hh"
32 #include "pointer-group-interface.hh"
34 #include "staff-symbol-referencer.hh"
39 TODO: figure out if we can prune this class. This is just an
40 annoying layer between (rest)collision & (note-head + stem)
44 Note_column::has_rests (Grob
*me
)
46 return unsmob_grob (me
->get_object ("rest"));
50 Note_column::shift_less (Grob
*const &p1
, Grob
*const &p2
)
52 SCM s1
= p1
->get_property ("horizontal-shift");
53 SCM s2
= p2
->get_property ("horizontal-shift");
55 int h1
= (scm_is_number (s1
)) ? scm_to_int (s1
) : 0;
56 int h2
= (scm_is_number (s2
)) ? scm_to_int (s2
) : 0;
61 Note_column::get_stem (Grob
*me
)
63 SCM s
= me
->get_object ("stem");
64 return unsmob_item (s
);
68 Note_column::head_positions_interval (Grob
*me
)
74 extract_grob_set (me
, "note-heads", heads
);
75 for (vsize i
= 0; i
< heads
.size (); i
++)
79 int j
= Staff_symbol_referencer::get_rounded_position (se
);
80 iv
.unite (Slice (j
, j
));
86 Note_column::dir (Grob
*me
)
88 Grob
*stem
= unsmob_grob (me
->get_object ("stem"));
89 if (stem
&& Stem::has_interface (stem
))
90 return get_grob_direction (stem
);
93 extract_grob_set (me
, "note-heads", heads
);
95 return (Direction
)sign (head_positions_interval (me
).center ());
98 programming_error ("note column without heads and stem");
103 Note_column::set_stem (Grob
*me
, Grob
*stem
)
105 me
->set_object ("stem", stem
->self_scm ());
106 Axis_group_interface::add_element (me
, stem
);
110 Note_column::get_rest (Grob
*me
)
112 return unsmob_grob (me
->get_object ("rest"));
116 Note_column::add_head (Grob
*me
, Grob
*h
)
119 if (Rest::has_interface (h
))
121 extract_grob_set (me
, "note-heads", heads
);
125 me
->set_object ("rest", h
->self_scm ());
127 else if (Note_head::has_interface (h
))
129 if (unsmob_grob (me
->get_object ("rest")))
131 Pointer_group_interface::add_grob (me
, ly_symbol2scm ("note-heads"), h
);
135 me
->warning (_ ("cannot have note heads and rests together on a stem"));
137 Axis_group_interface::add_element (me
, h
);
141 translate the rest symbols vertically by amount DY, but only if
142 they have no staff-position set.
145 Note_column::translate_rests (Grob
*me
, int dy
)
147 Grob
*r
= unsmob_grob (me
->get_object ("rest"));
148 if (r
&& !scm_is_number (r
->get_property ("staff-position")))
150 r
->translate_axis (dy
* Staff_symbol_referencer::staff_space (r
) / 2.0, Y_AXIS
);
151 Grob
*p
= r
->get_parent (Y_AXIS
);
152 p
->flush_extent_cache (Y_AXIS
);
157 Note_column::first_head (Grob
*me
)
159 Grob
*st
= get_stem (me
);
160 return st
? Stem::first_head (st
) : 0;
164 Return the first AccidentalPlacement grob that we find in a note-head.
167 Note_column::accidentals (Grob
*me
)
169 extract_grob_set (me
, "note-heads", heads
);
171 for (vsize i
= 0; i
< heads
.size (); i
++)
174 acc
= h
? unsmob_grob (h
->get_object ("accidental-grob")) : 0;
182 if (Accidental_placement::has_interface (acc
->get_parent (X_AXIS
)))
183 return acc
->get_parent (X_AXIS
);
190 Note_column::dot_column (Grob
*me
)
192 extract_grob_set (me
, "note-heads", heads
);
193 for (vsize i
= 0; i
< heads
.size (); i
++)
195 Grob
*dots
= unsmob_grob (heads
[i
]->get_object ("dot"));
197 return dots
->get_parent (X_AXIS
);
204 Note_column::arpeggio (Grob
*me
)
206 return unsmob_grob (me
->get_object ("arpeggio"));
209 /* If a note-column contains a cross-staff stem then
210 nc->extent (Y_AXIS, refp) will not consider the extent of the stem.
211 If you want the extent of the stem to be included (and you are safe
212 from any cross-staff issues) then call this function instead. */
214 Note_column::cross_staff_extent (Grob
*me
, Grob
*refp
)
216 Interval iv
= me
->extent (refp
, Y_AXIS
);
217 if (Grob
*s
= get_stem (me
))
218 iv
.unite (s
->extent (refp
, Y_AXIS
));
223 ADD_INTERFACE (Note_column
,
224 "Stem and noteheads combined.",