Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Attributes | List of all members
Mezzanine::WorldManager Class Referenceabstract

This is the base class for all managers that belong to a single world instance. More...

#include <worldmanager.h>

+ Inheritance diagram for Mezzanine::WorldManager:
+ Collaboration diagram for Mezzanine::WorldManager:

Public Member Functions

 WorldManager (World *Creator)
 Class constructor. More...
 
virtual ~WorldManager ()
 Class destructor.
 
virtual WorldGetWorld () const
 Gets the world this manager belongs to. More...
 
virtual void Initialize ()
 Configures this manager for use prior to entering the main loop. More...
 
virtual Boole IsPaused () const
 Gets whether or not this manager is currently paused. More...
 
virtual void Pause (const UInt32 PL)=0
 Sets the pause state of this manager, or has no effect depending on the value passed in. More...
 
- Public Member Functions inherited from Mezzanine::ManagerBase
 ManagerBase ()
 Class constructor.
 
virtual ~ManagerBase ()
 Class destructor.
 
virtual void Deinitialize ()=0
 Removes this manager from any necessary configuration so it can be safely disposed of.
 
virtual String GetImplementationTypeName () const =0
 This Allows any manager name to be sent to a stream. Primarily used for logging. More...
 
virtual ManagerType GetInterfaceType () const =0
 This returns the type of this manager. More...
 
virtual String GetInterfaceTypeAsString () const
 Gets a string of the interface type of this manager. More...
 
Boole IsInitialized () const
 Gets whether or not this manager has been initialized. More...
 

Protected Attributes

Boole OperationsPaused
 This stores whether or not processing for some or all objects in this manager has been paused. More...
 
WorldParentWorld
 A pointer to the world that created this manager. More...
 
- Protected Attributes inherited from Mezzanine::ManagerBase
Boole Initialized
 Simple Boole indicating whether or not this manager has been initialized. More...
 
EntresolTheEntresol
 The actual pointer to the Entresol core class. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::ManagerBase
enum  ManagerType {
  MT_Undefined = 0, MT_AudioManager = 1, MT_AnimationManager = 2, MT_CollisionShapeManager = 3,
  MT_CompositorManager = 4, MT_GraphicsManager = 5, MT_EventManager = 6, MT_InputManager = 7,
  MT_LogManager = 8, MT_MaterialManager = 9, MT_MeshManager = 10, MT_NetworkManager = 11,
  MT_ResourceManager = 12, MT_ScriptingManager = 13, MT_TextureManager = 14, MT_UIManager = 15,
  MT_ActorManager = 101, MT_AreaEffectManager = 102, MT_DebrisManager = 103, MT_PagingManager = 104,
  MT_PhysicsManager = 105, MT_SceneManager = 106, MT_SoundScapeManager = 107, MT_TerrainManager = 108,
  MT_VehicleManager = 109, MT_UserCreated = 512
}
 A listing of Manager Types. More...
 
- Static Public Member Functions inherited from Mezzanine::ManagerBase
static String GetTypeAsString (const ManagerType &ManagerType)
 Gets the string form of the type of manager. More...
 
static ManagerType GetTypeFromString (const String &ManagerName)
 Gets the type of manager requested from a string. More...
 

Detailed Description

This is the base class for all managers that belong to a single world instance.

Definition at line 55 of file worldmanager.h.

Constructor & Destructor Documentation

Mezzanine::WorldManager::WorldManager ( World Creator)

Class constructor.

Parameters
CreatorThe parent world that is creating the manager.

Definition at line 50 of file worldmanager.cpp.

Member Function Documentation

World * Mezzanine::WorldManager::GetWorld ( ) const
virtual

Gets the world this manager belongs to.

Returns
Returns a pointer to the world that created this manager.

Definition at line 61 of file worldmanager.cpp.

void Mezzanine::WorldManager::Initialize ( )
virtual

Configures this manager for use prior to entering the main loop.

Exceptions
Ifthis is called while no valid world is set, this will throw an "INVALID_STATE_EXCEPTION".

Implements Mezzanine::ManagerBase.

Reimplemented in Mezzanine::Physics::PhysicsManager, Mezzanine::Graphics::SceneManager, Mezzanine::Audio::SoundScapeManager, Mezzanine::AreaEffectManager, Mezzanine::DebrisManager, Mezzanine::ActorManager, and Mezzanine::TerrainManager.

Definition at line 70 of file worldmanager.cpp.

Boole Mezzanine::WorldManager::IsPaused ( ) const
virtual

Gets whether or not this manager is currently paused.

Returns
Returns true if this manager has some or all of it's operations paused currently.

Definition at line 64 of file worldmanager.cpp.

virtual void Mezzanine::WorldManager::Pause ( const UInt32  PL)
pure virtual

Sets the pause state of this manager, or has no effect depending on the value passed in.

Parameters
PLA bitfield describing the pause level being assigned to the parent world of this manager.

Implemented in Mezzanine::Physics::PhysicsManager, Mezzanine::Graphics::SceneManager, Mezzanine::Audio::SoundScapeManager, Mezzanine::AreaEffectManager, Mezzanine::DebrisManager, Mezzanine::ActorManager, and Mezzanine::TerrainManager.

Member Data Documentation

Boole Mezzanine::WorldManager::OperationsPaused
protected

This stores whether or not processing for some or all objects in this manager has been paused.

Definition at line 63 of file worldmanager.h.

World* Mezzanine::WorldManager::ParentWorld
protected

A pointer to the world that created this manager.

Definition at line 60 of file worldmanager.h.


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