lightrenderer.cpp

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          *
 ***************************************************************************/

// Standard C++ library includes
#include <SDL.h>

// 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 "video/renderbackend.h"
#include "video/animation.h"
#include "video/fonts/ifont.h"
#include "video/imagemanager.h"
#include "video/image.h"
#include "video/opengl/glimage.h"
#include "video/opengl/renderbackendopengl.h"
#include "util/math/fife_math.h"
#include "util/log/logger.h"
#include "util/time/timemanager.h"
#include "model/metamodel/grids/cellgrid.h"
#include "model/metamodel/timeprovider.h"
#include "model/structures/instance.h"
#include "model/structures/layer.h"
#include "model/structures/location.h"

#include "view/camera.h"
#include "lightrenderer.h"


namespace FIFE {
    static Logger _log(LM_VIEWVIEW);

    LightRendererElementInfo::LightRendererElementInfo(RendererNode n, int32_t src, int32_t dst):
        m_anchor(n),
        m_src(src),
        m_dst(dst),
        m_stencil(false),
        m_stencil_ref(0) {
    }
    void LightRendererElementInfo::setStencil(uint8_t stencil_ref) {
        m_stencil = true;
        m_stencil_ref = stencil_ref;
    }
    int32_t LightRendererElementInfo::getStencil() {
        if(!m_stencil) {
            return -1;
        }
        return m_stencil_ref;
    }
    void LightRendererElementInfo::removeStencil() {
        m_stencil = false;
        m_stencil_ref = 0;
    }
    LightRendererImageInfo::LightRendererImageInfo(RendererNode anchor, ImagePtr image, int32_t src, int32_t dst):
        LightRendererElementInfo(anchor, src, dst),
        m_image(image){
    }
    void LightRendererImageInfo::render(Camera* cam, Layer* layer, RenderList& instances, RenderBackend* renderbackend) {
        Point p = m_anchor.getCalculatedPoint(cam, layer, true);
        if(m_anchor.getLayer() == layer) {
            Rect r;
            Rect viewport = cam->getViewPort();
            uint32_t width = static_cast<uint32_t>(round(m_image->getWidth() * cam->getZoom()));
            uint32_t height = static_cast<uint32_t>(round(m_image->getHeight() * cam->getZoom()));
            r.x = p.x-width/2;
            r.y = p.y-height/2;
            r.w = width;
            r.h = height;

            if(r.intersects(viewport)) {
                uint8_t lm = renderbackend->getLightingModel();
                m_image->render(r);
                if (m_stencil) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, m_stencil_ref, INCR, GEQUAL);
                } else if (lm == 1) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, 255, KEEP, NOTEQUAL);
                }
            }
        }
    }
    LightRendererAnimationInfo::LightRendererAnimationInfo(RendererNode anchor, AnimationPtr animation, int32_t src, int32_t dst):
        LightRendererElementInfo(anchor, src, dst),
        m_animation(animation),
        m_start_time(TimeManager::instance()->getTime()),
        m_time_scale(1.0){
    }
    void LightRendererAnimationInfo::render(Camera* cam, Layer* layer, RenderList& instances, RenderBackend* renderbackend) {
        Point p = m_anchor.getCalculatedPoint(cam, layer, true);
        if(m_anchor.getLayer() == layer) {
            int32_t animtime = scaleTime(m_time_scale, TimeManager::instance()->getTime() - m_start_time) % m_animation->getDuration();
            ImagePtr img = m_animation->getFrameByTimestamp(animtime);
            Rect r;
            Rect viewport = cam->getViewPort();
            uint32_t width = static_cast<uint32_t>(round(img->getWidth() * cam->getZoom()));
            uint32_t height = static_cast<uint32_t>(round(img->getHeight() * cam->getZoom()));
            r.x = p.x-width/2;
            r.y = p.y-height/2;
            r.w = width;
            r.h = height;

            if(r.intersects(viewport)) {
                uint8_t lm = renderbackend->getLightingModel();
                img->render(r);
                if (m_stencil) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, m_stencil_ref, INCR, GEQUAL);
                } else if (lm == 1) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, 255, KEEP, NOTEQUAL);
                }
            }
        }
    }
    LightRendererResizeInfo::LightRendererResizeInfo(RendererNode anchor, ImagePtr image, int32_t width, int32_t height, int32_t src, int32_t dst):
        LightRendererElementInfo(anchor, src, dst),
        m_image(image),
        m_width(width),
        m_height(height) {
    }
    void LightRendererResizeInfo::render(Camera* cam, Layer* layer, RenderList& instances, RenderBackend* renderbackend) {
        Point p = m_anchor.getCalculatedPoint(cam, layer, true);
        if(m_anchor.getLayer() == layer) {
            Rect r;
            Rect viewport = cam->getViewPort();
            uint32_t width = static_cast<uint32_t>(round(m_width * cam->getZoom()));
            uint32_t height = static_cast<uint32_t>(round(m_height * cam->getZoom()));
            r.x = p.x-width/2;
            r.y = p.y-height/2;
            r.w = width;
            r.h = height;

            if(r.intersects(viewport)) {
                uint8_t lm = renderbackend->getLightingModel();
                m_image->render(r);
                if (m_stencil) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, m_stencil_ref, INCR, GEQUAL);
                } else if (lm == 1) {
                    renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, 255, KEEP, NOTEQUAL);
                }
            }
        }
    }
    LightRendererSimpleLightInfo::LightRendererSimpleLightInfo(RendererNode anchor, uint8_t intensity, float radius, int32_t subdivisions, float xstretch, float ystretch, uint8_t r, uint8_t g, uint8_t b, int32_t src, int32_t dst):
        LightRendererElementInfo(anchor, src, dst),
        m_intensity(intensity),
        m_radius(radius),
        m_subdivisions(subdivisions),
        m_xstretch(xstretch),
        m_ystretch(ystretch),
        m_red(r),
        m_green(g),
        m_blue(b){
    }
    void LightRendererSimpleLightInfo::render(Camera* cam, Layer* layer, RenderList& instances, RenderBackend* renderbackend) {
        Point p = m_anchor.getCalculatedPoint(cam, layer, true);
        if(m_anchor.getLayer() == layer) {
            double zoom = cam->getZoom();

            uint8_t lm = renderbackend->getLightingModel();
            renderbackend->drawLightPrimitive(p, m_intensity, m_radius, m_subdivisions,
                static_cast<float>(m_xstretch * zoom), static_cast<float>(m_ystretch * zoom),
                m_red, m_green, m_blue);

            if (m_stencil) {
                renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, m_stencil_ref, INCR, GEQUAL);
            } else if (lm == 1) {
                renderbackend->changeRenderInfos(RENDER_DATA_WITHOUT_Z, 1, m_src, m_dst, false, true, 255, KEEP, NOTEQUAL);
            }
        }
    }
    std::vector<uint8_t> LightRendererSimpleLightInfo::getColor() {
        std::vector<uint8_t> colors;
        colors.push_back(m_red);
        colors.push_back(m_green);
        colors.push_back(m_blue);
        colors.push_back(m_intensity);
        return colors;
    }
    LightRenderer* LightRenderer::getInstance(IRendererContainer* cnt) {
        return dynamic_cast<LightRenderer*>(cnt->getRenderer("LightRenderer"));
    }
    LightRenderer::LightRenderer(RenderBackend* renderbackend, int32_t position):
        RendererBase(renderbackend, position),
        m_groups() {
        setEnabled(false);
    }
    LightRenderer::LightRenderer(const LightRenderer& old):
        RendererBase(old),
        m_groups() {
        setEnabled(false);
    }
    RendererBase* LightRenderer::clone() {
        return new LightRenderer(*this);
    }
    LightRenderer::~LightRenderer() {
    }
    // Add a static lightmap
    void LightRenderer::addImage(const std::string &group, RendererNode n, ImagePtr image, int32_t src, int32_t dst) {
        LightRendererElementInfo* info = new LightRendererImageInfo(n, image, src, dst);
        m_groups[group].push_back(info);
    }
    // Add a animation lightmap
    void LightRenderer::addAnimation(const std::string &group, RendererNode n, AnimationPtr animation, int32_t src, int32_t dst) {
        LightRendererElementInfo* info = new LightRendererAnimationInfo(n, animation, src, dst);
        m_groups[group].push_back(info);
    }
    // Add a simple light
    void LightRenderer::addSimpleLight(const std::string &group, RendererNode n, uint8_t intensity, float radius, int32_t subdivisions, float xstretch, float ystretch, uint8_t r, uint8_t g, uint8_t b, int32_t src, int32_t dst) {
        LightRendererElementInfo* info = new LightRendererSimpleLightInfo(n, intensity, radius, subdivisions, xstretch, ystretch, r, g, b, src, dst);
        m_groups[group].push_back(info);
    }
    // Resize an Image
    void LightRenderer::resizeImage(const std::string &group, RendererNode n, ImagePtr image, int32_t width, int32_t height, int32_t src, int32_t dst) {
        LightRendererElementInfo* info = new LightRendererResizeInfo(n, image, width, height, src, dst);
        m_groups[group].push_back(info);
    }
    // Enable stencil test for the group
    void LightRenderer::addStencilTest(const std::string &group, uint8_t stencil_ref) {
        std::vector<LightRendererElementInfo*>::const_iterator info_it = m_groups[group].begin();
        for (;info_it != m_groups[group].end(); ++info_it) {
            (*info_it)->setStencil(stencil_ref);
        }
    }
    // Disable stencil test for the group
    void LightRenderer::removeStencilTest(const std::string &group) {
        std::vector<LightRendererElementInfo*>::const_iterator info_it = m_groups[group].begin();
        for (;info_it != m_groups[group].end(); ++info_it) {
            (*info_it)->removeStencil();
        }
    }
    // Return a list of all groups
    std::list<std::string> LightRenderer::getGroups() {
        std::list<std::string> groups;
        std::map<std::string, std::vector<LightRendererElementInfo*> >::iterator group_it = m_groups.begin();
        for(; group_it != m_groups.end(); ++group_it) {
            groups.push_back(group_it->first);
        }
        groups.sort();
        groups.unique();
        return groups;
    }
    // Return a vector of all LightElementInfos
    std::vector<LightRendererElementInfo*> LightRenderer::getLightInfo(const std::string &group) {
        std::vector<LightRendererElementInfo*> info;
        std::vector<LightRendererElementInfo*>::const_iterator info_it = m_groups[group].begin();
        for (;info_it != m_groups[group].end(); ++info_it) {
            info.push_back(*info_it);
        }
        return info;
    }
    // Remove the group
    void LightRenderer::removeAll(const std::string &group) {
        std::vector<LightRendererElementInfo*>::const_iterator info_it = m_groups[group].begin();
        for (;info_it != m_groups[group].end(); ++info_it) {
            delete *info_it;
        }
        m_groups[group].clear();
        m_groups.erase(group);
    }
    // Remove all groups
    void LightRenderer::removeAll() {
        std::map<std::string, std::vector<LightRendererElementInfo*> >::iterator it = m_groups.begin();
        for (; it != m_groups.end(); ++it) {
            std::vector<LightRendererElementInfo*>::const_iterator info_it = it->second.begin();
            for (;info_it != it->second.end(); ++info_it) {
                delete *info_it;
            }
        }
        m_groups.clear();
    }
    // Clear all groups
    void LightRenderer::reset() {
        removeAll();
    }
    // Render
    void LightRenderer::render(Camera* cam, Layer* layer, RenderList& instances) {
        uint8_t lm = m_renderbackend->getLightingModel();

        if (!layer->areInstancesVisible()) {
            return;
        }

        std::map<std::string, std::vector<LightRendererElementInfo*> >::iterator group_it = m_groups.begin();
        for (; group_it != m_groups.end(); ++group_it) {
            std::vector<LightRendererElementInfo*>::const_iterator info_it = group_it->second.begin();
            for (;info_it != group_it->second.end(); ++info_it) {
                if (lm != 0) {
                    if ((*info_it)->getStencil() != -1 && (*info_it)->getStencil() < 255) {
                        if(info_it != group_it->second.begin()) {
                            (*info_it)->setStencil((*info_it)->getStencil()+1);
                        }
                    }
                }
                (*info_it)->render(cam, layer, instances, m_renderbackend);
            }
        }
    }

}