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