Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

mortic::ISceneManager Class Reference

The Scene Manager. More...

Inheritance diagram for mortic::ISceneManager:

mortic::IObject List of all members.

Public Member Functions

 ISceneManager (IRoot *root)
 Constructor.
virtual ~ISceneManager ()
 Destructor.
virtual void addScene (IScene *scene)=0
 Add a scene.
virtual bool loadScene (std::string filename)=0
 Load a Scene.
virtual void startScene (std::string name)=0
 Start a Scene by Name.
virtual void startScene (IScene *scene)=0
 Start a Scene by Pointer.
virtual void endScene (std::string name)=0
 End a Scene by Name.
virtual void endScene (IScene *scene)=0
 End a Scene by Pointer.
virtual void endAllScenes ()=0
 End all running scenes.
virtual void run ()=0
 Run every scene.
virtual void event (IEvent *e)=0
 Dispatch an Event.

Detailed Description

The Scene Manager.

The Scene Manager, well, manages Scenes. For more info on scenes, see IScene. This is the class that you use to register and control the scenes you write. This is also where you close the program, by starting scene "SceneEnd".

Definition at line 34 of file ISceneManager.h.


Constructor & Destructor Documentation

mortic::ISceneManager::ISceneManager IRoot root  )  [inline]
 

Constructor.

Definition at line 38 of file ISceneManager.h.

virtual mortic::ISceneManager::~ISceneManager  )  [inline, virtual]
 

Destructor.

Definition at line 41 of file ISceneManager.h.


Member Function Documentation

virtual void mortic::ISceneManager::addScene IScene scene  )  [pure virtual]
 

Add a scene.

A scene must be added before it can be controlled. This makes the manager aware of your scene.

  • scene - the scene to add

virtual void mortic::ISceneManager::endAllScenes  )  [pure virtual]
 

End all running scenes.

This function will end all of the scenes that are running. Useful at shutdown.

virtual void mortic::ISceneManager::endScene IScene scene  )  [pure virtual]
 

End a Scene by Pointer.

This function ends the scene given.

  • scene - the scene to end.

virtual void mortic::ISceneManager::endScene std::string  name  )  [pure virtual]
 

End a Scene by Name.

This function ends the scene with the given name.

  • name - the name of the scene to end

virtual void mortic::ISceneManager::event IEvent e  )  [pure virtual]
 

Dispatch an Event.

This calls on all scenes to handle the event given. Never call this directly, but use the appropriate method of IEventManager. Note: this dispatches an event to all scenes, not just the running ones. This lets a scene start itself when the time is right.

  • e - the event to handle

virtual bool mortic::ISceneManager::loadScene std::string  filename  )  [pure virtual]
 

Load a Scene.

This loads a scene from an XML file. Due to current restrictions in the engine, this function does nothing.

virtual void mortic::ISceneManager::run  )  [pure virtual]
 

Run every scene.

This calls IScene::run() on every scene that is started. This should only be used internally, where it is called every frame.

virtual void mortic::ISceneManager::startScene IScene scene  )  [pure virtual]
 

Start a Scene by Pointer.

This function starts the scene given. If the scene is not added yet, it will be added for you.

  • scene - pointer to the scene to start

virtual void mortic::ISceneManager::startScene std::string  name  )  [pure virtual]
 

Start a Scene by Name.

This function starts a loaded scene by name. The name used is the name of the object.

  • name - the name of the scene to load


Generated on Sat Dec 30 21:21:59 2006 for mortic by  doxygen 1.4.4