curve.h

Go to the documentation of this file.

/*
 * Authors:
 *   MenTaLguY <mental@rydia.net>
 *   Marco Cecchetti <mrcekets at gmail.com>
 *   Krzysztof Kosiński <tweenk.pl@gmail.com>
 * 
 * Copyright 2007-2009 Authors
 *
 * This library is free software; you can redistribute it and/or
 * modify it either under the terms of the GNU Lesser General Public
 * License version 2.1 as published by the Free Software Foundation
 * (the "LGPL") or, at your option, under the terms of the Mozilla
 * Public License Version 1.1 (the "MPL"). If you do not alter this
 * notice, a recipient may use your version of this file under either
 * the MPL or the LGPL.
 *
 * You should have received a copy of the LGPL along with this library
 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * You should have received a copy of the MPL along with this library
 * in the file COPYING-MPL-1.1
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
 * OF ANY KIND, either express or implied. See the LGPL or the MPL for
 * the specific language governing rights and limitations.
 */
 
 
#ifndef LIB2GEOM_SEEN_CURVE_H
#define LIB2GEOM_SEEN_CURVE_H
 
#include <vector>
#include <boost/operators.hpp>
#include <2geom/coord.h>
#include <2geom/point.h>
#include <2geom/interval.h>
#include <2geom/sbasis.h>
#include <2geom/d2.h>
#include <2geom/affine.h>
#include <2geom/intersection.h>
 
namespace Geom {
 
class PathSink;
typedef Intersection<> CurveIntersection;
 
class Curve
     : boost::equality_comparable<Curve>
{
public:
    virtual ~Curve() {}
 
 
    virtual Point initialPoint() const = 0;
 
    virtual Point finalPoint() const = 0;
 
    virtual bool isDegenerate() const = 0;
 
    virtual bool isLineSegment() const { return false; }
 
    virtual Interval timeRange() const {
        Interval tr(0, 1);
        return tr;
    }
 
    virtual Point pointAt(Coord t) const { return pointAndDerivatives(t, 0).front(); }
 
    virtual Coord valueAt(Coord t, Dim2 d) const { return pointAt(t)[d]; }
 
    virtual Point operator() (Coord t)  const { return pointAt(t); }
 
    virtual std::vector<Point> pointAndDerivatives(Coord t, unsigned n) const = 0;
 
 
    virtual void setInitial(Point const &v) = 0;
 
    virtual void setFinal(Point const &v) = 0;
 
 
    virtual Rect boundsFast() const = 0;
 
    virtual Rect boundsExact() const = 0;
 
    virtual void expandToTransformed(Rect &bbox, Affine const &transform) const = 0;
 
    // I have no idea what the 'deg' parameter is for, so this is undocumented for now.
    virtual OptRect boundsLocal(OptInterval const &i, unsigned deg) const = 0;
 
    OptRect boundsLocal(OptInterval const &a) const { return boundsLocal(a, 0); }
 
 
    virtual Curve *duplicate() const = 0;
 
    void transform(Affine const &m) {
         *this *= m;
    }
 
    virtual void operator*=(Translate const &tr) { *this *= Affine(tr); }
    virtual void operator*=(Scale const &s) { *this *= Affine(s); }
    virtual void operator*=(Rotate const &r) { *this *= Affine(r); }
    virtual void operator*=(HShear const &hs) { *this *= Affine(hs); }
    virtual void operator*=(VShear const &vs) { *this *= Affine(vs); }
    virtual void operator*=(Zoom const &z) { *this *= Affine(z); }
    virtual void operator*=(Affine const &m) = 0;
 
    virtual Curve *transformed(Affine const &m) const {
         Curve *ret = duplicate();
         ret->transform(m);
         return ret;
    }
 
    virtual Curve *portion(Coord a, Coord b) const = 0;
 
    Curve *portion(Interval const &i) const { return portion(i.min(), i.max()); }
 
    virtual Curve *reverse() const { return portion(1, 0); }
 
    virtual Curve *derivative() const = 0;
 
 
    virtual Coord nearestTime( Point const& p, Coord a = 0, Coord b = 1 ) const;
 
    Coord nearestTime(Point const &p, Interval const &i) const {
        return nearestTime(p, i.min(), i.max());
    }
 
    virtual std::vector<Coord> allNearestTimes( Point const& p, Coord from = 0,
        Coord to = 1 ) const;
 
    std::vector<Coord> allNearestTimes(Point const &p, Interval const &i) {
        return allNearestTimes(p, i.min(), i.max());
    }
 
    virtual Coord length(Coord tolerance=0.01) const;
 
    virtual std::vector<Coord> roots(Coord v, Dim2 d) const = 0;
 
    virtual int winding(Point const &p) const;
 
    virtual std::vector<CurveIntersection> intersect(Curve const &other, Coord eps = EPSILON) const;
 
    virtual std::vector<CurveIntersection> intersectSelf(Coord eps = EPSILON) const;
 
    virtual Point unitTangentAt(Coord t, unsigned n = 3) const;
 
    virtual D2<SBasis> toSBasis() const = 0;
    
 
    virtual int degreesOfFreedom() const { return 0;}
 
    bool operator==(Curve const &c) const { return _equalTo(c); }
 
    virtual bool isNear(Curve const &c, Coord precision) const = 0;
 
    virtual void feed(PathSink &sink, bool moveto_initial) const;
 
protected:
    virtual bool _equalTo(Curve const &c) const = 0;
};
 
inline
Coord nearest_time(Point const& p, Curve const& c) {
    return c.nearestTime(p);
}
 
// for make benefit glorious library of Boost Pointer Container
inline
Curve *new_clone(Curve const &c) {
     return c.duplicate();
}
 
} // end namespace Geom
 
 
#endif // _2GEOM_CURVE_H_
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :