RigsofRods
Soft-body Physics Simulation
Data Structures | Public Member Functions | Private Member Functions | Private Attributes
SkyX::CloudLayer Class Reference

#include <CloudsManager.h>

+ Collaboration diagram for SkyX::CloudLayer:

Data Structures

struct  Options
 Cloud layer options. More...
 

Public Member Functions

 CloudLayer (SkyX *s)
 Default onstructor. More...
 
 CloudLayer (SkyX *s, const Options &o)
 Constructor. More...
 
 ~CloudLayer ()
 Destructor. More...
 
void setOptions (const Options &o)
 Set options. More...
 
const OptionsgetOptions () const
 Get options. More...
 
void setAmbientGradient (const ColorGradient &AmbientGradient)
 Set ambient gradient. More...
 
const ColorGradientgetAmbientGradient () const
 Get ambient color gradient. More...
 
void setSunGradient (const ColorGradient &SunGradient)
 Set sun gradient. More...
 
const ColorGradientgetSunGradient () const
 Get sun color gradient. More...
 
void _registerCloudLayer (Ogre::Pass *CloudLayerPass)
 Register layer. More...
 
void _unregister ()
 Unregister cloud pass. More...
 
void _updateInternalPassParameters ()
 Update internal cloud pass parameters. More...
 

Private Member Functions

void _updatePassParameters ()
 Update cloud pass parameters. More...
 

Private Attributes

Options mOptions
 Cloud layer options. More...
 
ColorGradient mAmbientGradient
 Ambient and Sun color gradients. More...
 
ColorGradient mSunGradient
 
Ogre::Pass * mCloudLayerPass
 Cloud layer pass. More...
 
SkyXmSkyX
 SkyX parent pointer. More...
 

Detailed Description

Definition at line 35 of file CloudsManager.h.

Constructor & Destructor Documentation

◆ CloudLayer() [1/2]

SkyX::CloudLayer::CloudLayer ( SkyX s)

Default onstructor.

-----------— CloudLayer --------------—

Parameters
sSkyX parent pointer

Definition at line 31 of file CloudsManager.cpp.

+ Here is the call graph for this function:

◆ CloudLayer() [2/2]

SkyX::CloudLayer::CloudLayer ( SkyX s,
const Options o 
)

Constructor.

Parameters
sSkyX parent pointer
oCloud layer options

Definition at line 56 of file CloudsManager.cpp.

+ Here is the call graph for this function:

◆ ~CloudLayer()

SkyX::CloudLayer::~CloudLayer ( )

Destructor.

Definition at line 81 of file CloudsManager.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ _registerCloudLayer()

void SkyX::CloudLayer::_registerCloudLayer ( Ogre::Pass *  CloudLayerPass)

Register layer.

Parameters
CloudLayerPassPass where register the cloud layer

Definition at line 86 of file CloudsManager.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _unregister()

void SkyX::CloudLayer::_unregister ( )

Unregister cloud pass.

Definition at line 116 of file CloudsManager.cpp.

+ Here is the caller graph for this function:

◆ _updateInternalPassParameters()

void SkyX::CloudLayer::_updateInternalPassParameters ( )

Update internal cloud pass parameters.

Definition at line 152 of file CloudsManager.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _updatePassParameters()

void SkyX::CloudLayer::_updatePassParameters ( )
private

Update cloud pass parameters.

Definition at line 125 of file CloudsManager.cpp.

+ Here is the caller graph for this function:

◆ getAmbientGradient()

const ColorGradient& SkyX::CloudLayer::getAmbientGradient ( ) const
inline

Get ambient color gradient.

Returns
Ambient color gradient

Definition at line 171 of file CloudsManager.h.

◆ getOptions()

const Options& SkyX::CloudLayer::getOptions ( ) const
inline

Get options.

Returns
Cloud layer options

Definition at line 155 of file CloudsManager.h.

◆ getSunGradient()

const ColorGradient& SkyX::CloudLayer::getSunGradient ( ) const
inline

Get sun color gradient.

Returns
Sun color gradient

Definition at line 187 of file CloudsManager.h.

◆ setAmbientGradient()

void SkyX::CloudLayer::setAmbientGradient ( const ColorGradient AmbientGradient)
inline

Set ambient gradient.

Parameters
AmbientGradientAmbient color gradient

Definition at line 163 of file CloudsManager.h.

◆ setOptions()

void SkyX::CloudLayer::setOptions ( const Options o)
inline

Set options.

Parameters
oNew options

Definition at line 146 of file CloudsManager.h.

+ Here is the call graph for this function:

◆ setSunGradient()

void SkyX::CloudLayer::setSunGradient ( const ColorGradient SunGradient)
inline

Set sun gradient.

Parameters
SunGradientSun color gradient

Definition at line 179 of file CloudsManager.h.

Field Documentation

◆ mAmbientGradient

ColorGradient SkyX::CloudLayer::mAmbientGradient
private

Ambient and Sun color gradients.

Definition at line 214 of file CloudsManager.h.

◆ mCloudLayerPass

Ogre::Pass* SkyX::CloudLayer::mCloudLayerPass
private

Cloud layer pass.

Definition at line 218 of file CloudsManager.h.

◆ mOptions

Options SkyX::CloudLayer::mOptions
private

Cloud layer options.

Definition at line 211 of file CloudsManager.h.

◆ mSkyX

SkyX* SkyX::CloudLayer::mSkyX
private

SkyX parent pointer.

Definition at line 221 of file CloudsManager.h.

◆ mSunGradient

ColorGradient SkyX::CloudLayer::mSunGradient
private

Definition at line 215 of file CloudsManager.h.


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