SkyX::AtmosphereManager Class Reference

#include <AtmosphereManager.h>

Collaboration diagram for SkyX::AtmosphereManager:

Data Structures
struct	Options
	Atmosphere options. More...

Public Member Functions
	AtmosphereManager (SkyX *s)
	Constructor. More...
	~AtmosphereManager ()
	Destructor. More...
void	setOptions (const Options &_Options)
	Set options. More...
const Options &	getOptions () const
	Get current options. More...
const Ogre::Vector3	getColorAt (const Ogre::Vector3 &Direction) const
	Get current atmosphere color at the given direction. More...
void	_update (const Options &NewOptions, const bool &ForceToUpdateAll=false)
	Update atmoshpere. More...

Private Member Functions
const float	_scale (const float &cos, const float &uScaleDepth) const
	Shader scale funtion. More...

Private Attributes
Options	mOptions
	Our options. More...
SkyX *	mSkyX
	SkyX parent pointer. More...

Detailed Description

Definition at line 33 of file AtmosphereManager.h.

Constructor & Destructor Documentation

AtmosphereManager()

SkyX::AtmosphereManager::AtmosphereManager

(

SkyX *

s

)

Constructor.

Parameters

s	Parent SkyX pointer

Definition at line 32 of file AtmosphereManager.cpp.

~AtmosphereManager()

SkyX::AtmosphereManager::~AtmosphereManager

(

)

Destructor.

Definition at line 38 of file AtmosphereManager.cpp.

Member Function Documentation

_scale()

const float SkyX::AtmosphereManager::_scale ( const float &  cos, const float &  uScaleDepth  ) const

private

Shader scale funtion.

Parameters

cos	Cos
uScaleDepth	Scale Depth

Returns

Scale

Definition at line 139 of file AtmosphereManager.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

_update()

void SkyX::AtmosphereManager::_update	(	const Options &	NewOptions,
		const bool &	ForceToUpdateAll = false
	)

Update atmoshpere.

Parameters

NewOptions	Update only the differences between actual parameters and new ones.
ForceToUpdateAll	Forces to upload all current parameters to skyx material.

Remarks

Current options parameters are updated if needed.

Definition at line 42 of file AtmosphereManager.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getColorAt()

const Ogre::Vector3 SkyX::AtmosphereManager::getColorAt

(

const Ogre::Vector3 &

Direction

)

const

Get current atmosphere color at the given direction.

Parameters

Direction

Normalised direction

Returns

Atmosphere color at the especified direction

Definition at line 145 of file AtmosphereManager.cpp.

Here is the call graph for this function:

getOptions()

const Options& SkyX::AtmosphereManager::getOptions ( ) const

inline

Get current options.

Returns

Current options

Definition at line 139 of file AtmosphereManager.h.

Here is the caller graph for this function:

setOptions()

void SkyX::AtmosphereManager::setOptions ( const Options &  _Options )

inline

Set options.

Parameters

_Options

New options

Definition at line 131 of file AtmosphereManager.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

mOptions

Options SkyX::AtmosphereManager::mOptions

private

Our options.

Definition at line 166 of file AtmosphereManager.h.

mSkyX

SkyX* SkyX::AtmosphereManager::mSkyX

private

SkyX parent pointer.

Definition at line 169 of file AtmosphereManager.h.

---

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

• source/main/gfx/skyx/AtmosphereManager.h
• source/main/gfx/skyx/AtmosphereManager.cpp