color.hpp

Go to the documentation of this file.

/*
**    TP 4ETI CPE Lyon
**    Copyright (C) 2011 Damien Rohmer
**
**    This program is free software: you can redistribute it and/or modify
**    it under the terms of the GNU General Public License as published by
**    the Free Software Foundation, either version 3 of the License, or
**    (at your option) any later version.
**
**   This program is distributed in the hope that it will be useful,
**    but WITHOUT ANY WARRANTY; without even the implied warranty of
**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**    GNU General Public License for more details.
**
**    You should have received a copy of the GNU General Public License
**    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _COLOR_RGB_HPP_
#define _COLOR_RGB_HPP_

#include <iostream>
#include <exception_cpe.hpp>

#include <vector>

namespace cpe
{
    class color
    {
    public:


        // ********************************************* //
        // ********************************************* //
        //  CONSTRUCTORS
        // ********************************************* //
        // ********************************************* //

        color();
        color(const unsigned char& gray);
        color(const unsigned char& r,const unsigned char& g,const unsigned char& b);

        // ********************************************* //
        // ********************************************* //
        //  ACCESS COLOR VALUE
        // ********************************************* //
        // ********************************************* //

        void set(const unsigned char& r,const unsigned char& g,const unsigned char& b);
        void get(unsigned char* r,unsigned char* g,unsigned char *b) const;

        const unsigned char& r() const;
        unsigned char& r();
        const unsigned char& g() const;
        unsigned char& g();
        const unsigned char& b() const;
        unsigned char& b();

        // ********************************************* //
        // ********************************************* //
        //  COLOR INTERPOLATION
        // ********************************************* //
        // ********************************************* //

        static color interpolate_linear(const color& c1,const color& c2,double alpha);

        static color interpolate_linear(const std::vector<color>& v_color,const std::vector<double>& weights);


        // ********************************************* //
        // ********************************************* //
        //  MATH OPERATOR
        // ********************************************* //
        // ********************************************* //

        friend color operator+(const color& c0,const color& c1);
        color& operator+=(const color& c);

        friend color operator*(const double& alpha,const color& c);
        friend color operator*(const color& c,const double& alpha);
        color& operator*=(const double& alpha);



        // ********************************************* //
        // ********************************************* //
        //  I/O
        // ********************************************* //
        // ********************************************* //

        friend std::ostream& operator<<(std::ostream& stream,const color& c);


    private:

        // ********************************************* //
        // ********************************************* //
        //  INTERNAL STORAGE
        // ********************************************* //
        // ********************************************* //

        unsigned char internal_r;
        unsigned char internal_g;
        unsigned char internal_b;

    };

    class exception_color: public exception_cpe
    {
    public:
        exception_color():exception_cpe(){}
        exception_color(const std::string& msg,const std::string& file,const std::string& caller,const int& line):exception_cpe(msg,file,caller,line){}
    };
}

#endif