SO3::SWater Class Reference

#include <SO3Water.h>

Inheritance diagram for SO3::SWater:

Classes
class	WaterComponent
class	WaterComponentCaustics
class	WaterComponentDepth
class	WaterComponentFoam
class	WaterComponentGodRays
class	WaterComponentSmooth
class	WaterComponentSun
class	WaterComponentUnderwater
Public Types
enum	WaterGeometryType { SO3_WATER_GEOM_INFINITE_PLANE, SO3_WATER_GEOM_FINITE_PLANE, SO3_WATER_GEOM_RADIAL }
enum	WaterComponentType { SO3_WATER_COMPONENT_NONE, SO3_WATER_COMPONENT_SUN, SO3_WATER_COMPONENT_FOAM, SO3_WATER_COMPONENT_DEPTH, SO3_WATER_COMPONENT_SMOOTH, SO3_WATER_COMPONENT_CAUSTICS, SO3_WATER_COMPONENT_UNDERWATER, SO3_WATER_COMPONENT_GODRAYS }
Public Member Functions
	SWater (SEnvironment parent, std::string waterName, SViewPort targetViewport, SCamera *targetCamera)
	SWater (SEnvironment parent, std::string waterName, SViewPort targetViewport, SCamera *targetCamera, int planeSizeX, int planeSizeY)
	SWater (SEnvironment parent, std::string waterName, SViewPort targetViewport, SCamera *targetCamera, float waterRadius)
	~SWater ()
Hydrax::Hydrax *	GetHydrax ()
WaterGeometryType	GetGeometryType ()
void	SetGeometryTypeInfinitePlane ()
void	SetGeometryTypeFinitePlane (int planeSizeX, int planeSizeY)
void	SetGeometryTypeRadialPlane (float waterRadius)
WaterComponent *	GetComponent (SWater::WaterComponentType componentType)
WaterComponentSun *	GetSun ()
WaterComponentFoam *	GetFoam ()
WaterComponentDepth *	GetDepth ()
WaterComponentSmooth *	GetSmooth ()
WaterComponentCaustics *	GetCaustics ()
WaterComponentUnderwater *	GetUnderwater ()
WaterComponentGodRays *	GetGodRays ()
void	SetWindSpeed (float newWindSpeed)
void	SetWindDirection (Ogre::Vector3 newWindDirection)
const Ogre::Vector3 &	GetPosition () const
void	SetPosition (const Ogre::Vector3 &newSeaLevel)
Ogre::ColourValue	GetColor ()
void	SetColor (Ogre::ColourValue color)
virtual void	Update (Ogre::Real updateTime)
float	GetAnimationSpeed ()
void	SetAnimationSpeed (float animationSpeed)
virtual void	preRenderTargetUpdate (const Hydrax::RttManager::RttType &Rtt)
virtual void	postRenderTargetUpdate (const Hydrax::RttManager::RttType &Rtt)

Detailed Description

Definition at line 51 of file SO3Water.h.

Member Enumeration Documentation

enum SO3::SWater::WaterComponentType

Enumerator:

SO3_WATER_COMPONENT_NONE
SO3_WATER_COMPONENT_SUN
SO3_WATER_COMPONENT_FOAM
SO3_WATER_COMPONENT_DEPTH
SO3_WATER_COMPONENT_SMOOTH
SO3_WATER_COMPONENT_CAUSTICS
SO3_WATER_COMPONENT_UNDERWATER
SO3_WATER_COMPONENT_GODRAYS

Definition at line 66 of file SO3Water.h.

enum SO3::SWater::WaterGeometryType

Enumerator:

SO3_WATER_GEOM_INFINITE_PLANE
SO3_WATER_GEOM_FINITE_PLANE
SO3_WATER_GEOM_RADIAL

Definition at line 57 of file SO3Water.h.

Constructor & Destructor Documentation

SO3::SWater::SWater	(	SEnvironment *	parent,
		std::string	waterName,
		SViewPort *	targetViewport,
		SCamera *	targetCamera
	)

Create a new water instance, with infinite plane geom shape by default

Definition at line 45 of file SO3Water.cpp.

SO3::SWater::SWater	(	SEnvironment *	parent,
		std::string	waterName,
		SViewPort *	targetViewport,
		SCamera *	targetCamera,
		int	planeSizeX,
		int	planeSizeY
	)

Create a new water instance, with defined finite plane geom shape by default

Definition at line 52 of file SO3Water.cpp.

