File: OverlayRenderer.h

package info (click to toggle)
0ad 0.0.23.1-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 78,412 kB
  • sloc: cpp: 245,162; ansic: 200,249; javascript: 19,244; python: 13,754; sh: 6,104; perl: 4,620; makefile: 977; xml: 810; java: 533; ruby: 229; erlang: 46; pascal: 30; sql: 21; tcl: 4
file content (152 lines) | stat: -rw-r--r-- 4,737 bytes parent folder | download | duplicates (2)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/* Copyright (C) 2013 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. 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.
 *
 * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef INCLUDED_OVERLAYRENDERER
#define INCLUDED_OVERLAYRENDERER

#include "graphics/ShaderManager.h"

struct SOverlayLine;
struct SOverlayTexturedLine;
struct SOverlaySprite;
struct SOverlayQuad;
struct SOverlaySphere;
class CCamera;

struct OverlayRendererInternals;

/**
 * Class OverlayRenderer: Render various bits of data that overlay the
 * game world (selection circles, health bars, etc).
 */
class OverlayRenderer
{
	NONCOPYABLE(OverlayRenderer);

public:
	OverlayRenderer();
	~OverlayRenderer();

	/**
	 * Performs one-time initialization. Called by CRenderer::Open after graphics
	 * capabilities and the shader path have been determined (notably VBO support).
	 */
	void Initialize();

	/**
	 * Add a line overlay for rendering in this frame.
	 * @param overlay Must be non-null. The pointed-to object must remain valid at least
	 *                until the end of the frame.
	 */
	void Submit(SOverlayLine* overlay);

	/**
	 * Add a textured line overlay for rendering in this frame.
	 * @param overlay Must be non-null. The pointed-to object must remain valid at least
	 *                until the end of the frame.
	 */
	void Submit(SOverlayTexturedLine* overlay);

	/**
	 * Add a sprite overlay for rendering in this frame.
	 * @param overlay Must be non-null. The pointed-to object must remain valid at least
	 *                until the end of the frame.
	 */
	void Submit(SOverlaySprite* overlay);

	/**
	 * Add a textured quad overlay for rendering in this frame.
	 * @param overlay Must be non-null. The pointed-to object must remain valid at least
	 *                until the end of the frame.
	 */
	void Submit(SOverlayQuad* overlay);

	/**
	 * Add a sphere overlay for rendering in this frame.
	 * @param overlay Must be non-null. The pointed-to object must remain valid at least
	 *                until the end of the frame.
	 */
	void Submit(SOverlaySphere* overlay);

	/**
	 * Prepare internal data structures for rendering.
	 * Must be called after all Submit calls for a frame, and before
	 * any rendering calls.
	 */
	void PrepareForRendering();

	/**
	 * Reset the list of submitted overlays.
	 */
	void EndFrame();

	/**
	 * Render all the submitted overlays that are embedded in the world
	 * (i.e. rendered behind other objects in the normal 3D way)
	 * and should be drawn before water (i.e. may be visible under the water)
	 */
	void RenderOverlaysBeforeWater();

	/**
	 * Render all the submitted overlays that are embedded in the world
	 * (i.e. rendered behind other objects in the normal 3D way)
	 * and should be drawn after water (i.e. may be visible on top of the water)
	 */
	void RenderOverlaysAfterWater();

	/**
	 * Render all the submitted overlays that should appear on top of everything
	 * in the world.
	 * @param viewCamera camera to be used for billboard computations
	 */
	void RenderForegroundOverlays(const CCamera& viewCamera);

	/// Small vertical offset of overlays from terrain to prevent visual glitches
	static const float OVERLAY_VOFFSET;

private:

	/**
	 * Helper method; renders all overlay lines currently registered in the internals. Batch-
	 * renders textured overlay lines batched according to their visibility status by delegating
	 * to RenderTexturedOverlayLines(CShaderProgramPtr, bool).
	 */
	void RenderTexturedOverlayLines();

	/**
	 * Helper method; renders those overlay lines currently registered in the internals (i.e.
	 * in m->texlines) for which the 'always visible' flag equals @p alwaysVisible. Used for
	 * batch rendering the overlay lines according to their alwaysVisible status, as this
	 * requires a separate shader to be used.
	 */
	void RenderTexturedOverlayLines(CShaderProgramPtr shader, bool alwaysVisible);

	/**
	 * Helper method; batch-renders all registered quad overlays, batched by their texture for effiency.
	 */
	void RenderQuadOverlays();

	/**
	 * Helper method; batch-renders all sphere quad overlays.
	 */
	 void RenderSphereOverlays();

private:
	OverlayRendererInternals* m;
};

#endif // INCLUDED_OVERLAYRENDERER