ASR::Game Class Reference

#include <Game.h>

Collaboration diagram for ASR::Game:

[legend]List of all members.

Public Member Functions
	Game (SceneManager *sceneMgr, RenderWindow *win)
	~Game ()
SceneManager *	getSceneManager () const
	Grab the SceneManager.
Level *	createLevel ()
	Start up a new level.
Level *	getLevel () const
	Retrieves the current level.
void	destroyLevel ()
	Destroys the current level.
void	addUpdater (Updater *updater)
	Registers a new Updater with the system.
Static Public Member Functions
static Game &	getSingleton (void)
	Override standard Singleton retrieval.
static Game *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Private Attributes
Level *	mLevel
GameListener *	mListener
SceneManager *	mSceneMgr
RenderWindow *	mWindow

---

Detailed Description

Definition at line 20 of file Game.h.

---

Constructor & Destructor Documentation

ASR::Game::Game	(	SceneManager *	sceneMgr,
		RenderWindow *	win
	)

Definition at line 20 of file Game.cpp.

References mLevel, and mListener.

                : mSceneMgr ( sceneMgr ), mWindow ( win )
        {
                mLevel = NULL;
                mListener = NULL;
        }

ASR::Game::~Game

(

)

Definition at line 29 of file Game.cpp.

References destroyLevel().

        {
                destroyLevel ();
        }

---

Member Function Documentation

void ASR::Game::addUpdater

(

Updater *

updater

)

Registers a new Updater with the system.

Updaters are called in the order they are added

Definition at line 96 of file Game.cpp.

References ASR::GameListener::addUpdater(), and mListener.

Referenced by ASR::Client::createCamera(), ASR::Client::createTeam(), and ASR::Team::Team().

        {
                OgreAssert ( mListener != NULL, "Listener has not been created - Game::addUpdater" );
                mListener->addUpdater ( updater );
        }

Level * ASR::Game::createLevel

(

)

Start up a new level.

Definition at line 47 of file Game.cpp.

References mLevel, mListener, and mWindow.

Referenced by TutorialApplication::chooseSceneManager().

        {
                if ( mLevel != NULL )
                        throw Exception ( Exception::ERR_DUPLICATE_ITEM, "Level already created", "Game::createLevel" );

                if ( mListener != NULL )
                        throw Exception ( Exception::ERR_DUPLICATE_ITEM, "There is already an existing Listener", "Game::createLevel" );

                mListener = new GameListener ( mWindow );
                Ogre::Root::getSingleton().addFrameListener( mListener );

                mLevel = new Level ();
                return mLevel;
        }

void ASR::Game::destroyLevel

(

)

Destroys the current level.

Definition at line 81 of file Game.cpp.

References mLevel, and mListener.

Referenced by ~Game().

        {
                if ( mLevel == NULL )
                        throw Exception ( Exception::ERR_ITEM_NOT_FOUND, "Level does not exist", "Game::getLevel" );

                Ogre::Root::getSingleton().removeFrameListener ( mListener );
                delete mListener;
                mListener = NULL;

                delete mLevel;
                mLevel = NULL;
        }

Level * ASR::Game::getLevel

(

)

const

Retrieves the current level.

Definition at line 71 of file Game.cpp.

References mLevel.

        {
                if ( mLevel == NULL )
                        throw Exception ( Exception::ERR_ITEM_NOT_FOUND, "Level does not exist", "Game::getLevel" );

                return mLevel;
        }

SceneManager * ASR::Game::getSceneManager

(

)

const

Grab the SceneManager.

Definition at line 64 of file Game.cpp.

References mSceneMgr.

Referenced by ASR::Projectile::_destroyEntity(), ASR::Projectile::_generateEntity(), ASR::UnitSelecter::_selectUnits(), ASR::Building::Building(), ASR::TeamBuildings::TeamBuildings(), ASR::TeamUnits::TeamUnits(), ASR::UnitSelecter::UnitSelecter(), ASR::TeamUnits::~TeamUnits(), and ASR::UnitSelecter::~UnitSelecter().

        {
                return mSceneMgr;
        }

Game & ASR::Game::getSingleton

(

void

)

[static]

Override standard Singleton retrieval.

Remarks:

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Definition at line 40 of file Game.cpp.

Referenced by ASR::Client::_createGUI(), ASR::Projectile::_destroyEntity(), ASR::Projectile::_generateEntity(), ASR::Client::createCamera(), ASR::Client::createTeam(), ASR::Team::Team(), and ASR::UnitSelecter::UnitSelecter().

        {
                assert( ms_Singleton );  return ( *ms_Singleton );
        }

Game * ASR::Game::getSingletonPtr

(

void

)

[static]

Override standard Singleton retrieval.

Remarks:

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Definition at line 36 of file Game.cpp.

Referenced by ASR::UnitSelecter::_selectUnits(), ASR::Building::Building(), ASR::TeamBuildings::TeamBuildings(), ASR::TeamUnits::TeamUnits(), ASR::TeamUnits::~TeamUnits(), and ASR::UnitSelecter::~UnitSelecter().

        {
                return ms_Singleton;
        }

---

Member Data Documentation

Level* ASR::Game::mLevel [private]

Definition at line 25 of file Game.h.

Referenced by createLevel(), destroyLevel(), Game(), and getLevel().

GameListener* ASR::Game::mListener [private]

Definition at line 26 of file Game.h.

Referenced by addUpdater(), createLevel(), destroyLevel(), and Game().

SceneManager* ASR::Game::mSceneMgr [private]

Definition at line 28 of file Game.h.

Referenced by getSceneManager().

RenderWindow* ASR::Game::mWindow [private]

Definition at line 29 of file Game.h.

Referenced by createLevel().

---

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

• D:/simple_rts/include/Game.h
• D:/simple_rts/src/Game.cpp

---