tmw/src/gui/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
 *
 *  This file is part of The Mana World.
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALETTE_H
#define PALETTE_H

#include <cstdlib>
#include <string>
#include <vector>

#include <guichan/listmodel.hpp>
#include <guichan/color.hpp>

// Generate strings from an enum ... some preprocessor fun.
#define EDEF(a) a,
#define LASTEDEF(a) a
#define ECONFIGSTR(a) Palette::getConfigName(#a),
#define LASTECONFIGSTR(a) Palette::getConfigName(#a)

#define TEXTENUM(name,def)\
    enum name { def(EDEF,LASTEDEF) };\
    static const std::string name ## Names[]
#define DEFENUMNAMES(name,def)\
    const std::string Palette::name ## Names[] = { def(ECONFIGSTR,ECONFIGSTR) "" }

// Default Gradient Delay
#define GRADIENT_DELAY 40

class Palette : public gcn::ListModel
{
    public:
        #define COLOR_TYPE(ENTRY,LASTENTRY)\
            ENTRY(TEXT)\
            ENTRY(SHADOW)\
            ENTRY(OUTLINE)\
            ENTRY(PROGRESS_BAR)\
            ENTRY(BACKGROUND)\
            ENTRY(HIGHLIGHT)\
            ENTRY(TAB_HIGHLIGHT)\
            ENTRY(SHOP_WARNING)\
            ENTRY(ITEM_EQUIPPED)\
            ENTRY(CHAT)\
            ENTRY(GM)\
            ENTRY(PLAYER)\
            ENTRY(WHISPER)\
            ENTRY(IS)\
            ENTRY(PARTY)\
            ENTRY(SERVER)\
            ENTRY(LOGGER)\
            ENTRY(HYPERLINK)\
            ENTRY(BEING)\
            ENTRY(PC)\
            ENTRY(SELF)\
            ENTRY(GM_NAME)\
            ENTRY(NPC)\
            ENTRY(MONSTER)\
            ENTRY(UNKNOWN_ITEM)\
            ENTRY(GENERIC)\
            ENTRY(HEAD)\
            ENTRY(USABLE)\
            ENTRY(TORSO)\
            ENTRY(ONEHAND)\
            ENTRY(LEGS)\
            ENTRY(FEET)\
            ENTRY(TWOHAND)\
            ENTRY(SHIELD)\
            ENTRY(RING)\
            ENTRY(NECKLACE)\
            ENTRY(ARMS)\
            ENTRY(AMMO)\
            ENTRY(PARTICLE)\
            ENTRY(EXP_INFO)\
            ENTRY(PICKUP_INFO)\
            ENTRY(HIT_PLAYER_MONSTER)\
            ENTRY(HIT_MONSTER_PLAYER)\
            ENTRY(HIT_CRITICAL)\
            ENTRY(MISS)\
            ENTRY(HPBAR_FULL)\
            ENTRY(HPBAR_THREE_QUARTERS)\
            ENTRY(HPBAR_ONE_HALF)\
            ENTRY(HPBAR_ONE_QUARTER)\
            LASTENTRY(TYPE_COUNT)

        TEXTENUM(ColorType, COLOR_TYPE);

        enum GradientType {
            STATIC,
            PULSE,
            SPECTRUM,
            RAINBOW
        };

        Palette();

        ~Palette();

        const gcn::Color &getColor(char c, bool &valid);

        inline const gcn::Color &getColor(ColorType type, int alpha = 255)
        {
            gcn::Color* col = &mColVector[type].color;
            col->a = alpha;
            return *col;
        }

        inline const gcn::Color &getCommittedColor(ColorType type)
        {
            return mColVector[type].committedColor;
        }

        inline const gcn::Color &getTestColor(ColorType type)
        {
            return mColVector[type].testColor;
        }

        inline void setTestColor(ColorType type, gcn::Color color)
        {
            mColVector[type].testColor = color;
        }

        inline GradientType getGradientType(ColorType type)
        {
            return mColVector[type].grad;
        }

        inline int getGradientDelay(ColorType type)
            { return mColVector[type].delay; }

        inline char getColorChar(ColorType type)
        {
            return mColVector[type].ch;
        }

        void setColor(ColorType type, int r, int g, int b);

        void setGradient(ColorType type, GradientType grad);

        void setGradientDelay(ColorType type, int delay)
            { mColVector[type].delay = delay; }

        inline int getNumberOfElements() { return mColVector.size(); }

        std::string getElementAt(int i);

        ColorType getColorTypeAt(int i);

        inline void commit()
        {
            commit(false);
        }

        void rollback();

        void advanceGradient();

    private:
        static const gcn::Color BLACK;

        static const gcn::Color RAINBOW_COLORS[];
        static const int RAINBOW_COLOR_COUNT;
        int mRainbowTime;

        void setColorAt(int i, int r, int g, int b);

        void commit(bool commitNonStatic);

        struct ColorElem
        {
            ColorType type;
            gcn::Color color;
            gcn::Color testColor;
            gcn::Color committedColor;
            std::string text;
            char ch;
            GradientType grad;
            GradientType committedGrad;
            int gradientIndex;
            int delay;
            int committedDelay;

            void set(ColorType type, gcn::Color& color, GradientType grad,
                     const std::string &text, char c, int delay)
            {
                ColorElem::type = type;
                ColorElem::color = color;
                ColorElem::testColor = color;
                ColorElem::text = text;
                ColorElem::ch = c;
                ColorElem::grad = grad;
                ColorElem::delay = delay;
                ColorElem::gradientIndex = rand();
            }

            inline int getRGB()
            {
                return (committedColor.r << 16) | (committedColor.g << 8) |
                        committedColor.b;
            }
        };
        typedef std::vector<ColorElem> ColVector;
        ColVector mColVector;
        std::vector<ColorElem*> mGradVector;

        void addColor(ColorType type, int rgb, GradientType grad,
                      const std::string &text, char c = 0, 
                      int delay = GRADIENT_DELAY);

        static std::string getConfigName(const std::string &typeName);
};

extern Palette *guiPalette;

#endif

---