SO3::SWater::SWater	(	SEnvironment *	parent,
		std::string	waterName,
		SViewPort *	targetViewport,
		SCamera *	targetCamera,
		float	waterRadius
	)

Create a new water instance, with defined radial geom shape by default

Definition at line 59 of file SO3Water.cpp.

SO3::SWater::~SWater ( )

Destructor

Definition at line 117 of file SO3Water.cpp.

Member Function Documentation

float SO3::SWater::GetAnimationSpeed ( )

Retrieve the waves animation speed.

Definition at line 909 of file SO3Water.cpp.

SWater::WaterComponentCaustics * SO3::SWater::GetCaustics ( )

Definition at line 253 of file SO3Water.cpp.

Ogre::ColourValue SO3::SWater::GetColor ( )

Definition at line 898 of file SO3Water.cpp.

SWater::WaterComponent * SO3::SWater::GetComponent ( SWater::WaterComponentType componentType )

Definition at line 200 of file SO3Water.cpp.

SWater::WaterComponentDepth * SO3::SWater::GetDepth ( )

Definition at line 243 of file SO3Water.cpp.

SWater::WaterComponentFoam * SO3::SWater::GetFoam ( )

Definition at line 238 of file SO3Water.cpp.

SWater::WaterGeometryType SO3::SWater::GetGeometryType ( )

Get the actual geometry shape of the water

Definition at line 268 of file SO3Water.cpp.

SWater::WaterComponentGodRays * SO3::SWater::GetGodRays ( )

Definition at line 263 of file SO3Water.cpp.

Hydrax::Hydrax * SO3::SWater::GetHydrax ( )

Internal use only!

Definition at line 195 of file SO3Water.cpp.

const Ogre::Vector3 & SO3::SWater::GetPosition ( ) const

Retrieve the position of the water plane geometry, y is the "sea level" component.

Definition at line 888 of file SO3Water.cpp.

SWater::WaterComponentSmooth * SO3::SWater::GetSmooth ( )

Definition at line 248 of file SO3Water.cpp.

SWater::WaterComponentSun * SO3::SWater::GetSun ( )

Definition at line 233 of file SO3Water.cpp.

SWater::WaterComponentUnderwater * SO3::SWater::GetUnderwater ( )

Definition at line 258 of file SO3Water.cpp.

void SO3::SWater::postRenderTargetUpdate ( const Hydrax::RttManager::RttType & Rtt ) [virtual]

Definition at line 963 of file SO3Water.cpp.

void SO3::SWater::preRenderTargetUpdate ( const Hydrax::RttManager::RttType & Rtt ) [virtual]

Definition at line 929 of file SO3Water.cpp.

void SO3::SWater::SetAnimationSpeed ( float animationSpeed )

Change the waves animations speed.

Definition at line 914 of file SO3Water.cpp.

void SO3::SWater::SetColor ( Ogre::ColourValue color )

Definition at line 903 of file SO3Water.cpp.

void SO3::SWater::SetGeometryTypeFinitePlane	(	int	planeSizeX,
		int	planeSizeY
	)

Change the geometry to an finite plane (width and height provided).

Definition at line 278 of file SO3Water.cpp.

void SO3::SWater::SetGeometryTypeInfinitePlane ( )

Change the geometry to an infinite plane.

Definition at line 273 of file SO3Water.cpp.

void SO3::SWater::SetGeometryTypeRadialPlane ( float waterRadius )

Change the geometry to an radial plane (circle radius provided).

Definition at line 283 of file SO3Water.cpp.

void SO3::SWater::SetPosition ( const Ogre::Vector3 & newSeaLevel )

Changes the sea level on the y component. x and z are usefull for radial and finite plane, but not for infinite plane.

Definition at line 893 of file SO3Water.cpp.

void SO3::SWater::SetWindDirection ( Ogre::Vector3 newWindDirection )

TODO DELETE

Definition at line 850 of file SO3Water.cpp.

void SO3::SWater::SetWindSpeed ( float newWindSpeed )

TODO DELETE

Definition at line 818 of file SO3Water.cpp.

void SO3::SWater::Update ( Ogre::Real updateTime ) [virtual]

Implements SO3::SEnvironmentComponent.

Definition at line 859 of file SO3Water.cpp.

The documentation for this class was generated from the following files:

SO3Engine/SO3SceneGraph/SO3Water.h
SO3Engine/SO3SceneGraph/SO3Water.cpp

SO3::SWater Class Reference

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation