1 /* === S Y N F I G ========================================================= */
3 ** \brief Color Gradient Class
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === S T A R T =========================================================== */
25 #ifndef __SYNFIG_GRADIENT_H
26 #define __SYNFIG_GRADIENT_H
28 /* === H E A D E R S ======================================================= */
36 /* === M A C R O S ========================================================= */
38 /* === T Y P E D E F S ===================================================== */
40 /* === C L A S S E S & S T R U C T S ======================================= */
44 /*! \struct GradientCPoint
47 struct GradientCPoint : public UniqueID
52 bool operator<(const GradientCPoint &rhs)const { return pos<rhs.pos; }
53 bool operator<(const Real &rhs)const { return pos<rhs; }
56 GradientCPoint(const Real &pos, const Color &color):pos(pos),color(color) { }
57 }; // END of class GradientCPoint
61 ** \brief Color Gradient Class
67 typedef GradientCPoint CPoint;
68 typedef vector<CPoint> CPointList;
69 typedef CPointList::const_iterator const_iterator;
70 typedef CPointList::iterator iterator;
71 typedef CPointList::const_reverse_iterator const_reverse_iterator;
72 typedef CPointList::reverse_iterator reverse_iterator;
78 //! Two-Tone Color Gradient Convenience Constructor
79 Gradient(const Color &c1, const Color &c2);
81 //! Three-Tone Color Gradient Convenience Constructor
82 Gradient(const Color &c1, const Color &c2, const Color &c3);
84 //! Alias for sort (Implemented for consistency)
85 void sync() { sort(); }
87 //! You should call this function after changing stuff.
90 void push_back(const CPoint cpoint) { cpoints.push_back(cpoint); }
91 iterator erase(iterator iter) { return cpoints.erase(iter); }
92 bool empty()const { return cpoints.empty(); }
93 size_t size()const { return cpoints.size(); }
95 iterator begin() { return cpoints.begin(); }
96 iterator end() { return cpoints.end(); }
97 reverse_iterator rbegin() { return cpoints.rbegin(); }
98 reverse_iterator rend() { return cpoints.rend(); }
99 const_iterator begin()const { return cpoints.begin(); }
100 const_iterator end()const { return cpoints.end(); }
101 const_reverse_iterator rbegin()const { return cpoints.rbegin(); }
102 const_reverse_iterator rend()const { return cpoints.rend(); }
104 Gradient &operator+=(const Gradient &rhs);
105 Gradient &operator-=(const Gradient &rhs);
106 Gradient &operator*=(const float &rhs);
107 Gradient &operator/=(const float &rhs);
109 Gradient operator+(const Gradient &rhs)const { return Gradient(*this)+=rhs; }
110 Gradient operator-(const Gradient &rhs)const { return Gradient(*this)-=rhs; }
111 Gradient operator*(const float &rhs)const { return Gradient(*this)*=rhs; }
112 Gradient operator/(const float &rhs)const { return Gradient(*this)/=rhs; }
114 Color operator()(const Real &x, float supersample=0)const;
116 //! Returns the iterator of the CPoint closest to \a x
117 iterator proximity(const Real &x);
119 //! Returns the const_iterator of the CPoint closest to \a x
120 const_iterator proximity(const Real &x)const;
122 //! Returns the iterator of the CPoint with UniqueID \a id
123 iterator find(const UniqueID &id);
125 //! Returns the const_iterator of the CPoint with UniqueID \a id
126 const_iterator find(const UniqueID &id)const;
127 }; // END of class Gradient
129 }; // END of namespace synfig
131 /* === E N D =============================================================== */