]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/arpeggio.cc
Issue 5168 Let arpeggio-bracket/slur depend on grob-property thickness
[lilypond.git] / lily / arpeggio.cc
index 80858426bc6eb43bc7f12e2f77a83aec4351d8b3..3f0d32fe81149baf362cf25e2ebc6126a9f4d1a5 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  arpeggio.cc -- implement Arpeggio
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2000--2015 Jan Nieuwenhuizen <janneke@gnu.org>
 
-  (c) 2000--2007 Jan Nieuwenhuizen <janneke@gnu.org>
+  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 "arpeggio.hh"
@@ -11,6 +22,7 @@
 #include "bezier.hh"
 #include "font-interface.hh"
 #include "grob.hh"
+#include "international.hh"
 #include "lookup.hh"
 #include "output-def.hh"
 #include "pointer-group-interface.hh"
 #include "stem.hh"
 #include "warn.hh"
 
+static Stencil
+get_squiggle (Grob *me)
+{
+  Font_metric *fm = Font_interface::get_default_font (me);
+  Stencil squiggle = fm->find_by_name ("scripts.arpeggio");
+
+  return squiggle;
+}
+
 Grob *
 Arpeggio::get_common_y (Grob *me)
 {
@@ -29,19 +50,42 @@ Arpeggio::get_common_y (Grob *me)
     {
       Grob *stem = stems[i];
       common = common->common_refpoint (Staff_symbol_referencer::get_staff_symbol (stem),
-                                       Y_AXIS);
+                                        Y_AXIS);
     }
 
   return common;
 }
 
-MAKE_SCHEME_CALLBACK(Arpeggio, calc_positions, 1);
+MAKE_SCHEME_CALLBACK (Arpeggio, calc_cross_staff, 1);
+SCM
+Arpeggio::calc_cross_staff (SCM grob)
+{
+  Grob *me = unsmob<Grob> (grob);
+
+  extract_grob_set (me, "stems", stems);
+  Grob *vag = 0;
+
+  for (vsize i = 0; i < stems.size (); i++)
+    {
+      if (!i)
+        vag = Grob::get_vertical_axis_group (stems[i]);
+      else
+        {
+          if (vag != Grob::get_vertical_axis_group (stems[i]))
+            return SCM_BOOL_T;
+        }
+    }
+
+  return SCM_BOOL_F;
+}
+
+MAKE_SCHEME_CALLBACK (Arpeggio, calc_positions, 1);
 SCM
 Arpeggio::calc_positions (SCM grob)
 {
-  Grob *me = unsmob_grob (grob);
+  Grob *me = unsmob<Grob> (grob);
   Grob *common = get_common_y (me);
-  
+
   /*
     TODO:
 
@@ -58,13 +102,12 @@ Arpeggio::calc_positions (SCM grob)
       Grob *stem = stems[i];
       Grob *ss = Staff_symbol_referencer::get_staff_symbol (stem);
       Interval iv = Stem::head_positions (stem);
-      iv *= Staff_symbol::staff_space (ss) / 2.0;
-
-      heads.unite (iv + ss->relative_coordinate (common, Y_AXIS)
-                  - my_y);
+      iv *= Staff_symbol_referencer::staff_space (me) / 2.0;
+      Real staff_y = ss ? ss->relative_coordinate (common, Y_AXIS) : 0.0;
+      heads.unite (iv + staff_y - my_y);
     }
 
-  heads *= 1/Staff_symbol_referencer::staff_space(me);
+  heads *= 1 / Staff_symbol_referencer::staff_space (me);
 
   return ly_interval2scm (heads);
 }
@@ -73,19 +116,29 @@ MAKE_SCHEME_CALLBACK (Arpeggio, print, 1);
 SCM
 Arpeggio::print (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Interval heads = robust_scm2interval (me->get_property ("positions"),
-                                       Interval())
-    * Staff_symbol_referencer::staff_space (me);
-  
+                                        Interval ())
+                   * Staff_symbol_referencer::staff_space (me);
+
   if (heads.is_empty () || heads.length () < 0.5)
     {
-      if (!to_boolean (me->get_property ("transparent")))
-       {
-         me->warning ("no heads for arpeggio found?");
-         me->suicide ();
-       }
-      return SCM_EOL;
+      if (to_boolean (me->get_property ("transparent")))
+        {
+          /*
+            This is part of a cross-staff/-voice span-arpeggio,
+            so we need to ensure `heads' is large enough to encompass
+            a single trill-element since the span-arpeggio depends on
+            its children to prevent collisions.
+          */
+          heads.unite (get_squiggle (me).extent (Y_AXIS));
+        }
+      else
+        {
+          me->warning (_ ("no heads for arpeggio found?"));
+          me->suicide ();
+          return SCM_EOL;
+        }
     }
 
   SCM ad = me->get_property ("arpeggio-direction");
@@ -94,18 +147,27 @@ Arpeggio::print (SCM smob)
     dir = to_dir (ad);
 
   Stencil mol;
