2006-01-07 02:04:26 +01:00
|
|
|
/**
|
|
|
|
* =========================================================================
|
|
|
|
* File : TerrainRenderer.h
|
|
|
|
* Project : Pyrogenesis
|
|
|
|
* Description : Terrain rendering (everything related to patches and
|
|
|
|
* : water) is encapsulated in TerrainRenderer
|
|
|
|
*
|
2006-07-26 16:04:52 +02:00
|
|
|
* @author Nicolai Haehnle <nicolai@wildfiregames.com>
|
2006-01-07 02:04:26 +01:00
|
|
|
* =========================================================================
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef TERRAINRENDERER_H
|
|
|
|
#define TERRAINRENDERER_H
|
|
|
|
|
|
|
|
class CPatch;
|
2006-02-11 19:04:32 +01:00
|
|
|
class ShadowMap;
|
2006-01-07 02:04:26 +01:00
|
|
|
class WaterManager;
|
|
|
|
|
|
|
|
struct TerrainRendererInternals;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class TerrainRenderer: Render everything related to the terrain,
|
|
|
|
* especially patches and water.
|
|
|
|
*/
|
|
|
|
class TerrainRenderer
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
TerrainRenderer();
|
|
|
|
~TerrainRenderer();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Submit: Add a patch for rendering in this frame.
|
|
|
|
*
|
|
|
|
* preconditions : PrepareForRendering must not have been called
|
|
|
|
* for this frame yet.
|
|
|
|
* The patch must not have been submitted in this frame yet (i.e. you
|
|
|
|
* can only submit a frame once).
|
|
|
|
*
|
|
|
|
* @param patch the patch
|
|
|
|
*/
|
|
|
|
void Submit(CPatch* patch);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* PrepareForRendering: Prepare internal data structures like vertex
|
|
|
|
* buffers for rendering.
|
|
|
|
*
|
|
|
|
* All patches must have been submitted before the call to
|
|
|
|
* PrepareForRendering.
|
|
|
|
* PrepareForRendering must be called before any rendering calls.
|
|
|
|
*/
|
|
|
|
void PrepareForRendering();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* EndFrame: Remove all patches from the list of submitted patches.
|
|
|
|
*/
|
|
|
|
void EndFrame();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* HaveSubmissions: Query whether any patches have been submitted
|
|
|
|
* for this frame.
|
|
|
|
*
|
|
|
|
* @return @c true if a patch has been submitted for this frame,
|
|
|
|
* @c false otherwise.
|
|
|
|
*/
|
|
|
|
bool HaveSubmissions();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* RenderTerrain: Render textured terrain (including blends between
|
|
|
|
* different terrain types).
|
|
|
|
*
|
|
|
|
* preconditions : PrepareForRendering must have been called this
|
|
|
|
* frame before calling RenderTerrain.
|
2006-02-11 19:04:32 +01:00
|
|
|
*
|
|
|
|
* @param shadow a prepared shadow map, in case rendering with shadows is enabled
|
|
|
|
* @param shadowColor color of shadows
|
2006-01-07 02:04:26 +01:00
|
|
|
*/
|
2006-02-13 15:18:20 +01:00
|
|
|
void RenderTerrain(ShadowMap* shadow);
|
2006-01-07 02:04:26 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* RenderPatches: Render all patches un-textured as polygons.
|
|
|
|
*
|
|
|
|
* preconditions : PrepareForRendering must have been called this
|
|
|
|
* frame before calling RenderPatches.
|
|
|
|
*/
|
|
|
|
void RenderPatches();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* RenderOutlines: Render the outline of patches as lines.
|
|
|
|
*
|
|
|
|
* preconditions : PrepareForRendering must have been called this
|
2006-01-22 00:27:42 +01:00
|
|
|
* frame before calling RenderOutlines.
|
2006-01-07 02:04:26 +01:00
|
|
|
*/
|
|
|
|
void RenderOutlines();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* RenderWater: Render water for all patches that have been submitted
|
|
|
|
* this frame.
|
|
|
|
*
|
|
|
|
* preconditions : PrepareForRendering must have been called this
|
2006-01-22 00:27:42 +01:00
|
|
|
* frame before calling RenderWater.
|
2006-01-07 02:04:26 +01:00
|
|
|
*/
|
|
|
|
void RenderWater();
|
|
|
|
|
|
|
|
private:
|
|
|
|
TerrainRendererInternals* m;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // TERRAINRENDERER_H
|