-/*
- stem-tremolo.cc -- implement Stem_tremolo
-
- source file of the GNU LilyPond music typesetter
-
- (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.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 "debug.hh"
+
+#include "spanner.hh"
#include "beam.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
-#include "stem.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 "directional-element-interface.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);
+
+ SCM style = me->get_property ("style");
+
+ if (beam && !scm_is_eq (style, ly_symbol2scm ("constant")))
+ {
+ 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);
-void
-Stem_tremolo::set_interface (Grob *me)
+ Grob *common = s1->common_refpoint (s2, X_AXIS);
+ Real dx = s2->relative_coordinate (common, X_AXIS)
+ - s1->relative_coordinate (common, X_AXIS);
+
+ 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 && !beam)
+ ? 0.40 : 0.25);
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_width, 1)
+SCM
+Stem_tremolo::calc_width (SCM smob)
{
- me->set_interface (ly_symbol2scm ("stem-tremolo"));
+ 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;
+
+ /* beamed stems and up-stems with flags have shorter tremolos */
+ return scm_from_double (((dir == UP && flag) || beam) ? 1.0 : 1.5);
}
-bool
-Stem_tremolo::has_interface (Grob *me)
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_shape, 1)
+SCM
+Stem_tremolo::calc_shape (SCM smob)
{
- return me->has_interface (ly_symbol2scm ("stem-tremolo"));
+ 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;
+ SCM style = me->get_property ("style");
+
+ return ly_symbol2scm (!scm_is_eq (style, ly_symbol2scm ("constant"))
+ && ((dir == UP && flag) || beam)
+ ? "rectangle" : "beam-like");
}
-MAKE_SCHEME_CALLBACK (Stem_tremolo,dim_callback,2);
+Real
+Stem_tremolo::get_beam_translation (Grob *me)
+{
+ Grob *stem = unsmob<Grob> (me->get_object ("stem"));
+ Spanner *beam = Stem::get_beam (stem);
-/*
- todo: init with cons.
- */
+ 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->layout ()->get_dimension (ly_symbol2scm ("blot-diameter"));
+ SCM shape = me->get_property ("shape");
+ if (!scm_is_symbol (shape))
+ shape = ly_symbol2scm ("beam-like");
+
+ width *= ss;
+ thick *= ss;
+
+ Stencil a;
+ if (scm_is_eq (shape, ly_symbol2scm ("rectangle")))
+ a = Lookup::rotated_box (slope, width, thick, blot);
+ else
+ a = Lookup::beam (slope, width, thick, blot);
+
+ 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");
+
+ me->suicide ();
+ return Stencil ();
+ }
+
+ 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 * dir * -1, Y_AXIS);
+ mol.add_stencil (b);
+ }
+ return mol;
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, pure_height, 3);
SCM
-Stem_tremolo::dim_callback (SCM e, SCM)
+Stem_tremolo::pure_height (SCM smob, SCM, SCM)
{
- Grob * se = unsmob_grob (e);
-
- Real space = Staff_symbol_referencer::staff_space (se);
- return ly_interval2scm (Interval (-space, space));
+ 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_y_extent (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);
}
-/*
- ugh ? --from Slur
- */
-MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 2);
+MAKE_SCHEME_CALLBACK (Stem_tremolo, width, 1);
SCM
-Stem_tremolo::height (SCM smob, SCM ax)
+Stem_tremolo::width (SCM smob)
{
- Axis a = (Axis)gh_scm2int (ax);
- Grob * me = unsmob_grob (smob);
- assert (a == Y_AXIS);
+ 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));
+}
- SCM mol = me->get_uncached_molecule ();
- return ly_interval2scm (unsmob_molecule (mol)->extent (a));
+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 *stem = unsmob<Grob> (me->get_object ("stem"));
+ if (!stem)
+ {
+ programming_error ("no stem for stem-tremolo");
+ return Stencil ();
+ }
+
+ Direction dir = get_grob_direction (me);
+
+ bool whole_note = Stem::duration_log (stem) <= 0;
+
+ /* 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);
+}
+
+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));
+}
+
+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));
+}
-MAKE_SCHEME_CALLBACK (Stem_tremolo,brew_molecule,1);
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_direction, 1);
SCM
-Stem_tremolo::brew_molecule (SCM smob)
+Stem_tremolo::calc_direction (SCM smob)
{
- Grob *me= unsmob_grob (smob);
- Grob * stem = unsmob_grob (me->get_grob_property ("stem"));
- Grob * beam = Stem::beam_l (stem);
-
- Real dydx;
- if (beam)
+ 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 && has_interface<Note_collision_interface> (maybe_nc))
{
- Real dy = 0;
- SCM s = beam->get_grob_property ("dy");
- if (gh_number_p (s))
- dy = gh_scm2double (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;
+ 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;
+ }
+ }
}
- else
- // urg
- dydx = 0.25;
+ return scm_from_int (stemdir);
+}
- Real ss = Staff_symbol_referencer::staff_space (stem);
- Real thick = gh_scm2double (me->get_grob_property ("beam-thickness"));
- Real width = gh_scm2double (me->get_grob_property ("beam-width"));
- width *= ss;
- thick *= ss;
-
- Molecule a (Lookup::beam (dydx, width, thick));
- a.translate (Offset (-width/2, width / 2 * dydx));
-
- int tremolo_flags;
- SCM s = me->get_grob_property ("tremolo-flags");
- if (gh_number_p (s))
- tremolo_flags = gh_scm2int (s);
- else
- // huh?
- tremolo_flags = 1;
+Real
+Stem_tremolo::y_offset (Grob *me, bool pure)
+{
+ Item *stem = unsmob<Item> (me->get_object ("stem"));
+ if (!stem)
+ return 0.0;
- int mult = beam ? Beam::get_multiplicity (beam) : 0;
- SCM space_proc = me->get_grob_property ("beam-space-function");
- SCM space = gh_call1 (space_proc, gh_int2scm (mult));
- Real interbeam_f = gh_scm2double (space) * ss;
+ Direction dir = get_grob_direction (me);
+ Spanner *beam = Stem::get_beam (stem);
+ Real beam_translation = get_beam_translation (me);
- Molecule mol;
- for (int i = 0; i < tremolo_flags; i++)
+ int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
+
+ if (pure && beam)
{
- Molecule b (a);
- b.translate_axis (interbeam_f * i, Y_AXIS);
- mol.add_molecule (b);
+ Interval ph = stem->pure_y_extent (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_y_extent (me, 0, INT_MAX).length ();
}
- if (tremolo_flags)
- mol.translate_axis (-mol.extent (Y_AXIS).center (), Y_AXIS);
- if (beam)
+
+ Real end_y
+ = (pure
+ ? stem->pure_y_extent (stem, 0, INT_MAX)[dir]
+ : stem->extent (stem, Y_AXIS)[dir])
+ - dir * max (beam_count, 1) * beam_translation
+ - Stem::beam_end_corrective (stem);
+
+ if (!beam && Stem::duration_log (stem) >= 3)
{
- // ugh, rather calc from Stem_tremolo_req
- int beams_i = Stem::beam_count (stem, RIGHT) >? Stem::beam_count (stem, LEFT);
- mol.translate (Offset (stem->relative_coordinate (0, X_AXIS) - me->relative_coordinate (0, X_AXIS),
- Stem::stem_end_position (stem) * ss / 2 -
- Directional_element_interface::get (beam) * beams_i * interbeam_f));
+ end_y -= dir * (Stem::duration_log (stem) - 2) * beam_translation;
+ if (dir == UP)
+ end_y -= dir * beam_translation * 0.5;
}
- else
- {
- /*
- Beams should intersect one beamthickness below stem end
- */
- Real dy = Stem::stem_end_position (stem) * ss / 2;
- dy -= mol.extent (Y_AXIS).length () / 2 * Stem::get_direction (stem);
-
- /*
- uhg. Should use relative coords and placement
- */
- Real whole_note_correction;
- if (Stem::invisible_b (stem))
- {
- Grob *hed = Stem::support_head (stem);
- whole_note_correction = -Stem::get_direction (stem)
- *hed->extent (hed, X_AXIS).length () / 2;
- }
- else
- whole_note_correction = 0;
-
- mol.translate (Offset (stem->relative_coordinate (0, X_AXIS) - me->relative_coordinate (0, X_AXIS) +
- whole_note_correction, dy));
+
+ 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 mol.smobbed_copy ();
-}
+ return end_y;
+}
-void
-Stem_tremolo::set_stem (Grob*me,Grob *s)
+MAKE_SCHEME_CALLBACK (Stem_tremolo, print, 1);
+SCM
+Stem_tremolo::print (SCM grob)
{
- me->set_grob_property ("stem", s->self_scm ());
+ 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,
+ "A beam slashing a stem to indicate a tremolo. The property"
+ " @code{shape} can be @code{beam-like} or @code{rectangle}.",
+
+ /* properties */
+ "beam-thickness "
+ "beam-width "
+ "direction "
+ "flag-count "
+ "length-fraction "
+ "stem "
+ "shape "
+ "slope "
+ );
projects / lilypond.git / blobdiff