SO3::SEnvironment Class Reference

#include <SO3Environment.h>

Inheritance diagram for SO3::SEnvironment:

Public Types
typedef std::set< SViewPort * >	ViewportList

Public Member Functions
	SEnvironment (SScene *parent, const std::string &environmentName)
	~SEnvironment ()
SScene *	GetScene ()
void	RegisterViewport (SViewPort *targetViewport)
void	UnregisterViewport (SViewPort *targetViewport)
void	UnregisterCamera (Ogre::Camera *cam)
bool	IsRegisteredViewport (SViewPort *targetViewport)
bool	IsRegisteredViewport (Ogre::Viewport *targetViewport)
void	UnregisterAllViewports ()
ViewportList	GetRegisteredViewports ()
SUniversalClock *	GetUniversalClock ()
SWater *	GetWater ()
SSky *	GetSky ()
SSun *	GetSun ()
SMoon *	GetMoon ()
bool	GetEnable ()
void	SetEnable (const bool &enableEnvironment)
bool	GetPaused ()
void	SetPaused (const bool &pauseSimulation)
bool	GetWaterEnable ()
void	SetWaterEnable (const bool &enableWater)
bool	GetSkyEnable ()
void	SetSkyEnable (const bool &enableSky)
float	GetWindSpeed ()
void	SetWindSpeed (const float &newWindSpeed)
Ogre::Vector2	GetWindDirection ()
void	SetWindDirection (const Ogre::Vector2 &newWindDirection)
float	GetHumidity ()
void	SetHumidity (const float &newHumidity)
float	GetTimeSpeedFactor ()
void	SetTimeSpeedFactor (const float &newTimeSpeedFactor)
SDateTime	GetDateTime ()
void	SetDateTime (const SDateTime &newDateTime)
Ogre::Degree	GetLongitude ()
void	SetLongitude (const Ogre::Degree &newLongitude)
Ogre::Degree	GetLatitude ()
void	SetLatitude (const Ogre::Degree &newLatitude)
void	_NotifyEnvironmentComponentRegisterRenderTarget (Ogre::Viewport *targetViewport)
void	_NotifyEnvironmentComponentUnRegisterRenderTarget (Ogre::Viewport *targetViewport)
void	UpdateCamera (SViewPort *viewport)
Public Member Functions inherited from SO3::SData
	SData (const std::string &dataName)
virtual	~SData ()
std::string	GetName () const
SUserObjectBindings &	GetUserObjectBindings ()
const SUserObjectBindings &	GetUserObjectBindings () const

Protected Member Functions
virtual bool	frameStarted (const Ogre::FrameEvent &evt)

Additional Inherited Members
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Definition at line 44 of file SO3Environment.h.

Member Typedef Documentation

ViewportList

typedef std::set<SViewPort*> SO3::SEnvironment::ViewportList

Definition at line 49 of file SO3Environment.h.

Constructor & Destructor Documentation

SEnvironment()

SO3::SEnvironment::SEnvironment	(	SScene *	parent,
		const std::string &	environmentName
	)

Definition at line 44 of file SO3Environment.cpp.

~SEnvironment()

SO3::SEnvironment::~SEnvironment

(

)

Destructor

Definition at line 110 of file SO3Environment.cpp.

Member Function Documentation

_NotifyEnvironmentComponentRegisterRenderTarget()

void SO3::SEnvironment::_NotifyEnvironmentComponentRegisterRenderTarget

(

Ogre::Viewport *

targetViewport

)

Internal hack to be sure that the SEnvironement RenderTargetListener is AFTER SkyX/Hydrax RenderTargetListener in the RenderTarget::mListener list.

Definition at line 447 of file SO3Environment.cpp.

_NotifyEnvironmentComponentUnRegisterRenderTarget()

void SO3::SEnvironment::_NotifyEnvironmentComponentUnRegisterRenderTarget

(

Ogre::Viewport *

targetViewport

)

Definition at line 460 of file SO3Environment.cpp.

frameStarted()

bool SO3::SEnvironment::frameStarted ( const Ogre::FrameEvent &  evt )

protectedvirtual

Definition at line 418 of file SO3Environment.cpp.

GetDateTime()

SDateTime SO3::SEnvironment::GetDateTime

(

)

Definition at line 379 of file SO3Environment.cpp.

GetEnable()

bool SO3::SEnvironment::GetEnable

(

)

Definition at line 262 of file SO3Environment.cpp.

GetHumidity()

float SO3::SEnvironment::GetHumidity

(

)

Definition at line 340 of file SO3Environment.cpp.

GetLatitude()

Ogre::Degree SO3::SEnvironment::GetLatitude

(

)

Remarks

: this is not updated as the camera moves, due to too overloading calculation on each frames!

Definition at line 408 of file SO3Environment.cpp.

GetLongitude()

Ogre::Degree SO3::SEnvironment::GetLongitude

(

)

Remarks

: this is not updated as the camera moves, due to too overloading calculation on each frames!

Definition at line 398 of file SO3Environment.cpp.

GetMoon()

SMoon * SO3::SEnvironment::GetMoon

(

)

Definition at line 257 of file SO3Environment.cpp.

GetPaused()

bool SO3::SEnvironment::GetPaused

(

)

Definition at line 369 of file SO3Environment.cpp.

GetRegisteredViewports()

SEnvironment::ViewportList SO3::SEnvironment::GetRegisteredViewports

(

)

Definition at line 232 of file SO3Environment.cpp.

GetScene()

SScene * SO3::SEnvironment::GetScene

(

)

Definition at line 123 of file SO3Environment.cpp.

GetSky()

SSky * SO3::SEnvironment::GetSky

(

)

Definition at line 247 of file SO3Environment.cpp.

GetSkyEnable()

bool SO3::SEnvironment::GetSkyEnable

(

)

Definition at line 307 of file SO3Environment.cpp.

GetSun()

SSun * SO3::SEnvironment::GetSun

(

)

Definition at line 252 of file SO3Environment.cpp.

GetTimeSpeedFactor()

float SO3::SEnvironment::GetTimeSpeedFactor

(

)

Definition at line 355 of file SO3Environment.cpp.

GetUniversalClock()

SUniversalClock * SO3::SEnvironment::GetUniversalClock

(

)

Definition at line 237 of file SO3Environment.cpp.

GetWater()

SWater * SO3::SEnvironment::GetWater

(

)

Definition at line 242 of file SO3Environment.cpp.

GetWaterEnable()

bool SO3::SEnvironment::GetWaterEnable

(

)

Definition at line 294 of file SO3Environment.cpp.

GetWindDirection()

Ogre::Vector2 SO3::SEnvironment::GetWindDirection

(

)

Definition at line 330 of file SO3Environment.cpp.

GetWindSpeed()

float SO3::SEnvironment::GetWindSpeed

(

)

Definition at line 320 of file SO3Environment.cpp.

IsRegisteredViewport() [1/2]

bool SO3::SEnvironment::IsRegisteredViewport

(

Ogre::Viewport *

targetViewport

)

Definition at line 208 of file SO3Environment.cpp.

IsRegisteredViewport() [2/2]

bool SO3::SEnvironment::IsRegisteredViewport

(

SViewPort *

targetViewport

)

Definition at line 199 of file SO3Environment.cpp.

RegisterViewport()

void SO3::SEnvironment::RegisterViewport

(

SViewPort *

targetViewport

)

Definition at line 128 of file SO3Environment.cpp.

SetDateTime()

void SO3::SEnvironment::SetDateTime

(

const SDateTime &

newDateTime

)

Definition at line 391 of file SO3Environment.cpp.

SetEnable()

void SO3::SEnvironment::SetEnable

(

const bool &

enableEnvironment

)

Definition at line 267 of file SO3Environment.cpp.

SetHumidity()

void SO3::SEnvironment::SetHumidity

(

const float &

newHumidity

)

Definition at line 345 of file SO3Environment.cpp.

SetLatitude()

void SO3::SEnvironment::SetLatitude

(

const Ogre::Degree &

newLatitude

)

Definition at line 413 of file SO3Environment.cpp.

SetLongitude()

void SO3::SEnvironment::SetLongitude

(

const Ogre::Degree &

newLongitude

)

Definition at line 403 of file SO3Environment.cpp.

SetPaused()

void SO3::SEnvironment::SetPaused

(

const bool &

pauseSimulation

)

Definition at line 374 of file SO3Environment.cpp.

SetSkyEnable()

void SO3::SEnvironment::SetSkyEnable

(

const bool &

enableSky

)

Definition at line 312 of file SO3Environment.cpp.

SetTimeSpeedFactor()

void SO3::SEnvironment::SetTimeSpeedFactor

(

const float &

newTimeSpeedFactor

)

Definition at line 363 of file SO3Environment.cpp.

SetWaterEnable()

void SO3::SEnvironment::SetWaterEnable

(

const bool &

enableWater

)

Definition at line 299 of file SO3Environment.cpp.

SetWindDirection()

void SO3::SEnvironment::SetWindDirection

(

const Ogre::Vector2 &

newWindDirection

)

Definition at line 335 of file SO3Environment.cpp.

SetWindSpeed()

void SO3::SEnvironment::SetWindSpeed

(

const float &

newWindSpeed

)

Definition at line 325 of file SO3Environment.cpp.

UnregisterAllViewports()

void SO3::SEnvironment::UnregisterAllViewports

(

)

Definition at line 221 of file SO3Environment.cpp.

UnregisterCamera()

void SO3::SEnvironment::UnregisterCamera

(

Ogre::Camera *

cam

)

Definition at line 190 of file SO3Environment.cpp.

UnregisterViewport()

void SO3::SEnvironment::UnregisterViewport

(

SViewPort *

targetViewport

)

Definition at line 161 of file SO3Environment.cpp.

UpdateCamera()

void SO3::SEnvironment::UpdateCamera

(

SViewPort *

viewport

)

Definition at line 472 of file SO3Environment.cpp.

---

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

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