SkyX::Controller Class Reference

Controller base class. More...

#include <Controller.h>

Public Member Functions
	Controller (const bool &deleteBySkyX)
	Constructor. More...
virtual	~Controller ()
	Destructor. More...
const bool &	getDeleteBySkyX () const
	Must the controller be destroyed by SkyX? More...
virtual Ogre::Vector3	getMoonDirection ()=0
	Get moon direction. More...
virtual Ogre::Real	getMoonPhase ()=0
	Get moon phase. More...
virtual Ogre::Vector3	getSunDirection ()=0
	Get sun direction. More...
virtual void	update (const Ogre::Real &)
	Update controller. More...

Detailed Description

Controller base class.

Constructor & Destructor Documentation

SkyX::Controller::Controller ( const bool &  deleteBySkyX )

inlineexplicit

Constructor.

Parameters

deleteBySkyX

true to automatically destroy the controller by SkyX, false otherwise

virtual SkyX::Controller::~Controller ( )

inlinevirtual

Destructor.

Member Function Documentation

const bool& SkyX::Controller::getDeleteBySkyX ( ) const

inline

Must the controller be destroyed by SkyX?

Returns

true if yes, false if not

Referenced by SkyX::setController().

virtual Ogre::Vector3 SkyX::Controller::getMoonDirection ( )

pure virtual

Get moon direction.

Returns

Moon direction, Earth-to-Moon direction

virtual Ogre::Real SkyX::Controller::getMoonPhase ( )

pure virtual

Get moon phase.

Returns

Moon phase in [-1,1] range, where -1 means fully covered Moon, 0 clear Moon and 1 fully covered Moon

virtual Ogre::Vector3 SkyX::Controller::getSunDirection ( )

pure virtual

Get sun direction.

Returns

Sun direction, the Earth-to-Sun direction

virtual void SkyX::Controller::update ( const Ogre::Real &  )

inlinevirtual

Update controller.

Parameters

simDeltaTime

Simulation delta time (It's not the time since last frame, it's the delta simulation time, one time the time since last frame has been multiplied by the time multiplier)

---

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

• Controller.h