gradient.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_GRADIENT_H
#define __SYNFIG_GRADIENT_H

/* === H E A D E R S ======================================================= */

#include "real.h"
#include "color.h"
#include <vector>
#include <utility>
#include "uniqueid.h"

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

struct GradientCPoint : public UniqueID
{
    Real pos;
    Color color;

    bool operator<(const GradientCPoint &rhs)const { return pos<rhs.pos; }
    bool operator<(const Real &rhs)const { return pos<rhs; }

    GradientCPoint(): pos() { }
    GradientCPoint(const Real &pos, const Color &color):pos(pos),color(color) { }
}; // END of class GradientCPoint


using namespace std;
class Gradient
{
public:
    typedef GradientCPoint CPoint;
    typedef vector<CPoint> CPointList;
    typedef CPointList::const_iterator          const_iterator;
    typedef CPointList::iterator                iterator;
    typedef CPointList::const_reverse_iterator  const_reverse_iterator;
    typedef CPointList::reverse_iterator        reverse_iterator;
private:
    CPointList cpoints;
public:
    Gradient() { }

    Gradient(const Color &c1, const Color &c2);

    Gradient(const Color &c1, const Color &c2, const Color &c3);

    void sync() { sort(); }

    void sort();

    void push_back(const CPoint cpoint) { cpoints.push_back(cpoint); }
    iterator erase(iterator iter) { return cpoints.erase(iter); }
    bool empty()const { return cpoints.empty(); }
    size_t size()const { return cpoints.size(); }

    iterator begin() { return cpoints.begin(); }
    iterator end() { return cpoints.end(); }
    reverse_iterator rbegin() { return cpoints.rbegin(); }
    reverse_iterator rend() { return cpoints.rend(); }
    const_iterator begin()const { return cpoints.begin(); }
    const_iterator end()const { return cpoints.end(); }
    const_reverse_iterator rbegin()const { return cpoints.rbegin(); }
    const_reverse_iterator rend()const { return cpoints.rend(); }

    Gradient &operator+=(const Gradient &rhs);
    Gradient &operator-=(const Gradient &rhs);
    Gradient &operator*=(const float    &rhs);
    Gradient &operator/=(const float    &rhs);

    Gradient operator+(const Gradient &rhs)const { return Gradient(*this)+=rhs; }
    Gradient operator-(const Gradient &rhs)const { return Gradient(*this)-=rhs; }
    Gradient operator*(const float    &rhs)const { return Gradient(*this)*=rhs; }
    Gradient operator/(const float    &rhs)const { return Gradient(*this)/=rhs; }

    Color operator()(const Real &x, float supersample=0)const;

    Real mag()const;

    iterator proximity(const Real &x);

    const_iterator proximity(const Real &x)const;

    iterator find(const UniqueID &id);

    const_iterator find(const UniqueID &id)const;
}; // END of class Gradient

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif