]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem-tremolo.cc
Run `make grand-replace'.
[lilypond.git] / lily / stem-tremolo.cc
index 9a0fb6f1714be67f415f42ab7fcdd5dde7d9c15e..4c722c915dbf143c27805d2f2833a13ceebdcca9 100644 (file)
-/*   
-  stem-tremolo.cc --  implement Stem_tremolo
-  
+/*
+  stem-tremolo.cc -- implement Stem_tremolo
+
   source file of the GNU LilyPond music typesetter
-  
-  (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
 #include "stem-tremolo.hh"
-#include "warn.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 "output-def.hh"
 #include "staff-symbol-referencer.hh"
-#include "directional-element-interface.hh"
-
-/*
-  TODO:
-    lengthen stem if necessary
- */
-MAKE_SCHEME_CALLBACK (Stem_tremolo,dim_callback,2);
+#include "stem.hh"
+#include "warn.hh"
 
-/*
-  todo: init with cons. 
- */
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_slope, 1)
 SCM
-Stem_tremolo::dim_callback (SCM e, SCM)
+Stem_tremolo::calc_slope (SCM smob)
 {
-  Grob * se = unsmob_grob (e);
-  
-  Real space = Staff_symbol_referencer::staff_space (se);
-  return ly_interval2scm (Interval (-space, space));
+  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);
+      
+      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 (stem) == DOWN) ?
+          0.40 : 0.25);
 }
 
-/*
-  ugh ?  --from Slur
- */
-MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 2);
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_width, 1)
 SCM
-Stem_tremolo::height (SCM smob, SCM ax)
+Stem_tremolo::calc_width (SCM smob)
 {
-  Axis a = (Axis)gh_scm2int (ax);
-  Grob * me = unsmob_grob (smob);
-  assert (a == Y_AXIS);
-
-  SCM mol = me->get_uncached_molecule ();
+  Grob *me = unsmob_grob (smob);
+  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Direction stemdir = get_grob_direction (stem);
+  bool beam = Stem::get_beam (stem);
+  bool flag = Stem::duration_log (stem) >= 3 && !beam;
 
-  if (Molecule *m = unsmob_molecule (mol))
-    return ly_interval2scm (m->extent (a));
-  else
-    return ly_interval2scm (Interval());
+  /* beamed stems and up-stems with flags have shorter tremolos */
+  return scm_from_double (((stemdir == UP && flag) || beam)? 1.0 : 1.5);
 }
 
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_style, 1)
+SCM
+Stem_tremolo::calc_style (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Direction stemdir = get_grob_direction (stem);
+  bool beam = Stem::get_beam (stem);
+  bool flag = Stem::duration_log (stem) >= 3 && !beam;
+
+  return ly_symbol2scm (((stemdir == UP && flag) || beam) ? "rectangle" : "default");
+}
 
-Molecule
-Stem_tremolo::raw_molecule (Grob *me)
+Real
+Stem_tremolo::get_beam_translation (Grob *me)
 {
-  Grob *stem = unsmob_grob (me->get_grob_property ("stem"));
-  Grob *beam = Stem::get_beam (stem);
-  
-  Real dydx;
-  if (beam)
-    {
-      Real dy = 0;
-      SCM s = beam->get_grob_property ("positions");
-      if (is_number_pair (s))
-       {
-         dy = -gh_scm2double (gh_car (s)) +gh_scm2double (gh_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;
+  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Spanner *beam = Stem::get_beam (stem);
+
+  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 stemdir)
+{
   Real ss = Staff_symbol_referencer::staff_space (me);
-  Real thick = robust_scm2double (me->get_grob_property ("beam-thickness"),1);
-  Real width = robust_scm2double (me->get_grob_property ("beam-width"),1);
-  Real blot = me->get_paper ()->get_realvar (ly_symbol2scm ("blotdiameter"));
+  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 style = me->get_property ("style");
+  if (!scm_is_symbol (style))
+    style = ly_symbol2scm ("default");
 
   width *= ss;
   thick *= ss;
-  
-  Molecule a (Lookup::beam (dydx, width, thick, blot));
-  a.translate (Offset (-width/2, width / 2 * dydx));
-  
-  int tremolo_flags = 0;
-  SCM s = me->get_grob_property ("flag-count");
-  if (gh_number_p (s))
-    tremolo_flags = gh_scm2int (s);
 
+  Stencil a;
+  if (style == 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?");
+      programming_error ("no tremolo flags");
 
-      me->suicide();
-      return Molecule ();
+      me->suicide ();
+      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);
 
-  Molecule mol; 
+  Stencil mol;
   for (int i = 0; i < tremolo_flags; i++)
     {
-      Molecule b (a);
-      b.translate_axis (beam_translation * i, Y_AXIS);
-      mol.add_molecule (b);
+      Stencil b (a);
+      b.translate_axis (beam_translation * i * stemdir * -1, Y_AXIS);
+      mol.add_stencil (b);
     }
   return mol;
 }
 
 
-MAKE_SCHEME_CALLBACK (Stem_tremolo,brew_molecule,1);
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 1);
 SCM
-Stem_tremolo::brew_molecule (SCM grob) 
+Stem_tremolo::height (SCM smob)
 {
-  Grob *me = unsmob_grob (grob);
-  Grob *stem = unsmob_grob (me->get_grob_property ("stem"));
-  Grob *beam = Stem::get_beam (stem);
-  Direction stemdir = Stem::get_direction (stem);
-  Real beam_translation
-    = (beam && beam->live ())
-    ? Beam::get_beam_translation (beam)
-    : 0.81;
+  Grob *me = unsmob_grob (smob);
 
-  Molecule mol = raw_molecule (me);
-  Interval mol_ext = mol.extent (Y_AXIS);
-  Real ss = Staff_symbol_referencer::staff_space (me);
+  /*
+    Cannot use the real slope, since it looks at the Beam.
+   */
+  Stencil s1 (translated_stencil (me, 0.35));
 
-  // ugh, rather calc from Stem_tremolo_req
-  int beam_count = (beam) ? (Stem::beam_multiplicity (stem).length () + 1): 0;
+  return ly_interval2scm (s1.extent (Y_AXIS));
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, width, 1);
+SCM
+Stem_tremolo::width (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
 
   /*
-    TODO.
+    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 beamthickness = 0.0;
-  SCM sbt = (beam) ? beam->get_grob_property ("thickness") : SCM_EOL ;
-  if (gh_number_p (sbt))
+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)
     {
-      beamthickness = gh_scm2double (sbt) * ss;
+      programming_error ("no stem for stem-tremolo");
+      return Stencil ();
     }
 
-  Real end_y
-    = Stem::stem_end_position (stem) *ss/2 
-    - stemdir * (beam_count * beamthickness
-                + ((beam_count -1) >? 0) * beam_translation);
+  Direction stemdir = get_grob_direction (stem);
+  if (!stemdir)
+    stemdir = UP;
 
-  /*
-    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;
+  bool whole_note = Stem::duration_log (stem) <= 0;
 
-  Real padding = beam_translation;
+  /* 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 ? -stemdir : stemdir;
+  return raw_stencil (me, slope, stencil_dir);
+}
+
+  
+Stencil
+Stem_tremolo::translated_stencil (Grob *me, Real slope)
+{
+  Stencil mol = untranslated_stencil (me, slope);
+
+  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  if (!stem)
+    return Stencil ();
+  
+  Direction stemdir = get_grob_direction (stem);
+  if (stemdir == 0)
+    stemdir = UP;
+
+  Spanner *beam = Stem::get_beam (stem);
+  Real beam_translation = get_beam_translation (me);
+
+  int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
+  Real ss = Staff_symbol_referencer::staff_space (me);
+
+  Real end_y
+    = Stem::stem_end_position (stem) * ss / 2
+    - stemdir * max (beam_count, 1) * beam_translation;
 
-  /*
-    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 + .5 * stemdir, Y_AXIS);
-    }
-  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);
+      end_y -= stemdir * (Stem::duration_log (stem) - 2) * beam_translation;
+      if (stemdir == UP)
+        end_y -= stemdir * beam_translation * 0.5;
     }
-  else
+
+  bool whole_note = Stem::duration_log (stem) <= 0;
+  if (whole_note)
     {
-      mol.translate_axis (end_y - stemdir * beam_translation
-                         -mol_ext [stemdir]
-                         , Y_AXIS);
+      /* we shouldn't position relative to the end of the stem since the stem
+         is invisible */
+      vector<int> nhp = Stem::note_head_positions (stem);
+      Real note_head = (stemdir == UP ? nhp.back () : nhp[0]) * ss / 2;
+      end_y = note_head + stemdir * 1.5;
     }
-  
-  return mol.smobbed_copy ();
-}
+  mol.translate_axis (end_y, Y_AXIS);
 
+  return mol;
+}
 
-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 = translated_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{style} can be @code{default} or @code{rectangle}.",
 
-ADD_INTERFACE (Stem_tremolo,"stem-tremolo-interface",
-  "",
-  "stem beam-width beam-thickness flag-count");
+               /* properties */
+              "beam-thickness "
+              "beam-width "
+              "flag-count "
+              "length-fraction "
+              "stem "
+               "style "
+              "slope "
+              );