visual.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VIEW_VISUAL_H
#define FIFE_VIEW_VISUAL_H

// Standard C++ library includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "model/metamodel/ivisual.h"
#include "util/math/angles.h"
#include "util/structures/rect.h"
#include "video/animation.h"
#include "video/color.h"


namespace FIFE {
    class Object;
    class Instance;
    class Action;
    class Image;

    class OverlayColors {
    public:
        OverlayColors();
        OverlayColors(ImagePtr image);
        OverlayColors(AnimationPtr animation);

        ~OverlayColors();

        void setColorOverlayImage(ImagePtr image);
        ImagePtr getColorOverlayImage();
        void setColorOverlayAnimation(AnimationPtr animation);
        AnimationPtr getColorOverlayAnimation();
        void changeColor(const Color& source, const Color& target);
        const std::map<Color, Color>& getColors();
        void resetColors();

    private:
        std::map<Color, Color> m_colorMap;
        ImagePtr m_image;
        AnimationPtr m_animation;
    };

    class Visual2DGfx: public IVisual {
    public:
        virtual ~Visual2DGfx();

    protected:
        Visual2DGfx();
    };

    class ObjectVisual: public Visual2DGfx {
    public:
        static ObjectVisual* create(Object* object);

        virtual ~ObjectVisual();

        void addStaticImage(uint32_t angle, int32_t image_index);

        int32_t getStaticImageIndexByAngle(int32_t angle);

        void addStaticColorOverlay(uint32_t angle, const OverlayColors& colors);

        OverlayColors* getStaticColorOverlay(int32_t angle);

        void removeStaticColorOverlay(int32_t angle);

        int32_t getClosestMatchingAngle(int32_t angle);

        void getStaticImageAngles(std::vector<int32_t>& angles);

        bool isColorOverlay() { return !m_colorOverlayMap.empty(); }

    private:
        ObjectVisual();

        type_angle2id m_angle2img;
        
        typedef std::map<uint32_t, OverlayColors> AngleColorOverlayMap;
        AngleColorOverlayMap m_colorOverlayMap;
        type_angle2id m_map;
    };


    class InstanceVisual: public Visual2DGfx {
    public:
        static InstanceVisual* create(Instance* instance);

        virtual ~InstanceVisual();

        void setTransparency(uint8_t transparency);

        uint8_t getTransparency();

        void setVisible(bool visible);

        bool isVisible();

        void setStackPosition(int32_t stackposition);

        int32_t getStackPosition();

    private:
        InstanceVisual();
        uint8_t m_transparency;
        bool m_visible;
        int32_t m_stackposition;
        Instance* m_instance;
    };

    class ActionVisual: public Visual2DGfx {
    public:
        static ActionVisual* create(Action* action);

        virtual ~ActionVisual();

        void addAnimation(uint32_t angle, AnimationPtr animationptr);

        AnimationPtr getAnimationByAngle(int32_t angle);

        void addAnimationOverlay(uint32_t angle, int32_t order, AnimationPtr animationptr);

        std::map<int32_t, AnimationPtr> getAnimationOverlay(int32_t angle);

        void removeAnimationOverlay(uint32_t angle, int32_t order);

        void addColorOverlay(uint32_t angle, const OverlayColors& colors);

        OverlayColors* getColorOverlay(int32_t angle);

        void removeColorOverlay(int32_t angle);

        void addColorOverlay(uint32_t angle, int32_t order, const OverlayColors& colors);

        OverlayColors* getColorOverlay(int32_t angle, int32_t order);

        void removeColorOverlay(int32_t angle, int32_t order);

        void getActionImageAngles(std::vector<int32_t>& angles);

        void convertToOverlays(bool color);

        bool isAnimationOverlay() { return !m_animationOverlayMap.empty(); }

        bool isColorOverlay() { return !m_colorOverlayMap.empty() || !m_colorAnimationOverlayMap.empty(); }

    private:
        ActionVisual();

        // animations associated with this action
        typedef std::map<uint32_t, AnimationPtr> AngleAnimationMap;
        AngleAnimationMap m_animation_map;

        typedef std::map<uint32_t, std::map<int32_t, AnimationPtr> > AngleAnimationOverlayMap;
        AngleAnimationOverlayMap m_animationOverlayMap;

        typedef std::map<uint32_t, OverlayColors> AngleColorOverlayMap;
        AngleColorOverlayMap m_colorOverlayMap;

        typedef std::map<uint32_t, std::map<int32_t, OverlayColors> > AngleColorAnimationOverlayMap;
        AngleColorAnimationOverlayMap m_colorAnimationOverlayMap;
        //need this map to use the getIndexByAngle() function in angles.h
        type_angle2id m_map;
    };

}
#endif