]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
2003 -> 2004
[lilypond.git] / lily / tie.cc
index 87de462d7391656f316118bf2c377c9faebb76b6..debdfc8e2d0b906c7a4092d5710cd376df9fb510 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 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 "molecule.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, Item * head_l)
+Tie::set_head (Grob*me,Direction d, Grob * h)
 {
-  assert (!head (d));
-  index_set_cell (get_elt_property ("heads"), d, head_l->self_scm_);
+  assert (!head (me,d));
+  index_set_cell (me->get_grob_property ("head-pair"), d, h->self_scm ());
   
-  set_bounds (d, head_l);
-  add_dependency (head_l);
+  dynamic_cast<Spanner*> (me)->set_bound (d, h);
+  me->add_dependency (h);
 }
 
-Tie::Tie()
+void
+Tie::set_interface (Grob*me)
 {
-  set_elt_property ("heads", gh_cons (SCM_EOL, SCM_EOL));
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = 0.0;
-  dx_f_drul_[LEFT] = dx_f_drul_[RIGHT] = 0.0;
-
+  me->set_grob_property ("head-pair", gh_cons (SCM_EOL, SCM_EOL));
 }
 
-Note_head* 
-Tie::head (Direction d) const
+
+Grob*
+Tie::head (Grob*me, Direction d) 
 {
-  SCM c = get_elt_property ("heads");
-  c = index_cell (c, d);
+  SCM c = me->get_grob_property ("head-pair");
 
-  return dynamic_cast<Note_head*> (unsmob_element (c));  
+  if (gh_pair_p)
+    return unsmob_grob (index_get_cell (c, d));
+  else
+    return 0;
 }
 
 Real
-Tie::position_f () const
+Tie::get_position (Grob*me) 
 {
-  return head (LEFT)
-    ? staff_symbol_referencer (head (LEFT)).position_f ()
-    : staff_symbol_referencer (head (RIGHT)).position_f () ;  
+  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) 
 {
-  Stem * sl =  head(LEFT) ? head (LEFT)->stem_l () :0;
-  Stem * sr =  head(RIGHT) ? head (RIGHT)->stem_l () :0;  
+  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 (sl && directional_element (sl).get () == UP
-      && sr && directional_element (sr).get () == UP)
-    return DOWN;
-  else
-    return UP;
+  
+  return UP;
 }
 
-void
-Tie::do_add_processing()
-{
-  if (!(head (LEFT) && head (RIGHT)))
-    warning (_ ("lonely tie"));
-
-  Direction d = LEFT;
-  Drul_array<Note_head *> new_head_drul;
-  new_head_drul[LEFT] = head(LEFT);
-  new_head_drul[RIGHT] = head(RIGHT);  
-  do {
-    if (!head (d))
-      new_head_drul[d] = head((Direction)-d);
-  } while (flip(&d) != LEFT);
-
-  index_set_cell (get_elt_property ("heads"), LEFT, new_head_drul[LEFT]->self_scm_ );
-  index_set_cell (get_elt_property ("heads"), RIGHT, new_head_drul[RIGHT]->self_scm_ );
-}
 
 void
-Tie::do_post_processing()
+Tie::set_direction (Grob*me)
 {
-  if (!head (LEFT) && !head (RIGHT))
+  if (!get_grob_direction (me))
     {
-      programming_error ("Tie without heads.");
-      set_elt_property ("transparent", SCM_BOOL_T);
-      set_empty (X_AXIS);
-      set_empty (Y_AXIS);
-      return;
+      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));
     }
+}
 
-  if (!directional_element (this).get ())
-    directional_element (this).set (get_default_dir ());
+/*
+  TODO: we should also use thickness for computing the clearance
+  between head and tie. Very thick ties will now touch the note head.
   
-  Real staff_space = staff_symbol_referencer (this).staff_space ();
-  Real half_space = staff_space / 2;
-  Real x_gap_f = paper_l ()->get_var ("tie_x_gap");
-  Real y_gap_f = paper_l ()->get_var ("tie_y_gap");
-
-  /* 
-   Slur and tie placement [OSU]
-
-   Ties:
-
-       * x = inner vertical tangent - d * gap
-
-   */
-
-
-  /*
-    OSU: not different for outer notes, so why all this code?
-    ie,  can we drop this, or should it be made switchable.
-   */
-  if (head (LEFT))
-    dx_f_drul_[LEFT] = head (LEFT)->extent (X_AXIS).length ();
+  */
+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
-    dx_f_drul_[LEFT] = get_broken_left_end_align ();
-  dx_f_drul_[LEFT] += x_gap_f;
-  dx_f_drul_[RIGHT] -= x_gap_f;
+    {
+      programming_error ("Tie without heads.");
+      me->suicide ();
+      return SCM_EOL;
+    }
 
-  /* 
-   Slur and tie placement [OSU]  -- check this
+  set_direction (me);
 
-   Ties:
+  Direction dir = get_grob_direction (me);
+  
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
 
-       * y = dx <  5ss: horizontal tangent
-        y = dx >= 5ss: y next interline - d * 0.25 ss
+  Real x_gap_f = robust_scm2double (me->get_grob_property ("x-gap"), 0);
 
-        which probably means that OSU assumes that
+  Grob* l = me->get_bound (LEFT);
+  Grob* r = me->get_bound (RIGHT);  
 
-           dy <= 5 dx
+  Grob* commonx = me->common_refpoint (l, X_AXIS);
+  commonx = me->common_refpoint (r, X_AXIS);
+  
+  Real left_x;
 
-        for smal slurs
+  /*
+     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.
    */
