ExampleApplication Class Reference

#include <ExampleApplication.h>

Inheritance diagram for ExampleApplication:

GuiApplication List of all members.

Public Member Functions

 ExampleApplication ()
 Standard constructor.
virtual ~ExampleApplication ()
 Standard destructor.
virtual void go (void)
 Start the example.

Protected Member Functions

virtual bool setup (void)
virtual bool configure (void)
virtual void chooseSceneManager (void)
virtual void createCamera (void)
virtual void createFrameListener (void)
virtual void createScene (void)=0
virtual void destroyScene (void)
virtual void createViewports (void)
virtual void setupResources (void)
 Method which will define the source of resources (other than current folder).
virtual void createResourceListener (void)
 Optional override method where you can create resource listeners (e.g. for loading screens).
virtual void loadResources (void)

Protected Attributes

Root * mRoot
Camera * mCamera
SceneManager * mSceneMgr
ExampleFrameListener * mFrameListener
RenderWindow * mWindow

Detailed Description

Base class which manages the standard startup of an Ogre application. Designed to be subclassed for specific examples if required.


Constructor & Destructor Documentation

ExampleApplication::ExampleApplication (   )  [inline]
 

Standard constructor.

virtual ExampleApplication::~ExampleApplication (   )  [inline, virtual]
 

Standard destructor.


Member Function Documentation

virtual void ExampleApplication::chooseSceneManager (  void   )  [inline, protected, virtual]
 

virtual bool ExampleApplication::configure (  void   )  [inline, protected, virtual]
 

Configures the application - returns false if the user chooses to abandon configuration.

virtual void ExampleApplication::createCamera (  void   )  [inline, protected, virtual]
 

virtual void ExampleApplication::createFrameListener (  void   )  [inline, protected, virtual]
 

Reimplemented in GuiApplication.

virtual void ExampleApplication::createResourceListener (  void   )  [inline, protected, virtual]
 

Optional override method where you can create resource listeners (e.g. for loading screens).

virtual void ExampleApplication::createScene (  void   )  [protected, pure virtual]
 

Implemented in GuiApplication.

virtual void ExampleApplication::createViewports (  void   )  [inline, protected, virtual]
 

virtual void ExampleApplication::destroyScene (  void   )  [inline, protected, virtual]
 

virtual void ExampleApplication::go (  void   )  [inline, virtual]
 

Start the example.

virtual void ExampleApplication::loadResources (  void   )  [inline, protected, virtual]
 

Optional override method where you can perform resource group loading Must at least do ResourceGroupManager::getSingleton().initialiseAllResourceGroups();

virtual bool ExampleApplication::setup (  void   )  [inline, protected, virtual]
 

Sets up the application - returns false if the user chooses to abandon configuration.

virtual void ExampleApplication::setupResources (  void   )  [inline, protected, virtual]
 

Method which will define the source of resources (other than current folder).


Member Data Documentation

Camera* ExampleApplication::mCamera [protected]
 

ExampleFrameListener* ExampleApplication::mFrameListener [protected]
 

Root* ExampleApplication::mRoot [protected]
 

SceneManager* ExampleApplication::mSceneMgr [protected]
 

RenderWindow* ExampleApplication::mWindow [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon May 29 01:10:34 2006 for Papagan by  doxygen 1.4.6-NO