]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/slur.cc
Imported Upstream version 2.14.2
[lilypond.git] / lily / slur.cc
index b1794ad4014828bff6b1c9b8f62f89b944d3e10a..433406c92a57d9471daab3524cf5c32091af7ebe 100644 (file)
@@ -1,10 +1,21 @@
 /*
-  slur.cc -- implement external interface for Slur
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 1996--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "slur.hh"
@@ -82,7 +93,10 @@ Slur::pure_height (SCM smob, SCM start_scm, SCM end_scm)
        ret.unite (d);
     }
 
-  ret.widen (height * 0.5);
+  // The +0.5 comes from the fact that we try to place a slur
+  // 0.5 staff spaces from the note-head.
+  // (see Slur_score_state.get_base_attachments ())
+  ret.widen (height * 0.5 + 0.5);
   return ly_interval2scm (ret);
 }
 
@@ -119,25 +133,14 @@ Slur::print (SCM smob)
   Bezier one = get_curve (me);
   Stencil a;
 
-  SCM p = me->get_property ("dash-period");
-  SCM f = me->get_property ("dash-fraction");
-  if (scm_is_number (p) && scm_is_number (f))
-    a = Lookup::dashed_slur (one, line_thick, robust_scm2double (p, 1.0),
-                            robust_scm2double (f, 0));
-  else
-    a = Lookup::slur (one,
-                     get_grob_direction (me) * base_thick,
-                     line_thick);
+  SCM dash_definition = me->get_property ("dash-definition");
+  a = Lookup::slur (one,
+                    get_grob_direction (me) * base_thick,
+                   line_thick,
+                    dash_definition);
 
 #if DEBUG_SLUR_SCORING
   SCM annotation = me->get_property ("annotation");
-  if (!scm_is_string (annotation))
-    {
-      SCM debug = me->layout ()->lookup_variable (ly_symbol2scm ("debug-slur-scoring"));
-      if (to_boolean (debug))
-       annotation = me->get_property ("quant-score");
-    }
-  
   if (scm_is_string (annotation))
     {
       string str;
@@ -160,7 +163,7 @@ Slur::print (SCM smob)
 
 /*
   it would be better to do this at engraver level, but that is
-  fragile, as the breakabl items are generated on staff level, at
+  fragile, as the breakable items are generated on staff level, at
   which point slur starts and ends have to be tracked
 */
 void
@@ -279,9 +282,9 @@ Slur::outside_slur_callback (SCM grob, SCM offset_scm)
                                         0.0);
   yext.widen (slur_padding);
 
-  Real EPS = 1e-3;
+  const Real EPS = 1e-3;
   Interval bezext (curve.control_[0][X_AXIS], curve.control_[3][X_AXIS]);
-  bool consider[] = { false, false, false };
+  bool consider[] = {false, false, false};
   Real ys[] = {0, 0, 0};
   bool do_shift = false;
   
@@ -355,7 +358,7 @@ Slur::auxiliary_acknowledge_extra_object (Grob_info const &info,
          e->set_object ("slur", slur->self_scm ());
        }
     }
-  else
+  else if (avoid != ly_symbol2scm ("ignore"))
     e->warning (_f ("Ignoring grob for slur: %s. avoid-slur not set?",
                    e->name().c_str ()));
 }
@@ -411,14 +414,79 @@ Slur::calc_cross_staff (SCM smob)
 }
 
 ADD_INTERFACE (Slur,
-              "A slur.",
+              "A slur."
+              "\n"
+              "The following properties may be set in the @code{details}"
+              " list.\n"
+              "\n"
+              "@table @code\n"
+              "@item region-size\n"
+              "Size of region (in staff spaces) for determining"
+              " potential endpoints in the Y direction.\n"
+              "@item head-encompass-penalty\n"
+              "Demerit to apply when note heads collide with a slur.\n"
+              "@item stem-encompass-penalty\n"
+              "Demerit to apply when stems collide with a slur.\n"
+              "@item closeness-factor\n"
+              "Additional demerit used when scoring encompasses.\n"
+              "@item edge-attraction-factor\n"
+              "Factor used to calculate the demerit for distances"
+              " between slur endpoints and their corresponding base"
+              " attachments.\n"
+              "@item same-slope-penalty\n"
+              "Demerit for slurs with attachment points that are"
+              " horizontally aligned.\n"
+              "@item steeper-slope-factor\n"
+              "Factor used to calculate demerit only if this slur is"
+              " not broken.\n"
+              "@item non-horizontal-penalty\n"
+              "Demerit for slurs with attachment points that are not"
+              " horizontally aligned.\n"
+              "@item max-slope\n"
+              "The maximum slope allowed for this slur.\n"
+              "@item max-slope-factor\n"
+              "Factor that calculates demerit based on the max slope.\n"
+              "@item free-head-distance\n"
+              "The amount of vertical free space that must exist"
+              " between a slur and note heads.\n"
+              "@item absolute-closeness-measure\n"
+              "Factor to calculate demerit for variance between a note"
+              " head and slur.\n"
+              "@item extra-object-collision-penalty\n"
+              "Factor to calculate demerit for extra objects that the"
+              " slur encompasses, including accidentals, fingerings, and"
+              " tuplet numbers.\n"
+              "@item accidental-collision\n"
+              "Factor to calculate demerit for @code{Accidental} objects"
+              " that the slur encompasses.  This property value replaces"
+              " the value of @code{extra-object-collision-penalty}.\n"
+              "@item extra-encompass-free-distance\n"
+              "The amount of vertical free space that must exist"
+              " between a slur and various objects it encompasses,"
+              " including accidentals, fingerings, and tuplet numbers.\n"
+              "@item extra-encompass-collision-distance\n"
+              "This detail is currently unused.\n"
+              "@item head-slur-distance-factor\n"
+              "Factor to calculate demerit for variance between a note"
+              " head and slur.\n"
+              "@item head-slur-distance-max-ratio\n"
+              "The maximum value for the ratio of distance between a"
+              " note head and slur.\n"
+              "@item free-slur-distance\n"
+              "The amount of vertical free space that must exist"
+              " between adjacent slurs.  This subproperty only works"
+              " for @code{PhrasingSlur}.\n"
+              "@item edge-slope-exponent\n"
+              "Factor used to calculate the demerit for the slope of"
+              " a slur near its endpoints; a larger value yields a"
+              " larger demerit.\n"
+              "@end table\n",
               
               /* properties */
               "annotation "
               "avoid-slur "    /* UGH. */
               "control-points "
-              "dash-fraction "
-              "dash-period "
+               "dash-definition "
               "details "
               "direction "
               "eccentricity "
@@ -429,7 +497,6 @@ ADD_INTERFACE (Slur,
               "line-thickness "
               "note-columns "
               "positions "
-              "quant-score "
               "ratio "
               "thickness "
               );