SO3::SSkyLight Class Reference

#include <SO3SkyLight.h>

Inheritance diagram for SO3::SSkyLight:

Public Member Functions
	SSkyLight (SEnvironment *parent, const std::string &skyLightName, const Ogre::ColourValue &defaultBaseColour)
virtual	~SSkyLight ()
SEnvironment *	GetEnvironment ()
void	Update ()
const Ogre::Vector3	GetLightDirection () const
void	SetLightDirection (const Ogre::Vector3 &direction)
const Ogre::ColourValue	GetLightColour (const float &level=1.0f) const
void	SetLightColour (const Ogre::ColourValue &newColour)
bool	GetEnable ()
void	SetEnable (const bool &enable)
bool	GetCastShadowEnable ()
void	SetCastShadowEnable (const bool &enable)
void	UpdateShadowFarDistance (const float &distance)
void	UpdateShadowFarClipDistance (const float &distance)
Ogre::Light *	GetOgreLight ()
Public Member Functions inherited from SO3::SData
	SData (const std::string &dataName)
virtual	~SData ()
std::string	GetName () const
SUserObjectBindings &	GetUserObjectBindings ()
const SUserObjectBindings &	GetUserObjectBindings () const

Protected Member Functions
virtual const Ogre::Vector3	ComputeDirectionImpl (const double &julianDay)=0
const Ogre::Vector3	MakeDirection (const Ogre::Degree &azimuth, const Ogre::Degree &altitude)

Protected Attributes
SEnvironment *	parentEnvironment
Ogre::SceneManager *	ogreSceneManager
Ogre::Light *	ogreSkyLight
Ogre::SceneNode *	ogreSkyLightSceneNode
double	lastJulDay
Ogre::Degree	lastLatitude
Ogre::Degree	lastLongitude
Ogre::ColourValue	baseColour
SColourGradient	lightColourGradient
bool	forceUpdate
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Definition at line 41 of file SO3SkyLight.h.

Constructor & Destructor Documentation

SSkyLight()

SO3::SSkyLight::SSkyLight	(	SEnvironment *	parent,
		const std::string &	skyLightName,
		const Ogre::ColourValue &	defaultBaseColour
	)

Definition at line 39 of file SO3SkyLight.cpp.

~SSkyLight()

SO3::SSkyLight::~SSkyLight ( )

virtual

Destructor

Definition at line 74 of file SO3SkyLight.cpp.

Member Function Documentation

ComputeDirectionImpl()

virtual const Ogre::Vector3 SO3::SSkyLight::ComputeDirectionImpl ( const double &  julianDay )

protectedpure virtual

Implemented in SO3::SMoon, and SO3::SSun.

GetCastShadowEnable()

bool SO3::SSkyLight::GetCastShadowEnable

(

)

Is the light cast shadow is enable or disable.

Definition at line 223 of file SO3SkyLight.cpp.

GetEnable()

bool SO3::SSkyLight::GetEnable

(

)

Is the light is enable or disable.

Definition at line 96 of file SO3SkyLight.cpp.

GetEnvironment()

SEnvironment * SO3::SSkyLight::GetEnvironment

(

)

Definition at line 114 of file SO3SkyLight.cpp.

GetLightColour()

const Ogre::ColourValue SO3::SSkyLight::GetLightColour

(

const float &

level = 1.0f

)

const

Definition at line 187 of file SO3SkyLight.cpp.

GetLightDirection()

const Ogre::Vector3 SO3::SSkyLight::GetLightDirection

(

)

const

Definition at line 173 of file SO3SkyLight.cpp.

GetOgreLight()

Ogre::Light * SO3::SSkyLight::GetOgreLight

(

)

Definition at line 244 of file SO3SkyLight.cpp.

MakeDirection()

const Ogre::Vector3 SO3::SSkyLight::MakeDirection ( const Ogre::Degree &  azimuth, const Ogre::Degree &  altitude  )

protected

Definition at line 202 of file SO3SkyLight.cpp.

SetCastShadowEnable()

void SO3::SSkyLight::SetCastShadowEnable

(

const bool &

enable

)

Enable/disable light cast shadow.

Definition at line 228 of file SO3SkyLight.cpp.

SetEnable()

void SO3::SSkyLight::SetEnable

(

const bool &

enable

)

Enable/disable light.

Definition at line 104 of file SO3SkyLight.cpp.

SetLightColour()

void SO3::SSkyLight::SetLightColour

(

const Ogre::ColourValue &

newColour

)

Definition at line 195 of file SO3SkyLight.cpp.

SetLightDirection()

void SO3::SSkyLight::SetLightDirection

(

const Ogre::Vector3 &

direction

)

Definition at line 181 of file SO3SkyLight.cpp.

Update()

void SO3::SSkyLight::Update

(

)

Definition at line 119 of file SO3SkyLight.cpp.

UpdateShadowFarClipDistance()

void SO3::SSkyLight::UpdateShadowFarClipDistance

(

const float &

distance

)

Definition at line 238 of file SO3SkyLight.cpp.

UpdateShadowFarDistance()

void SO3::SSkyLight::UpdateShadowFarDistance

(

const float &

distance

)

Definition at line 233 of file SO3SkyLight.cpp.

Member Data Documentation

baseColour

Ogre::ColourValue SO3::SSkyLight::baseColour

protected

Definition at line 52 of file SO3SkyLight.h.

forceUpdate

bool SO3::SSkyLight::forceUpdate

protected

Definition at line 54 of file SO3SkyLight.h.

lastJulDay

double SO3::SSkyLight::lastJulDay

protected

Definition at line 49 of file SO3SkyLight.h.

lastLatitude

Ogre::Degree SO3::SSkyLight::lastLatitude

protected

Definition at line 50 of file SO3SkyLight.h.

lastLongitude

Ogre::Degree SO3::SSkyLight::lastLongitude

protected

Definition at line 51 of file SO3SkyLight.h.

lightColourGradient

SColourGradient SO3::SSkyLight::lightColourGradient

protected

Definition at line 53 of file SO3SkyLight.h.

ogreSceneManager

Ogre::SceneManager* SO3::SSkyLight::ogreSceneManager

protected

Definition at line 46 of file SO3SkyLight.h.

ogreSkyLight

Ogre::Light* SO3::SSkyLight::ogreSkyLight

protected

Definition at line 47 of file SO3SkyLight.h.

ogreSkyLightSceneNode

Ogre::SceneNode* SO3::SSkyLight::ogreSkyLightSceneNode

protected

Definition at line 48 of file SO3SkyLight.h.

parentEnvironment

SEnvironment* SO3::SSkyLight::parentEnvironment

protected

Definition at line 45 of file SO3SkyLight.h.

---

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

• include/SO3SceneGraph/SO3SkyLight.h
• src/SO3SceneGraph/SO3SkyLight.cpp