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  */
 204 void
 205 SPCurve::moveto(Geom::Point const &p)
 206 {
 207     _pathv.push_back( Geom::Path() );  // for some reason Geom::Path(p) does not work...
 208     _pathv.back().start(p);
 209 }
 210
 211 /**
 212  * Calls SPCurve::lineto() with a point's coordinates.
 213  */
 214 void
 215 SPCurve::lineto(Geom::Point const &p)
 216 {
 217     lineto(p[Geom::X], p[Geom::Y]);
 218 }
 219 /**
 220  * Adds a line to the current subpath.
 221  */
 222 void
 223 SPCurve::lineto(gdouble x, gdouble y)
 224 {
 225     if (_pathv.empty())  g_message("leeg");
 226     else _pathv.back().appendNew<Geom::LineSegment>( Geom::Point(x,y) );
 227 }
 228
 229 /**
 230  * Calls SPCurve::curveto() with coordinates of three points.
 231  */
 232 void
 233 SPCurve::curveto(Geom::Point const &p0, Geom::Point const &p1, Geom::Point const &p2)
 234 {
 235     using Geom::X;
 236     using Geom::Y;
 237     curveto( p0[X], p0[Y],
 238              p1[X], p1[Y],
 239              p2[X], p2[Y] );
 240 }
 241 /**
 242  * Adds a bezier segment to the current subpath.
 243  */
 244 void
 245 SPCurve::curveto(gdouble x0, gdouble y0, gdouble x1, gdouble y1, gdouble x2, gdouble y2)
 246 {
 247     if (_pathv.empty())  g_message("leeg");
 248     else _pathv.back().appendNew<Geom::CubicBezier>( Geom::Point(x0,y0), Geom::Point(x1,y1), Geom::Point(x2,y2) );
 249 }
 250
 251 /**
 252  * Close current subpath by possibly adding a line between start and end.
 253  */
 254 void
 255 SPCurve::closepath()
 256 {
 257     _pathv.back().close(true);
 258 }
 259
 260 /** Like SPCurve::closepath() but sets the end point of the last subpath
 261     to the subpath start point instead of adding a new lineto.
 262
 263     Used for freehand drawing when the user draws back to the start point.
 264 **/
 265 void
 266 SPCurve::closepath_current()
 267 {
 268     _pathv.back().setFinal(_pathv.back().initialPoint());
 269     _pathv.back().close(true);
 270 }
 271
 272 /**
 273  * True if no paths are in curve. If it only contains a path with only a moveto, the path is considered NON-empty
 274  */
 275 bool
 276 SPCurve::is_empty() const
 277 {
 278     return _pathv.empty();
 279 }
 280
 281 /**
 282  * True iff all subpaths are closed.
 283  * Returns false if the curve is empty.
 284  */
 285 bool
 286 SPCurve::is_closed() const
 287 {
 288     if (is_empty()) {
 289         return false;
 290     } else {
 291         bool closed = true;
 292         for (Geom::PathVector::const_iterator it = _pathv.begin(); it != _pathv.end(); it++) {
 293              if ( ! it->closed() ) {
 294                 closed = false;
 295                 break;
 296             }
 297         }
 298         return closed;
 299     }
 300 }
 301
 302 /**
 303  * Return last pathsegment (possibly the closing path segment) of the last path in PathVector or NULL.
 304  * If the last path is empty (contains only a moveto), the function returns NULL
 305  */
 306 Geom::Curve const *
 307 SPCurve::last_segment() const
 308 {
 309     if (is_empty()) {
 310         return NULL;
 311     }
 312     if (_pathv.back().empty()) {
 313         return NULL;
 314     }
 315
 316     return &_pathv.back().back_default();
 317 }
 318
 319 /**
 320  * Return last path in PathVector or NULL.
 321  */
 322 Geom::Path const *
 323 SPCurve::last_path() const
 324 {
 325     if (is_empty()) {
 326         return NULL;
 327     }
 328
 329     return &_pathv.back();
 330 }
 331
 332 /**
 333  * Return first pathsegment in PathVector or NULL.
 334  * equal in functionality to SPCurve::first_bpath()
 335  */
 336 Geom::Curve const *
 337 SPCurve::first_segment() const
 338 {
 339     if (is_empty()) {
 340         return NULL;
 341     }
 342     if (_pathv.front().empty()) {
 343         return NULL;
 344     }
 345
 346     return &_pathv.front().front();
 347 }
 348
 349 /**
 350  * Return first path in PathVector or NULL.
 351  */
 352 Geom::Path const *
 353 SPCurve::first_path() const
 354 {
 355     if (is_empty()) {
 356         return NULL;
 357     }
 358
 359     return &_pathv.front();
 360 }
 361
 362 /**
 363  * Return first point of first subpath or nothing when the path is empty.
 364  */
 365 boost::optional<Geom::Point>
 366 SPCurve::first_point() const
 367 {
 368     boost::optional<Geom::Point> retval;
 369
 370     if (!is_empty()) {
 371         retval = _pathv.front().initialPoint();
 372     }
 373
 374     return retval;
 375 }
 376
 377 /**
 378  * Return the second point of first subpath or _movePos if curve too short.
 379  * If the pathvector is empty, this returns nothing. If the first path is only a moveto, this method
 380  * returns the first point of the second path, if it exists. If there is no 2nd path, it returns the
 381  * first point of the first path.
 382  */
 383 boost::optional<Geom::Point>
 384 SPCurve::second_point() const
 385 {
 386     boost::optional<Geom::Point> retval;
 387     if (!is_empty()) {
 388         if (_pathv.front().empty()) {
 389             // first path is only a moveto
 390             // check if there is second path
 391             if (_pathv.size() > 1) {
 392                 retval = _pathv[1].initialPoint();
 393             } else {
 394                 retval = _pathv[0].initialPoint();
 395             }
 396         } else {
 397             retval = _pathv.front()[0].finalPoint();
 398         }
 399     }
 400
 401     return retval;
 402 }
 403
 404 /**
 405  * TODO: fix comment: Return the second-last point of last subpath or _movePos if curve too short.
 406  */
 407 boost::optional<Geom::Point>
 408 SPCurve::penultimate_point() const
 409 {
 410     boost::optional<Geom::Point> retval;
 411     if (!is_empty()) {
 412         Geom::Curve const& back = _pathv.back().back_default();
 413         retval = back.initialPoint();
 414     }
 415
 416     return retval;
 417 }
 418
 419 /**
 420  * Return last point of last subpath or nothing when the curve is empty.
 421  * If the last path is only a moveto, then return that point.
 422  */
 423 boost::optional<Geom::Point>
 424 SPCurve::last_point() const
 425 {
 426     boost::optional<Geom::Point> retval;
 427
 428     if (!is_empty()) {
 429         retval = _pathv.back().finalPoint();
 430     }
 431
 432     return retval;
 433 }
 434
 435 /**
 436  * Returns a *new* \a curve but drawn in the opposite direction.
 437  * Should result in the same shape, but
 438  * with all its markers drawn facing the other direction.
 439  * Reverses the order of subpaths as well
 440  **/
 441 SPCurve *
 442 SPCurve::create_reverse() const
 443 {
 444     SPCurve *new_curve = new SPCurve(Geom::reverse_paths_and_order(_pathv));
 445
 446     return new_curve;
 447 }
 448
 449 /**
 450  * Append \a curve2 to \a this.
 451  * If \a use_lineto is false, simply add all paths in \a curve2 to \a this;
 452  * 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.
 453  */
 454 void
 455 SPCurve::append(SPCurve const *curve2,
 456                 bool use_lineto)
 457 {
 458     if (curve2->is_empty())
 459         return;
 460
 461     if (use_lineto) {
 462         Geom::PathVector::const_iterator it = curve2->_pathv.begin();
 463         if ( ! _pathv.empty() ) {
 464             Geom::Path & lastpath = _pathv.back();
 465             lastpath.appendNew<Geom::LineSegment>( (*it).initialPoint() );
 466             lastpath.append( (*it) );
 467         } else {
 468             _pathv.push_back( (*it) );
 469         }
 470
 471         for (it++; it != curve2->_pathv.end(); it++) {
 472             _pathv.push_back( (*it) );
 473         }
 474     } else {
 475         for (Geom::PathVector::const_iterator it = curve2->_pathv.begin(); it != curve2->_pathv.end(); it++) {
 476             _pathv.push_back( (*it) );
 477         }
 478     }
 479 }
 480
 481 /**
 482  * 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,
 483  * 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.
 484  * 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.
 485  * When one of the curves is empty, this curves path becomes the non-empty path.
 486  */
 487 SPCurve *
 488 SPCurve::append_continuous(SPCurve const *c1, gdouble tolerance)
 489 {
 490     using Geom::X;
 491     using Geom::Y;
 492
 493     g_return_val_if_fail(c1 != NULL, NULL);
 494     if ( this->is_closed() || c1->is_closed() ) {
 495         return NULL;
 496     }
 497
 498     if (c1->is_empty()) {
 499         return this;
 500     }
 501
 502     if (this->is_empty()) {
 503         _pathv = c1->_pathv;
 504         return this;
 505     }
 506
 507     if ( (fabs((*this->last_point())[X] - (*c1->first_point())[X]) <= tolerance)
 508          && (fabs((*this->last_point())[Y] - (*c1->first_point())[Y]) <= tolerance) )
 509     {
 510     // c1's first subpath can be appended to this curve's last subpath
 511         Geom::PathVector::const_iterator path_it = c1->_pathv.begin();
 512         Geom::Path & lastpath = _pathv.back();
 513
 514         Geom::Path newfirstpath(*path_it);
 515         newfirstpath.setInitial(lastpath.finalPoint());
 516         lastpath.append( newfirstpath );
 517
 518         for (path_it++; path_it != c1->_pathv.end(); path_it++) {
 519             _pathv.push_back( (*path_it) );
 520         }
 521
 522     } else {
 523         append(c1, true);
 524     }
 525
 526     return this;
 527 }
 528
 529 /**
 530  * Remove last segment of curve.
 531  * (Only used once in /src/pen-context.cpp)
 532  */
 533 void
 534 SPCurve::backspace()
 535 {
 536     if ( is_empty() )
 537         return;
 538
 539     if ( !_pathv.back().empty() ) {
 540         _pathv.back().erase_last();
 541         _pathv.back().close(false);
 542     }
 543 }
 544
 545 /**
 546  * TODO: add comments about what this method does and what assumptions are made and requirements are put on SPCurve
 547  */
 548 void
 549 SPCurve::stretch_endpoints(Geom::Point const &new_p0, Geom::Point const &new_p1)
 550 {
 551     if (is_empty()) {
 552         return;
 553     }
 554
 555     Geom::Point const offset0( new_p0 - *first_point() );
 556     Geom::Point const offset1( new_p1 - *last_point() );
 557
 558     Geom::Piecewise<Geom::D2<Geom::SBasis> > pwd2 = _pathv.front().toPwSb();
 559     Geom::Piecewise<Geom::SBasis> arclength = Geom::arcLengthSb(pwd2);
 560     if ( arclength.lastValue() <= 0 ) {
 561         g_error("SPCurve::stretch_endpoints - arclength <= 0");
 562         throw;
 563     }
 564     arclength *= 1./arclength.lastValue();
 565     Geom::Point const A( offset0 );
 566     Geom::Point const B( offset1 );
 567     Geom::Piecewise<Geom::SBasis> offsetx = (arclength*-1.+1)*A[0] + arclength*B[0];
 568     Geom::Piecewise<Geom::SBasis> offsety = (arclength*-1.+1)*A[1] + arclength*B[1];
 569     Geom::Piecewise<Geom::D2<Geom::SBasis> > offsetpath = Geom::sectionize( Geom::D2<Geom::Piecewise<Geom::SBasis> >(offsetx, offsety) );
 570     pwd2 += offsetpath;
 571     _pathv = Geom::path_from_piecewise( pwd2, 0.001 );
 572 }
 573
 574 /**
 575  *  sets start of first path to new_p0, and end of first path to  new_p1
 576  */
 577 void
 578 SPCurve::move_endpoints(Geom::Point const &new_p0, Geom::Point const &new_p1)
 579 {
 580     if (is_empty()) {
 581         return;
 582     }
 583     _pathv.front().setInitial(new_p0);
 584     _pathv.front().setFinal(new_p1);
 585 }
 586
 587 /**
 588  * returns the number of nodes in a path, used for statusbar text when selecting an spcurve.
 589  */
 590 guint
 591 SPCurve::nodes_in_path() const
 592 {
 593     guint nr = 0;
 594     for(Geom::PathVector::const_iterator it = _pathv.begin(); it != _pathv.end(); ++it) {
 595         nr += (*it).size();
 596
 597         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
 598     }
 599
 600     return nr;
 601 }
 602
 603 /**
 604  *  Adds p to the last point (and last handle if present) of the last path
 605  */
 606 void
 607 SPCurve::last_point_additive_move(Geom::Point const & p)
 608 {
 609     if (is_empty()) {
 610         return;
 611     }
 612
 613     _pathv.back().setFinal( _pathv.back().finalPoint() + p );
 614
 615     // Move handle as well when the last segment is a cubic bezier segment:
 616     // TODO: what to do for quadratic beziers?
 617     if ( Geom::CubicBezier const *lastcube = dynamic_cast<Geom::CubicBezier const *>(&_pathv.back().back()) ) {
 618         Geom::CubicBezier newcube( *lastcube );
 619         newcube.setPoint(2, newcube[2] + p);
 620         _pathv.back().replace( --_pathv.back().end(), newcube );
 621     }
 622 }
 623
 624 /*
 625   Local Variables:
 626   mode:c++
 627   c-file-style:"stroustrup"
 628   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 629   indent-tabs-mode:nil
 630   fill-column:99
 631   End:
 632 */
 633 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :