lily/bezier.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2012 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 /*
 144   Cache binom (3, j) t^j (1-t)^{3-j}
 145 */
 146 struct Polynomial_cache
 147 {
 148   Polynomial terms_[4];
 149   Polynomial_cache ()
 150   {
 151     for (int j = 0; j <= 3; j++)
 152       terms_[j]
 153         = binomial_coefficient_3[j]
 154           * Polynomial::power (j, Polynomial (0, 1))
 155           * Polynomial::power (3 - j, Polynomial (1, -1));
 156   }
 157 };
 158
 159 static Polynomial_cache poly_cache;
 160
 161 Polynomial
 162 Bezier::polynomial (Axis a) const
 163 {
 164   Polynomial p (0.0);
 165   Polynomial q;
 166   for (int j = 0; j <= 3; j++)
 167     {
 168       q = poly_cache.terms_[j];
 169       q *= control_[j][a];
 170       p += q;
 171     }
 172
 173   return p;
 174 }
 175
 176 /**
 177    Remove all numbers outside [0, 1] from SOL
 178 */
 179 vector<Real>
 180 filter_solutions (vector<Real> sol)
 181 {
 182   for (vsize i = sol.size (); i--;)
 183     if (sol[i] < 0 || sol[i] > 1)
 184       sol.erase (sol.begin () + i);
 185   return sol;
 186 }
 187
 188 /**
 189    find t such that derivative is proportional to DERIV
 190 */
 191 vector<Real>
 192 Bezier::solve_derivative (Offset deriv) const
 193 {
 194   Polynomial xp = polynomial (X_AXIS);
 195   Polynomial yp = polynomial (Y_AXIS);
 196   xp.differentiate ();
 197   yp.differentiate ();
 198
 199   Polynomial combine = xp * deriv[Y_AXIS] - yp * deriv [X_AXIS];
 200
 201   return filter_solutions (combine.solve ());
 202 }
 203
 204 /*
 205   Find t such that curve_point (t)[AX] == COORDINATE
 206 */
 207 vector<Real>
 208 Bezier::solve_point (Axis ax, Real coordinate) const
 209 {
 210   Polynomial p (polynomial (ax));
 211   p.coefs_[0] -= coordinate;
 212
 213   vector<Real> sol (p.solve ());
 214   return filter_solutions (sol);
 215 }
 216
 217 /**
 218    For the portion of the curve between L and R along axis AX,
 219    return the bounding box limit in direction D along the cross axis to AX.
 220    If there is no portion between L and R, return 0.0 and report error.
 221 */
 222 Real
 223 Bezier::minmax (Axis ax, Real l, Real r, Direction d) const
 224 {
 225   Axis bx = other_axis (ax);
 226
 227   // The curve could hit its bounding box limit along BX at:
 228   //  points where the curve is parallel to AX,
 229   Offset vec (0.0, 0.0);
 230   vec[ax] = 1.0;
 231   vector<Real> sols (solve_derivative (vec));
 232   //  or endpoints of the curve,
 233   sols.push_back (0.999);
 234   sols.push_back (0.001);
 235   // (using points just inside the ends, so that an endpoint is evaulated
 236   //  if it falls within rounding error of L or R and the curve lies inside)
 237
 238   Interval iv;
 239   for (vsize i = sols.size (); i--;)
 240     {
 241       Offset p (curve_point (sols[i]));
 242       if (p[ax] >= l && p[ax] <= r)
 243         iv.add_point (p[bx]);
 244     }
 245
 246   //  or intersections of the curve with the bounding lines at L and R.
 247   Interval lr (l, r);
 248   Direction dir = LEFT;
 249   do
 250     {
 251       vector<Real> v = get_other_coordinates (ax, lr[dir]);
 252       for (vsize i = v.size (); i--;)
 253         iv.add_point (v[i]);
 254     }
 255   while (flip (&dir) != LEFT);
 256
 257   if (iv.is_empty ())
 258     {
 259       programming_error ("Bezier curve does not cross region of concern");
 260       return 0.0;
 261     }
 262
 263   return iv.at (d);
 264 }
 265
 266 /**
 267    Compute the bounding box dimensions in direction of A.
 268 */
 269 Interval
 270 Bezier::extent (Axis a) const
 271 {
 272   int o = (a + 1) % NO_AXES;
 273   Offset d;
 274   d[Axis (o)] = 1.0;
 275   Interval iv;
 276   vector<Real> sols (solve_derivative (d));
 277   sols.push_back (1.0);
 278   sols.push_back (0.0);
 279   for (vsize i = sols.size (); i--;)
 280     {
 281       Offset o (curve_point (sols[i]));
 282       iv.unite (Interval (o[a], o[a]));
 283     }
 284   return iv;
 285 }
 286
 287 Interval
 288 Bezier::control_point_extent (Axis a) const
 289 {
 290   Interval ext;
 291   for (int i = CONTROL_COUNT; i--;)
 292     ext.add_point (control_[i][a]);
 293
 294   return ext;
 295 }
 296
 297 /**
 298    Flip around axis A
 299 */
 300 void
 301 Bezier::scale (Real x, Real y)
 302 {
 303   for (int i = CONTROL_COUNT; i--;)
 304     {
 305       control_[i][X_AXIS] = x * control_[i][X_AXIS];
 306       control_[i][Y_AXIS] = y * control_[i][Y_AXIS];
 307     }
 308 }
 309
 310 void
 311 Bezier::rotate (Real phi)
 312 {
 313   Offset rot (complex_exp (Offset (0, phi)));
 314   for (int i = 0; i < CONTROL_COUNT; i++)
 315     control_[i] = complex_multiply (rot, control_[i]);
 316 }
 317
 318 void
 319 Bezier::translate (Offset o)
 320 {
 321   for (int i = 0; i < CONTROL_COUNT; i++)
 322     control_[i] += o;
 323 }
 324
 325 void
 326 Bezier::assert_sanity () const
 327 {
 328   for (int i = 0; i < CONTROL_COUNT; i++)
 329     assert (!isnan (control_[i].length ())
 330             && !isinf (control_[i].length ()));
 331 }
 332
 333 void
 334 Bezier::reverse ()
 335 {
 336   Bezier b2;
 337   for (int i = 0; i < CONTROL_COUNT; i++)
 338     b2.control_[CONTROL_COUNT - i - 1] = control_[i];
 339   *this = b2;
 340 }
 341
 342 /*
 343   Subdivide a bezier at T into LEFT_PART and RIGHT_PART
 344   using deCasteljau's algorithm.
 345 */
 346 void
 347 Bezier::subdivide (Real t, Bezier *left_part, Bezier *right_part) const
 348 {
 349   Offset p[CONTROL_COUNT][CONTROL_COUNT];
 350
 351   for (int i = 0; i < CONTROL_COUNT; i++)
 352     p[i][CONTROL_COUNT - 1 ] = control_[i];
 353   for (int j = CONTROL_COUNT - 2; j >= 0; j--)
 354     for (int i = 0; i < CONTROL_COUNT - 1; i++)
 355       p[i][j] = p[i][j + 1] + t * (p[i + 1][j + 1] - p[i][j + 1]);
 356   for (int i = 0; i < CONTROL_COUNT; i++)
 357     {
 358       left_part->control_[i] = p[0][CONTROL_COUNT - 1 - i];
 359       right_part->control_[i] = p[i][i];
 360     }
 361 }
 362
 363 /*
 364   Extract a portion of a bezier from T_MIN to T_MAX
 365 */
 366
 367 Bezier
 368 Bezier::extract (Real t_min, Real t_max) const
 369 {
 370   if ((t_min < 0) || (t_max) > 1)
 371     programming_error
 372     ("bezier extract arguments outside of limits: curve may have bad shape");
 373   if (t_min >= t_max)
 374     programming_error
 375     ("lower bezier extract value not less than upper value: curve may have bad shape");
 376   Bezier bez1, bez2, bez3, bez4;
 377   if (t_min == 0.0)
 378     bez2 = *this;
 379   else
 380     subdivide (t_min, &bez1, &bez2);
 381   if (t_max == 1.0)
 382     return bez2;
 383   else
 384     {
 385       bez2.subdivide ((t_max - t_min) / (1 - t_min), &bez3, &bez4);
 386       return bez3;
 387     }
 388 }