RGBColor.h

Go to the documentation of this file.

/****************************************************************************/
// A RGB-color definition
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   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 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef RGBColor_h
#define RGBColor_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <iostream>
#include <utils/common/UtilExceptions.h>


// ===========================================================================
// class definitions
// ===========================================================================
class RGBColor {
public:
    RGBColor() throw();


    RGBColor(SUMOReal red, SUMOReal green, SUMOReal blue) throw();


    RGBColor(const RGBColor& col) throw();


    ~RGBColor() throw();



    SUMOReal red() const throw() {
        return myRed;
    }


    SUMOReal green() const throw() {
        return myGreen;
    }


    SUMOReal blue() const throw() {
        return myBlue;
    }


    void set(SUMOReal r, SUMOReal g, SUMOReal b) throw();


    friend std::ostream& operator<<(std::ostream& os, const RGBColor& col);


    bool operator==(const RGBColor& c) const;
    bool operator!=(const RGBColor& c) const;


    RGBColor changedBrightness(SUMOReal change);


    static RGBColor parseColor(const std::string& coldef) throw(EmptyData, NumberFormatException);


    static RGBColor parseColorReporting(const std::string& coldef, const std::string& objecttype,
                                        const char* objectid, bool report, bool& ok) throw();


    static RGBColor getDefaultColor() throw();


    static RGBColor interpolate(const RGBColor& minColor, const RGBColor& maxColor, SUMOReal weight) throw();


    static RGBColor fromHSV(SUMOReal h, SUMOReal s, SUMOReal v) throw();


    static const std::string DEFAULT_COLOR_STRING;


    static const RGBColor DEFAULT_COLOR;


private:
    SUMOReal myRed, myGreen, myBlue;

};


#endif

/****************************************************************************/