caelum::SkyDome Class Reference
#include <SkyDome.h>
Public Member Functions | |
| SkyDome (Ogre::SceneManager *sceneMgr, Ogre::SceneNode *caelumRootNode) | |
| virtual | ~SkyDome () |
| void | setSunDirection (Ogre::Vector3 dir) |
| void | setHazeColour (Ogre::ColourValue hazeColour) |
| Explicit haze colour. | |
| void | setLightAbsorption (float absorption) const |
| void | setLightScattering (float scattering) const |
| void | setAtmosphereHeight (float height) const |
| void | setSkyGradientsImage (const Ogre::String &gradients) |
| Set the sky color gradients image. | |
| void | setAtmosphereDepthImage (const Ogre::String &gradients) |
| Set the atmosphere depthh gradient image. | |
| bool | getHazeEnabled () const |
| If skydome haze is enabled. | |
| void | setHazeEnabled (bool value) |
| virtual void | notifyCameraChanged (Ogre::Camera *cam) |
| Handle camera change. | |
Protected Member Functions | |
| virtual void | setFarRadius (Ogre::Real radius) |
| Handle far radius. | |
Detailed Description
A sky dome element.Definition at line 32 of file SkyDome.h.
Constructor & Destructor Documentation
| caelum::SkyDome::SkyDome | ( | Ogre::SceneManager * | sceneMgr, | |
| Ogre::SceneNode * | caelumRootNode | |||
| ) |
Constructor This will setup some nice defaults.
- Parameters:
-
sceneMgr The scene manager where this sky dome will be created.
Definition at line 31 of file SkyDome.cpp.
References caelum::GeometryFactory::generateSphericDome(), and setHazeEnabled().
| caelum::SkyDome::~SkyDome | ( | ) | [virtual] |
Destructor
Definition at line 59 of file SkyDome.cpp.
Member Function Documentation
| void caelum::SkyDome::setSunDirection | ( | Ogre::Vector3 | dir | ) |
Sets the sun direction.
- Parameters:
-
dir The sun light direction.
Definition at line 82 of file SkyDome.cpp.
Referenced by caelum::CaelumSystem::updateSubcomponents().
| void caelum::SkyDome::setLightAbsorption | ( | float | absorption | ) | const |
Sets the new light absorption factor.
- Parameters:
-
absorption The light absorption factor; a number in the range [0, 1], the lower, the less light the atmosphere will absorb.
Definition at line 104 of file SkyDome.cpp.
| void caelum::SkyDome::setLightScattering | ( | float | scattering | ) | const |
Sets the light scattering factor.
- Parameters:
-
scattering The light scattering factor; a number major than zero.
Definition at line 119 of file SkyDome.cpp.
| void caelum::SkyDome::setAtmosphereHeight | ( | float | height | ) | const |
Sets the atmosphere height factor.
- Parameters:
-
height The atmosphere height factor; a number in the range (0, 1].
Definition at line 132 of file SkyDome.cpp.
| void caelum::SkyDome::setHazeEnabled | ( | bool | value | ) |
Enable or disable skydome haze. This makes the sky darker. By default haze is disabled.
Definition at line 177 of file SkyDome.cpp.
Referenced by SkyDome().
The documentation for this class was generated from the following files:
- main/include/SkyDome.h
- main/src/SkyDome.cpp
