RGBColor.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A RGB-color definition
/****************************************************************************/
#pragma once
#include <config.h>
#include <iosfwd>
#include <utils/common/UtilExceptions.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SumoRNG;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class RGBColor {
public:
    RGBColor(bool valid = true);

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

    unsigned char red() const;

    unsigned char green() const;

    unsigned char blue() const;

    unsigned char alpha() const;

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

    void setAlpha(unsigned char alpha);

    void setValid(const bool value);

    bool isValid() const;

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

    RGBColor changedAlpha(int change) const;

    RGBColor multiply(double factor) const;

    RGBColor invertedColor() const;

    static SumoRNG* getColorRNG();

    static RGBColor parseColor(std::string coldef);

    static bool isColor(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);

    static RGBColor randomHue(double s = 1, double v = 1);

    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 INVISIBLE;

    static const RGBColor DEFAULT_COLOR;

    static const std::string DEFAULT_COLOR_STRING;
 
private:
    unsigned char myRed, myGreen, myBlue, myAlpha;

    bool myValid;

    static SumoRNG myRNG;
};