cpml/cpml-arc.c

   1 /* CPML - Cairo Path Manipulation Library
   2  * Copyright (C) 2008, 2009  Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:cpml-arc
  23  * @Section_Id:CpmlArc
  24  * @title: CpmlArc
  25  * @short_description: Manipulation of circular arcs
  26  *
  27  * The following functions manipulate #CAIRO_PATH_ARC_TO #CpmlPrimitive.
  28  * No validation is made on the input so use the following methods
  29  * only when you are sure the <varname>primitive</varname> argument
  30  * is effectively an arc-to.
  31  *
  32  * The arc primitive is defined by 3 points: the first one is the usual
  33  * implicit point got from the previous primitive, the second point is
  34  * an arbitrary intermediate point laying on the arc and the third point
  35  * is the end of the arc. These points identify univocally an arc:
  36  * furthermore, the intermediate point also gives the side of
  37  * the arc.
  38  *
  39  * As a special case, when the first point is coincident with the end
  40  * point the primitive is considered a circle with diameter defined by
  41  * the segment between the first and the intermediate point.
  42  *
  43  * <important>
  44  * <para>
  45  * An arc is not a native cairo primitive and should be treated specially.
  46  * </para>
  47  * </important>
  48  *
  49  * Using these CPML APIs you are free to use #CAIRO_PATH_ARC_TO whenever
  50  * you want but, if you are directly accessing the struct fields, you
  51  * are responsible of converting arcs to curves before passing them
  52  * to cairo. In other words, do not directly feed #CpmlPath struct to
  53  * cairo (throught cairo_append_path() for example) or at least do not
  54  * expect it will work.
  55  *
  56  * The conversion is provided by two APIs: cpml_arc_to_cairo() and
  57  * cpml_arc_to_curves(). The former directly renders to a cairo context
  58  * and is internally used by all the ..._to_cairo() functions when an
  59  * arc is met. The latter provided a more powerful (and more complex)
  60  * approach as it allows to specify the number of curves to use and do
  61  * not need a cairo context.
  62  **/
  63
  64
  65 #include "cpml-arc.h"
  66 #include "cpml-pair.h"
  67
  68 #include <stdlib.h>
  69 #include <math.h>
  70
  71
  72 /* Hardcoded max angle of the arc to be approximated by a Bézier curve:
  73  * this influence the arc quality (the default value is got from cairo) */
  74 #define ARC_MAX_ANGLE   M_PI_2
  75
  76
  77 static cairo_bool_t     get_center      (const CpmlPair *p,
  78                                          CpmlPair       *dest);
  79 static void             get_angles      (const CpmlPair *p,
  80                                          const CpmlPair *center,
  81                                          double         *start,
  82                                          double         *end);
  83 static void             arc_to_curve    (CpmlPrimitive  *curve,
  84                                          const CpmlPair *center,
  85                                          double          r,
  86                                          double          start,
  87                                          double          end);
  88
  89
  90 /**
  91  * cpml_arc_type_get_npoints:
  92  *
  93  * Returns the number of point needed to properly specify an arc primitive.
  94  *
  95  * Return value: 3
  96  **/
  97 int
  98 cpml_arc_type_get_npoints(void)
  99 {
 100     return 3;
 101 }
 102
 103 /**
 104  * cpml_arc_info:
 105  * @arc:    the #CpmlPrimitive arc data
 106  * @center: where to store the center coordinates (can be %NULL)
 107  * @r:      where to store the radius (can be %NULL)
 108  * @start:  where to store the starting angle (can be %NULL)
 109  * @end:    where to store the ending angle (can be %NULL)
 110  *
 111  * Given an @arc, this function calculates and returns its basic data.
 112  * Any pointer can be %NULL, in which case the requested info is not
 113  * returned. This function can fail (when the three points lay on a
 114  * straight line, for example) in which case 0 is returned and no
 115  * data can be considered valid.
 116  *
 117  * The radius @r can be 0 when the three points are coincidents: a
 118  * circle with radius 0 is considered a valid path.
 119  *
 120  * When the start and end angle are returned, together with their
 121  * values these angles implicitely gives another important information:
 122  * the arc direction.
 123  *
 124  * If @start < @end the arc must be rendered with increasing angle
 125  * value (clockwise direction using the ordinary cairo coordinate
 126  * system) while if @start > @end the arc must be rendered in reverse
 127  * order (that is counterclockwise in the cairo world). This is the
 128  * reason the angle values are returned in the range
 129  * { -M_PI < value < 3*M_PI } inclusive instead of the usual
 130  * { -M_PI < value < M_PI } range.
 131  *
 132  * Return value: 1 if the function worked succesfully, 0 on errors
 133  **/
 134 cairo_bool_t
 135 cpml_arc_info(const CpmlPrimitive *arc, CpmlPair *center,
 136               double *r, double *start, double *end)
 137 {
 138     CpmlPair p[3], l_center;
 139
 140     cpml_pair_from_cairo(&p[0], arc->org);
 141     cpml_pair_from_cairo(&p[1], &arc->data[1]);
 142     cpml_pair_from_cairo(&p[2], &arc->data[2]);
 143
 144     if (!get_center(p, &l_center))
 145         return 0;
 146
 147     if (center)
 148         *center = l_center;
 149
 150     if (r != NULL)
 151         *r = cpml_pair_distance(&p[0], &l_center);
 152
 153     if (start != NULL || end != NULL) {
 154         double l_start, l_end;
 155
 156         get_angles(p, &l_center, &l_start, &l_end);
 157
 158         if (start != NULL)
 159             *start = l_start;
 160         if (end != NULL)
 161             *end = l_end;
 162     }
 163
 164     return 1;
 165 }
 166
 167 /**
 168  * cpml_arc_length:
 169  * @arc:  the #CpmlPrimitive arc data
 170  *
 171  * Given the @arc primitive, returns its length.
 172  *
 173  * Return value: the requested length or 0 on errors
 174  **/
 175 double
 176 cpml_arc_length(const CpmlPrimitive *arc)
 177 {
 178     double r, start, end, delta;
 179
 180     if (!cpml_arc_info(arc, NULL, &r, &start, &end) || start == end)
 181         return 0.;
 182
 183     delta = end - start;
 184     if (delta < 0)
 185         delta += M_PI*2;
 186
 187     return r*delta;
 188 }
 189
 190 /**
 191  * cpml_arc_extents:
 192  * @arc: the #CpmlPrimitive arc data
 193  * @extents: where to store the extents
 194  *
 195  * Given an @arc primitive, returns its boundary box in @extents.
 196  **/
 197 void
 198 cpml_arc_extents(const CpmlPrimitive *arc, CpmlExtents *extents)
 199 {
 200     double r, start, end;
 201     CpmlPair center, pair;
 202
 203     extents->is_defined = 0;
 204
 205     if (!cpml_arc_info(arc, &center, &r, &start, &end))
 206         return;
 207
 208     /* Add the right quadrant point if needed */
 209     if ((start < 0 && end > 0) ||
 210         (end < M_PI * 2 && start > M_PI * 2)) {
 211         pair.x = center.x + r;
 212         pair.y = center.y;
 213         cpml_extents_pair_add(extents, &pair);
 214     }
 215
 216     /* Add the bottom quadrant point if needed */
 217     if ((start < M_PI_2 && end > M_PI_2) ||
 218         (end < M_PI_2 * 5 && start > M_PI_2 * 5)) {
 219         pair.x = center.x;
 220         pair.y = center.y + r;
 221         cpml_extents_pair_add(extents, &pair);
 222     }
 223
 224     /* Add the left quadrant point if needed */
 225     if (start < M_PI && end > M_PI) {
 226         pair.x = center.x - r;
 227         pair.y = center.y;
 228         cpml_extents_pair_add(extents, &pair);
 229     }
 230
 231     /* Add the top quadrant point if needed */
 232     if (start < M_PI_2 * 3 && end > M_PI) {
 233         pair.x = center.x;
 234         pair.y = center.y - r;
 235         cpml_extents_pair_add(extents, &pair);
 236     }
 237
 238     /* Add the start point */
 239     cpml_pair_from_cairo(&pair, cpml_primitive_get_point(arc, 0));
 240     cpml_extents_pair_add(extents, &pair);
 241
 242     /* Add the end point */
 243     cpml_pair_from_cairo(&pair, cpml_primitive_get_point(arc, -1));
 244     cpml_extents_pair_add(extents, &pair);
 245 }
 246
 247 /**
 248  * cpml_arc_pair_at:
 249  * @arc:  the #CpmlPrimitive arc data
 250  * @pair: the destination #CpmlPair
 251  * @pos:  the position value
 252  *
 253  * Given an @arc, finds the coordinates at position @pos (where 0 is
 254  * the start and 1 is the end) and stores the result in @pair.
 255  *
 256  * @pos can also be outside the 0..1 limit, as interpolating on an
 257  * arc is quite trivial.
 258  **/
 259 void
 260 cpml_arc_pair_at(const CpmlPrimitive *arc, CpmlPair *pair, double pos)
 261 {
 262     if (pos == 0.) {
 263         cpml_pair_from_cairo(pair, arc->org);
 264     } else if (pos == 1.) {
 265         cpml_pair_from_cairo(pair, &arc->data[2]);
 266     } else {
 267         CpmlPair center;
 268         double r, start, end, angle;
 269
 270         if (!cpml_arc_info(arc, &center, &r, &start, &end))
 271             return;
 272
 273         angle = (end-start)*pos + start;
 274         cpml_vector_from_angle(pair, angle);
 275         cpml_vector_set_length(pair, r);
 276         cpml_pair_add(pair, &center);
 277     }
 278 }
 279
 280 /**
 281  * cpml_arc_vector_at:
 282  * @arc:    the #CpmlPrimitive arc data
 283  * @vector: the destination vector
 284  * @pos:    the position value
 285  *
 286  * Given an @arc, finds the slope at position @pos (where 0 is
 287  * the start and 1 is the end) and stores the result in @vector.
 288  *
 289  * @pos can also be outside the 0..1 limit, as interpolating on an
 290  * arc is quite trivial.
 291  **/
 292 void
 293 cpml_arc_vector_at(const CpmlPrimitive *arc, CpmlVector *vector, double pos)
 294 {
 295     double start, end, angle;
 296
 297     if (!cpml_arc_info(arc, NULL, NULL, &start, &end))
 298         return;
 299
 300     angle = (end-start)*pos + start;
 301     cpml_vector_from_angle(vector, angle);
 302     cpml_vector_normal(vector);
 303
 304     if (start > end)
 305         cpml_pair_negate(vector);
 306 }
 307
 308 /**
 309  * cpml_arc_near_pos:
 310  * @arc: the #CpmlPrimitive arc data
 311  * @pair: the coordinates of the subject point
 312  *
 313  * Returns the pos value of the point on @arc nearest to @pair.
 314  * The returned value is always between 0 and 1.
 315  *
 316  * <important>
 317  * <title>TODO</title>
 318  * <itemizedlist>
 319  * <listitem>To be implemented...</listitem>
 320  * </itemizedlist>
 321  * </important>
 322  *
 323  * Return value: the pos value, always between 0 and 1
 324  **/
 325 double
 326 cpml_arc_near_pos(const CpmlPrimitive *arc, const CpmlPair *pair)
 327 {
 328     /* TODO */
 329
 330     return 0;
 331 }
 332
 333 /**
 334  * cpml_arc_intersection:
 335  * @arc:  the first arc
 336  * @arc2: the second arc
 337  * @dest: a vector of #CpmlPair
 338  * @max:  maximum number of intersections to return
 339  *        (that is, the size of @dest)
 340  *
 341  * Given two arcs (@arc and @arc2), gets their intersection points
 342  * and store the result in @dest. Keep in mind two arcs can have
 343  * up to 2 intersections.
 344  *
 345  * If @max is 0, the function returns 0 immediately without any
 346  * further processing. If @arc and @arc2 are cohincident (same
 347  * center and same radius), their intersections are not considered.
 348  *
 349  * <important>
 350  * <title>TODO</title>
 351  * <itemizedlist>
 352  * <listitem>To be implemented...</listitem>
 353  * </itemizedlist>
 354  * </important>
 355  *
 356  * Return value: the number of intersections found (max 2)
 357  *               or 0 if the primitives do not intersect
 358  **/
 359 int
 360 cpml_arc_intersection(const CpmlPrimitive *arc, const CpmlPrimitive *arc2,
 361                       CpmlPair *dest, int max)
 362 {
 363     return 0;
 364 }
 365
 366 /**
 367  * cpml_arc_intersection_with_line:
 368  * @arc:  an arc
 369  * @line: a line
 370  * @dest: a vector of #CpmlPair
 371  * @max:  maximum number of intersections to return
 372  *        (that is, the size of @dest)
 373  *
 374  * Given an @arc and a @line, gets their intersection points
 375  * and store the result in @dest. Keep in mind an arc and a
 376  * line can have up to 2 intersections.
 377  *
 378  * If @max is 0, the function returns 0 immediately without any
 379  * further processing.
 380  *
 381  * <important>
 382  * <title>TODO</title>
 383  * <itemizedlist>
 384  * <listitem>To be implemented...</listitem>
 385  * </itemizedlist>
 386  * </important>
 387  *
 388  * Return value: the number of intersections found (max 2)
 389  *               or 0 if the primitives do not intersect
 390  **/
 391 int
 392 cpml_arc_intersection_with_line(const CpmlPrimitive *arc,
 393                                 const CpmlPrimitive *line,
 394                                 CpmlPair *dest, int max)
 395 {
 396     return 0;
 397 }
 398
 399 /**
 400  * cpml_arc_offset:
 401  * @arc:    the #CpmlPrimitive arc data
 402  * @offset: distance for the computed parallel arc
 403  *
 404  * Given an @arc, this function computes the parallel arc at
 405  * distance @offset. The three points needed to build the
 406  * new arc are returned in the @arc data (substituting the
 407  * previous ones.
 408  **/
 409 void
 410 cpml_arc_offset(CpmlPrimitive *arc, double offset)
 411 {
 412     CpmlPair p[3], center;
 413     double r;
 414
 415     cpml_pair_from_cairo(&p[0], arc->org);
 416     cpml_pair_from_cairo(&p[1], &arc->data[1]);
 417     cpml_pair_from_cairo(&p[2], &arc->data[2]);
 418
 419     if (!get_center(p, &center))
 420         return;
 421
 422     r = cpml_pair_distance(&p[0], &center) + offset;
 423
 424     /* Offset the three points by calculating their vector from the center,
 425      * setting the new radius as length and readding the center */
 426     cpml_pair_sub(&p[0], &center);
 427     cpml_pair_sub(&p[1], &center);
 428     cpml_pair_sub(&p[2], &center);
 429
 430     cpml_vector_set_length(&p[0], r);
 431     cpml_vector_set_length(&p[1], r);
 432     cpml_vector_set_length(&p[2], r);
 433
 434     cpml_pair_add(&p[0], &center);
 435     cpml_pair_add(&p[1], &center);
 436     cpml_pair_add(&p[2], &center);
 437
 438     cpml_pair_to_cairo(&p[0], arc->org);
 439     cpml_pair_to_cairo(&p[1], &arc->data[1]);
 440     cpml_pair_to_cairo(&p[2], &arc->data[2]);
 441 }
 442
 443 /**
 444  * cpml_arc_to_cairo:
 445  * @arc: the #CpmlPrimitive arc data
 446  * @cr:  the destination cairo context
 447  *
 448  * Renders @arc to the @cr cairo context. As cairo does not support
 449  * arcs natively, it is approximated using one or more Bézier curves.
 450  *
 451  * The number of curves used is dependent from the angle of the arc.
 452  * Anyway, this function uses internally the hardcoded %M_PI_2 value
 453  * as threshold value. This means the maximum arc approximated by a
 454  * single curve will be a quarter of a circle and, consequently, a
 455  * whole circle will be approximated by 4 Bézier curves.
 456  **/
 457 void
 458 cpml_arc_to_cairo(const CpmlPrimitive *arc, cairo_t *cr)
 459 {
 460     CpmlPair center;
 461     double r, start, end;
 462     int n_curves;
 463     double step, angle;
 464     CpmlPrimitive curve;
 465     cairo_path_data_t data[4];
 466
 467     if (!cpml_arc_info(arc, &center, &r, &start, &end))
 468         return;
 469
 470     n_curves = ceil(fabs(end-start) / ARC_MAX_ANGLE);
 471     step = (end-start) / (double) n_curves;
 472     curve.data = data;
 473
 474     for (angle = start; n_curves--; angle += step) {
 475         arc_to_curve(&curve, &center, r, angle, angle+step);
 476         cairo_curve_to(cr,
 477                        curve.data[1].point.x, curve.data[1].point.y,
 478                        curve.data[2].point.x, curve.data[2].point.y,
 479                        curve.data[3].point.x, curve.data[3].point.y);
 480     }
 481 }
 482
 483 /**
 484  * cpml_arc_to_curves:
 485  * @arc:      the #CpmlPrimitive arc data
 486  * @segment:  the destination #CpmlSegment
 487  * @n_curves: number of Bézier to use
 488  *
 489  * Converts @arc to a serie of @n_curves Bézier curves and puts them
 490  * inside @segment. Obviously, @segment must have enough space to
 491  * contain at least @n_curves curves.
 492  *
 493  * This function works in a similar way as cpml_arc_to_cairo() but
 494  * has two important differences: it does not need a cairo context
 495  * and the number of curves to be generated is explicitely defined.
 496  * The latter difference allows a more specific error control from
 497  * the application: in the file src/cairo-arc.c, found in the cairo
 498  * tarball (at least in cairo-1.9.1), there is a table showing the
 499  * magnitude of error of this curve approximation algorithm.
 500  **/
 501 void
 502 cpml_arc_to_curves(const CpmlPrimitive *arc, CpmlSegment *segment,
 503                    int n_curves)
 504 {
 505     CpmlPair center;
 506     double r, start, end;
 507     double step, angle;
 508     CpmlPrimitive curve;
 509
 510     if (!cpml_arc_info(arc, &center, &r, &start, &end))
 511         return;
 512
 513     step = (end-start) / (double) n_curves;
 514     segment->num_data = n_curves*4;
 515     curve.segment = segment;
 516     curve.data = segment->data;
 517
 518     for (angle = start; n_curves--; angle += step) {
 519         arc_to_curve(&curve, &center, r, angle, angle+step);
 520         curve.data += 4;
 521     }
 522 }
 523
 524
 525 static cairo_bool_t
 526 get_center(const CpmlPair *p, CpmlPair *dest)
 527 {
 528     CpmlPair b, c;
 529     double d, b2, c2;
 530
 531     /* When p[0] == p[2], p[0]..p[1] is considered the diameter of a circle */
 532     if (p[0].x == p[2].x && p[0].y == p[2].y) {
 533         dest->x = (p[0].x + p[1].x) / 2;
 534         dest->y = (p[0].y + p[1].y) / 2;
 535         return 1;
 536     }
 537
 538     /* Translate the 3 points of -p0, to simplify the formula */
 539     cpml_pair_sub(cpml_pair_copy(&b, &p[1]), &p[0]);
 540     cpml_pair_sub(cpml_pair_copy(&c, &p[2]), &p[0]);
 541
 542     /* Check for division by 0, that is the case where the 3 given points
 543      * are laying on a straight line and there is no fitting circle */
 544     d = (b.x*c.y - b.y*c.x) * 2;
 545     if (d == 0.)
 546         return 0;
 547
 548     b2 = b.x*b.x + b.y*b.y;
 549     c2 = c.x*c.x + c.y*c.y;
 550
 551     dest->x = (c.y*b2 - b.y*c2) / d + p[0].x;
 552     dest->y = (b.x*c2 - c.x*b2) / d + p[0].y;
 553
 554     return 1;
 555 }
 556
 557 static void
 558 get_angles(const CpmlPair *p, const CpmlPair *center,
 559            double *start, double *end)
 560 {
 561     CpmlVector vector;
 562     double mid;
 563
 564     /* Calculate the starting angle */
 565     cpml_pair_sub(cpml_pair_copy(&vector, &p[0]), center);
 566     *start = cpml_vector_angle(&vector);
 567
 568     if (p[0].x == p[2].x && p[0].y == p[2].y) {
 569         /* When p[0] and p[2] are cohincidents, p[0]..p[1] is the diameter
 570          * of a circle: return by convention start=start end=start+2PI */
 571         *end = *start + M_PI*2;
 572     } else {
 573         /* Calculate the mid and end angle */
 574         cpml_pair_sub(cpml_pair_copy(&vector, &p[1]), center);
 575         mid = cpml_vector_angle(&vector);
 576         cpml_pair_sub(cpml_pair_copy(&vector, &p[2]), center);
 577         *end = cpml_vector_angle(&vector);
 578
 579         if (*end > *start) {
 580             if (mid > *end || mid < *start)
 581                 *start += M_PI*2;
 582         } else {
 583             if (mid < *end || mid > *start)
 584                 *end += M_PI*2;
 585         }
 586     }
 587 }
 588
 589 static void
 590 arc_to_curve(CpmlPrimitive *curve, const CpmlPair *center,
 591              double r, double start, double end)
 592 {
 593     double r_sin1, r_cos1;
 594     double r_sin2, r_cos2;
 595     double h;
 596
 597     r_sin1 = r*sin(start);
 598     r_cos1 = r*cos(start);
 599     r_sin2 = r*sin(end);
 600     r_cos2 = r*cos(end);
 601
 602     h = 4./3. * tan((end-start) / 4.);
 603
 604     curve->data[0].header.type = CAIRO_PATH_CURVE_TO;
 605     curve->data[0].header.length = 4;
 606     curve->data[1].point.x = center->x + r_cos1 - h*r_sin1;
 607     curve->data[1].point.y = center->y + r_sin1 + h*r_cos1;
 608     curve->data[2].point.x = center->x + r_cos2 + h*r_sin2;
 609     curve->data[2].point.y = center->y + r_sin2 - h*r_cos2;
 610     curve->data[3].point.x = center->x + r_cos2;
 611     curve->data[3].point.y = center->y + r_sin2;
 612 }