SO3::SSky Class Reference

#include <SO3Sky.h>

Inheritance diagram for SO3::SSky:

Classes
class	CloudLayered
class	CloudVolumetric
class	SkyComponent

Public Types
enum	SkyComponentType { SO3_SKY_COMPONENT_NONE , SO3_SKY_COMPONENT_LAYERER_CLOUD , SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD }
enum	SkyLightingMode { SO3_SKY_LDR = 0 , SO3_SKY_HDR = 1 }

Public Member Functions
	SSky (SEnvironment *parent, const std::string &skyName)
	~SSky ()
SkyX::SkyX *	GetSkyX ()
SSky::CloudVolumetric *	GetCloudVolumetric ()
SkyComponent *	GetComponent (const SkyComponentType &componentType)
SSky::CloudLayered *	GetCloudLayered ()
virtual void	Update (const Ogre::Real &updateTime)
virtual void	UpdateCamera (SViewPort *viewport)
float	GetAnimationSpeed ()
void	SetAnimationSpeed (const float &animationSpeed)
float	GetCloudCeiling ()
void	SetCloudCeiling (const float &newCloudCeiling)
bool	GetHDREnable ()
void	SetHDREnable (const bool &enable)
bool	GetLightningEnable ()
void	SetLightningEnable (const bool &enable)
void	AddLightning (const Ogre::Vector3 from, const Ogre::Vector3 dir, const Ogre::Real length)
void	AddViewport (Ogre::Viewport *viewport)
void	RemoveViewport (Ogre::Viewport *viewport)
Public Member Functions inherited from SO3::SEnvironmentComponent
	SEnvironmentComponent (SEnvironment *parent, const std::string &environmentComponentName)
virtual	~SEnvironmentComponent ()
SEnvironment *	GetEnvironment ()
bool	GetEnable ()
void	SetEnable (const bool &enableComponent)
void	RegisterViewport (SViewPort *viewport)
void	UnregisterViewport (SViewPort *viewport)
void	UnregisterCamera (Ogre::Camera *cam)
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 void	SetEnableImpl (const bool &enableComponent)
virtual void	RegisterViewportImpl (SViewPort *viewport)
virtual void	UnregisterViewportImpl (SViewPort *viewport)
virtual void	UnregisterCameraImpl (Ogre::Camera *cam)
Protected Member Functions inherited from SO3::SEnvironmentComponent
void	Cleanup ()
ViewportList	GetRegisteredViewports ()

Additional Inherited Members
Protected Types inherited from SO3::SEnvironmentComponent
typedef std::set< SViewPort * >	ViewportList
Protected Attributes inherited from SO3::SEnvironmentComponent
SEnvironment *	parentEnvironment
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Definition at line 45 of file SO3Sky.h.

Member Enumeration Documentation

SkyComponentType

enum SO3::SSky::SkyComponentType

Enumerator
SO3_SKY_COMPONENT_NONE
SO3_SKY_COMPONENT_LAYERER_CLOUD
SO3_SKY_COMPONENT_VOLUMETRIC_CLOUD

Definition at line 51 of file SO3Sky.h.

SkyLightingMode

enum SO3::SSky::SkyLightingMode

Enumerator
SO3_SKY_LDR	Low dynamic range.
SO3_SKY_HDR	High dynamic range.

Definition at line 60 of file SO3Sky.h.

Constructor & Destructor Documentation

SSky()

SO3::SSky::SSky	(	SEnvironment *	parent,
		const std::string &	skyName
	)

Definition at line 44 of file SO3Sky.cpp.

~SSky()

SO3::SSky::~SSky

(

)

Destructor

Definition at line 81 of file SO3Sky.cpp.

Member Function Documentation

AddLightning()

void SO3::SSky::AddLightning	(	const Ogre::Vector3	from,
		const Ogre::Vector3	dir,
		const Ogre::Real	length
	)

Definition at line 405 of file SO3Sky.cpp.

AddViewport()

void SO3::SSky::AddViewport

(

Ogre::Viewport *

viewport

)

Definition at line 200 of file SO3Sky.cpp.

GetAnimationSpeed()

float SO3::SSky::GetAnimationSpeed

(

)

Retrieve the clouds animation speed.

Definition at line 332 of file SO3Sky.cpp.

GetCloudCeiling()

float SO3::SSky::GetCloudCeiling

(

)

Definition at line 342 of file SO3Sky.cpp.

GetCloudLayered()

SSky::CloudLayered * SO3::SSky::GetCloudLayered

(

)

Definition at line 327 of file SO3Sky.cpp.

GetCloudVolumetric()

SSky::CloudVolumetric * SO3::SSky::GetCloudVolumetric

(

)

Definition at line 322 of file SO3Sky.cpp.

GetComponent()

SSky::SkyComponent * SO3::SSky::GetComponent

(

const SkyComponentType &

componentType

)

Definition at line 304 of file SO3Sky.cpp.

GetHDREnable()

bool SO3::SSky::GetHDREnable

(

)

Definition at line 363 of file SO3Sky.cpp.

GetLightningEnable()

bool SO3::SSky::GetLightningEnable

(

)

Definition at line 384 of file SO3Sky.cpp.

GetSkyX()

SkyX::SkyX * SO3::SSky::GetSkyX

(

)

Internal use only!

Definition at line 230 of file SO3Sky.cpp.

RegisterViewportImpl()

void SO3::SSky::RegisterViewportImpl ( SViewPort *  viewport )

protectedvirtual

Implements SO3::SEnvironmentComponent.

Definition at line 176 of file SO3Sky.cpp.

RemoveViewport()

void SO3::SSky::RemoveViewport

(

Ogre::Viewport *

viewport

)

Definition at line 210 of file SO3Sky.cpp.

SetAnimationSpeed()

void SO3::SSky::SetAnimationSpeed

(

const float &

animationSpeed

)

Change the clouds animations speed.

Definition at line 337 of file SO3Sky.cpp.

SetCloudCeiling()

void SO3::SSky::SetCloudCeiling

(

const float &

newCloudCeiling

)

Definition at line 347 of file SO3Sky.cpp.

SetEnableImpl()

void SO3::SSky::SetEnableImpl ( const bool &  enableComponent )

protectedvirtual

Implements SO3::SEnvironmentComponent.

Definition at line 95 of file SO3Sky.cpp.

SetHDREnable()

void SO3::SSky::SetHDREnable

(

const bool &

enable

)

Definition at line 368 of file SO3Sky.cpp.

SetLightningEnable()

void SO3::SSky::SetLightningEnable

(

const bool &

enable

)

Definition at line 389 of file SO3Sky.cpp.

UnregisterCameraImpl()

void SO3::SSky::UnregisterCameraImpl ( Ogre::Camera *  cam )

protectedvirtual

Reimplemented from SO3::SEnvironmentComponent.

Definition at line 222 of file SO3Sky.cpp.

UnregisterViewportImpl()

void SO3::SSky::UnregisterViewportImpl ( SViewPort *  viewport )

protectedvirtual

Implements SO3::SEnvironmentComponent.

Definition at line 187 of file SO3Sky.cpp.

Update()

void SO3::SSky::Update ( const Ogre::Real &  updateTime )

virtual

copydoc SEnvironmentComponent::Update

Implements SO3::SEnvironmentComponent.

Definition at line 239 of file SO3Sky.cpp.

UpdateCamera()

void SO3::SSky::UpdateCamera ( SViewPort *  viewport )

virtual

Reimplemented from SO3::SEnvironmentComponent.

Definition at line 235 of file SO3Sky.cpp.

---

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

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