]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/tie.cc
release commit
[lilypond.git] / lily / tie.cc
index e9e1ab70606ea8bd8c31094a9d45c34fd6324f63..36e97842f5745236527b49229e04b9aa13c1881d 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include "lookup.hh"
-#include "paper-def.hh"
 #include "tie.hh"
-#include "note-head.hh"
+
+#include <math.h>
+
+#include "spanner.hh"
+#include "lookup.hh"
+#include "output-def.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 "bezier.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_);
-  
-  set_bounds (d, head_l);
-  add_dependency (head_l);
+  assert (!head (me, d));
+  index_set_cell (me->get_property ("head-pair"), d, h->self_scm ());
+
+  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_property ("head-pair", scm_cons (SCM_EOL, SCM_EOL));
+}
 
+Grob *
+Tie::head (Grob *me, Direction d)
+{
+  SCM c = me->get_property ("head-pair");
+
+  if (scm_is_pair (c))
+    return unsmob_grob (index_get_cell (c, d));
+  else
+    return 0;
 }
 
-Note_head* 
-Tie::head (Direction d) const
+int
+Tie::get_column_rank (Grob *me, Direction d)
 {
-  SCM c = get_elt_property ("heads");
-  c = index_cell (c, d);
+  Spanner *span = dynamic_cast<Spanner *> (me);
+  Grob *h = head (me, d);
+  if (!h)
+    h = span->get_bound (d);
 
-  return dynamic_cast<Note_head*> (unsmob_element (c));  
+  Grob *col = dynamic_cast<Item *> (h)->get_column ();
+  return Paper_column::get_rank (col);
 }
 
+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
- */
-Direction
-Tie::get_default_dir () const
-{
-  Stem * sl =  head(LEFT) ? head (LEFT)->stem_l () :0;
-  Stem * sr =  head(RIGHT) ? head (RIGHT)->stem_l () :0;  
+  Default:  Put the tie oppositie of the stem [Wanske p231]
 
-  if (sl && directional_element (sl).get () == UP
-      && sr && directional_element (sr).get () == UP)
-    return DOWN;
-  else
-    return UP;
+  In case of chords: Tie_column takes over
 
-#if 0 
-  Real p1 = Staff_symbol_referencer_interface (head (LEFT)).position_f () ;
-  Real p2 = Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;  
-  
-  int m = int (p1  + p2);
+  The direction of the Tie is more complicated (See [Ross] p136 and
+  further).
 
-  /*
-    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;
-#endif
+  (what about linebreaks? )
+*/
+Direction
+Tie::get_default_dir (Grob *me)
+{
+  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);
+    }
+
+  return UP;
 }
 
 void
-Tie::do_add_processing()
+Tie::set_direction (Grob *me)
 {
-  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[LEFT]->self_scm_ );
-
+  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));
+    }
 }
 
-void
-Tie::do_post_processing()
+/*
+  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)
 {
-  if (!head (LEFT) && !head (RIGHT))
+  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.");
-      set_elt_property ("transparent", SCM_BOOL_T);
-      set_empty (X_AXIS);
-      set_empty (Y_AXIS);
-      return;
+      programming_error ("tie without heads");
+      me->suicide ();
+      return SCM_EOL;
     }
 
-  if (!directional_element (this).get ())
-    directional_element (this).set (get_default_dir ());
-  
-  Real staff_space = paper_l ()->get_var ("interline");
-  Real half_staff_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");
+  set_direction (me);
 
-  /* 
-   Slur and tie placement [OSU]
+  Direction dir = get_grob_direction (me);
 
-   Ties:
+  Real staff_space = Staff_symbol_referencer::staff_space (me);
 
-       * x = inner vertical tangent - d * gap
+  Real x_gap_f = robust_scm2double (me->get_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);
 
-  /*
-    OSU: not different for outer notes, so why all this code?
-    ie,  can we drop this, or should it be made switchable.
-   */
-#if 0
-  Direction d = LEFT;
-  do
-    {
-      Real head_width_f = head (d)
-       ? head (d)->extent (X_AXIS).length ()
-       : 0;
-      /*
-       side attached to outer (upper or lower) notehead of chord
-      */
-      if (head (d)
-         /*
+  Real left_x;
 
-               a~a~a;
+  /*
+    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;
 
-           to second tie, middle notehead seems not extremal
+  if (Note_head::has_interface (l))
+    {
+      Real where = RIGHT;
 
-           Getting scared a bit by score-element's comment:
-           // is this a good idea?
-         */
-         // FIXME extremal deprecated
-         && (head (d)->get_elt_property ("extremal")
-             != SCM_UNDEFINED))
-       {
-       if (d == LEFT)
-           dx_f_drul_[d] += head_width_f;
-         dx_f_drul_[d] += -d * x_gap_f;
-       }
       /*
-       side attached to inner notehead
+       This correction is due te the shape of the black note head.
       */
-      else
-       {
-         dx_f_drul_[d] += -d * head_width_f;
-       }
-    } while (flip (&d) != LEFT);
-
-#else
-
-  if (head (LEFT))
-    dx_f_drul_[LEFT] = head (LEFT)->extent (X_AXIS).length ();
+      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
-    dx_f_drul_[LEFT] = get_broken_left_end_align ();
-  dx_f_drul_[LEFT] += x_gap_f;
-  dx_f_drul_[RIGHT] -= x_gap_f;
+    left_x = l->extent (l, X_AXIS).linear_combination (lambda);
 
-#endif
+  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;
+    }
 
-  /* 
-   Slur and tie placement [OSU]  -- check this
+  SCM details = me->get_property ("details");
 
-   Ties:
+  SCM lim // groetjes aan de chirurgendochter.
+    = scm_assq (ly_symbol2scm ("height-limit"), details);
 
-       * y = dx <  5ss: horizontal tangent
-        y = dx >= 5ss: y next interline - d * 0.25 ss
+  Real h_inf = scm_to_double (scm_cdr (lim)) * staff_space;
+  Real r_0 = scm_to_double (scm_cdr (scm_assq (ly_symbol2scm ("ratio"), details)));
 
-        which probably means that OSU assumes that
+  Bezier b = slur_shape (width, h_inf, r_0);
 
-           dy <= 5 dx
+  /*
+    I think this better, particularly for small ties. It always allows
+    the user to move ties if they seem in the wrong place
 
-        for smal slurs
-   */
+    TODO: what if 2 heads have different size.
 
+  */
 
-  Real ypos = head (LEFT)
-    ? Staff_symbol_referencer_interface (head (LEFT)).position_f ()
-    : Staff_symbol_referencer_interface (head (RIGHT)).position_f () ;  
+  Real ypos = Tie::get_position (me) * staff_space / 2
+    + dir * scm_to_double (me->get_property ("y-offset"));;
 
-  Real y_f = half_staff_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"))
-    {
-      if (abs (ypos_i) % 2)
-       y_f += dir * half_staff_space;
-      y_f += dir * y_gap_f;
-    }
-  else
+  /*
+    Make sure we don't start on a dots
+  */
+  if (Note_head::has_interface (l) && Rhythmic_head::get_dots (l))
     {
-      if (! (abs (ypos_i) % 2))
-       y_f += dir * half_staff_space;
-      y_f += dir * half_staff_space;
-      y_f -= dir * y_gap_f;
+      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;
     }
-  
-  dy_f_drul_[LEFT] = dy_f_drul_[RIGHT] = y_f;
-}
 
+  /*
+    todo: prevent ending / staffline collision.
 
+    todo: tie / stem collision
+  */
 
-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;
-}
+  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.
 
-Molecule*
-Tie::do_brew_molecule_p () const
-{
-  Real thick = paper_l ()->get_var ("tie_thickness");
-  Bezier one = get_curve ();
+    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 = b.curve_point (horizontal[0])[Y_AXIS];
 
-  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 new Molecule (a); 
-}
+      Real ry = rint (y / staff_space) * staff_space;
+      Real diff = ry - y;
+      Real newy = y;
 
+      Real clear = staff_space * scm_to_double (me->get_property ("staffline-clearance"));
 
+      if (fabs (y)
+         <= Staff_symbol_referencer::staff_radius (me) * staff_space + clear
+         && fabs (diff) < clear)
+       {
+         Real y1 = ry + clear;
+         Real y2 = ry - clear;
 
-Bezier
-Tie::get_curve () const
-{
-  Bezier_bow b (get_encompass_offset_arr (), directional_element (this).get ());
+         /*
+           ugh, we shove the 0.5 out of our sleeves.
 
-  b.ratio_ = paper_l ()->get_var ("slur_ratio");
-  b.height_limit_ = paper_l ()->get_var ("slur_height_limit");
-  b.rc_factor_ = paper_l ()->get_var ("slur_rc_factor");
+           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;
 
-  b.calculate ();
-  return b.get_curve ();
-}
+         newy = (fabs (y1 - y) < fabs (y2 - y)) ? y1 : y2;
 
-#if 0
+         // newy = ry - 0.5 * staff_space * sign (diff) ;
 
-/*
-  TODO: FIXME.
- */
+         /*
+           we don't want horizontal ties
+         */
+         if (fabs (newy - b.control_[0][Y_AXIS]) < 1e-2)
+           newy = newy + dir * staff_space;
+       }
 
-/*
-  Clipping
-
-  This function tries to address two issues:
-    * the tangents of the slur should always point inwards 
-      in the actual slur, i.e.  *after rotating back*.
-
-    * slurs shouldn't be too high 
-      let's try : h <= 1.2 b && h <= 3 staffheight?
-
-  We could calculate the tangent of the bezier curve from
-  both ends going inward, and clip the slur at the point
-  where the tangent (after rotation) points up (or inward
-  with a certain maximum angle).
-  
-  However, we assume that real clipping is not the best
-  answer.  We expect that moving the outer control point up 
-  if the slur becomes too high will result in a nicer slur 
-  after recalculation.
-
-  Knowing that the tangent is the line through the first
-  two control points, we'll clip (move the outer control
-  point upwards) too if the tangent points outwards.
- */
-
-bool
-Bezier_Tie::calc_clipping ()
-{
-  Real clip_height = paper_l_->get_var ("slur_clip_height");
-  Real clip_ratio = paper_l_->get_var ("slur_clip_ratio");
-  Real clip_angle = paper_l_->get_var ("slur_clip_angle");
-
-  Real b = curve_.control_[3][X_AXIS] - curve_.control_[0][X_AXIS];
-  Real clip_h = clip_ratio * b <? clip_height;
-  Real begin_h = curve_.control_[1][Y_AXIS] - curve_.control_[0][Y_AXIS];
-  Real end_h = curve_.control_[2][Y_AXIS] - curve_.control_[3][Y_AXIS];
-  Real begin_dy = 0 >? begin_h - clip_h;
-  Real end_dy = 0 >? end_h - clip_h;
-  
-  Real pi = M_PI;
-  Real begin_alpha = (curve_.control_[1] - curve_.control_[0]).arg () + dir_ * alpha_;
-  Real end_alpha = pi -  (curve_.control_[2] - curve_.control_[3]).arg () - dir_  * alpha_;
-
-  Real max_alpha = clip_angle / 90 * pi / 2;
-  if ((begin_dy < 0) && (end_dy < 0)
-    && (begin_alpha < max_alpha) && (end_alpha < max_alpha))
-    return false;
-
-  transform_back ();
-
-  if ((begin_dy > 0) || (end_dy > 0))
-    {
-      Real dy = (begin_dy + end_dy) / 4;
-      dy *= cos (alpha_);
-      encompass_[0][Y_AXIS] += dir_ * dy;
-      encompass_.top ()[Y_AXIS] += dir_ * dy;
+      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");
+
+  SCM controls = SCM_EOL;
+  for (int i = 4; i--;)
+    controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
+  return controls;
+}
+
+MAKE_SCHEME_CALLBACK (Tie, print, 1);
+SCM
+Tie::print (SCM smob)
+{
+  Grob *me = unsmob_grob (smob);
+
+  SCM cp = me->get_property ("control-points");
+  if (!scm_is_pair (cp))               // list is more accurate
     {
-      //ugh
-      Real c = 0.4;
-      if (begin_alpha >= max_alpha)
-       begin_dy = 0 >? c * begin_alpha / max_alpha * begin_h;
-      if (end_alpha >= max_alpha)
-       end_dy = 0 >? c * end_alpha / max_alpha * end_h;
-
-      encompass_[0][Y_AXIS] += dir_ * begin_dy;
-      encompass_.top ()[Y_AXIS] += dir_ * end_dy;
-
-      Offset delta = encompass_.top () - encompass_[0];
-      alpha_ = delta.arg ();
+      cp = get_control_points (smob);
+      me->set_property ("control-points", cp);
     }
 
-  to_canonic_form ();
+  if (!scm_is_pair (cp))
+    return Stencil ().smobbed_copy ();
 
-  return true;
-}
-#endif
+  Real staff_thick = Staff_symbol_referencer::line_thickness (me);
+  Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
+  Real thick = base_thick * staff_thick;
+
+  Bezier b;
+  int i = 0;
+  for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
+    {
+      b.control_[i] = ly_scm2offset (scm_car (s));
+      i++;
+    }
 
+  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 (b,
+                            thick,
+                            robust_scm2double (p, 1.0),
+                            robust_scm2double (f, 0));
+  else
+    a = Lookup::slur (b,
+                     get_grob_direction (me) * staff_thick,
+                     thick);
 
-Array<Offset>
-Tie::get_encompass_offset_arr () const
-{
-  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;
+  return a.smobbed_copy ();
 }
 
+ADD_INTERFACE (Tie,
+              "tie-interface",
+              "A tie connecting two noteheads.\n",
 
+              "y-offset dash-period dash-fraction "
+              "staffline-clearance control-points head-pair "
+              "details thickness x-gap direction minimum-length");