Initial commit

engines/sword25/gfx/renderobjectmanager.h

@@ -0,0 +1,145 @@
+/* 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);
+};
+
+/**
+	@brief Diese Klasse ist für die Verwaltung von BS_RenderObjects zuständig.
+
+	Sie sorgt dafür, dass die BS_RenderObjects in der richtigen Reihenfolge gerendert werden und ermöglicht den Zugriff auf die
+	BS_RenderObjects über einen String.
+*/
+class RenderObjectManager : public Persistable {
+public:
+	/**
+	    @brief Erzeugt ein neues BS_RenderObjectManager-Objekt.
+	    @param Width die horizontale Bildschirmauflösung in Pixeln
+	    @param Height die vertikale Bildschirmauflösung in Pixeln
+	    @param Die Anzahl an Framebuffern, die eingesetzt wird (Backbuffer + Primary).
+	*/
+	RenderObjectManager(int width, int height, int framebufferCount);
+	~RenderObjectManager() override;
+
+	// Interface
+	// ---------
+	/**
+	    @brief Initialisiert den Manager für einen neuen Frame.
+	    @remark Alle Veränderungen an Objekten müssen nach einem Aufruf dieser Methode geschehen, damit sichergestellt ist, dass diese
+	            visuell umgesetzt werden.<br>
+	            Mit dem Aufruf dieser Methode werden die Rückgabewerte von GetUpdateRects() und GetUpdateRectCount() auf ihre Startwerte
+	            zurückgesetzt. Wenn man also mit diesen Werten arbeiten möchten, muss man dies nach einem Aufruf von Render() und vor
+	            einem Aufruf von StartFrame() tun.
+	 */
+	void startFrame();
+	/**
+	    @brief Rendert alle Objekte die sich während des letzten Aufrufes von Render() verändert haben.
+	    @return Gibt false zurück, falls das Rendern fehlgeschlagen ist.
+	 */
+	bool render();
+	/**
+	    @brief Gibt einen Pointer auf die Wurzel des Objektbaumes zurück.
+	 */
+	RenderObjectPtr<RenderObject> getTreeRoot() {
+		return _rootPtr;
+	}
+	/**
+	    @brief Fügt ein BS_TimedRenderObject in die Liste der zeitabhängigen Render-Objekte.
+
+	    Alle Objekte die sich in dieser Liste befinden werden vor jedem Frame über die seit dem letzten Frame
+	    vergangene Zeit informiert, so dass sich ihren Zustand zeitabhängig verändern können.
+
+	    @param RenderObject das einzufügende BS_TimedRenderObject
+	*/
+	void attatchTimedRenderObject(RenderObjectPtr<TimedRenderObject> pRenderObject);
+	/**
+	    @brief Entfernt ein BS_TimedRenderObject aus der Liste für zeitabhängige Render-Objekte.
+	*/
+	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