Project

General

Profile

SO3Engine
SO3::SSky::CloudLayered Class Reference

#include <SO3Sky.h>

Inheritance diagram for SO3::SSky::CloudLayered:
SO3::SSky::SkyComponent

Public Member Functions

 CloudLayered (SSky *parentSkyInstance)
 
 ~CloudLayered ()
 
virtual void Update (const Ogre::Real &updateTime)
 
unsigned int AddLayer (const Ogre::Real &heightFromCloudCeiling=0.0f, const Ogre::Real &scale=0.001f, const Ogre::Real &distanceAttenuation=0.05f, const Ogre::Real &detailAttenuation=1.0f, const Ogre::Real &heightVolume=0.25f, const Ogre::Real &volumetricDisplacement=0.01f)
 
void RemoveLayer (const unsigned int &index)
 
void RemoveAllLayers ()
 
std::vector< int > GetLayerIndexes ()
 
void SetParameters (const unsigned int &index, const float &heightFromCloudCeiling, const float &scale, const float &attenuationDistance, const float &attenuationDetail, const float &heightVolume, const float &volumetricDisplacement)
 
Ogre::Real GetHeightFromCloudCeiling (const unsigned int &index)
 
void SetHeightFromCloudCeiling (const unsigned int &index, const Ogre::Real &newHeightFromCloudCeiling)
 
Ogre::Real GetScale (const unsigned int &index)
 
void SetScale (const unsigned int &index, const Ogre::Real &newScale)
 
Ogre::Real GetAttenuationDistance (const unsigned int &index)
 
void SetAttenuationDistance (const unsigned int &index, const Ogre::Real &newAttenuationDistance)
 
Ogre::Real GetAttenuationDetail (const unsigned int &index)
 
void SetAttenuationDetail (const unsigned int &index, const Ogre::Real &newAttenuationDetail)
 
Ogre::Real GetHeightVolume (const unsigned int &index)
 
void SetHeightVolume (const unsigned int &index, const Ogre::Real &newHeightVolume)
 
Ogre::Real GetVolumetricDisplacement (const unsigned int &index)
 
void SetVolumetricDisplacement (const unsigned int &index, const Ogre::Real &newVolumetricDisplacement)
 
virtual void SetEnableImpl (const bool &enableComponent)
 
- Public Member Functions inherited from SO3::SSky::SkyComponent
 SkyComponent (SSky *parentSkyInstance, const SkyComponentType &component)
 
virtual ~SkyComponent ()
 
bool GetEnabled ()
 
void SetEnabled (const bool &enable)
 
virtual void UnregisterCamera (Ogre::Camera *cam)
 
SkyComponentType GetType ()
 

Additional Inherited Members

- Protected Attributes inherited from SO3::SSky::SkyComponent
SSkyparentSky
 

Detailed Description

Basic layer cloud

Definition at line 125 of file SO3Sky.h.

Constructor & Destructor Documentation

◆ CloudLayered()

SO3::SSky::CloudLayered::CloudLayered ( SSky parentSkyInstance)

Definition at line 465 of file SO3Sky.cpp.

◆ ~CloudLayered()

SO3::SSky::CloudLayered::~CloudLayered ( )

Definition at line 474 of file SO3Sky.cpp.

Member Function Documentation

◆ AddLayer()

unsigned int SO3::SSky::CloudLayered::AddLayer ( const Ogre::Real &  heightFromCloudCeiling = 0.0f,
const Ogre::Real &  scale = 0.001f,
const Ogre::Real &  distanceAttenuation = 0.05f,
const Ogre::Real &  detailAttenuation = 1.0f,
const Ogre::Real &  heightVolume = 0.25f,
const Ogre::Real &  volumetricDisplacement = 0.01f 
)
Returns
the index of the new layer

Definition at line 547 of file SO3Sky.cpp.

◆ GetAttenuationDetail()

