synfig::Gradient Class Reference

Color Gradient Class. More...

#include <gradient.h>

List of all members.

Public Types

typedef GradientCPoint CPoint

Public Member Functions

 Gradient ()
 Gradient (const Color &c1, const Color &c2)
 Two-Tone Color Gradient Convience Constructor.
 Gradient (const Color &c1, const Color &c2, const Color &c3)
 Three-Tone Color Gradient Convience Constructor.
void sync ()
 Alias for sort (Implemented for consistancy).
void sort ()
 You should call this function after changing stuff.
Color operator() (const Real &x, float supersample=0) const
iterator proximity (const Real &x)
 Returns the iterator of the CPoint closest to x.
const_iterator proximity (const Real &x) const
 Returns the const_iterator of the CPoint closest to x.
iterator find (const UniqueID &id)
 Returns the iterator of the CPoint with UniqueID id.
const_iterator find (const UniqueID &id) const
 Returns the const_iterator of the CPoint with UniqueID id.


Detailed Description

Color Gradient Class.

Member Typedef Documentation

typedef GradientCPoint synfig::Gradient::CPoint


Constructor & Destructor Documentation

synfig::Gradient::Gradient (  )  [inline]

synfig::Gradient::Gradient ( const Color c1,
const Color c2 
)

Two-Tone Color Gradient Convience Constructor.

synfig::Gradient::Gradient ( const Color c1,
const Color c2,
const Color c3 
)

Three-Tone Color Gradient Convience Constructor.


Member Function Documentation

void synfig::Gradient::sync (  )  [inline]

Alias for sort (Implemented for consistancy).

void synfig::Gradient::sort (  ) 

You should call this function after changing stuff.

Color synfig::Gradient::operator() ( const Real x,
float  supersample = 0 
) const

As a future optimization, this could be performed faster using a binary search.

synfig::Gradient::iterator synfig::Gradient::proximity ( const Real x  ) 

Returns the iterator of the CPoint closest to x.

synfig::Gradient::const_iterator synfig::Gradient::proximity ( const Real x  )  const

Returns the const_iterator of the CPoint closest to x.

synfig::Gradient::iterator synfig::Gradient::find ( const UniqueID id  ) 

Returns the iterator of the CPoint with UniqueID id.

synfig::Gradient::const_iterator synfig::Gradient::find ( const UniqueID id  )  const

Returns the const_iterator of the CPoint with UniqueID id.


The documentation for this class was generated from the following files:
Generated on Wed Aug 15 05:00:24 2007 for synfig by  doxygen 1.5.3