lily/bezier.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2014 Jan Nieuwenhuizen <janneke@gnu.org>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "bezier.hh"
  21 #include "warn.hh"
  22 #include "libc-extension.hh"
  23
  24 Real binomial_coefficient_3[]
  25 =
  26 {
  27   1, 3, 3, 1
  28 };
  29
  30 void
  31 scale (vector<Offset> *array, Real x, Real y)
  32 {
  33   for (vsize i = 0; i < array->size (); i++)
  34     {
  35       (*array)[i][X_AXIS] = x * (*array)[i][X_AXIS];
  36       (*array)[i][Y_AXIS] = y * (*array)[i][Y_AXIS];
  37     }
  38 }
  39
  40 void
  41 rotate (vector<Offset> *array, Real phi)
  42 {
  43   Offset rot (complex_exp (Offset (0, phi)));
  44   for (vsize i = 0; i < array->size (); i++)
  45     (*array)[i] = complex_multiply (rot, (*array)[i]);
  46 }
  47
  48 void
  49 translate (vector<Offset> *array, Offset o)
  50 {
  51   for (vsize i = 0; i < array->size (); i++)
  52     (*array)[i] += o;
  53 }
  54
  55 /*
  56   Formula of the bezier 3-spline
  57
  58   sum_{j = 0}^3 (3 over j) z_j (1-t)^ (3-j)  t^j
  59
  60
  61   A is the axis of X coordinate.
  62 */
  63
  64 Real
  65 Bezier::get_other_coordinate (Axis a, Real x) const
  66 {
  67   Axis other = Axis ((a + 1) % NO_AXES);
  68   vector<Real> ts = solve_point (a, x);
  69
  70   if (ts.size () == 0)
  71     {
  72       programming_error ("no solution found for Bezier intersection");
  73       return 0.0;
  74     }
  75
  76 #ifdef PARANOID
  77   Offset c = curve_point (ts[0]);
  78   if (fabs (c[a] - x) > 1e-8)
  79     programming_error ("bezier intersection not correct?");
  80 #endif
  81
  82   return curve_coordinate (ts[0], other);
  83 }
  84
  85 vector<Real>
  86 Bezier::get_other_coordinates (Axis a, Real x) const
  87 {
  88   Axis other = other_axis (a);
  89   vector<Real> ts = solve_point (a, x);
  90   vector<Real> sols;
  91   for (vsize i = 0; i < ts.size (); i++)
  92     sols.push_back (curve_coordinate (ts[i], other));
  93   return sols;
  94 }
  95
  96 Real
  97 Bezier::curve_coordinate (Real t, Axis a) const
  98 {
  99   Real tj = 1;
 100   Real one_min_tj[4];
 101   one_min_tj[0] = 1;
 102   for (int i = 1; i < 4; i++)
 103     one_min_tj[i] = one_min_tj[i - 1] * (1 - t);
 104
 105   Real r = 0.0;
 106   for (int j = 0; j < 4; j++)
 107     {
 108       r += control_[j][a] * binomial_coefficient_3[j]
 109            * tj * one_min_tj[3 - j];
 110
 111       tj *= t;
 112     }
 113
 114   return r;
 115 }
 116
 117 Offset
 118 Bezier::curve_point (Real t) const
 119 {
 120   Real tj = 1;
 121   Real one_min_tj[4];
 122   one_min_tj[0] = 1;
 123   for (int i = 1; i < 4; i++)
 124     one_min_tj[i] = one_min_tj[i - 1] * (1 - t);
 125
 126   Offset o;
 127   for (int j = 0; j < 4; j++)
 128     {
 129       o += control_[j] * binomial_coefficient_3[j]
 130            * tj * one_min_tj[3 - j];
 131
 132       tj *= t;
 133     }
 134
 135 #ifdef PARANOID
 136   assert (fabs (o[X_AXIS] - polynomial (X_AXIS).eval (t)) < 1e-8);
 137   assert (fabs (o[Y_AXIS] - polynomial (Y_AXIS).eval (t)) < 1e-8);
 138 #endif
 139
 140   return o;
 141 }
 142
 143 Real
 144 Bezier::slope_at_point (Real t) const
 145 {
 146   Offset second_order[3];
 147   Offset third_order[2];
 148
 149   for (vsize i = 0; i < 3; i++)
 150     second_order[i] = ((control_[i + 1] - control_[i]) * t) + control_[i];
 151
 152   for (vsize i = 0; i < 2; i++)
 153     third_order[i] = ((second_order[i + 1] - second_order[i]) * t) + second_order[i];
 154
 155   if (third_order[1][X_AXIS] - third_order[0][X_AXIS] == 0)
 156     return infinity_f;
 157
 158   return (third_order[1][Y_AXIS] - third_order[0][Y_AXIS]) / (third_order[1][X_AXIS] - third_order[0][X_AXIS]);
 159 }
 160
 161 /*
 162   Cache binom (3, j) t^j (1-t)^{3-j}
 163 */
 164 struct Polynomial_cache
 165 {
 166   Polynomial terms_[4];
 167   Polynomial_cache ()
 168   {
 169     for (int j = 0; j <= 3; j++)
 170       terms_[j]
 171         = binomial_coefficient_3[j]
 172           * Polynomial::power (j, Polynomial (0, 1))
 173           * Polynomial::power (3 - j, Polynomial (1, -1));
 174   }
 175 };
 176
 177 static Polynomial_cache poly_cache;
 178
 179 Polynomial
 180 Bezier::polynomial (Axis a) const
 181 {
 182   Polynomial p (0.0);
 183   Polynomial q;
 184   for (int j = 0; j <= 3; j++)
 185     {
 186       q = poly_cache.terms_[j];
 187       q *= control_[j][a];
 188       p += q;
 189     }
 190
 191   return p;
 192 }
 193
 194 /**
 195    Remove all numbers outside [0, 1] from SOL
 196 */
 197 vector<Real>
 198 filter_solutions (vector<Real> sol)
 199 {
 200   for (vsize i = sol.size (); i--;)
 201     if (sol[i] < 0 || sol[i] > 1)
 202       sol.erase (sol.begin () + i);
 203   return sol;
 204 }
 205
 206 /**
 207    find t such that derivative is proportional to DERIV
 208 */
 209 vector<Real>
 210 Bezier::solve_derivative (Offset deriv) const
 211 {
 212   Polynomial xp = polynomial (X_AXIS);
 213   Polynomial yp = polynomial (Y_AXIS);
 214   xp.differentiate ();
 215   yp.differentiate ();
 216
 217   Polynomial combine = xp * deriv[Y_AXIS] - yp * deriv [X_AXIS];
 218
 219   return filter_solutions (combine.solve ());
 220 }
 221
 222 /*
 223   Find t such that curve_point (t)[AX] == COORDINATE
 224 */
 225 vector<Real>
 226 Bezier::solve_point (Axis ax, Real coordinate) const
 227 {
 228   Polynomial p (polynomial (ax));
 229   p.coefs_[0] -= coordinate;
 230
 231   vector<Real> sol (p.solve ());
 232   return filter_solutions (sol);
 233 }
 234
 235 /**
 236    For the portion of the curve between L and R along axis AX,
 237    return the bounding box limit in direction D along the cross axis to AX.
 238    If there is no portion between L and R, return 0.0 and report error.
 239 */
 240 Real
 241 Bezier::minmax (Axis ax, Real l, Real r, Direction d) const
 242 {
 243   Axis bx = other_axis (ax);
 244
 245   // The curve could hit its bounding box limit along BX at:
 246   //  points where the curve is parallel to AX,
 247   Offset vec (0.0, 0.0);
 248   vec[ax] = 1.0;
 249   vector<Real> sols (solve_derivative (vec));
 250   //  or endpoints of the curve,
 251   sols.push_back (0.999);
 252   sols.push_back (0.001);
 253   // (using points just inside the ends, so that an endpoint is evaulated
 254   //  if it falls within rounding error of L or R and the curve lies inside)
 255
 256   Interval iv;
 257   for (vsize i = sols.size (); i--;)
 258     {
 259       Offset p (curve_point (sols[i]));
 260       if (p[ax] >= l && p[ax] <= r)
 261         iv.add_point (p[bx]);
 262     }
 263
 264   //  or intersections of the curve with the bounding lines at L and R.
 265   Interval lr (l, r);
 266   for (LEFT_and_RIGHT (dir))
 267     {
 268       vector<Real> v = get_other_coordinates (ax, lr[dir]);
 269       for (vsize i = v.size (); i--;)
 270         iv.add_point (v[i]);
 271     }
 272
 273   if (iv.is_empty ())
 274     {
 275       programming_error ("Bezier curve does not cross region of concern");
 276       return 0.0;
 277     }
 278
 279   return iv.at (d);
 280 }
 281
 282 /**
 283    Compute the bounding box dimensions in direction of A.
 284 */
 285 Interval
 286 Bezier::extent (Axis a) const
 287 {
 288   int o = (a + 1) % NO_AXES;
 289   Offset d;
 290   d[Axis (o)] = 1.0;
 291   Interval iv;
 292   vector<Real> sols (solve_derivative (d));
 293   sols.push_back (1.0);
 294   sols.push_back (0.0);
 295   for (vsize i = sols.size (); i--;)
 296     {
 297       Offset o (curve_point (sols[i]));
 298       iv.unite (Interval (o[a], o[a]));
 299     }
 300   return iv;
 301 }
 302
 303 Interval
 304 Bezier::control_point_extent (Axis a) const
 305 {
 306   Interval ext;
 307   for (int i = CONTROL_COUNT; i--;)
 308     ext.add_point (control_[i][a]);
 309
 310   return ext;
 311 }
 312
 313 /**
 314    Flip around axis A
 315 */
 316 void
 317 Bezier::scale (Real x, Real y)
 318 {
 319   for (int i = CONTROL_COUNT; i--;)
 320     {
 321       control_[i][X_AXIS] = x * control_[i][X_AXIS];
 322       control_[i][Y_AXIS] = y * control_[i][Y_AXIS];
 323     }
 324 }
 325
 326 void
 327 Bezier::rotate (Real phi)
 328 {
 329   Offset rot (complex_exp (Offset (0, phi)));
 330   for (int i = 0; i < CONTROL_COUNT; i++)
 331     control_[i] = complex_multiply (rot, control_[i]);
 332 }
 333
 334 void
 335 Bezier::translate (Offset o)
 336 {
 337   for (int i = 0; i < CONTROL_COUNT; i++)
 338     control_[i] += o;
 339 }
 340
 341 void
 342 Bezier::assert_sanity () const
 343 {
 344   for (int i = 0; i < CONTROL_COUNT; i++)
 345     assert (!isnan (control_[i].length ())
 346             && !isinf (control_[i].length ()));
 347 }
 348
 349 void
 350 Bezier::reverse ()
 351 {
 352   Bezier b2;
 353   for (int i = 0; i < CONTROL_COUNT; i++)
 354     b2.control_[CONTROL_COUNT - i - 1] = control_[i];
 355   *this = b2;
 356 }
 357
 358 /*
 359   Subdivide a bezier at T into LEFT_PART and RIGHT_PART
 360   using deCasteljau's algorithm.
 361 */
 362 void
 363 Bezier::subdivide (Real t, Bezier *left_part, Bezier *right_part) const
 364 {
 365   Offset p[CONTROL_COUNT][CONTROL_COUNT];
 366
 367   for (int i = 0; i < CONTROL_COUNT; i++)
 368     p[i][CONTROL_COUNT - 1 ] = control_[i];
 369   for (int j = CONTROL_COUNT - 2; j >= 0; j--)
 370     for (int i = 0; i < CONTROL_COUNT - 1; i++)
 371       p[i][j] = p[i][j + 1] + t * (p[i + 1][j + 1] - p[i][j + 1]);
 372   for (int i = 0; i < CONTROL_COUNT; i++)
 373     {
 374       left_part->control_[i] = p[0][CONTROL_COUNT - 1 - i];
 375       right_part->control_[i] = p[i][i];
 376     }
 377 }
 378
 379 /*
 380   Extract a portion of a bezier from T_MIN to T_MAX
 381 */
 382
 383 Bezier
 384 Bezier::extract (Real t_min, Real t_max) const
 385 {
 386   if ((t_min < 0) || (t_max) > 1)
 387     programming_error
 388     ("bezier extract arguments outside of limits: curve may have bad shape");
 389   if (t_min >= t_max)
 390     programming_error
 391     ("lower bezier extract value not less than upper value: curve may have bad shape");
 392   Bezier bez1, bez2, bez3, bez4;
 393   if (t_min == 0.0)
 394     bez2 = *this;
 395   else
 396     subdivide (t_min, &bez1, &bez2);
 397   if (t_max == 1.0)
 398     return bez2;
 399   else
 400     {
 401       bez2.subdivide ((t_max - t_min) / (1 - t_min), &bez3, &bez4);
 402       return bez3;
 403     }
 404 }