renderobjectmanager.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 of the License, or
 * (at your option) 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/>.
 *
 */

/*
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

/*
    BS_RenderObjectManager
    ----------------------
    Diese Klasse ist für die Verwaltung von BS_RenderObjects zuständig.

    Sie sorgt z.B. dafür, dass die BS_RenderObjects in der richtigen Reihenfolge gerendert werden.

    Autor: Malte Thiesen
*/

#ifndef SWORD25_RENDEROBJECTMANAGER_H
#define SWORD25_RENDEROBJECTMANAGER_H

#include "common/rect.h"
#include "sword25/kernel/common.h"
#include "sword25/gfx/renderobjectptr.h"
#include "sword25/kernel/persistable.h"

#include "sword25/gfx/microtiles.h"

namespace Sword25 {

class Kernel;
class RenderObject;
class TimedRenderObject;
class RenderObjectManager;

struct RenderObjectQueueItem {
    RenderObject *_renderObject;
    Common::Rect _bbox;
    int _version;
    RenderObjectQueueItem(RenderObject *renderObject, const Common::Rect &bbox, int version)
        : _renderObject(renderObject), _bbox(bbox), _version(version) {}
};

class RenderObjectQueue : public Common::List<RenderObjectQueueItem> {
public:
    void add(RenderObject *renderObject);
    bool exists(const RenderObjectQueueItem &renderObjectQueueItem);
};

class RenderObjectManager : public Persistable {
public:
    RenderObjectManager(int width, int height, int framebufferCount);
    ~RenderObjectManager() override;

    // Interface
    // ---------
    void startFrame();
    bool render();
    RenderObjectPtr<RenderObject> getTreeRoot() {
        return _rootPtr;
    }
    void attatchTimedRenderObject(RenderObjectPtr<TimedRenderObject> pRenderObject);
    void detatchTimedRenderObject(RenderObjectPtr<TimedRenderObject> pRenderObject);

    bool persist(OutputPersistenceBlock &writer) override;
    bool unpersist(InputPersistenceBlock &reader) override;

private:
    bool _frameStarted;
    typedef Common::Array<RenderObjectPtr<TimedRenderObject> > RenderObjectList;
    RenderObjectList _timedRenderObjects;

    MicroTileArray *_uta;
    RenderObjectQueue *_currQueue, *_prevQueue;

    // RenderObject-Tree Variablen
    // ---------------------------
    // Der Baum legt die hierachische Ordnung der BS_RenderObjects fest.
    // Zu weiteren Informationen siehe: "renderobject.h"
    RenderObjectPtr<RenderObject>     _rootPtr;      // Die Wurzel der Baumes
};

} // End of namespace Sword25

#endif