]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/line-interface.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / line-interface.cc
index c765ffcd4cb56d7db3cfe13fc1790da464f0a457..1e2dd53c6bd1ca9cd25029e711660ff9ef6fd7b8 100644 (file)
@@ -1,22 +1,34 @@
 /*
-  line-interface.cc -- implement Line_interface
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2004--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2004--2006 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 "line-interface.hh"
 
-#include "staff-symbol-referencer.hh"
+#include "font-interface.hh"
+#include "grob.hh"
 #include "lookup.hh"
 #include "output-def.hh"
-#include "grob.hh"
+#include "staff-symbol-referencer.hh"
 
 Stencil
 Line_interface::make_arrow (Offset begin, Offset end,
-                           Real thick,
-                           Real length, Real width)
+                            Real thick,
+                            Real length, Real width)
 {
   Real angle = (end - begin).arg ();
   vector<Offset> points;
@@ -31,22 +43,97 @@ Line_interface::make_arrow (Offset begin, Offset end,
   return Lookup::round_filled_polygon (points, thick);
 }
 
+Stencil
+Line_interface::make_trill_line (Grob *me,
+                                 Offset from,
+                                 Offset to)
+{
+  Offset dz = (to - from);
+
+  Font_metric *fm = Font_interface::get_default_font (me);
+
+  Stencil elt = fm->find_by_name ("scripts.trill_element");
+  elt.align_to (Y_AXIS, CENTER);
+  Real elt_len = elt.extent (X_AXIS).length ();
+  if (elt_len <= 0.0)
+    {
+      programming_error ("can't find scripts.trill_element");
+      return Stencil ();
+    }
+
+  Stencil line;
+  Real len = 0.0;
+  do
+    {
+      line.add_at_edge (X_AXIS, RIGHT, elt, 0);
+      len = line.extent (X_AXIS).length ();
+    }
+  while (len + elt_len < dz.length ());
+
+  line.rotate (dz.arg (), Offset (LEFT, CENTER));
+  line.translate (from);
+
+  return line;
+}
+
+Stencil
+Line_interface::make_zigzag_line (Grob *me,
+                                  Offset from,
+                                  Offset to)
+{
+  Offset dz = to - from;
+
+  Real thick = Staff_symbol_referencer::line_thickness (me);
+  thick *= robust_scm2double (me->get_property ("thickness"), 1.0); // todo: staff sym referencer?
+
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
+
+  Real w = robust_scm2double (me->get_property ("zigzag-width"), 1) * staff_space;
+  int count = (int) ceil (dz.length () / w);
+  w = dz.length () / count;
+
+  Real l = robust_scm2double (me->get_property ("zigzag-length"), 1) * w;
+  Real h = l > w / 2 ? sqrt (l * l - w * w / 4) : 0;
+
+  Offset rotation_factor = complex_exp (Offset (0, dz.arg ()));
+
+  Offset points[3];
+  points[0] = Offset (0, -h / 2);
+  points[1] = Offset (w / 2, h / 2);
+  points[2] = Offset (w, -h / 2);
+  for (int i = 0; i < 3; i++)
+    points[i] = complex_multiply (points[i], rotation_factor);
+
+  Stencil squiggle (Line_interface::make_line (thick, points[0], points[1]));
+  squiggle.add_stencil (Line_interface::make_line (thick, points[1], points[2]));
+
+  Stencil total;
+  for (int i = 0; i < count; i++)
+    {
+      Stencil moved_squiggle (squiggle);
+      moved_squiggle.translate (from + Offset (i * w, 0) * rotation_factor);
+      total.add_stencil (moved_squiggle);
+    }
+
+  return total;
+}
+
 Stencil
 Line_interface::make_dashed_line (Real thick, Offset from, Offset to,
-                                 Real dash_period, Real dash_fraction)
+                                  Real dash_period, Real dash_fraction)
 {
   dash_fraction = min (max (dash_fraction, 0.0), 1.0);
   Real on = dash_fraction * dash_period + thick;
-  Real off = dash_period - on;
+  Real off = max (0.0, dash_period - on);
 
   SCM at = scm_list_n (ly_symbol2scm ("dashed-line"),
-                      scm_from_double (thick),
-                      scm_from_double (on),
-                      scm_from_double (off),
-                      scm_from_double (to[X_AXIS] - from[X_AXIS]),
-                      scm_from_double (to[Y_AXIS] - from[Y_AXIS]),
-                      scm_from_double (0.0),
-                      SCM_UNDEFINED);
+                       scm_from_double (thick),
+                       scm_from_double (on),
+                       scm_from_double (off),
+                       scm_from_double (to[X_AXIS] - from[X_AXIS]),
+                       scm_from_double (to[Y_AXIS] - from[Y_AXIS]),
+                       scm_from_double (0.0),
+                       SCM_UNDEFINED);
 
   Box box;
   box.add_point (Offset (0, 0));
@@ -64,12 +151,12 @@ Stencil
 Line_interface::make_line (Real th, Offset from, Offset to)
 {
   SCM at = scm_list_n (ly_symbol2scm ("draw-line"),
-                      scm_from_double (th),
-                      scm_from_double (from[X_AXIS]),
-                      scm_from_double (from[Y_AXIS]),
-                      scm_from_double (to[X_AXIS]),
-                      scm_from_double (to[Y_AXIS]),
-                      SCM_UNDEFINED);
+                       scm_from_double (th),
+                       scm_from_double (from[X_AXIS]),
+                       scm_from_double (from[Y_AXIS]),
+                       scm_from_double (to[X_AXIS]),
+                       scm_from_double (to[Y_AXIS]),
+                       SCM_UNDEFINED);
 
   Box box;
   box.add_point (from);
@@ -83,24 +170,24 @@ Line_interface::make_line (Real th, Offset from, Offset to)
 
 Stencil
 Line_interface::arrows (Grob *me, Offset from, Offset to,
-                       bool from_arrow,
-                       bool to_arrow)
+                        bool from_arrow,
+                        bool to_arrow)
 {
   Stencil a;
   if (from_arrow || to_arrow)
     {
       Real thick = Staff_symbol_referencer::line_thickness (me)
-       * robust_scm2double (me->get_property ("thickness"), 1);
+                   * robust_scm2double (me->get_property ("thickness"), 1);
       Real ss = Staff_symbol_referencer::staff_space (me);
 
       Real len = robust_scm2double (me->get_property ("arrow-length"), 1.3 * ss);
       Real wid = robust_scm2double (me->get_property ("arrow-width"), 0.5 * ss);
 
       if (to_arrow)
-       a.add_stencil (make_arrow (from, to, thick, len, wid));
+        a.add_stencil (make_arrow (from, to, thick, len, wid));
 
       if (from_arrow)
-       a.add_stencil (make_arrow (to, from, thick, len, wid));
+        a.add_stencil (make_arrow (to, from, thick, len, wid));
     }
 
   return a;
@@ -110,49 +197,70 @@ Stencil
 Line_interface::line (Grob *me, Offset from, Offset to)
 {
   Real thick = Staff_symbol_referencer::line_thickness (me)
-    * robust_scm2double (me->get_property ("thickness"), 1);
+               * robust_scm2double (me->get_property ("thickness"), 1);
 
   SCM type = me->get_property ("style");
+  if (type == ly_symbol2scm ("zigzag"))
+    return make_zigzag_line (me, from, to);
+  else if (type == ly_symbol2scm ("trill"))
+    return make_trill_line (me, from, to);
+  else if (type == ly_symbol2scm ("none"))
+    return Stencil ();
 
-  Stencil stil;
+  Stencil stencil;
 
-  SCM dash_fraction = me->get_property ("dash-fraction");
-  if (scm_is_number (dash_fraction) || type == ly_symbol2scm ("dotted-line"))
+  if (type == ly_symbol2scm ("dashed-line") || type == ly_symbol2scm ("dotted-line"))
     {
 
       Real fraction
-       = type == ly_symbol2scm ("dotted-line")
-       ? 0.0
-       : robust_scm2double (dash_fraction, 0.4);
+        = type == ly_symbol2scm ("dotted-line")
+          ? 0.0
+          : robust_scm2double (me->get_property ("dash-fraction"), 0.4);
 
       fraction = min (max (fraction, 0.0), 1.0);
       Real period = Staff_symbol_referencer::staff_space (me)
-       * robust_scm2double (me->get_property ("dash-period"), 1.0);
-
-      if (period < 0)
-       return Stencil ();
-
-      stil = make_dashed_line (thick, from, to, period, fraction);
+                    * robust_scm2double (me->get_property ("dash-period"), 1.0);
+
+      if (period <= 0)
+        return Stencil ();
+
+      Real len = (to - from).length ();
+
+      int n = (int) rint ((len - period * fraction) / period);
+      n = max (0, n);
+      if (n > 0)
+        {
+          /*
+            TODO: figure out something intelligent for really short
+            sections.
+           */
+          period = ((to - from).length () - period * fraction) / n;
+        }
+      stencil = make_dashed_line (thick, from, to, period, fraction);
     }
   else
