synfig-core  1.0.3
Public Types | Public Member Functions | Friends | List of all members
synfig::ColorAccumulator Class Reference

#include <coloraccumulator.h>

Public Types

typedef float value_type

Public Member Functions

ColorAccumulatoroperator+= (const ColorAccumulator &rhs)
ColorAccumulatoroperator-= (const ColorAccumulator &rhs)
ColorAccumulatoroperator*= (const float &rhs)
ColorAccumulatoroperator/= (const float &rhs)
ColorAccumulator operator+ (const ColorAccumulator &rhs) const
ColorAccumulator operator- (const ColorAccumulator &rhs) const
ColorAccumulator operator* (const float &rhs) const
ColorAccumulator operator/ (const float &rhs) const
bool operator== (const ColorAccumulator &rhs) const
bool operator!= (const ColorAccumulator &rhs) const
Color operator- () const
bool is_valid () const
 ColorAccumulator ()
 ColorAccumulator (const value_type &R, const value_type &G, const value_type &B, const value_type &A=1)
 ColorAccumulator (const ColorAccumulator &c)
 Copy constructor.
 ColorAccumulator (const Color &c)
 Converter.
 ColorAccumulator (int c)
 Converter.
const value_typeget_r () const
 Returns the RED component.
const value_typeget_g () const
 Returns the GREEN component.
const value_typeget_b () const
 Returns the BLUE component.
const value_typeget_a () const
 Returns the amount of opacity (alpha)
const value_typeget_alpha () const
 Synonym for get_a().
ColorAccumulatorset_r (const value_type &x)
 Sets the RED component to x.
ColorAccumulatorset_g (const value_type &x)
 Sets the GREEN component to x.
ColorAccumulatorset_b (const value_type &x)
 Sets the BLUE component to x.
ColorAccumulatorset_a (const value_type &x)
 Sets the opacity (alpha) to x.
ColorAccumulatorset_alpha (const value_type &x)
 Synonym for set_a().

Friends

class Color

Member Typedef Documentation

Constructor & Destructor Documentation

synfig::ColorAccumulator::ColorAccumulator ( )
inline

Referenced by operator-().

synfig::ColorAccumulator::ColorAccumulator ( const value_type R,
const value_type G,
const value_type B,
const value_type A = 1 
)
inline
Parameters
RRed
GGreen
BBlue
AOpacity(alpha)
synfig::ColorAccumulator::ColorAccumulator ( const ColorAccumulator c)
inline

Copy constructor.

synfig::ColorAccumulator::ColorAccumulator ( const Color c)
inline

Converter.

synfig::ColorAccumulator::ColorAccumulator ( int  c)
inline

Converter.

Member Function Documentation

ColorAccumulator& synfig::ColorAccumulator::operator+= ( const ColorAccumulator rhs)
inline
ColorAccumulator& synfig::ColorAccumulator::operator-= ( const ColorAccumulator rhs)
inline
ColorAccumulator& synfig::ColorAccumulator::operator*= ( const float &  rhs)
inline
ColorAccumulator& synfig::ColorAccumulator::operator/= ( const float &  rhs)
inline
ColorAccumulator synfig::ColorAccumulator::operator+ ( const ColorAccumulator rhs) const
inline

References Color.

ColorAccumulator synfig::ColorAccumulator::operator- ( const ColorAccumulator rhs) const
inline

References Color.

ColorAccumulator synfig::ColorAccumulator::operator* ( const float &  rhs) const
inline

References Color.

ColorAccumulator synfig::ColorAccumulator::operator/ ( const float &  rhs) const
inline

References Color.

bool synfig::ColorAccumulator::operator== ( const ColorAccumulator rhs) const
inline
bool synfig::ColorAccumulator::operator!= ( const ColorAccumulator rhs) const
inline
Color synfig::ColorAccumulator::operator- ( ) const
inline

References ColorAccumulator().

bool synfig::ColorAccumulator::is_valid ( ) const
inline

References isnan.

Referenced by synfig::Gradient::operator()().

const value_type& synfig::ColorAccumulator::get_r ( ) const
inline

Returns the RED component.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

const value_type& synfig::ColorAccumulator::get_g ( ) const
inline

Returns the GREEN component.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

const value_type& synfig::ColorAccumulator::get_b ( ) const
inline

Returns the BLUE component.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

const value_type& synfig::ColorAccumulator::get_a ( ) const
inline

Returns the amount of opacity (alpha)

Referenced by get_alpha(), synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

const value_type& synfig::ColorAccumulator::get_alpha ( ) const
inline

Synonym for get_a().

See Also
get_a()

References get_a().

ColorAccumulator& synfig::ColorAccumulator::set_r ( const value_type x)
inline

Sets the RED component to x.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

ColorAccumulator& synfig::ColorAccumulator::set_g ( const value_type x)
inline

Sets the GREEN component to x.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

ColorAccumulator& synfig::ColorAccumulator::set_b ( const value_type x)
inline

Sets the BLUE component to x.

Referenced by synfig::Gradient::operator()(), and synfig::ColorPrep::uncook().

ColorAccumulator& synfig::ColorAccumulator::set_a ( const value_type x)
inline

Sets the opacity (alpha) to x.

Referenced by set_alpha().

ColorAccumulator& synfig::ColorAccumulator::set_alpha ( const value_type x)
inline

Synonym for set_a().

See Also
set_a()

References set_a().

Friends And Related Function Documentation

friend class Color
friend

The documentation for this class was generated from the following file: