]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
($(outdir)/%.pdf): add DVIPS_FLAGS. This will
[lilypond.git] / lily / tie.cc
index bdc3089f64749fba3bf69b824961a9ca70f8eaf9..afdfd0240aa64c7110aa5ceb43a2a4d564da9aef 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
+#include <math.h>
 
+
+#include "spanner.hh"
+#include "lookup.hh"
 #include "paper-def.hh"
 #include "tie.hh"
-#include "note-head.hh"
+#include "rhythmic-head.hh"
+#include "bezier.hh"
 #include "paper-column.hh"
-#include "debug.hh"
+#include "warn.hh"
+#include "staff-symbol-referencer.hh"
+#include "directional-element-interface.hh"
+#include "stencil.hh"
+#include "bezier-bow.hh"
+#include "stem.hh"
+#include "note-head.hh"
+#include "tie-column.hh"
+
+/*
+  tie: Connect two noteheads.
+
+  What if we have
+
+  c4 ~ \clef bass ; c4 or
 
+  c4 \staffchange c4
+
+  do we have non-horizontal ties then?
+  */
 
 
 void
-Tie::set_head (Direction d, Note_head * head_l)
+Tie::set_head (Grob*me,Direction d, Grob * h)
 {
-  assert (!head_l_drul_[d]);
-  head_l_drul_[d] = head_l;
-  set_bounds (d, head_l);
+  assert (!head (me,d));
+  index_set_cell (me->get_grob_property ("head-pair"), d, h->self_scm ());
+  
+  dynamic_cast<Spanner*> (me)->set_bound (d, h);
+  me->add_dependency (h);
+}
 
-  add_dependency (head_l);
+void
+Tie::set_interface (Grob*me)
+{
+  me->set_grob_property ("head-pair", gh_cons (SCM_EOL, SCM_EOL));
 }
 
-Tie::Tie()
+
+Grob*
+Tie::head (Grob*me, Direction d) 
 {
-  head_l_drul_[RIGHT] =0;
-  head_l_drul_[LEFT] =0;
+  SCM c = me->get_grob_property ("head-pair");
+
+  if (gh_pair_p (c))
+    return unsmob_grob (index_get_cell (c, d));
+  else
+    return 0;
+}
+
+Real
+Tie::get_position (Grob*me) 
+{
+  Direction d = head (me,LEFT) ? LEFT:RIGHT;
+  return Staff_symbol_referencer::get_position (head (me,d));
 }
 
 
 /*
-  ugh: direction of the Tie is more complicated.  See [Ross] p136 and further
- */
+  Default:  Put the tie oppositie of the stem [Wanske p231]
+
+  In case of chords: Tie_column takes over
+  
+  The direction of the Tie is more complicated (See [Ross] p136 and
+  further).
+
+  (what about linebreaks? )  
+  
+*/
 Direction
-Tie::get_default_dir () const
+Tie::get_default_dir (Grob*me) 
 {
-  int m = int (head_l_drul_[LEFT]->position_f () 
-              + head_l_drul_[RIGHT]->position_f ()) /2;
+  Item * sl =  head (me,LEFT) ? Rhythmic_head::get_stem (head (me,LEFT)) :0;
+  Item * sr =  head (me,RIGHT) ? Rhythmic_head::get_stem (head (me,RIGHT)) :0;  
+  if (sl && sr)
+    {
+      if (get_grob_direction (sl) == UP
+         && get_grob_direction (sr) == UP)
+       return DOWN;
+    }
+  else if (sl || sr)
+    {
+      Item *s = sl ? sl : sr;
+      return - get_grob_direction (s);
+    }
 
-  /*
-    If dir is not determined: inverse of stem: down
-    (see stem::get_default_dir ())
-   */
-  Direction neutral_dir = (Direction)(int)paper_l ()->get_var ("stem_default_neutral_direction");
-  return (m == 0) ? other_dir (neutral_dir) : (m < 0) ? DOWN : UP;
+  
+  return UP;
 }
 