-    stil = make_line (thick, from, to);
+    stencil = make_line (thick, from, to);
 
-  return stil;
+  return stencil;
 }
 
 ADD_INTERFACE (Line_interface,
-              "Generic line objects. Any object using lines supports this.  Normally, "
-              "you get a straight line. If @code{dash-period} is defined, a dashed line is "
-              "produced; the length of the dashes is tuned with "
-              "@code{dash-fraction}. If the latter is set to 0, a dotted line is "
-              "produced. If @code{dash-fraction} is negative, the line is made "
-              "transparent.",
-
-              /* properties */
-              "dash-period "
-              "dash-fraction "
-              "thickness "
-              "style "
-              "arrow-length "
-              "arrow-width")
-
+               "Generic line objects.  Any object using lines supports this."
+               "  The property @code{style} can be @code{line},"
+               " @code{dashed-line}, @code{trill}, @code{dotted-line},"
+               " @code{zigzag} or @code{none} (a transparent line).\n"
+               "\n"
+               "For @code{dashed-line}, the length of the dashes is tuned"
+               " with @code{dash-fraction}.  If the latter is set to@tie{}0, a"
+               " dotted line is produced.",
+
+               /* properties */
+               "arrow-length "
+               "arrow-width "
+               "dash-fraction "
+               "dash-period "
+               "style "
+               "thickness "
+               "zigzag-length "
+               "zigzag-width "
+              );