/*
- stem-tremolo.cc -- implement Stem_tremolo
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
#include "stem-tremolo.hh"
#include "directional-element-interface.hh"
#include "item.hh"
#include "lookup.hh"
+#include "note-collision.hh"
+#include "note-column.hh"
#include "output-def.hh"
#include "staff-symbol-referencer.hh"
#include "stem.hh"
#include "warn.hh"
-/* TODO: lengthen stem if necessary */
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_slope, 1)
+SCM
+Stem_tremolo::calc_slope (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Grob *stem = unsmob_grob (me->get_object ("stem"));
+ Spanner *beam = Stem::get_beam (stem);
+
+ if (beam)
+ {
+ Real dy = 0;
+ SCM s = beam->get_property ("quantized-positions");
+ if (is_number_pair (s))
+ dy = - scm_to_double (scm_car (s)) + scm_to_double (scm_cdr (s));
+
+ Grob *s2 = Beam::last_normal_stem (beam);
+ Grob *s1 = Beam::first_normal_stem (beam);
-MAKE_SCHEME_CALLBACK (Stem_tremolo, dim_callback, 2);
+ Grob *common = s1->common_refpoint (s2, X_AXIS);
+ Real dx = s2->relative_coordinate (common, X_AXIS)
+ - s1->relative_coordinate (common, X_AXIS);
-/* todo: init with cons. */
+ return scm_from_double (dx ? dy / dx : 0);
+ }
+ else
+ /* down stems with flags should have more sloped trems (helps avoid
+ flag/stem collisions without making the stem very long) */
+ return scm_from_double ((Stem::duration_log (stem) >= 3 && get_grob_direction (me) == DOWN)
+ ? 0.40 : 0.25);
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_width, 1)
SCM
-Stem_tremolo::dim_callback (SCM e, SCM)
+Stem_tremolo::calc_width (SCM smob)
{
- Grob *se = unsmob_grob (e);
+ Grob *me = unsmob_grob (smob);
+ Grob *stem = unsmob_grob (me->get_object ("stem"));
+ Direction dir = get_grob_direction (me);
+ bool beam = Stem::get_beam (stem);
+ bool flag = Stem::duration_log (stem) >= 3 && !beam;
- Real space = Staff_symbol_referencer::staff_space (se);
- return ly_interval2scm (Interval (-space, space));
+ /* beamed stems and up-stems with flags have shorter tremolos */
+ return scm_from_double (((dir == UP && flag) || beam) ? 1.0 : 1.5);
}
-/* ugh ? --from Slur */
-MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 2);
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_style, 1)
SCM
-Stem_tremolo::height (SCM smob, SCM ax)
+Stem_tremolo::calc_style (SCM smob)
{
- Axis a = (Axis)scm_to_int (ax);
Grob *me = unsmob_grob (smob);
- assert (a == Y_AXIS);
-
- SCM mol = me->get_uncached_stencil ();
+ Grob *stem = unsmob_grob (me->get_object ("stem"));
+ Direction dir = get_grob_direction (me);
+ bool beam = Stem::get_beam (stem);
+ bool flag = Stem::duration_log (stem) >= 3 && !beam;
- if (Stencil *m = unsmob_stencil (mol))
- return ly_interval2scm (m->extent (a));
- else
- return ly_interval2scm (Interval ());
+ return ly_symbol2scm (((dir == UP && flag) || beam) ? "rectangle" : "default");
}
-Stencil
-Stem_tremolo::raw_stencil (Grob *me)
+Real
+Stem_tremolo::get_beam_translation (Grob *me)
{
Grob *stem = unsmob_grob (me->get_object ("stem"));
Spanner *beam = Stem::get_beam (stem);
- Real dydx;
- if (beam)
- {
- Real dy = 0;
- SCM s = beam->get_property ("positions");
- if (is_number_pair (s))
- dy = -scm_to_double (scm_car (s)) +scm_to_double (scm_cdr (s));
- Real dx = Beam::last_visible_stem (beam)->relative_coordinate (0, X_AXIS)
- - Beam::first_visible_stem (beam)->relative_coordinate (0, X_AXIS);
- dydx = dx ? dy / dx : 0;
- }
- else
- // urg
- dydx = 0.25;
+ return (beam && beam->is_live ())
+ ? Beam::get_beam_translation (beam)
+ : (Staff_symbol_referencer::staff_space (me)
+ * robust_scm2double (me->get_property ("length-fraction"), 1.0) * 0.81);
+}
+Stencil
+Stem_tremolo::raw_stencil (Grob *me, Real slope, Direction dir)
+{
Real ss = Staff_symbol_referencer::staff_space (me);
Real thick = robust_scm2double (me->get_property ("beam-thickness"), 1);
Real width = robust_scm2double (me->get_property ("beam-width"), 1);
- Real blot = me->get_layout ()->get_dimension (ly_symbol2scm ("blotdiameter"));
+ Real blot = me->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+ SCM style = me->get_property ("style");
+ if (!scm_is_symbol (style))
+ style = ly_symbol2scm ("default");
width *= ss;
thick *= ss;
- Stencil a (Lookup::beam (dydx, width, thick, blot));
- a.translate (Offset (-width * 0.5, width * 0.5 * dydx));
+ Stencil a;
+ if (style == ly_symbol2scm ("rectangle"))
+ a = Lookup::rotated_box (slope, width, thick, blot);
+ else
+ a = Lookup::beam (slope, width, thick, blot);
- int tremolo_flags = 0;
- SCM s = me->get_property ("flag-count");
- if (scm_is_number (s))
- tremolo_flags = scm_to_int (s);
+ a.align_to (X_AXIS, CENTER);
+ a.align_to (Y_AXIS, CENTER);
+ int tremolo_flags = robust_scm2int (me->get_property ("flag-count"), 0);
if (!tremolo_flags)
{
programming_error ("no tremolo flags");
return Stencil ();
}
- /* Who the fuck is 0.81 ? --hwn. */
- Real beam_translation = beam ? Beam::get_beam_translation (beam) : 0.81;
+ Real beam_translation = get_beam_translation (me);
Stencil mol;
for (int i = 0; i < tremolo_flags; i++)
{
Stencil b (a);
- b.translate_axis (beam_translation * i, Y_AXIS);
+ b.translate_axis (beam_translation * i * dir * -1, Y_AXIS);
mol.add_stencil (b);
}
return mol;
}
-MAKE_SCHEME_CALLBACK (Stem_tremolo, print, 1);
+MAKE_SCHEME_CALLBACK (Stem_tremolo, pure_height, 3);
SCM
-Stem_tremolo::print (SCM grob)
+Stem_tremolo::pure_height (SCM smob, SCM, SCM)
+{
+ Item *me = unsmob_item (smob);
+
+ /*
+ Cannot use the real slope, since it looks at the Beam.
+ */
+ Stencil s1 (untranslated_stencil (me, 0.35));
+ Item *stem = unsmob_item (me->get_object ("stem"));
+ if (!stem)
+ return ly_interval2scm (s1.extent (Y_AXIS));
+
+ Direction dir = get_grob_direction (me);
+
+ Spanner *beam = Stem::get_beam (stem);
+
+ if (!beam)
+ return ly_interval2scm (s1.extent (Y_AXIS));
+
+ Interval ph = stem->pure_height (stem, 0, INT_MAX);
+ Stem_info si = Stem::get_stem_info (stem);
+ ph[-dir] = si.shortest_y_;
+ int beam_count = Stem::beam_multiplicity (stem).length () + 1;
+ Real beam_translation = get_beam_translation (me);
+
+ ph = ph - dir * max (beam_count, 1) * beam_translation;
+ ph = ph - ph.center ();
+
+ return ly_interval2scm (ph);
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, width, 1);
+SCM
+Stem_tremolo::width (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+
+ /*
+ Cannot use the real slope, since it looks at the Beam.
+ */
+ Stencil s1 (untranslated_stencil (me, 0.35));
+
+ return ly_interval2scm (s1.extent (X_AXIS));
+}
+
+Real
+Stem_tremolo::vertical_length (Grob *me)
+{
+ return untranslated_stencil (me, 0.35).extent (Y_AXIS).length ();
+}
+
+Stencil
+Stem_tremolo::untranslated_stencil (Grob *me, Real slope)
{
- Grob *me = unsmob_grob (grob);
Grob *stem = unsmob_grob (me->get_object ("stem"));
if (!stem)
{
programming_error ("no stem for stem-tremolo");
- return SCM_EOL;
+ return Stencil ();
}
- Spanner *beam = Stem::get_beam (stem);
- Direction stemdir = Stem::get_direction (stem);
- if (stemdir == 0)
- stemdir = UP;
+ Direction dir = get_grob_direction (me);
- Real beam_translation
- = (beam && beam->is_live ())
- ? Beam::get_beam_translation (beam)
- : 0.81;
+ bool whole_note = Stem::duration_log (stem) <= 0;
- Stencil mol = raw_stencil (me);
- Interval mol_ext = mol.extent (Y_AXIS);
- Real ss = Staff_symbol_referencer::staff_space (me);
+ /* for a whole note, we position relative to the notehead, so we want the
+ stencil aligned on the flag closest to the head */
+ Direction stencil_dir = whole_note ? -dir : dir;
+ return raw_stencil (me, slope, stencil_dir);
+}
- // ugh, rather calc from Stem_tremolo_req
- int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_y_offset, 1);
+SCM
+Stem_tremolo::calc_y_offset (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ return scm_from_double (y_offset (me, false));
+}
- Real beamthickness = 0.0;
- SCM sbt = (beam) ? beam->get_property ("thickness") : SCM_EOL;
- if (scm_is_number (sbt))
- beamthickness = scm_to_double (sbt) * ss;
+MAKE_SCHEME_CALLBACK (Stem_tremolo, pure_calc_y_offset, 3);
+SCM
+Stem_tremolo::pure_calc_y_offset (SCM smob,
+ SCM, /* start */
+ SCM /* end */)
+{
+ Grob *me = unsmob_grob (smob);
+ return scm_from_double (y_offset (me, true));
+}
- Real end_y
- = Stem::stem_end_position (stem) * ss / 2
- - stemdir * (beam_count * beamthickness
- + (max (beam_count -1, 0) * beam_translation));
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_direction, 1);
+SCM
+Stem_tremolo::calc_direction (SCM smob)
+{
+ Item *me = unsmob_item (smob);
+
+ Item *stem = unsmob_item (me->get_object ("stem"));
+ if (!stem)
+ return scm_from_int (CENTER);
+
+ Direction stemdir = get_grob_direction (stem);
+
+ vector<int> nhp = Stem::note_head_positions (stem);
+ /*
+ * We re-decide stem-dir if there may be collisions with other
+ * note heads in the staff.
+ */
+ Grob *maybe_nc = stem->get_parent (X_AXIS)->get_parent (X_AXIS);
+ bool whole_note = Stem::duration_log (stem) <= 0;
+ if (whole_note && Note_collision_interface::has_interface (maybe_nc))
+ {
+ Drul_array<bool> avoid_me (false, false);
+ vector<int> all_nhps = Note_collision_interface::note_head_positions (maybe_nc);
+ if (all_nhps[0] < nhp[0])
+ avoid_me[DOWN] = true;
+ if (all_nhps.back () > nhp.back ())
+ avoid_me[UP] = true;
+ if (avoid_me[stemdir])
+ {
+ stemdir = -stemdir;
+ if (avoid_me[stemdir])
+ {
+ me->warning ("Whole-note tremolo may collide with simultaneous notes.");
+ stemdir = -stemdir;
+ }
+ }
+ }
+ return scm_from_int (stemdir);
+}
- /* FIXME: the 0.33 ss is to compensate for the size of the note head. */
- Real chord_start_y = Stem::chord_start_y (stem) + 0.33 * ss * stemdir;
+Real
+Stem_tremolo::y_offset (Grob *me, bool pure)
+{
+ Item *stem = unsmob_item (me->get_object ("stem"));
+ if (!stem)
+ return 0.0;
+
+ Direction dir = get_grob_direction (me);
+
+ Spanner *beam = Stem::get_beam (stem);
+ Real beam_translation = get_beam_translation (me);
+
+ int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
+
+ if (pure && beam)
+ {
+ Interval ph = stem->pure_height (stem, 0, INT_MAX);
+ Stem_info si = Stem::get_stem_info (stem);
+ ph[-dir] = si.shortest_y_;
+
+ return (ph - dir * max (beam_count, 1) * beam_translation)[dir] - dir * 0.5 * me->pure_height (me, 0, INT_MAX).length ();
+ }
- Real padding = beam_translation;
+ Real end_y
+ = (pure
+ ? stem->pure_height (stem, 0, INT_MAX)[dir]
+ : stem->extent (stem, Y_AXIS)[dir])
+ - dir * max (beam_count, 1) * beam_translation
+ - Stem::beam_end_corrective (stem);
- /* if there is a flag, just above/below the notehead.
- if there is not enough space, center on remaining space,
- else one beamspace away from stem end. */
if (!beam && Stem::duration_log (stem) >= 3)
{
- mol.align_to (Y_AXIS, -stemdir);
- mol.translate_axis (chord_start_y + 0.5 * stemdir, Y_AXIS);
+ end_y -= dir * (Stem::duration_log (stem) - 2) * beam_translation;
+ if (dir == UP)
+ end_y -= dir * beam_translation * 0.5;
}
- else if (stemdir * (end_y - chord_start_y) - 2 * padding - mol_ext.length ()
- < 0.0)
- mol.translate_axis (0.5 * (end_y + chord_start_y) - mol_ext.center (),
- Y_AXIS);
- else
- mol.translate_axis (end_y - stemdir * beam_translation -mol_ext [stemdir],
- Y_AXIS);
- return mol.smobbed_copy ();
+ bool whole_note = Stem::duration_log (stem) <= 0;
+ if (whole_note || isinf(end_y))
+ {
+ /* we shouldn't position relative to the end of the stem since the stem
+ is invisible */
+ Real ss = Staff_symbol_referencer::staff_space (me);
+ vector<int> nhp = Stem::note_head_positions (stem);
+ Real note_head = (dir == UP ? nhp.back () : nhp[0]) * ss / 2;
+ end_y = note_head + dir * 1.5;
+ }
+
+ return end_y;
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, print, 1);
+SCM
+Stem_tremolo::print (SCM grob)
+{
+ Grob *me = unsmob_grob (grob);
+
+ Stencil s = untranslated_stencil (me, robust_scm2double (me->get_property ("slope"), 0.25));
+ return s.smobbed_copy ();
}
-ADD_INTERFACE (Stem_tremolo, "stem-tremolo-interface",
- "A beam slashing a stem to indicate a tremolo.",
- "stem beam-width beam-thickness flag-count");
+ADD_INTERFACE (Stem_tremolo,
+ "A beam slashing a stem to indicate a tremolo. The property"
+ " @code{style} can be @code{default} or @code{rectangle}.",
+
+ /* properties */
+ "beam-thickness "
+ "beam-width "
+ "direction "
+ "flag-count "
+ "length-fraction "
+ "stem "
+ "style "
+ "slope "
+ );
projects / lilypond.git / blobdiff