Annwvyn::AnnSceneryManager Class Reference

Scenery Manager. Set the scene rendering parameters, like the exposure or the ambient lighting... More...

#include <AnnSceneryManager.hpp>

Inheritance diagram for Annwvyn::AnnSceneryManager:
Collaboration diagram for Annwvyn::AnnSceneryManager:

Public Member Functions

 AnnSceneryManager (AnnOgreVRRendererPtr renderer)
 Construct the AnnSceneryManager. More...
 
bool needUpdate () override
 This subsystem doesn't need to be updated. More...
 
void setSkyDomeMaterial (bool activate, const std::string &materialName, float curvature=2.0f, float tiling=1.0f) const
 
void setSkyBoxMaterial (bool activate, const std::string &materialName, float distance=8000, bool renderedFirst=true) const
 
void removeSkyDome () const
 Remove the sky dome. More...
 
void removeSkyBox () const
 Remove the sky box. More...
 
void setAmbientLight (AnnColor upperColor, float upperMul, AnnColor lowerColor, float lowerMul, AnnVect3 direction, float environementMapScaling=16) const
 Set the ambient light. Ambiant light is 2 hemisphere, and upper one and a lower one. HDR light values are color * multiplier. More...
 
void setDefaultAmbientLight () const
 Set the defautl ambient light. More...
 