Ogre::Real SO3::SSky::CloudLayered::GetAttenuationDetail ( const unsigned int &  index)

Definition at line 721 of file SO3Sky.cpp.

◆ GetAttenuationDistance()

Ogre::Real SO3::SSky::CloudLayered::GetAttenuationDistance ( const unsigned int &  index)

Definition at line 710 of file SO3Sky.cpp.

◆ GetHeightFromCloudCeiling()

Ogre::Real SO3::SSky::CloudLayered::GetHeightFromCloudCeiling ( const unsigned int &  index)

Definition at line 688 of file SO3Sky.cpp.

◆ GetHeightVolume()

Ogre::Real SO3::SSky::CloudLayered::GetHeightVolume ( const unsigned int &  index)

Definition at line 732 of file SO3Sky.cpp.

◆ GetLayerIndexes()

std::vector< int > SO3::SSky::CloudLayered::GetLayerIndexes ( )

Definition at line 655 of file SO3Sky.cpp.

◆ GetScale()

Ogre::Real SO3::SSky::CloudLayered::GetScale ( const unsigned int &  index)

Definition at line 699 of file SO3Sky.cpp.

◆ GetVolumetricDisplacement()

Ogre::Real SO3::SSky::CloudLayered::GetVolumetricDisplacement ( const unsigned int &  index)

Definition at line 743 of file SO3Sky.cpp.

◆ RemoveAllLayers()

void SO3::SSky::CloudLayered::RemoveAllLayers ( )

Definition at line 645 of file SO3Sky.cpp.

◆ RemoveLayer()

void SO3::SSky::CloudLayered::RemoveLayer ( const unsigned int &  index)
Parameters
indexIndex of the layer to destroy

Definition at line 623 of file SO3Sky.cpp.

◆ SetAttenuationDetail()

void SO3::SSky::CloudLayered::SetAttenuationDetail ( const unsigned int &  index,
const Ogre::Real &  newAttenuationDetail 
)

Definition at line 726 of file SO3Sky.cpp.

◆ SetAttenuationDistance()

void SO3::SSky::CloudLayered::SetAttenuationDistance ( const unsigned int &  index,
const Ogre::Real &  newAttenuationDistance 
)

Definition at line 715 of file SO3Sky.cpp.

◆ SetEnableImpl()

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

Reimplemented from SO3::SSky::SkyComponent.

Definition at line 479 of file SO3Sky.cpp.

◆ SetHeightFromCloudCeiling()

void SO3::SSky::CloudLayered::SetHeightFromCloudCeiling ( const unsigned int &  index,
const Ogre::Real &  newHeightFromCloudCeiling 
)

Definition at line 693 of file SO3Sky.cpp.

◆ SetHeightVolume()

void SO3::SSky::CloudLayered::SetHeightVolume ( const unsigned int &  index,
const Ogre::Real &  newHeightVolume 
)

Definition at line 737 of file SO3Sky.cpp.

◆ SetParameters()

void SO3::SSky::CloudLayered::SetParameters ( const unsigned int &  index,
const float &  heightFromCloudCeiling,
const float &  scale,
const float &  attenuationDistance,
const float &  attenuationDetail,
const float &  heightVolume,
const float &  volumetricDisplacement 
)

Definition at line 676 of file SO3Sky.cpp.

◆ SetScale()

void SO3::SSky::CloudLayered::SetScale ( const unsigned int &  index,
const Ogre::Real &  newScale 
)

Definition at line 704 of file SO3Sky.cpp.

◆ SetVolumetricDisplacement()

void SO3::SSky::CloudLayered::SetVolumetricDisplacement ( const unsigned int &  index,
const Ogre::Real &  newVolumetricDisplacement 
)

Definition at line 748 of file SO3Sky.cpp.

◆ Update()

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

Implements SO3::SSky::SkyComponent.

Definition at line 504 of file SO3Sky.cpp.


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