Caelum  0.6.4
Classes | Public Member Functions | Protected Member Functions | List of all members
Caelum::SkyDome Class Reference

A sky dome element. More...

#include <SkyDome.h>

Inheritance diagram for Caelum::SkyDome:
[legend]

Public Member Functions

 SkyDome (Ogre::SceneManager *sceneMgr, Ogre::SceneNode *caelumRootNode)
 Constructor This will setup some nice defaults. More...
 
virtual ~SkyDome ()
 Destructor.
 
void setSunDirection (const Ogre::Vector3 &dir)
 Sets the sun direction. More...
 
void setHazeColour (const Ogre::ColourValue &hazeColour)
 Explicit haze colour.
 
void setSkyGradientsImage (const Ogre::String &gradients)
 Set the sky color gradients image.
 
void setAtmosphereDepthImage (const Ogre::String &gradients)
 Set the atmosphere depthh gradient image.
 
void setHazeEnabled (bool value)
 Enable or disable skydome haze. More...
 
bool getHazeEnabled () const
 If skydome haze is enabled.
 
void setQueryFlags (uint flags)
 
uint getQueryFlags () const
 
void setVisibilityFlags (uint flags)
 
uint getVisibilityFlags () const
 
virtual void notifyCameraChanged (Ogre::Camera *cam)
 Handle camera change.
 
- Public Member Functions inherited from Caelum::CameraBoundElement
 CameraBoundElement ()
 Constructor. More...
 
virtual ~CameraBoundElement ()
 Virtual Destructor.
 
void forceFarRadius (Ogre::Real radius)
 Forces the "far" size of the element to a specific radius. More...
 
bool getAutoRadius () const
 Checks if this element is in auto-radius mode. More...
 
void setAutoRadius ()
 Re-enable auto-radius; if disabled. More...
 

Protected Member Functions

virtual void setFarRadius (Ogre::Real radius)
 Handle far radius.
 

Additional Inherited Members

- Static Public Attributes inherited from Caelum::CameraBoundElement
static const Ogre::Real CAMERA_FAR_DISTANCE_MULTIPLIER
 Camera distances multiplier for the far clipping distance. More...
 
static const Ogre::Real CAMERA_NEAR_DISTANCE_MULTIPLIER
 Camera distances multiplier for the near clipping distance. More...
 

Detailed Description

A sky dome element.

Constructor & Destructor Documentation

◆ SkyDome()

Caelum::SkyDome::SkyDome ( Ogre::SceneManager sceneMgr,
Ogre::SceneNode caelumRootNode 
)

Constructor This will setup some nice defaults.

Parameters
sceneMgrThe scene manager where this sky dome will be created.

Member Function Documentation

◆ setSunDirection()

void Caelum::SkyDome::setSunDirection ( const Ogre::Vector3 dir)

Sets the sun direction.

Parameters
dirThe sun light direction.

◆ setHazeEnabled()

void Caelum::SkyDome::setHazeEnabled ( bool  value)

Enable or disable skydome haze.

This makes the sky darker. By default haze is disabled.