proland::DrawOceanFFTTask Class Reference
[ocean]

An AbstractTask to draw a flat or spherical ocean. More...

#include <DrawOceanFFTTask.h>

List of all members.

Public Member Functions
	DrawOceanFFTTask (float radius, float zmin, ptr< Program > fftInit, ptr< Program > fftx, ptr< Program > ffty, ptr< Program > variances, ptr< Module > brdfShader)
	Creates a new DrawOceanFFTTask.
virtual	~DrawOceanFFTTask ()
	Deletes this DrawOceanFFTTask.
Protected Member Functions
	DrawOceanFFTTask ()
	Creates an uninitialized DrawOceanFFTTask.
void	init (float radius, float zmin, ptr< Program > fftInit, ptr< Program > fftx, ptr< Program > ffty, ptr< Program > variances, ptr< Module > brdfShader)
	Initializes this DrawOceanFFTTask.
Private Attributes
float	radius
	The radius of the planet for a spherical ocean, or 0 for a flat ocean.
float	zmin
	The maximum altitude at which the ocean must be displayed.
vec3f	seaColor
	Color of the seabed.
int	resolution
	Number of pixels per cell to use for the screen space grid used to display the ocean surface.
int	screenWidth
	Current width of the viewport, in pixels.
int	screenHeight
	Current height of the viewport, in pixels.
ptr< Mesh< vec2f, unsigned int > >	screenGrid
	The mesh used to display the ocean surface.
ptr< Module >	brdfShader
	The Shader used to render the ocean surface.

---

Detailed Description

An AbstractTask to draw a flat or spherical ocean.

Authors:

Eric Bruneton, Antoine Begault, Guillaume Piolat

---

Constructor & Destructor Documentation

proland::DrawOceanFFTTask::DrawOceanFFTTask	(	float	radius,
		float	zmin,
		ptr< Program >	fftInit,
		ptr< Program >	fftx,
		ptr< Program >	ffty,
		ptr< Program >	variances,
		ptr< Module >	brdfShader
	)

Creates a new DrawOceanFFTTask.

Parameters:

	radius	the radius of the planet for a spherical ocean, or 0 for a flat ocean.
	zmin	the maximum altitude at which the ocean must be displayed.
	brdfShader	the Shader used to render the ocean surface.

virtual proland::DrawOceanFFTTask::~DrawOceanFFTTask

(

)

[virtual]

Deletes this DrawOceanFFTTask.

proland::DrawOceanFFTTask::DrawOceanFFTTask

(

)

[protected]

Creates an uninitialized DrawOceanFFTTask.

---

Member Function Documentation

void proland::DrawOceanFFTTask::init	(	float	radius,
		float	zmin,
		ptr< Program >	fftInit,
		ptr< Program >	fftx,
		ptr< Program >	ffty,
		ptr< Program >	variances,
		ptr< Module >	brdfShader
	)			[protected]

Initializes this DrawOceanFFTTask.

Parameters:

	radius	the radius of the planet for a spherical ocean, or 0 for a flat ocean.
	zmin	the maximum altitude at which the ocean must be displayed.
	brdfShader	the Shader used to display the ocean surface.

---

Member Data Documentation

ptr<Module> proland::DrawOceanFFTTask::brdfShader [private]

The Shader used to render the ocean surface.

float proland::DrawOceanFFTTask::radius [private]

The radius of the planet for a spherical ocean, or 0 for a flat ocean.

int proland::DrawOceanFFTTask::resolution [private]

Number of pixels per cell to use for the screen space grid used to display the ocean surface.

ptr< Mesh<vec2f, unsigned int> > proland::DrawOceanFFTTask::screenGrid [private]

The mesh used to display the ocean surface.

int proland::DrawOceanFFTTask::screenHeight [private]

Current height of the viewport, in pixels.

int proland::DrawOceanFFTTask::screenWidth [private]

Current width of the viewport, in pixels.

vec3f proland::DrawOceanFFTTask::seaColor [private]

Color of the seabed.

float proland::DrawOceanFFTTask::zmin [private]

The maximum altitude at which the ocean must be displayed.