palette.h

Go to the documentation of this file.

/*
 *  Configurable text colors
 *  Copyright (C) 2008  Douglas Boffey <dougaboffey@netscape.net>
 *  Copyright (C) 2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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
 *  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/>.
 */
 
#pragma once
 
#include "utils/time.h"
 
#include <guichan/color.hpp>
 
#include <cstdlib>
#include <optional>
#include <set>
#include <string>
#include <vector>
 
// Default Gradient Delay
constexpr int GRADIENT_DELAY = 40;
 
class Palette
{
    public:
        Palette(int size);
        Palette(const Palette &) = delete;
        Palette(Palette &&);
        ~Palette();
 
        Palette &operator=(const Palette &) = delete;
        Palette &operator=(Palette &&);
 
        enum GradientType {
            STATIC,
            PULSE,
            SPECTRUM,
            RAINBOW
        };
 
        void setColor(int type,
                      const gcn::Color &color,
                      const std::optional<gcn::Color> &outlineColor,
                      GradientType grad,
                      int delay);
 
        const gcn::Color &getColor(int type) const
        {
            return mColors[type].color;
        }
 
        const std::optional<gcn::Color> &getOutlineColor(int type) const
        {
            return mColors[type].outlineColor;
        }
 
        GradientType getGradientType(int type) const
        {
            return mColors[type].grad;
        }
 
        int getGradientDelay(int type) const
        { return mColors[type].delay; }
 
        static void advanceGradients();
 
    protected:
        static const gcn::Color RAINBOW_COLORS[];
        static const int RAINBOW_COLOR_COUNT;
 
        static Timer mRainbowTimer;
 
        using Palettes = std::set<Palette *>;
        static Palettes mInstances;
 
        void advanceGradient(int advance);
 
        struct ColorElem
        {
            int type;
            gcn::Color color;
            gcn::Color testColor;
            gcn::Color committedColor;
            std::optional<gcn::Color> outlineColor;
            std::string text;
            GradientType grad;
            GradientType committedGrad;
            int gradientIndex;
            int delay;
            int committedDelay;
 
            void set(int type, const gcn::Color &color, GradientType grad, int delay)
            {
                ColorElem::type = type;
                ColorElem::color = color;
                ColorElem::testColor = color;
                ColorElem::grad = grad;
                ColorElem::delay = delay;
                ColorElem::gradientIndex = rand();
            }
 
            int getRGB() const
            {
                return (committedColor.r << 16) | (committedColor.g << 8) |
                        committedColor.b;
            }
        };
        std::vector<ColorElem> mColors;
        std::vector<ColorElem*> mGradVector;
};