+  Real lambda = 0.9;           
+  
+  if (Note_head::has_interface (l))
+    {
+      Real where = RIGHT;
 
+      /*
+       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);
+  
 
-  Real ypos = position_f ();
-
-  Real y_f = half_space * ypos; 
-  int ypos_i = int (ypos);
-  Real dx_f = extent (X_AXIS).length () + dx_f_drul_[RIGHT] - dx_f_drul_[LEFT];
-  Direction dir = directional_element (this).get();
-  if (dx_f < paper_l ()->get_var ("tie_staffspace_length"))
+  Real width;
+  if (Note_head::has_interface (l) && Note_head::has_interface (r))
     {
-      if (abs (ypos_i) % 2)
-       y_f += dir * half_space;
-      y_f += dir * y_gap_f;
+      width = 
+       + r->extent (commonx,X_AXIS)[LEFT]
+       - l->extent (commonx, X_AXIS)[RIGHT]
+       -2 * x_gap_f;
     }
   else
     {
-      if (! (abs (ypos_i) % 2))
-       y_f += dir * half_space;
-      y_f += dir * half_space;
-      y_f -= dir * y_gap_f;
+      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;
     }
   
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = y_f;
-}
-
 
 
-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;
-}
+  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
 
+    TODO: what if 2 heads have different size.
 
-Molecule 
-Tie::do_brew_molecule () const
-{
-  Real thick = paper_l ()->get_var ("tie_thickness");
-  Bezier one = get_curve ();
+  */
 
-  Molecule a;
-  SCM d =  get_elt_property ("dashed");
-  if (gh_number_p (d))
-    a = lookup_l ()->dashed_slur (one, thick, gh_scm2int (d));
-  else
-    a = lookup_l ()->slur (one, directional_element (this).get () * thick, thick);
-  
-  return a; 
-}
+  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)
+       {
+         ypos += 0.5 * dir ;
+       }
+    }
 
+  
+  /*
+    todo: prevent ending / staffline collision.
 
-Bezier
-Tie::get_curve () const
-{
-  Direction d (directional_element (this).get ());
-  Bezier_bow b (get_encompass_offset_arr (), d);
+    todo: tie / stem collision
+   */
 
-  Real staff_space = staff_symbol_referencer (this).staff_space ();
-  Real h_inf = paper_l ()->get_var ("tie_height_limit_factor") * staff_space;
-  Real r_0 = paper_l ()->get_var ("tie_ratio");
+  b = slur_shape (width,h_inf, r_0);
+  b.scale (1, dir);
+  b.translate (Offset (left_x, ypos));
+  
 
-  b.set_default_bezier (h_inf, r_0);
-  Bezier c = b.get_bezier ();
+  /*
+    Avoid colliding of the horizontal part with stafflines.
 
-  /* should do this for slurs as well. */
-  Array<Real> horizontal (c.solve_derivative (Offset (1,0)));
+    
+    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 ())
     {
       /*
        ugh. Doesnt work for non-horizontal curves.
        */
-      Real y = c.curve_point (horizontal[0])[Y_AXIS];
+      Real y = b.curve_point (horizontal[0])[Y_AXIS];
 
       Real ry = rint (y/staff_space) * staff_space;
       Real diff = ry - y;
       Real newy = y;
-      if (fabs (y) <= 2.0
-         && fabs (diff) < paper_l ()->get_var ("tie_staffline_clearance"))
+
+      Real clear = staff_space * gh_scm2double (me->get_grob_property ("staffline-clearance"));
+
+      if (fabs (y) <=
+         Staff_symbol_referencer::staff_radius (me) * staff_space + clear
+         && fabs (diff) < clear)
        {
-         newy = ry - 0.5 * staff_space * sign (diff) ;
+         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) ;
+
+         /*
+           we don't want horizontal ties
+          */
+         if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
+           {
+             newy = newy + dir * staff_space; 
+           }
        }
 
-      Real y0 = c.control_ [0][Y_AXIS];
-      c.control_[2][Y_AXIS] = 
-      c.control_[1][Y_AXIS] =
      (c.control_[1][Y_AXIS] - y0)  * ((newy - y0) / (y - y0)) + y0; 
+      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");
-  return c;
+
+
+
+  SCM controls = SCM_EOL;
+  for (int i= 4; i--;)
+    controls = gh_cons (ly_offset2scm (b.control_[i]), controls);
+  return controls;
 }
 
-Array<Offset>
-Tie::get_encompass_offset_arr () const
+
+MAKE_SCHEME_CALLBACK (Tie,brew_molecule,1);
+SCM
+Tie::brew_molecule (SCM smob) 
 {
-  Array<Offset> offset_arr;
-  offset_arr.push (Offset (dx_f_drul_[LEFT], dy_f_drul_[LEFT]));
-  offset_arr.push (Offset (spanner_length () + dx_f_drul_[RIGHT],
-                          dy_f_drul_[RIGHT]));
-                     
-  return offset_arr;
+  Grob*me = unsmob_grob (smob);
+
+  SCM cp = me->get_grob_property ("control-points");
+  if (!gh_pair_p (cp))         // list is more accurate
+    {
+      cp = get_control_points (smob);
+      me->set_grob_property ("control-points", cp);
+    }
+
+  if (!gh_pair_p (cp))
+    return Molecule ().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))
+    {
+      b.control_[i] = ly_scm2offset (ly_car (s));
+      i++;
+    }
+  
+   Molecule a = Lookup::slur (b, get_grob_direction (me) * thick, thick);
+   
+   return a.smobbed_copy ();
 }
 
 
+
+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");