aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/gfx/renderobjectmanager.h
blob: 6a46cfa9e9f900e852dcc51296689dbfa169b524 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// -----------------------------------------------------------------------------
// This file is part of Broken Sword 2.5
// Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsd�rfer
//
// Broken Sword 2.5 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 2 of the License, or
// (at your option) any later version.
//
// Broken Sword 2.5 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 Broken Sword 2.5; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
// -----------------------------------------------------------------------------

/*
	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 _BS_RENDEROBJECTMANAGER_H
#define _BS_RENDEROBJECTMANAGER_H

// Includes
#include "kernel/memlog_off.h"
#include <vector>
#include "kernel/memlog_on.h"

#include "kernel/common.h"
#include "renderobjectptr.h"
#include "kernel/persistable.h"

// Klassendefinition
class BS_Kernel;
class BS_Rect;
class BS_RenderObject;
class BS_TimedRenderObject;

/**
	@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 BS_RenderObjectManager : public BS_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).
	*/
	BS_RenderObjectManager(int Width, int Height, int FramebufferCount);
	virtual ~BS_RenderObjectManager();
	
	// 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.
	 */
	BS_RenderObjectPtr<BS_RenderObject> GetTreeRoot() { return m_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(BS_RenderObjectPtr<BS_TimedRenderObject> pRenderObject);
	/**
		@brief Entfernt ein BS_TimedRenderObject aus der Liste f�r zeitabh�ngige Render-Objekte.
	*/
	void DetatchTimedRenderObject(BS_RenderObjectPtr<BS_TimedRenderObject> pRenderObject);

	virtual bool Persist(BS_OutputPersistenceBlock & Writer);
	virtual bool Unpersist(BS_InputPersistenceBlock & Reader);

private:
	bool m_FrameStarted;
	typedef std::vector<BS_RenderObjectPtr<BS_TimedRenderObject> > RenderObjectList;
	RenderObjectList m_TimedRenderObjects;

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

#endif