src/display/curve.cpp

   1 #define __CURVE_C__
   2
   3 /** \file
   4  * Routines for SPCurve and for its Geom::PathVector
   5  */
   6
   7 /*
   8  * Authors:
   9  *   Lauris Kaplinski <lauris@kaplinski.com>
  10  *   Johan Engelen
  11  *
  12  * Copyright (C) 2000 Lauris Kaplinski
  13  * Copyright (C) 2000-2001 Ximian, Inc.
  14  * Copyright (C) 2002 Lauris Kaplinski
  15  * Copyright (C) 2008 Johan Engelen
  16  *
  17  * Released under GNU GPL
  18  */
  19
  20 #include "display/curve.h"
  21
  22 #include <glib/gmessages.h>
  23 #include <2geom/pathvector.h>
  24 #include <2geom/sbasis-geometric.h>
  25 #include <2geom/sbasis-to-bezier.h>
  26 #include <2geom/point.h>
  27
  28 /* Constructors */
  29
  30 /**
  31  * The returned curve's state is as if SPCurve::reset has just been called on it.
  32  */
  33 SPCurve::SPCurve()
  34   : _refcount(1),
  35     _pathv()
  36 {
  37     _pathv.clear();
  38 }
  39
  40 SPCurve::SPCurve(Geom::PathVector const& pathv)
  41   : _refcount(1),
  42     _pathv(pathv)
  43 {
  44 }
  45
  46 SPCurve *
  47 SPCurve::new_from_rect(Geom::Rect const &rect)
  48 {
  49     SPCurve *c =  new SPCurve();
  50
  51     Geom::Point p = rect.corner(0);
  52     c->moveto(p);
  53
  54     for (int i=3; i>=0; i--) {
  55         c->lineto(rect.corner(i));
  56     }
  57     c->closepath_current();
  58
  59     return c;
  60 }
  61
  62 SPCurve::~SPCurve()
  63 {
  64 }
  65
  66 /* Methods */
  67
  68 void
  69 SPCurve::set_pathvector(Geom::PathVector const & new_pathv)
  70 {
  71     _pathv = new_pathv;
  72 }
  73
  74 Geom::PathVector const &
  75 SPCurve::get_pathvector() const
  76 {
  77     return _pathv;
  78 }
  79
  80 /*
  81  * Returns the number of segments of all paths summed
  82  * This count includes the closing line segment of a closed path.
  83  */
  84 guint
  85 SPCurve::get_segment_count() const
  86 {
  87     guint nr = 0;
  88     for(Geom::PathVector::const_iterator it = _pathv.begin(); it != _pathv.end(); ++it) {
  89         nr += (*it).size();
  90
  91         if (it->closed())   nr += 1;
  92     }
  93     return nr;
  94 }
  95
  96 /**
  97  * Increase _refcount of curve.
  98  *
  99  * \todo should this be shared with other refcounting code?
 100  */
 101 SPCurve *
 102 SPCurve::ref()
 103 {
 104     _refcount += 1;
 105
 106     return this;
 107 }
 108
 109 /**
 110  * Decrease refcount of curve, with possible destruction.
 111  *
 112  * \todo should this be shared with other refcounting code?
 113  */
 114 SPCurve *
 115 SPCurve::unref()
 116 {
 117     _refcount -= 1;
 118
 119     if (_refcount < 1) {
 120         delete this;
 121     }
 122
 123     return NULL;
 124 }
 125
 126 /**
 127  * Create new curve from this curve's pathvector array.
 128  */
 129 SPCurve *
 130 SPCurve::copy() const
 131 {
 132     return new SPCurve(_pathv);
 133 }
 134
 135 /**
 136  * Return new curve that is the concatenation of all curves in list.
 137  */
 138 SPCurve *
 139 SPCurve::concat(GSList const *list)
 140 {
 141     SPCurve *new_curve = new SPCurve();
 142
 143     for (GSList const *l = list; l != NULL; l = l->next) {
 144         SPCurve *c = (SPCurve *) l->data;
 145         new_curve->_pathv.insert( new_curve->_pathv.end(), c->get_pathvector().begin(), c->get_pathvector().end() );
 146     }
 147
 148     return new_curve;
 149 }
 150
 151 /**
 152  * Returns a list of new curves corresponding to the subpaths in \a curve.
 153  * 2geomified
 154  */
 155 GSList *
 156 SPCurve::split() const
 157 {
 158     GSList *l = NULL;
 159
 160     for (Geom::PathVector::const_iterator path_it = _pathv.begin(); path_it != _pathv.end(); ++path_it) {
 161         Geom::PathVector newpathv;
 162         newpathv.push_back(*path_it);
 163         SPCurve * newcurve = new SPCurve(newpathv);
 164         l = g_slist_prepend(l, newcurve);
 165     }
 166
 167     return l;
 168 }
 169
 170 /**
 171  * Transform all paths in curve using matrix.
 172  */
 173 void
 174 SPCurve::transform(Geom::Matrix const &m)
 175 {
 176     _pathv *= m;
 177 }
 178
 179 /**
 180  * Set curve to empty curve.
 181  * In more detail: this clears the internal pathvector from all its paths.
 182  */
 183 void
 184 SPCurve::reset()
 185 {
 186     _pathv.clear();
 187 }
 188
 189 /** Several consecutive movetos are ALLOWED
 190  *  Ref: http://www.w3.org/TR/SVG11/implnote.html#PathElementImplementationNotes
 191  * (first subitem of the item about zero-length path segments) */
 192
 193 /**
 194  * Calls SPCurve::moveto() with point made of given coordinates.
 195  */
 196 void
 197 SPCurve::moveto(gdouble x, gdouble y)
 198 {
 199     moveto(Geom::Point(x, y));
 200 }
 201 /**
 202  * Perform a moveto to a point, thus starting a new subpath.
 203  * Point p must be finite.
 204  */
 205 void
 206 SPCurve::moveto(Geom::Point const &p)
 207 {
 208     _pathv.push_back( Geom::Path() );  // for some reason Geom::Path(p) does not work...
 209     _pathv.back().start(p);
 210 }
 211
 212 /**
 213  * Adds a line to the current subpath.
 214  * Point p must be finite.
 215  */
 216 void
 217 SPCurve::lineto(Geom::Point const &p)
 218 {
 219     if (_pathv.empty())  g_message("SPCurve::lineto - path is empty!");
 220     else _pathv.back().appendNew<Geom::LineSegment>( p );
 221 }
 222 /**
 223  * Calls SPCurve::lineto( Geom::Point(x,y) )
 224  */
 225 void
 226 SPCurve::lineto(gdouble x, gdouble y)
 227 {
 228     lineto(Geom::Point(x,y));
 229 }
 230
 231 /**
 232  * Adds a quadratic bezier segment to the current subpath.
 233  * All points must be finite.
 234  */
 235 void
 236 SPCurve::quadto(Geom::Point const &p1, Geom::Point const &p2)
 237 {
 238     if (_pathv.empty())  g_message("SPCurve::quadto - path is empty!");
 239     else _pathv.back().appendNew<Geom::QuadraticBezier>( p1, p2);
 240 }
 241 /**
 242  * Calls SPCurve::quadto( Geom::Point(x1,y1), Geom::Point(x2,y2) )
 243  * All coordinates must be finite.
 244  */
 245 void
 246 SPCurve::quadto(gdouble x1, gdouble y1, gdouble x2, gdouble y2)
 247 {
 248     quadto( Geom::Point(x1,y1), Geom::Point(x2,y2) );
 249 }
 250
 251 /**
 252  * Adds a bezier segment to the current subpath.
 253  * All points must be finite.
 254  */
 255 void
 256 SPCurve::curveto(Geom::Point const &p0, Geom::Point const &p1, Geom::Point const &p2)
 257 {
 258     if (_pathv.empty())  g_message("SPCurve::curveto - path is empty!");
 259     else _pathv.back().appendNew<Geom::CubicBezier>( p0, p1, p2 );
 260 }
 261 /**
 262  * Calls SPCurve::curveto( Geom::Point(x0,y0), Geom::Point(x1,y1), Geom::Point(x2,y2) )
 263  * All coordinates must be finite.
 264  */
 265 void
 266 SPCurve::curveto(gdouble x0, gdouble y0, gdouble x1, gdouble y1, gdouble x2, gdouble y2)
 267 {
 268     curveto( Geom::Point(x0,y0), Geom::Point(x1,y1), Geom::Point(x2,y2) );
 269 }
 270
 271 /**
 272  * Close current subpath by possibly adding a line between start and end.
 273  */
 274 void
 275 SPCurve::closepath()
 276 {
 277     _pathv.back().close(true);
 278 }
 279
 280 /** Like SPCurve::closepath() but sets the end point of the last subpath
 281     to the subpath start point instead of adding a new lineto.
 282
 283     Used for freehand drawing when the user draws back to the start point.
 284 **/
 285 void
 286 SPCurve::closepath_current()
 287 {
 288     _pathv.back().setFinal(_pathv.back().initialPoint());
 289     _pathv.back().close(true);
 290 }
 291
 292 /**
 293  * True if no paths are in curve. If it only contains a path with only a moveto, the path is considered NON-empty
 294  */
 295 bool
 296 SPCurve::is_empty() const
 297 {
 298     return _pathv.empty();
 299 }
 300
 301 /**
 302  * True iff all subpaths are closed.
 303  * Returns false if the curve is empty.
 304  */
 305 bool
 306 SPCurve::is_closed() const
 307 {
 308     if (is_empty()) {
 309         return false;
 310     } else {
 311         bool closed = true;
 312         for (Geom::PathVector::const_iterator it = _pathv.begin(); it != _pathv.end(); it++) {
 313              if ( ! it->closed() ) {
 314                 closed = false;
 315                 break;
 316             }
 317         }
 318         return closed;
 319     }
 320 }
 321
 322 /**
 323  * Return last pathsegment (possibly the closing path segment) of the last path in PathVector or NULL.
 324  * If the last path is empty (contains only a moveto), the function returns NULL
 325  */
 326 Geom::Curve const *
 327 SPCurve::last_segment() const
 328 {
 329     if (is_empty()) {
 330         return NULL;
 331     }
 332     if (_pathv.back().empty()) {
 333         return NULL;
 334     }
 335
 336     return &_pathv.back().back_default();
 337 }
 338
 339 /**
 340  * Return last path in PathVector or NULL.
 341  */
 342 Geom::Path const *
 343 SPCurve::last_path() const
 344 {
 345     if (is_empty()) {
 346         return NULL;
 347     }
 348
 349     return &_pathv.back();
 350 }
 351
 352 /**
 353  * Return first pathsegment in PathVector or NULL.
 354  * equal in functionality to SPCurve::first_bpath()
 355  */
 356 Geom::Curve const *
 357 SPCurve::first_segment() const
 358 {
 359     if (is_empty()) {
 360         return NULL;
 361     }
 362     if (_pathv.front().empty()) {
 363         return NULL;
 364     }
 365
 366     return &_pathv.front().front();
 367 }
 368
 369 /**
 370  * Return first path in PathVector or NULL.
 371  */
 372 Geom::Path const *
 373 SPCurve::first_path() const
 374 {
 375     if (is_empty()) {
 376         return NULL;
 377     }
 378
 379     return &_pathv.front();
 380 }
 381
 382 /**
 383  * Return first point of first subpath or nothing when the path is empty.
 384  */
 385 boost::optional<Geom::Point>
 386 SPCurve::first_point() const
 387 {
 388     boost::optional<Geom::Point> retval;
 389
 390     if (!is_empty()) {
 391         retval = _pathv.front().initialPoint();
 392     }
 393
 394     return retval;
 395 }
 396
 397 /**
 398  * Return the second point of first subpath or _movePos if curve too short.
 399  * If the pathvector is empty, this returns nothing. If the first path is only a moveto, this method
 400  * returns the first point of the second path, if it exists. If there is no 2nd path, it returns the
 401  * first point of the first path.
 402  */
 403 boost::optional<Geom::Point>
 404 SPCurve::second_point() const
 405 {
 406     boost::optional<Geom::Point> retval;
 407     if (!is_empty()) {
 408         if (_pathv.front().empty()) {
 409             // first path is only a moveto
 410             // check if there is second path
 411             if (_pathv.size() > 1) {
 412                 retval = _pathv[1].initialPoint();
 413             } else {
 414                 retval = _pathv[0].initialPoint();
 415             }
 416         } else {
 417             retval = _pathv.front()[0].finalPoint();
 418         }
 419     }
 420
 421     return retval;
 422 }
 423
 424 /**
 425  * Return the second-last point of last subpath or first point when that last subpath has only a moveto.
 426  */
 427 boost::optional<Geom::Point>
 428 SPCurve::penultimate_point() const
 429 {
 430     boost::optional<Geom::Point> retval;
 431     if (!is_empty()) {
 432         Geom::Path const &lastpath = _pathv.back();
 433         if (!lastpath.empty()) {
 434             Geom::Curve const &back = lastpath.back_default();
 435             retval = back.initialPoint();
 436         } else {
 437             retval = lastpath.initialPoint();
 438         }
 439     }
 440
 441     return retval;
 442 }
 443
 444 /**
 445  * Return last point of last subpath or nothing when the curve is empty.
 446  * If the last path is only a moveto, then return that point.
 447  */
 448 boost::optional<Geom::Point>
 449 SPCurve::last_point() const
 450 {
 451     boost::optional<Geom::Point> retval;
 452
 453     if (!is_empty()) {
 454         retval = _pathv.back().finalPoint();
 455     }
 456
 457     return retval;
 458 }
 459
 460 /**
 461  * Returns a *new* \a curve but drawn in the opposite direction.
 462  * Should result in the same shape, but
 463  * with all its markers drawn facing the other direction.
 464  * Reverses the order of subpaths as well
 465  **/
 466 SPCurve *
 467 SPCurve::create_reverse() const
 468 {
 469     SPCurve *new_curve = new SPCurve(Geom::reverse_paths_and_order(_pathv));
 470
 471     return new_curve;
 472 }
 473
 474 /**
 475  * Append \a curve2 to \a this.
 476  * If \a use_lineto is false, simply add all paths in \a curve2 to \a this;
 477  * if \a use_lineto is true, combine \a this's last path and \a curve2's first path and add the rest of the paths in \a curve2 to \a this.
 478  */
 479 void
 480 SPCurve::append(SPCurve const *curve2,
 481                 bool use_lineto)
 482 {
 483     if (curve2->is_empty())
 484         return;
 485
 486     if (use_lineto) {
 487         Geom::PathVector::const_iterator it = curve2->_pathv.begin();
 488         if ( ! _pathv.empty() ) {
 489             Geom::Path & lastpath = _pathv.back();
 490             lastpath.appendNew<Geom::LineSegment>( (*it).initialPoint() );
 491             lastpath.append( (*it) );
 492         } else {
 493             _pathv.push_back( (*it) );
 494         }
 495
 496         for (it++; it != curve2->_pathv.end(); it++) {
 497             _pathv.push_back( (*it) );
 498         }
 499     } else {
 500         for (Geom::PathVector::const_iterator it = curve2->_pathv.begin(); it != curve2->_pathv.end(); it++) {
 501             _pathv.push_back( (*it) );
 502         }
 503     }
 504 }
 505
 506 /**
 507  * Append \a c1 to \a this with possible fusing of close endpoints. If the end of this curve and the start of c1 are within tolerance distance,
 508  * then the startpoint of c1 is moved to the end of this curve and the first subpath of c1 is appended to the last subpath of this curve.
 509  * When one of the curves (this curve or the argument curve) is closed, the returned value is NULL; otherwise the returned value is this curve.
 510  * When one of the curves is empty, this curves path becomes the non-empty path.
 511  */
 512 SPCurve *
 513 SPCurve::append_continuous(SPCurve const *c1, gdouble tolerance)
 514 {
 515     using Geom::X;
 516     using Geom::Y;
 517
 518     g_return_val_if_fail(c1 != NULL, NULL);
 519     if ( this->is_closed() || c1->is_closed() ) {
 520         return NULL;
 521     }
 522
 523     if (c1->is_empty()) {
 524         return this;
 525     }
 526
 527     if (this->is_empty()) {
 528         _pathv = c1->_pathv;
 529         return this;
 530     }
 531
 532     if ( (fabs((*this->last_point())[X] - (*c1->first_point())[X]) <= tolerance)
 533          && (fabs((*this->last_point())[Y] - (*c1->first_point())[Y]) <= tolerance) )
 534     {
 535     // c1's first subpath can be appended to this curve's last subpath
 536         Geom::PathVector::const_iterator path_it = c1->_pathv.begin();
 537         Geom::Path & lastpath = _pathv.back();
 538
 539         Geom::Path newfirstpath(*path_it);
 540         newfirstpath.setInitial(lastpath.finalPoint());
 541         lastpath.append( newfirstpath );
 542
 543         for (path_it++; path_it != c1->_pathv.end(); path_it++) {
 544             _pathv.push_back( (*path_it) );
 545         }
 546
 547     } else {
 548         append(c1, true);
 549     }
 550
 551     return this;
 552 }
 553
 554 /**
 555  * Remove last segment of curve.
 556  * (Only used once in /src/pen-context.cpp)
 557  */
 558 void
 559 SPCurve::backspace()
 560 {
 561     if ( is_empty() )
 562         return;
 563
 564     if ( !_pathv.back().empty() ) {
 565         _pathv.back().erase_last();
 566         _pathv.back().close(false);
 567     }
 568 }
 569
 570 /**
 571  * TODO: add comments about what this method does and what assumptions are made and requirements are put on SPCurve
 572  (2:08:18 AM) Johan: basically, i convert the path to pw<d2>
 573 (2:08:27 AM) Johan: then i calculate an offset path
 574 (2:08:29 AM) Johan: to move the knots
 575 (2:08:36 AM) Johan: then i add it
 576 (2:08:40 AM) Johan: then convert back to path
 577 If I remember correctly, this moves the firstpoint to new_p0, and the lastpoint to new_p1, and moves all nodes in between according to their arclength (interpolates the movement amount)
 578  */
 579 void
 580 SPCurve::stretch_endpoints(Geom::Point const &new_p0, Geom::Point const &new_p1)
 581 {
 582     if (is_empty()) {
 583         return;
 584     }
 585
 586     Geom::Point const offset0( new_p0 - *first_point() );
 587     Geom::Point const offset1( new_p1 - *last_point() );
 588
 589     Geom::Piecewise<Geom::D2<Geom::SBasis> > pwd2 = _pathv.front().toPwSb();
 590     Geom::Piecewise<Geom::SBasis> arclength = Geom::arcLengthSb(pwd2);
 591     if ( arclength.lastValue() <= 0 ) {
 592         g_error("SPCurve::stretch_endpoints - arclength <= 0");
 593         throw;
 594     }
 595     arclength *= 1./arclength.lastValue();
 596     Geom::Point const A( offset0 );
 597     Geom::Point const B( offset1 );
 598     Geom::Piecewise<Geom::SBasis> offsetx = (arclength*-1.+1)*A[0] + arclength*B[0];
 599     Geom::Piecewise<Geom::SBasis> offsety = (arclength*-1.+1)*A[1] + arclength*B[1];
 600     Geom::Piecewise<Geom::D2<Geom::SBasis> > offsetpath = Geom::sectionize( Geom::D2<Geom::Piecewise<Geom::SBasis> >(offsetx, offsety) );
 601     pwd2 += offsetpath;
 602     _pathv = Geom::path_from_piecewise( pwd2, 0.001 );
 603 }
 604
 605 /**
 606  *  sets start of first path to new_p0, and end of first path to  new_p1
 607  */
 608 void
 609 SPCurve::move_endpoints(Geom::Point const &new_p0, Geom::Point const &new_p1)
 610 {
 611     if (is_empty()) {
 612         return;
 613     }
 614     _pathv.front().setInitial(new_p0);
 615     _pathv.front().setFinal(new_p1);
 616 }
 617
 618 /**
 619  * returns the number of nodes in a path, used for statusbar text when selecting an spcurve.
 620  * Sum of nodes in all the paths. When a path is closed, and its closing line segment is of zero-length,
 621  * this function will not count the closing knot double (so basically ignores the closing line segment when it has zero length)
 622  */
 623 guint
 624 SPCurve::nodes_in_path() const
 625 {
 626     guint nr = 0;
 627     for(Geom::PathVector::const_iterator it = _pathv.begin(); it != _pathv.end(); ++it) {
 628         nr += (*it).size();
 629
 630         nr++; // count last node (this works also for closed paths because although they don't have a 'last node', they do have an extra segment
 631
 632         // do not count closing knot double for zero-length closing line segments
 633         // however, if the path is only a moveto, and is closed, do not subtract 1 (otherwise the result will be zero nodes)
 634         if ( it->closed()
 635              && ((*it).size() != 0) )
 636         {
 637             Geom::Curve const &c = it->back_closed();
 638             if (are_near(c.initialPoint(), c.finalPoint())) {
 639                 nr--;
 640             }
 641         }
 642     }
 643
 644     return nr;
 645 }
 646
 647 /**
 648  *  Adds p to the last point (and last handle if present) of the last path
 649  */
 650 void
 651 SPCurve::last_point_additive_move(Geom::Point const & p)
 652 {
 653     if (is_empty()) {
 654         return;
 655     }
 656
 657     _pathv.back().setFinal( _pathv.back().finalPoint() + p );
 658
 659     // Move handle as well when the last segment is a cubic bezier segment:
 660     // TODO: what to do for quadratic beziers?
 661     if ( Geom::CubicBezier const *lastcube = dynamic_cast<Geom::CubicBezier const *>(&_pathv.back().back()) ) {
 662         Geom::CubicBezier newcube( *lastcube );
 663         newcube.setPoint(2, newcube[2] + p);
 664         _pathv.back().replace( --_pathv.back().end(), newcube );
 665     }
 666 }
 667
 668 /*
 669   Local Variables:
 670   mode:c++
 671   c-file-style:"stroustrup"
 672   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 673   indent-tabs-mode:nil
 674   fill-column:99
 675   End:
 676 */
 677 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :