BlackTopp Studios inc
This is the base class from which all the Entresol and World Managers inherit. More...
#include <managerbase.h>
Inheritance diagram for Mezzanine::ManagerBase: Collaboration diagram for Mezzanine::ManagerBase:Public Types | |
| 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... | |
Public Member Functions | |
| 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... | |
| virtual void | Initialize ()=0 |
| Configures this manager for use prior to entering the main loop. | |
| Boole | IsInitialized () const |
| Gets whether or not this manager has been initialized. More... | |
Static Public Member Functions | |
| 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... | |
Protected Attributes | |
| Boole | Initialized |
| Simple Boole indicating whether or not this manager has been initialized. More... | |
| Entresol * | TheEntresol |
| The actual pointer to the Entresol core class. More... | |
This is the base class from which all the Entresol and World Managers inherit.
This creates a base set of functions that Managers are all expected to implement.
Definition at line 58 of file managerbase.h.
A listing of Manager Types.
These will be returned by ManagerBase::GetType(), and will allow code using this to determine what type of Manager class they are working with and use this information to more safely cast to the correct manager if needed.
| Enumerator | |
|---|---|
| MT_UserCreated |
This, and values above it, is what User created managers that do not derive from any other managers are expected to use to prevent confusion with game internals. |
Definition at line 65 of file managerbase.h.
|
pure virtual |
This Allows any manager name to be sent to a stream. Primarily used for logging.
Implemented in Mezzanine::Physics::PhysicsManager, Mezzanine::UI::UIManager, Mezzanine::EventManager, Mezzanine::Graphics::SceneManager, Mezzanine::Scripting::Lua::Lua51ScriptingEngine, Mezzanine::Graphics::GraphicsManager, Mezzanine::AreaEffectManager, Mezzanine::Physics::CollisionShapeManager, Mezzanine::DebrisManager, Mezzanine::Resource::ResourceManager, Mezzanine::Input::InputManager, Mezzanine::ActorManager, Mezzanine::Graphics::TextureManager, Mezzanine::Graphics::MeshManager, Mezzanine::TerrainManager, Mezzanine::Scripting::iScriptingManager, and Mezzanine::Network::NetworkManager.
|
pure virtual |
This returns the type of this manager.
This is intended to make using and casting from Manager base easier. With this is is possible to cast from ManagerBase to the correct Manager Type.
Implemented in Mezzanine::Physics::PhysicsManager, Mezzanine::Audio::AudioManager, Mezzanine::UI::UIManager, Mezzanine::EventManager, Mezzanine::Graphics::SceneManager, Mezzanine::Audio::SoundScapeManager, Mezzanine::Graphics::GraphicsManager, Mezzanine::AreaEffectManager, Mezzanine::Physics::CollisionShapeManager, Mezzanine::DebrisManager, Mezzanine::Resource::ResourceManager, Mezzanine::Input::InputManager, Mezzanine::ActorManager, Mezzanine::Graphics::TextureManager, Mezzanine::Graphics::MeshManager, Mezzanine::TerrainManager, Mezzanine::Scripting::iScriptingManager, and Mezzanine::Network::NetworkManager.
|
virtual |
Gets a string of the interface type of this manager.
Definition at line 71 of file managerbase.cpp.
|
static |
Gets the string form of the type of manager.
Definition at line 76 of file managerbase.cpp.
|
static |
Gets the type of manager requested from a string.
Definition at line 161 of file managerbase.cpp.
| Boole Mezzanine::ManagerBase::IsInitialized | ( | ) | const |
Gets whether or not this manager has been initialized.
Definition at line 65 of file managerbase.cpp.
|
protected |
Simple Boole indicating whether or not this manager has been initialized.
Definition at line 111 of file managerbase.h.
|
protected |
The actual pointer to the Entresol core class.
Definition at line 108 of file managerbase.h.
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