-void
-Tie::do_add_processing()
-{
-  if (!(head_l_drul_[LEFT] && head_l_drul_[RIGHT]))
-    warning (_ ("lonely tie"));
-
-  Direction d = LEFT;
-  Drul_array<Note_head *> new_head_drul = head_l_drul_;
-  do {
-    if (!head_l_drul_[d])
-      new_head_drul[d] = head_l_drul_[(Direction)-d];
-  } while (flip(&d) != LEFT);
-  head_l_drul_ = new_head_drul;
-}
 
 void
-Tie::do_post_processing()
+Tie::set_direction (Grob*me)
 {
-  assert (head_l_drul_[LEFT] || head_l_drul_[RIGHT]);
+  if (!get_grob_direction (me))
+    {
+      if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
+       Tie_column::set_directions (me->get_parent (Y_AXIS));
+      else
+       set_grob_direction (me, Tie::get_default_dir (me));
+    }
+}
 
-  Real interline_f = paper_l ()->get_realvar (interline_scm_sym);
-  Real internote_f = interline_f / 2;
-  Real x_gap_f = paper_l ()->get_var ("tie_x_gap");
-  Real y_gap_f = paper_l ()->get_var ("tie_y_gap");
+/*
+  TODO: we should also use thickness for computing the clearance
+  between head and tie. Very thick ties will now touch the note head.
+  
+  */
+SCM
+Tie::get_control_points (SCM smob)
+{  
+  Spanner*me = unsmob_spanner (smob);
+  Direction headdir = CENTER; 
+  if (head (me,LEFT))
+    headdir = LEFT;
+  else if (head (me,RIGHT))
+    headdir = RIGHT;
+  else
+    {
+      programming_error ("Tie without heads.");
+      me->suicide ();
+      return SCM_EOL;
+    }
 
-  /* 
-   Slur and tie placement [OSU]
+  set_direction (me);
 
-   Ties:
+  Direction dir = get_grob_direction (me);
+  
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
 
-       * x = inner vertical tangent - d * gap
+  Real x_gap_f = robust_scm2double (me->get_grob_property ("x-gap"), 0);
 
-   */
+  Grob* l = me->get_bound (LEFT);
+  Grob* r = me->get_bound (RIGHT);  
 
+  Grob* commonx = me->common_refpoint (l, X_AXIS);
+  commonx = me->common_refpoint (r, X_AXIS);
+  
+  Real left_x;
 
   /*
-    OSU: not different for outer notes, so why all this code?
-    ie,  can we drop this, or should it be made switchable.
+     the tie has to be long enough to be visible, but should not go
+    through key sigs. In the 1.5 series the pref.matter - note
+    distance is fixed , so this won't be a problem anymore.
    */
-#if 0
-  Direction d = LEFT;
-  do
+  Real lambda = 0.9;           
+  
+  if (Note_head::has_interface (l))
     {
-      Real head_width_f = head_l_drul_[d]
-       ? head_l_drul_[d]->extent (X_AXIS).length ()
-       : 0;
+      Real where = RIGHT;
+
       /*
-       side attached to outer (upper or lower) notehead of chord
-      */
-      if (head_l_drul_[d]
-         /*
-           && head_l_drul_[d]->remove_elt_property (extremal_scm_sym) != SCM_BOOL_F)
-           ugh, ugh:
+       This correction is due te the shape of the black note head.
+       */
+      if (Rhythmic_head::duration_log (l) == 2)
+       where += dir* 0.2;
+      left_x = l->extent (l, X_AXIS).linear_combination (where)
+       + x_gap_f;
+    }
+  else
+    left_x = l->extent (l, X_AXIS).linear_combination (lambda);
+  
 
-               a~a~a;
+  Real width;
+  if (Note_head::has_interface (l) && Note_head::has_interface (r))
+    {
+      width = 
+       + r->extent (commonx,X_AXIS)[LEFT]
+       - l->extent (commonx, X_AXIS)[RIGHT]
+       -2 * x_gap_f;
+    }
+  else
+    {
+      if (Note_head::has_interface (l))
+       width = r->relative_coordinate (commonx, X_AXIS)
+         - l->extent (commonx, X_AXIS)[RIGHT]
+         - 2 * x_gap_f;
+      else
+       width =
+         - l->extent (commonx, X_AXIS).linear_combination (lambda)  
+         + r->extent (commonx, X_AXIS)[LEFT]
+         - 2 * x_gap_f;
+    }
+  
+
+
+  SCM details = me->get_grob_property ("details");
+
+  SCM lim // groetjes aan de chirurgendochter.
+    = scm_assq (ly_symbol2scm ("height-limit"),details);
+  
+  Real h_inf = gh_scm2double (ly_cdr (lim)) *  staff_space;
+  Real r_0 = gh_scm2double (ly_cdr (scm_assq (ly_symbol2scm ("ratio"),details)));
+
+  Bezier b  = slur_shape (width, h_inf, r_0);
+  
+  /*
+    I think this better, particularly for small ties. It always allows the user to move ties if
+    they seem in the wrong place
 
-           to second tie, middle notehead seems not extremal
+    TODO: what if 2 heads have different size.
 
-           Getting scared a bit by score-element's comment:
-           // is this a good idea?
-         */
-         && (head_l_drul_[d]->get_elt_property (extremal_scm_sym)
-             != SCM_BOOL_F))
+  */
+
+  Real ypos = Tie::get_position (me) * staff_space/2
+    + dir * gh_scm2double (me->get_grob_property ("y-offset"));;
+
+  /*
+    Make sure we don't start on a dots
+   */
+  if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
+    {
+      Grob* dots = Rhythmic_head::get_dots (l);
+      if(fabs (staff_space * Staff_symbol_referencer::get_position (dots) /2
+              - ypos) < 0.5)
        {
-       if (d == LEFT)
-           dx_f_drul_[d] += head_width_f;
-         dx_f_drul_[d] += -d * x_gap_f;
+         ypos += 0.5 * dir ;
        }
+    }
+
+  
+  /*
+    todo: prevent ending / staffline collision.
+
+    todo: tie / stem collision
+   */
+
+  b = slur_shape (width,h_inf, r_0);
+  b.scale (1, dir);
+  b.translate (Offset (left_x, ypos));
+  
+
+  /*
+    Avoid colliding of the horizontal part with stafflines.
+
+    
+    TODO: redo this, heuristic is half-baken, and ties often look ugly
+    as a result.
+
+    TODO: doesn't work when on staff with even number of lines.
+   */
+  Array<Real> horizontal (b.solve_derivative (Offset (1,0)));
+  if (horizontal.size ())
+    {
       /*
-       side attached to inner notehead
-      */
-      else
-       {
-         dx_f_drul_[d] += -d * head_width_f;
-       }
-    } while (flip (&d) != LEFT);
+       ugh. Doesnt work for non-horizontal curves.
+       */
+      Real y = b.curve_point (horizontal[0])[Y_AXIS];
 
-#else
+      Real ry = rint (y/staff_space) * staff_space;
+      Real diff = ry - y;
+      Real newy = y;
 
-  if (head_l_drul_[LEFT])
-    dx_f_drul_[LEFT] = head_l_drul_[LEFT]->extent (X_AXIS).length ();
-  else
-    dx_f_drul_[LEFT] = get_broken_left_end_align ();
-  dx_f_drul_[LEFT] += x_gap_f;
-  dx_f_drul_[RIGHT] -= x_gap_f;
+      Real clear = staff_space * gh_scm2double (me->get_grob_property ("staffline-clearance"));
 
-#endif
+      if (fabs (y) <=
+         Staff_symbol_referencer::staff_radius (me) * staff_space + clear
+         && fabs (diff) < clear)
+       {
+         Real y1 = ry + clear;
+         Real y2 = ry - clear;
+
+         /*
+           ugh, we shove the 0.5 out of our sleeves.
+
+           Any way. This test is to make sure that staffline
+           collision avoidance does not result in completely flat
+           ties.
+          */
+         if (fabs (y1 - ypos) < 0.5)
+           y1 = y2;
+         else if (fabs (y2 - ypos) < 0.5)
+           y2 = y1;
+         
+         newy = (fabs (y1 - y) < fabs (y2 - y)) ? y1 : y2;
+         
+         // newy = ry - 0.5 * staff_space * sign (diff) ;
 
-  /* 
-   Slur and tie placement [OSU]  -- check this
+         /*
+           we don't want horizontal ties
+          */
+         if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
+           {
+             newy = newy + dir * staff_space; 
+           }
+       }
 
-   Ties:
+      Real y0 = b.control_ [0][Y_AXIS];
+      b.control_[2][Y_AXIS] = 
+      b.control_[1][Y_AXIS] =
+ (b.control_[1][Y_AXIS] - y0)  * ((newy - y0) / (y - y0)) + y0; 
+    }
+  else
+    programming_error ("Tie is nowhere horizontal");
 