void setExposure (float exposure, float minExposure, float maxExposure) const
 Set the exposure value in "ev" (what's used in photography for exposure compensation). Also set the delta of adjustmen. More...
 
void setDefaultExposure () const
 Reset the default exposure. More...
 
void setSkyColor (AnnColor color, float multiplier) const
 Set the color of the sky. Converted into HDR light values with the multiplier. More...
 
void setDefaultSkyColor () const
 Reset the engine default sky color. More...
 
void setBloomThreshold (float threshold) const
 Set the threshold that define where to put the bloom effect. More...
 
void setDefaultBloomThreshold () const
 Reset the default bloom effect. More...
 
void resetSceneParameters () const
 Reset everything to engine default. More...
 
- Public Member Functions inherited from Annwvyn::AnnSubSystem
 AnnSubSystem (const std::string &systemName)
 Construct a SubSystem. More...
 
virtual ~AnnSubSystem ()
 Destruct a SubSystem. More...
 

Private Attributes

Ogre::SceneManager * smgr
 Scene manager created by the VR renderer. More...
 
AnnOgreVRRendererPtr renderer
 Pointer to the VR renderer. More...
 
const float defaultExposure
 Defaults environmental floats. More...
 
const float defaultMinAutoExposure
 
const float defaultMaxAutoExposure
 
const float defaultSkyColorMultiplier
 
const float defaultBloom
 
const float defaultUpperAmbientLightMul
 
const float defaultLowerAmbientLightMul
 
const AnnColor defaultSkyColor
 Default sky color. More...
 
const AnnColor defaultUpperAmbient
 
const AnnColor defaultLowerAmbient
 

Additional Inherited Members

- Protected Member Functions inherited from Annwvyn::AnnSubSystem
virtual void update ()
 To be called by AnnEngine : update the subsystem for the next frame. More...
 
- Protected Attributes inherited from Annwvyn::AnnSubSystem
std::string name
 Name of the subsystem. More...
 

Detailed Description

Scenery Manager. Set the scene rendering parameters, like the exposure or the ambient lighting...

Definition at line 14 of file AnnSceneryManager.hpp.

Constructor & Destructor Documentation

◆ AnnSceneryManager()

AnnSceneryManager::AnnSceneryManager ( AnnOgreVRRendererPtr  renderer)

Construct the AnnSceneryManager.

Definition at line 10 of file AnnSceneryManager.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ needUpdate()

bool Annwvyn::AnnSceneryManager::needUpdate ( )
inlineoverridevirtual

This subsystem doesn't need to be updated.

Reimplemented from Annwvyn::AnnSubSystem.

Definition at line 21 of file AnnSceneryManager.hpp.

◆ removeSkyBox()

void AnnSceneryManager::removeSkyBox ( ) const

Remove the sky box.

Definition at line 62 of file AnnSceneryManager.cpp.

Here is the caller graph for this function:

◆ removeSkyDome()

void AnnSceneryManager::removeSkyDome ( ) const

Remove the sky dome.

Definition at line 56 of file AnnSceneryManager.cpp.

Here is the caller graph for this function:

◆ resetSceneParameters()

void AnnSceneryManager::resetSceneParameters ( ) const

Reset everything to engine default.

Definition at line 106 of file AnnSceneryManager.cpp.

Here is the call graph for this function:

◆ setAmbientLight()

void AnnSceneryManager::setAmbientLight ( AnnColor  upperColor,
float  upperMul,
AnnColor  lowerColor,
float  lowerMul,
AnnVect3  direction,
float  environementMapScaling = 16 
) const

Set the ambient light. Ambiant light is 2 hemisphere, and upper one and a lower one. HDR light values are color * multiplier.

Definition at line 31 of file AnnSceneryManager.cpp.

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

◆ setBloomThreshold()

void AnnSceneryManager::setBloomThreshold ( float  threshold) const

Set the threshold that define where to put the bloom effect.

Definition at line 90 of file AnnSceneryManager.cpp.

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

◆ setDefaultAmbientLight()

void AnnSceneryManager::setDefaultAmbientLight ( ) const

Set the defautl ambient light.

Definition at line 101 of file AnnSceneryManager.cpp.

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

◆ setDefaultBloomThreshold()

void AnnSceneryManager::setDefaultBloomThreshold ( ) const

Reset the default bloom effect.

Definition at line 96 of file AnnSceneryManager.cpp.

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

◆ setDefaultExposure()

void AnnSceneryManager::setDefaultExposure ( ) const

Reset the default exposure.

Definition at line 74 of file AnnSceneryManager.cpp.

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

◆ setDefaultSkyColor()

void AnnSceneryManager::setDefaultSkyColor ( ) const

Reset the engine default sky color.

Definition at line 85 of file AnnSceneryManager.cpp.

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

◆ setExposure()

void AnnSceneryManager::setExposure ( float  exposure,
float  minExposure,
float  maxExposure 
) const

Set the exposure value in "ev" (what's used in photography for exposure compensation). Also set the delta of adjustmen.

Definition at line 68 of file AnnSceneryManager.cpp.

Here is the caller graph for this function:

◆ setSkyBoxMaterial()

void AnnSceneryManager::setSkyBoxMaterial ( bool  activate,
const std::string materialName,
float  distance = 8000,
bool  renderedFirst = true 
) const

Set the ogre material for the sky-box with params

Parameters
activateif true put the sky-box on the scene
materialNamename of a material declared on the resource manager
distancedistance of the sky from the camera
renderedFirstif true, the sky-box will be the first thing rendered

Definition at line 50 of file AnnSceneryManager.cpp.

◆ setSkyColor()

void AnnSceneryManager::setSkyColor ( AnnColor  color,
float  multiplier 
) const

Set the color of the sky. Converted into HDR light values with the multiplier.

Definition at line 79 of file AnnSceneryManager.cpp.

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

◆ setSkyDomeMaterial()

void AnnSceneryManager::setSkyDomeMaterial ( bool  activate,
const std::string materialName,
float  curvature = 2.0f,
float  tiling = 1.0f 
) const

Set the ogre material for the sky-dome with params

Parameters
activateif true put a sky-dome
materialNamename of a material known from the Ogre Resource group manager
curvaturecurvature of the texture
tilingtilling of the texture

Definition at line 44 of file AnnSceneryManager.cpp.

Member Data Documentation

◆ defaultBloom

const float Annwvyn::AnnSceneryManager::defaultBloom
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultExposure

const float Annwvyn::AnnSceneryManager::defaultExposure
private

Defaults environmental floats.

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultLowerAmbient

const AnnColor Annwvyn::AnnSceneryManager::defaultLowerAmbient
private

Definition at line 86 of file AnnSceneryManager.hpp.

◆ defaultLowerAmbientLightMul

const float Annwvyn::AnnSceneryManager::defaultLowerAmbientLightMul
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultMaxAutoExposure

const float Annwvyn::AnnSceneryManager::defaultMaxAutoExposure
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultMinAutoExposure

const float Annwvyn::AnnSceneryManager::defaultMinAutoExposure
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultSkyColor

const AnnColor Annwvyn::AnnSceneryManager::defaultSkyColor
private

Default sky color.

Definition at line 86 of file AnnSceneryManager.hpp.

◆ defaultSkyColorMultiplier

const float Annwvyn::AnnSceneryManager::defaultSkyColorMultiplier
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ defaultUpperAmbient

const AnnColor Annwvyn::AnnSceneryManager::defaultUpperAmbient
private

Definition at line 86 of file AnnSceneryManager.hpp.

◆ defaultUpperAmbientLightMul

const float Annwvyn::AnnSceneryManager::defaultUpperAmbientLightMul
private

Definition at line 84 of file AnnSceneryManager.hpp.

◆ renderer

AnnOgreVRRendererPtr Annwvyn::AnnSceneryManager::renderer
private

Pointer to the VR renderer.

Definition at line 81 of file AnnSceneryManager.hpp.

◆ smgr

Ogre::SceneManager* Annwvyn::AnnSceneryManager::smgr
private

Scene manager created by the VR renderer.

Definition at line 78 of file AnnSceneryManager.hpp.


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