SO3::SWater::WaterComponent Class Reference

#include <SO3Water.h>

Inheritance diagram for SO3::SWater::WaterComponent:

Public Member Functions
	WaterComponent (SWater *parentWaterInstance, const SWater::WaterComponentType &component, const Hydrax::HydraxComponent &hydraxComponent)
virtual	~WaterComponent ()
bool	GetEnabled ()
void	SetEnabled (const bool &enable)
void	ApplyEnable ()
SWater::WaterComponentType	GetType ()
virtual void	Update (const Ogre::Real &updateTime)=0

Protected Member Functions
virtual void	ApplyParameters ()=0

Protected Attributes
SWater *	parentWater
const Hydrax::HydraxComponent	hydraxComponentType
const SWater::WaterComponentType	componentType

Detailed Description

Base class that define a generic water component.

Definition at line 81 of file SO3Water.h.

Constructor & Destructor Documentation

WaterComponent()

SO3::SWater::WaterComponent::WaterComponent	(	SWater *	parentWaterInstance,
		const SWater::WaterComponentType &	component,
		const Hydrax::HydraxComponent &	hydraxComponent
	)

Definition at line 681 of file SO3Water.cpp.

~WaterComponent()

SO3::SWater::WaterComponent::~WaterComponent ( )

virtual

Definition at line 696 of file SO3Water.cpp.

Member Function Documentation

ApplyEnable()

void SO3::SWater::WaterComponent::ApplyEnable

(

)

Definition at line 716 of file SO3Water.cpp.

ApplyParameters()

virtual void SO3::SWater::WaterComponent::ApplyParameters ( )

protectedpure virtual

Implemented in SO3::SWater::WaterComponentSun, SO3::SWater::WaterComponentFoam, SO3::SWater::WaterComponentDepth, SO3::SWater::WaterComponentSmooth, SO3::SWater::WaterComponentCaustics, SO3::SWater::WaterComponentUnderwater, SO3::SWater::WaterComponentUnderwaterReflections, and SO3::SWater::WaterComponentGodRays.

GetEnabled()

bool SO3::SWater::WaterComponent::GetEnabled

(

)

Get if the component is enabled or disabled.

Definition at line 702 of file SO3Water.cpp.

GetType()

SWater::WaterComponentType SO3::SWater::WaterComponent::GetType

(

)

Definition at line 729 of file SO3Water.cpp.

SetEnabled()

void SO3::SWater::WaterComponent::SetEnabled

(

const bool &

enable

)

Activate/desactive the component rendering.

Definition at line 707 of file SO3Water.cpp.

Update()

virtual void SO3::SWater::WaterComponent::Update ( const Ogre::Real &  updateTime )

pure virtual

Implemented in SO3::SWater::WaterComponentSun, SO3::SWater::WaterComponentFoam, SO3::SWater::WaterComponentDepth, SO3::SWater::WaterComponentSmooth, SO3::SWater::WaterComponentCaustics, SO3::SWater::WaterComponentUnderwater, SO3::SWater::WaterComponentUnderwaterReflections, and SO3::SWater::WaterComponentGodRays.

Member Data Documentation

componentType

const SWater::WaterComponentType SO3::SWater::WaterComponent::componentType

protected

Definition at line 87 of file SO3Water.h.

hydraxComponentType

const Hydrax::HydraxComponent SO3::SWater::WaterComponent::hydraxComponentType

protected

Definition at line 86 of file SO3Water.h.

parentWater

SWater* SO3::SWater::WaterComponent::parentWater

protected

Definition at line 85 of file SO3Water.h.

---

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

• include/SO3SceneGraph/SO3Water.h
• src/SO3SceneGraph/SO3Water.cpp