lily/tie.cc

   1 /*
   2   tie.cc -- implement Tie
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "tie.hh"
  10
  11 #include <math.h>
  12
  13 #include "spanner.hh"
  14 #include "lookup.hh"
  15 #include "output-def.hh"
  16 #include "rhythmic-head.hh"
  17 #include "bezier.hh"
  18 #include "paper-column.hh"
  19 #include "warn.hh"
  20 #include "staff-symbol-referencer.hh"
  21 #include "directional-element-interface.hh"
  22 #include "bezier.hh"
  23 #include "stem.hh"
  24 #include "note-head.hh"
  25 #include "tie-column.hh"
  26
  27 /*
  28   tie: Connect two noteheads.
  29
  30   What if we have
  31
  32   c4 ~ \clef bass ; c4 or
  33
  34   c4 \staffchange c4
  35
  36   do we have non-horizontal ties then?
  37 */
  38
  39 void
  40 Tie::set_head (Grob *me, Direction d, Grob *h)
  41 {
  42   assert (!head (me, d));
  43   index_set_cell (me->get_property ("head-pair"), d, h->self_scm ());
  44
  45   dynamic_cast<Spanner *> (me)->set_bound (d, h);
  46   me->add_dependency (h);
  47 }
  48
  49 void
  50 Tie::set_interface (Grob *me)
  51 {
  52   me->set_property ("head-pair", scm_cons (SCM_EOL, SCM_EOL));
  53 }
  54
  55 Grob *
  56 Tie::head (Grob *me, Direction d)
  57 {
  58   SCM c = me->get_property ("head-pair");
  59
  60   if (scm_is_pair (c))
  61     return unsmob_grob (index_get_cell (c, d));
  62   else
  63     return 0;
  64 }
  65
  66 int
  67 Tie::get_column_rank (Grob *me, Direction d)
  68 {
  69   Spanner *span = dynamic_cast<Spanner *> (me);
  70   Grob *h = head (me, d);
  71   if (!h)
  72     h = span->get_bound (d);
  73
  74   Grob *col = dynamic_cast<Item *> (h)->get_column ();
  75   return Paper_column::get_rank (col);
  76 }
  77
  78 Real
  79 Tie::get_position (Grob *me)
  80 {
  81   Direction d = head (me, LEFT) ? LEFT : RIGHT;
  82   return Staff_symbol_referencer::get_position (head (me, d));
  83 }
  84
  85 /*
  86   Default:  Put the tie oppositie of the stem [Wanske p231]
  87
  88   In case of chords: Tie_column takes over
  89
  90   The direction of the Tie is more complicated (See [Ross] p136 and
  91   further).
  92
  93   (what about linebreaks? )
  94 */
  95 Direction
  96 Tie::get_default_dir (Grob *me)
  97 {
  98   Item *sl = head (me, LEFT) ? Rhythmic_head::get_stem (head (me, LEFT)) : 0;
  99   Item *sr = head (me, RIGHT) ? Rhythmic_head::get_stem (head (me, RIGHT)) : 0;
 100   if (sl && sr)
 101     {
 102       if (get_grob_direction (sl) == UP
 103           && get_grob_direction (sr) == UP)
 104         return DOWN;
 105     }
 106   else if (sl || sr)
 107     {
 108       Item *s = sl ? sl : sr;
 109       return -get_grob_direction (s);
 110     }
 111
 112   return UP;
 113 }
 114
 115 void
 116 Tie::set_direction (Grob *me)
 117 {
 118   if (!get_grob_direction (me))
 119     {
 120       if (Tie_column::has_interface (me->get_parent (Y_AXIS)))
 121         Tie_column::set_directions (me->get_parent (Y_AXIS));
 122       else
 123         set_grob_direction (me, Tie::get_default_dir (me));
 124     }
 125 }
 126
 127
 128 SCM
 129 Tie::get_control_points (SCM smob)
 130 {
 131   Spanner *me = unsmob_spanner (smob);
 132   if (!head (me, LEFT) && !head (me, RIGHT))
 133     {
 134       programming_error ("tie without heads");
 135       me->suicide ();
 136       return SCM_EOL;
 137     }
 138
 139   set_direction (me);
 140
 141   Direction dir = get_grob_direction (me);
 142
 143   Real staff_space = Staff_symbol_referencer::staff_space (me);
 144   Real staff_position = Tie::get_position (me);
 145
 146   Grob *common[NO_AXES];
 147   for (int a = X_AXIS; a < NO_AXES; a++)
 148     {
 149       Axis ax ((Axis) a);
 150       common[ax] = me->get_bound (LEFT)->common_refpoint (me, ax);
 151       common[ax] = me->get_bound (RIGHT)->common_refpoint (common[a], ax);
 152     }
 153
 154   Interval attachments;
 155
 156   Direction d = LEFT;
 157   Real gap = robust_scm2double (me->get_property ("x-gap"), 0.2);
 158   do
 159     {
 160       attachments[d]
 161         = robust_relative_extent (me->get_bound (d),
 162                                   common[X_AXIS],
 163                                   X_AXIS)[-d]
 164         - gap * d;
 165     }
 166   while (flip (&d) != LEFT);
 167
 168   bool in_between = true;
 169   if (attachments.length () < 0.6 * staff_space)
 170     {
 171       /*
 172         Let short ties start over note heads, instead of between.
 173        */
 174       Drul_array<bool> allow (true, true);
 175
 176       Direction d = LEFT;
 177       do {
 178         if (Note_head::has_interface (me->get_bound (d)))
 179           {
 180             Grob *stem = unsmob_grob (me->get_bound (d)->get_object ("stem"));
 181             if (get_grob_direction (stem) == dir
 182                 && -d == dir)
 183               allow[d] = false;
 184           }
 185       } while (flip (&d) != LEFT);
 186
 187       if (allow[LEFT] && allow[RIGHT])
 188         {
 189           staff_position += dir;
 190           do
 191             {
 192               if (Note_head::has_interface (me->get_bound (d)))
 193                 {
 194                   Interval extent
 195                     = robust_relative_extent (me->get_bound (d),
 196                                               common[X_AXIS], X_AXIS);
 197
 198                   attachments[d] = extent.linear_combination (- 0.5 * d);
 199                   in_between = false;
 200                 }
 201             }
 202           while (flip (&d) != LEFT);
 203         }
 204     }
 205
 206   SCM details = me->get_property ("details");
 207
 208   SCM limit
 209     = scm_assq (ly_symbol2scm ("height-limit"), details);
 210
 211   Real h_inf = robust_scm2double (scm_cdr (limit), 0.75) * staff_space;
 212   Real r_0 = robust_scm2double (scm_cdr (scm_assq (ly_symbol2scm ("ratio"), details)),
 213                                 .333);
 214
 215   Bezier b = slur_shape (attachments.length(),
 216                          h_inf, r_0);
 217   b.scale (1, dir);
 218
 219   Offset middle = b.curve_point (0.5);
 220   Offset edge = b.curve_point (0.0);
 221
 222   staff_position = rint (staff_position);
 223
 224   Real dy = fabs (middle[Y_AXIS] - edge[Y_AXIS]);
 225   bool in_space = !(Staff_symbol_referencer::on_staffline (me, (int) staff_position));
 226   bool fits_in_space =
 227     (dy < 0.6 * staff_space);
 228
 229   /*
 230     Avoid dot
 231    */
 232   Grob *left_dot = unsmob_grob (me->get_bound (LEFT)->get_object ("dot"));
 233   if (left_dot && in_space && fits_in_space)
 234     {
 235       if (staff_position == Staff_symbol_referencer::get_position (left_dot))
 236         {
 237           staff_position += dir;
 238           in_space = false;
 239         }
 240     }
 241
 242   /*
 243     Avoid flag.
 244    */
 245   Grob *left_stem = unsmob_grob (me->get_bound (LEFT)->get_object ("stem"));
 246   if (left_stem)
 247     {
 248       Stencil flag = Stem::get_translated_flag (left_stem);
 249       Real y = staff_position * staff_space * 0.5;
 250       if (flag.extent (Y_AXIS).contains (y))
 251         {
 252           staff_position += dir;
 253           in_space = !in_space;
 254         }
 255     }
 256
 257   /*
 258     Putting larger in-space ties next to the notes forces
 259     the edges to be opposite (Y-wise) to the tie direction.
 260    */
 261   if (staff_position == Tie::get_position (me)
 262       && in_space
 263       && dy > 0.3 * staff_space)
 264     {
 265       staff_position += 2 * dir;
 266     }
 267
 268   if (in_space != fits_in_space)
 269     {
 270       if (in_space)
 271         {
 272           staff_position += dir;
 273         }
 274       else
 275         {
 276           in_space = true;
 277           staff_position += dir;
 278         }
 279     }
 280
 281   if (!in_between
 282       && in_space
 283       && fabs (staff_position - Tie::get_position (me)) <= 1)
 284     staff_position += 2*dir;
 285
 286
 287   if (in_space)
 288     {
 289       if (fabs (dy) < 0.4 * staff_space)
 290         {
 291           /*
 292             vertically center in space.
 293           */
 294           Offset middle = b.curve_point (0.5);
 295           Offset edge = b.curve_point (0.0);
 296
 297           Real center = (edge[Y_AXIS] + middle[Y_AXIS])/2.0;
 298           b.translate (Offset (0,
 299                                staff_position * staff_space * 0.5
 300                                - center));
 301         }
 302       else
 303         {
 304           b.translate (Offset (0,
 305                                (staff_position - dir) * staff_space * 0.5
 306                                + dir * 0.2 * staff_space));
 307         }
 308     }
 309   else
 310     {
 311       Real rounding_dy = (1.5 * dir  - middle[Y_AXIS]);
 312
 313       b.translate (Offset (0,
 314                            0.5 * staff_position * staff_space + rounding_dy));
 315     }
 316
 317   b.translate (Offset (attachments[LEFT]
 318                        - me->relative_coordinate (common[X_AXIS], X_AXIS), 0));
 319
 320   SCM controls = SCM_EOL;
 321   for (int i = 4; i--;)
 322     controls = scm_cons (ly_offset2scm (b.control_[i]), controls);
 323   return controls;
 324 }
 325
 326
 327
 328 MAKE_SCHEME_CALLBACK (Tie, print, 1);
 329 SCM
 330 Tie::print (SCM smob)
 331 {
 332   Grob *me = unsmob_grob (smob);
 333
 334   SCM cp = me->get_property ("control-points");
 335   if (!scm_is_pair (cp))                // list is more accurate
 336     {
 337       cp = get_control_points (smob);
 338       me->set_property ("control-points", cp);
 339     }
 340
 341   if (!scm_is_pair (cp))
 342     return Stencil ().smobbed_copy ();
 343
 344   Real staff_thick = Staff_symbol_referencer::line_thickness (me);
 345   Real base_thick = robust_scm2double (me->get_property ("thickness"), 1);
 346   Real thick = base_thick * staff_thick;
 347
 348   Bezier b;
 349   int i = 0;
 350   for (SCM s = cp; s != SCM_EOL; s = scm_cdr (s))
 351     {
 352       b.control_[i] = ly_scm2offset (scm_car (s));
 353       i++;
 354     }
 355
 356   Stencil a;
 357
 358   SCM p = me->get_property ("dash-period");
 359   SCM f = me->get_property ("dash-fraction");
 360   if (scm_is_number (p) && scm_is_number (f))
 361     a = Lookup::dashed_slur (b,
 362                              thick,
 363                              robust_scm2double (p, 1.0),
 364                              robust_scm2double (f, 0));
 365   else
 366     a = Lookup::slur (b,
 367                       get_grob_direction (me) * staff_thick,
 368                       thick);
 369
 370   return a.smobbed_copy ();
 371 }
 372
 373 ADD_INTERFACE (Tie,
 374                "tie-interface",
 375                "A tie connecting two noteheads.\n",
 376
 377                "y-offset dash-period dash-fraction "
 378                "staffline-clearance control-points head-pair "
 379                "details thickness x-gap direction minimum-length");