RGBColor.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// A RGB-color definition
/****************************************************************************/
#ifndef RGBColor_h
#define RGBColor_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

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


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

    RGBColor(unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha = 255);

    RGBColor(const RGBColor& col);

    ~RGBColor();

    unsigned char red() const {
        return myRed;
    }

    unsigned char green() const {
        return myGreen;
    }

    unsigned char blue() const {
        return myBlue;
    }

    unsigned char alpha() const {
        return myAlpha;
    }

    void set(unsigned char r, unsigned char g, unsigned char b, unsigned char a);

    RGBColor changedBrightness(int change, int toChange = 3) const;

    RGBColor invertedColor() const;

    static RGBColor parseColor(std::string coldef);

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

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

    static RGBColor fromHSV(double h, double s, double v);

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

    // @brief Equality operator
    bool operator==(const RGBColor& c) const;

    // @brief Inequality operator
    bool operator!=(const RGBColor& c) const;

    static const RGBColor RED;
    static const RGBColor GREEN;
    static const RGBColor BLUE;
    static const RGBColor YELLOW;
    static const RGBColor CYAN;
    static const RGBColor MAGENTA;
    static const RGBColor ORANGE;
    static const RGBColor WHITE;
    static const RGBColor BLACK;
    static const RGBColor GREY;

    static const RGBColor DEFAULT_COLOR;

    static const std::string DEFAULT_COLOR_STRING;

private:
    unsigned char myRed, myGreen, myBlue, myAlpha;
};


#endif

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