Use scalar instead of embedded_scm for context mod overrides.
[lilypond/mpolesky.git] / lily / stem-tremolo.cc
blobce9e3529b693746d51eea7ba6b75119f308b6a4a
1 /*
2 stem-tremolo.cc -- implement Stem_tremolo
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 */
9 #include "stem-tremolo.hh"
11 #include "spanner.hh"
12 #include "beam.hh"
13 #include "directional-element-interface.hh"
14 #include "item.hh"
15 #include "lookup.hh"
16 #include "output-def.hh"
17 #include "staff-symbol-referencer.hh"
18 #include "stem.hh"
19 #include "warn.hh"
21 MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_slope, 1)
22 SCM
23 Stem_tremolo::calc_slope (SCM smob)
25 Grob *me = unsmob_grob (smob);
26 Grob *stem = unsmob_grob (me->get_object ("stem"));
27 Spanner *beam = Stem::get_beam (stem);
29 if (beam)
31 Real dy = 0;
32 SCM s = beam->get_property ("quantized-positions");
33 if (is_number_pair (s))
34 dy = - scm_to_double (scm_car (s)) + scm_to_double (scm_cdr (s));
36 Grob *s2 = Beam::last_normal_stem (beam);
37 Grob *s1 = Beam::first_normal_stem (beam);
39 Grob *common = s1->common_refpoint (s2, X_AXIS);
40 Real dx = s2->relative_coordinate (common, X_AXIS) -
41 s1->relative_coordinate (common, X_AXIS);
43 return scm_from_double (dx ? dy / dx : 0);
45 else
46 /* down stems with flags should have more sloped trems (helps avoid
47 flag/stem collisions without making the stem very long) */
48 return scm_from_double (
49 (Stem::duration_log (stem) >= 3 && get_grob_direction (stem) == DOWN) ?
50 0.40 : 0.25);
53 MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_width, 1)
54 SCM
55 Stem_tremolo::calc_width (SCM smob)
57 Grob *me = unsmob_grob (smob);
58 Grob *stem = unsmob_grob (me->get_object ("stem"));
59 Direction stemdir = get_grob_direction (stem);
60 bool beam = Stem::get_beam (stem);
61 bool flag = Stem::duration_log (stem) >= 3 && !beam;
63 /* beamed stems and up-stems with flags have shorter tremolos */
64 return scm_from_double (((stemdir == UP && flag) || beam)? 1.0 : 1.5);
67 MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_style, 1)
68 SCM
69 Stem_tremolo::calc_style (SCM smob)
71 Grob *me = unsmob_grob (smob);
72 Grob *stem = unsmob_grob (me->get_object ("stem"));
73 Direction stemdir = get_grob_direction (stem);
74 bool beam = Stem::get_beam (stem);
75 bool flag = Stem::duration_log (stem) >= 3 && !beam;
77 return ly_symbol2scm (((stemdir == UP && flag) || beam) ? "rectangle" : "default");
80 Real
81 Stem_tremolo::get_beam_translation (Grob *me)
83 Grob *stem = unsmob_grob (me->get_object ("stem"));
84 Spanner *beam = Stem::get_beam (stem);
86 return (beam && beam->is_live ())
87 ? Beam::get_beam_translation (beam)
88 : (Staff_symbol_referencer::staff_space (me)
89 * robust_scm2double (me->get_property ("length-fraction"), 1.0) * 0.81);
92 Stencil
93 Stem_tremolo::raw_stencil (Grob *me, Real slope, Direction stemdir)
95 Real ss = Staff_symbol_referencer::staff_space (me);
96 Real thick = robust_scm2double (me->get_property ("beam-thickness"), 1);
97 Real width = robust_scm2double (me->get_property ("beam-width"), 1);
98 Real blot = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
99 SCM style = me->get_property ("style");
100 if (!scm_is_symbol (style))
101 style = ly_symbol2scm ("default");
103 width *= ss;
104 thick *= ss;
106 Stencil a;
107 if (style == ly_symbol2scm ("rectangle"))
108 a = Lookup::rotated_box (slope, width, thick, blot);
109 else
110 a = Lookup::beam (slope, width, thick, blot);
112 a.align_to (X_AXIS, CENTER);
113 a.align_to (Y_AXIS, CENTER);
115 int tremolo_flags = robust_scm2int (me->get_property ("flag-count"), 0);
116 if (!tremolo_flags)
118 programming_error ("no tremolo flags");
120 me->suicide ();
121 return Stencil ();
124 Real beam_translation = get_beam_translation (me);
126 Stencil mol;
127 for (int i = 0; i < tremolo_flags; i++)
129 Stencil b (a);
130 b.translate_axis (beam_translation * i * stemdir * -1, Y_AXIS);
131 mol.add_stencil (b);
133 return mol;
138 MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 1);
140 Stem_tremolo::height (SCM smob)
142 Grob *me = unsmob_grob (smob);
145 Cannot use the real slope, since it looks at the Beam.
147 Stencil s1 (translated_stencil (me, 0.35));
149 return ly_interval2scm (s1.extent (Y_AXIS));
152 MAKE_SCHEME_CALLBACK (Stem_tremolo, width, 1);
154 Stem_tremolo::width (SCM smob)
156 Grob *me = unsmob_grob (smob);
159 Cannot use the real slope, since it looks at the Beam.
161 Stencil s1 (untranslated_stencil (me, 0.35));
163 return ly_interval2scm (s1.extent (X_AXIS));
166 Real
167 Stem_tremolo::vertical_length (Grob *me)
169 return untranslated_stencil (me, 0.35).extent (Y_AXIS).length ();
172 Stencil
173 Stem_tremolo::untranslated_stencil (Grob *me, Real slope)
175 Grob *stem = unsmob_grob (me->get_object ("stem"));
176 if (!stem)
178 programming_error ("no stem for stem-tremolo");
179 return Stencil ();
182 Direction stemdir = get_grob_direction (stem);
183 if (!stemdir)
184 stemdir = UP;
186 bool whole_note = Stem::duration_log (stem) <= 0;
188 /* for a whole note, we position relative to the notehead, so we want the
189 stencil aligned on the flag closest to the head */
190 Direction stencil_dir = whole_note ? -stemdir : stemdir;
191 return raw_stencil (me, slope, stencil_dir);
195 Stencil
196 Stem_tremolo::translated_stencil (Grob *me, Real slope)
198 Stencil mol = untranslated_stencil (me, slope);
200 Grob *stem = unsmob_grob (me->get_object ("stem"));
201 if (!stem)
202 return Stencil ();
204 Direction stemdir = get_grob_direction (stem);
205 if (stemdir == 0)
206 stemdir = UP;
208 Spanner *beam = Stem::get_beam (stem);
209 Real beam_translation = get_beam_translation (me);
211 int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
212 Real ss = Staff_symbol_referencer::staff_space (me);
214 Real end_y
215 = Stem::stem_end_position (stem) * ss / 2
216 - stemdir * max (beam_count, 1) * beam_translation;
218 if (!beam && Stem::duration_log (stem) >= 3)
220 end_y -= stemdir * (Stem::duration_log (stem) - 2) * beam_translation;
221 if (stemdir == UP)
222 end_y -= stemdir * beam_translation * 0.5;
225 bool whole_note = Stem::duration_log (stem) <= 0;
226 if (whole_note)
228 /* we shouldn't position relative to the end of the stem since the stem
229 is invisible */
230 vector<int> nhp = Stem::note_head_positions (stem);
231 Real note_head = (stemdir == UP ? nhp.back () : nhp[0]) * ss / 2;
232 end_y = note_head + stemdir * 1.5;
234 mol.translate_axis (end_y, Y_AXIS);
236 return mol;
239 MAKE_SCHEME_CALLBACK (Stem_tremolo, print, 1);
241 Stem_tremolo::print (SCM grob)
243 Grob *me = unsmob_grob (grob);
245 Stencil s = translated_stencil (me, robust_scm2double (me->get_property ("slope"), 0.25));
246 return s.smobbed_copy ();
249 ADD_INTERFACE (Stem_tremolo,
250 "A beam slashing a stem to indicate a tremolo. The property"
251 " @code{style} can be @code{default} or @code{rectangle}.",
253 /* properties */
254 "beam-thickness "
255 "beam-width "
256 "flag-count "
257 "length-fraction "
258 "stem "
259 "style "
260 "slope "