Logo Search packages:      
Sourcecode: inkscape version File versions  Download package


Go to the documentation of this file.
/** \file color-rgba.h

    A class to handle a RGBA color as one unit.
      bulia byak <buliabyak@gmail.com>

    Copyright (C) 2004 Authors

    Released under GNU GPL, read the file 'COPYING' for more information

#include <glib/gmessages.h>

    \brief  A class to contain a floating point RGBA color.
00020 class ColorRGBA {
        \brief  A constructor to create the color from four floating
                point values.
        \param  c0  Red
        \param  c1  Green
        \param  c2  Blue
        \param  c3  Alpha

        Load the values into the array of floats in this object.
00032     ColorRGBA(float c0, float c1, float c2, float c3)
        _c[0] = c0; _c[1] = c1;
        _c[2] = c2; _c[3] = c3;

        \brief  Create a quick ColorRGBA with all zeros
00041     ColorRGBA(void)
        for (int i = 0; i < 4; i++)
            _c[i] = 0.0;

        \brief  Create a ColorRGBA using an array of floats
        \param  in_array  The values to be placed into the object

        Go through each entry in the array and put it into \c _c.
00053     ColorRGBA(float in_array[4])
        for (int i = 0; i < 4; i++)
            _c[i] = in_array[i];

        \brief  Overwrite the values in this object with another \c ColorRGBA.
        \param  m  Values to use for the array
        \return This ColorRGBA object

        Copy all the values from \c m into \c this.
00066     ColorRGBA &operator=(ColorRGBA const &m) {
        for (unsigned i = 0 ; i < 4 ; ++i) {
            _c[i] = m._c[i];
        return *this;

        \brief  Grab a particular value from the ColorRGBA object
        \param  i  Which value to grab
        \return The requested value.

        First checks to make sure that the value is within the array,
        and then return the value if it is.
00081     float operator[](unsigned int const i) const {
        g_assert( unsigned(i) < 4 );
        return _c[i];

        \brief  Check to ensure that two \c ColorRGBA's are equal
        \param  other  The guy to check against
        \return Whether or not they are equal

        Check each value to see if they are equal.  If they all are,
        return TRUE.
00094     bool operator== (const ColorRGBA other) const {
        for (int i = 0; i < 4; i++) {
            if (_c[i] != other[i])
                return FALSE;
        return TRUE;

        \brief  Average two \c ColorRGBAs to create another one.
        \param  second  The second RGBA, with this being the first
        \param  weight  How much of each should be used.  Zero is all
                        this while one is all the second.  Default is
                        half and half.
        This function goes through all the points in the two objects and
        merges them together based on the weighting.  The current objects
        value are multiplied by 1.0 - weight and the second object by weight.
        This means that they should always be balanced by the parameter.
00114     ColorRGBA average (const ColorRGBA second, const float weight = 0.5) const {
        float returnval[4];

        for (int i = 0; i < 4; i++) {
            returnval[i] = _c[i] * (1.0 - weight) + second[i] * weight; 

        return ColorRGBA(returnval[0], returnval[1], returnval[2], returnval[3]);

    /** \brief  Array of values that are stored. */
00126     float _c[4];

#endif /* !SEEN_COLOR_RGBA_H */

  Local Variables:
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :

Generated by  Doxygen 1.6.0   Back to index