-  Font_metric *fm = Font_interface::get_default_font (me);
-  Stencil squiggle = fm->find_by_name ("scripts.arpeggio");
+  Stencil squiggle (get_squiggle (me));
+
+  /*
+    Compensate for rounding error which may occur when a chord
+    reaches the center line, resulting in an extra squiggle
+    being added to the arpeggio stencil.  This value is appreciably
+    larger than the rounding error, which is in the region of 1e-16
+    for a global-staff-size of 20, but small enough that it does not
+    interfere with smaller staff sizes.
+  */
+  const Real epsilon = 1e-3;
 
   Stencil arrow;
   if (dir)
     {
-      arrow = fm->find_by_name ("scripts.arpeggio.arrow." + to_string (dir));
+      Font_metric *fm = Font_interface::get_default_font (me);
+      arrow = fm->find_by_name ("scripts.arpeggio.arrow." + ::to_string (dir));
       heads[dir] -= dir * arrow.extent (Y_AXIS).length ();
     }
 
-  for (Real y = heads[LEFT]; y < heads[RIGHT];
-       y += squiggle.extent (Y_AXIS).length ())
+  while (mol.extent (Y_AXIS).length () + epsilon < heads.length ())
     mol.add_at_edge (Y_AXIS, UP, squiggle, 0.0);
 
   mol.translate_axis (heads[LEFT], Y_AXIS);
@@ -122,17 +184,19 @@ MAKE_SCHEME_CALLBACK (Arpeggio, brew_chord_bracket, 1);
 SCM
 Arpeggio::brew_chord_bracket (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   Interval heads = robust_scm2interval (me->get_property ("positions"),
-                                       Interval())
-    * Staff_symbol_referencer::staff_space (me);
+                                        Interval ())
+                   * Staff_symbol_referencer::staff_space (me);
 
-  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+  Real th
+    = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"))
+      * robust_scm2double (me->get_property ("thickness"), 1);
   Real sp = 1.5 * Staff_symbol_referencer::staff_space (me);
   Real dy = heads.length () + sp;
-  Real x = 0.7;
+  Real x = robust_scm2double (me->get_property ("protrusion"), 0.4);
 
-  Stencil mol (Lookup::bracket (Y_AXIS, Interval (0, dy), lt, x, lt));
+  Stencil mol (Lookup::bracket (Y_AXIS, Interval (0, dy), th, x, th));
   mol.translate_axis (heads[LEFT] - sp / 2.0, Y_AXIS);
   return mol.smobbed_copy ();
 }
@@ -141,20 +205,26 @@ MAKE_SCHEME_CALLBACK (Arpeggio, brew_chord_slur, 1);
 SCM
 Arpeggio::brew_chord_slur (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
+  SCM dash_definition = me->get_property ("dash-definition");
   Interval heads = robust_scm2interval (me->get_property ("positions"),
-                                       Interval())
-    * Staff_symbol_referencer::staff_space (me);
-
-  Real lt = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"));
+                                        Interval ())
+                   * Staff_symbol_referencer::staff_space (me);
+
+  Real lt
+    = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"))
+      * robust_scm2double (me->get_property ("line-thickness"), 1.0);
+  Real th
+    = me->layout ()->get_dimension (ly_symbol2scm ("line-thickness"))
+      * robust_scm2double (me->get_property ("thickness"), 1.0);
   Real dy = heads.length ();
 
   Real height_limit = 1.5;
   Real ratio = .33;
   Bezier curve = slur_shape (dy, height_limit, ratio);
-  curve.rotate (M_PI / 2);
+  curve.rotate (90.0);
 
-  Stencil mol (Lookup::slur (curve, lt, lt));
+  Stencil mol (Lookup::slur (curve, th, lt, dash_definition));
   mol.translate_axis (heads[LEFT], Y_AXIS);
   return mol.smobbed_copy ();
 }
@@ -167,38 +237,32 @@ MAKE_SCHEME_CALLBACK (Arpeggio, width, 1);
 SCM
 Arpeggio::width (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Stencil arpeggio = Font_interface::get_default_font (me)->find_by_name ("scripts.arpeggio");
-
-  return ly_interval2scm (arpeggio.extent (X_AXIS));
-}
-
-MAKE_SCHEME_CALLBACK (Arpeggio, height, 1);
-SCM
-Arpeggio::height (SCM smob)
-{
-  return Grob::stencil_height (smob);
+  Grob *me = unsmob<Grob> (smob);
+  return ly_interval2scm (get_squiggle (me).extent (X_AXIS));
 }
 
 MAKE_SCHEME_CALLBACK (Arpeggio, pure_height, 3);
 SCM
 Arpeggio::pure_height (SCM smob, SCM, SCM)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = unsmob<Grob> (smob);
   if (to_boolean (me->get_property ("cross-staff")))
     return ly_interval2scm (Interval ());
 
-  return height (smob);
+  return Grob::stencil_height (smob);
 }
 
 ADD_INTERFACE (Arpeggio,
-              "Functions and settings for drawing an arpeggio symbol (a"
-              " wavy line left to noteheads.",
-
-              /* properties */
-              "arpeggio-direction "
-              "positions "
-              "script-priority " // TODO: make around-note-interface
-              "stems "
-              );
+               "Functions and settings for drawing an arpeggio symbol.",
+
+               /* properties */
+               "arpeggio-direction "
+               "dash-definition " // TODO: make apply to non-slur arpeggios
+               "line-thickness "
+               "positions "
+               "protrusion "
+               "script-priority " // TODO: make around-note-interface
+               "stems "
+               "thickness "
+              );