-       * y = dx <  5ss: horizontal tangent
-        y = dx >= 5ss: y next interline - d * 0.25 ss
 
-        which probably means that OSU assumes that
 
-           dy <= 5 dx
+  SCM controls = SCM_EOL;
+  for (int i= 4; i--;)
+    controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
+  return controls;
+}
 
-        for smal slurs
-   */
 
-  Real ypos = head_l_drul_[LEFT] ? head_l_drul_[LEFT]->position_f ()
-    : head_l_drul_[RIGHT]->position_f ();
+MAKE_SCHEME_CALLBACK (Tie,print,1);
+SCM
+Tie::print (SCM smob) 
+{
+  Grob*me = unsmob_grob (smob);
 
-  Real y_f = internote_f * ypos; 
-  int ypos_i = int (ypos);
-  Real dx_f = extent (X_AXIS).length () + dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
-  if (dx_f < paper_l ()->get_var ("tie_staffspace_length"))
+  SCM cp = me->get_grob_property ("control-points");
+  if (!gh_pair_p (cp))         // list is more accurate
     {
-      if (abs (ypos_i) % 2)
-       y_f += dir_ * internote_f;
-      y_f += dir_ * y_gap_f;
+      cp = get_control_points (smob);
+      me->set_grob_property ("control-points", cp);
     }
-  else
+
+  if (!gh_pair_p (cp))
+    return Stencil ().smobbed_copy ();
+  
+  Real thick
+    = Staff_symbol_referencer::line_thickness (me)
+    *  robust_scm2double (me->get_grob_property ("thickness"), 1);
+
+  Bezier b;
+  int i = 0;
+  for (SCM s= cp; s != SCM_EOL; s = ly_cdr (s))
     {
-      if (! (abs (ypos_i) % 2))
-       y_f += dir_ * internote_f;
-      y_f += dir_ * internote_f;
-      y_f -= dir_ * y_gap_f;
+      b.control_[i] = ly_scm2offset (ly_car (s));
+      i++;
     }
   
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = y_f;
+   Stencil a = Lookup::slur (b, get_grob_direction (me) * thick, thick);
+   
+   return a.smobbed_copy ();
 }
 
-void
-Tie::do_substitute_element_pointer (Score_element*o, Score_element*n)
-{
-  Note_head *new_l = n ? dynamic_cast<Note_head *> (n) : 0;
-  if (dynamic_cast <Item *> (o) == head_l_drul_[LEFT])
-    head_l_drul_[LEFT] = new_l;
-  else if (dynamic_cast <Item *> (o) == head_l_drul_[RIGHT])
-    head_l_drul_[RIGHT] = new_l;
-}
 
 
-Array<Rod>
-Tie::get_rods () const
-{
-  Array<Rod> a;
-  Rod r;
-  r.item_l_drul_ = spanned_drul_;
-  r.distance_f_ = paper_l ()->get_var ("tie_x_minimum");
-  a.push (r);
-  return a;
-}
+ADD_INTERFACE (Tie,"tie-interface",
+  "A tie connecting two noteheads.\n"
+"direction = Forced direction for all ties",
+  "y-offset staffline-clearance control-points head-pair details thickness x-gap direction minimum-length");