rendererbase.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_RENDERERBASE_H
#define FIFE_RENDERERBASE_H

// Standard C++ library includes
#include <list>
#include <vector>

// 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 "renderitem.h"

namespace FIFE {
    class Camera;
    class Layer;
    class Map;
    class Instance;
    class RenderBackend;
    
    class RendererBase;
    class IRendererListener {
    public:
        virtual ~IRendererListener() {}
        
        virtual void onRendererPipelinePositionChanged(RendererBase* renderer) = 0;
        
        virtual void onRendererEnabledChanged(RendererBase* renderer) = 0;
    };
    
    class IRendererContainer {
    public:
        virtual ~IRendererContainer() {}
        
        virtual RendererBase* getRenderer(const std::string& renderername) = 0;
    };
    
    class RendererBase {
    public:
        RendererBase(RenderBackend* renderbackend, int32_t position);
        
        RendererBase(const RendererBase& old);
        
        virtual RendererBase* clone() = 0;
        
        virtual ~RendererBase() {};
        
        virtual void render(Camera* cam, Layer* layer, RenderList& instances) = 0;
        
        virtual std::string getName() = 0;
        
        int32_t getPipelinePosition() const { return m_pipeline_position; }
        
        void setPipelinePosition(int32_t position);
        
        virtual void setEnabled(bool enabled);
        
        virtual void reset() {}
        
        bool isEnabled() const { return m_enabled; }
        
        void setRendererListener(IRendererListener* listener) { m_listener = listener; }
        
        void addActiveLayer(Layer* layer);
        
        void removeActiveLayer(Layer* layer);
        
        void clearActiveLayers();
        
        void activateAllLayers(Map* elevation);
        
        bool isActivedLayer(Layer* layer);

        std::list<Layer*> getActiveLayers() const {return m_active_layers;}
        
    
    protected:
        RendererBase();
        
        std::list<Layer*> m_active_layers;
        RenderBackend* m_renderbackend;
    
    private:
        bool m_enabled;
        int32_t m_pipeline_position;
        IRendererListener* m_listener;
    };
}

#endif