Mezzanine::WorldManager Class Reference

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 ()
	Class constructor.
virtual	~WorldManager ()
	Class destructor.
virtual void	_SetWorld (World *Parent)
	Sets the world this manager belongs to. Exceptions If this manager is already initialized, this method will throw an "INVALID_STATE_EXCEPTION". More...
virtual World *	GetWorld () 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 bool	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...
bool	IsInitialized () const
	Gets whether or not this manager has been initialized. More...

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

Additional Inherited Members
Public Types inherited from Mezzanine::ManagerBase
enum	ManagerType {   MT_AudioManager = 1, MT_AnimationManager, MT_CollisionShapeManager, MT_CompositorManager,   MT_GraphicsManager, MT_EventManager, MT_InputManager, MT_LogManager,   MT_MaterialManager, MT_MeshManager, MT_NetworkManager, MT_ResourceManager,   MT_ScriptingManager, MT_UIManager, MT_ActorManager = 100, MT_AreaEffectManager,   MT_CameraManager, MT_DebrisManager, MT_PagingManager, MT_PhysicsManager,   MT_SceneManager, MT_SoundScapeManager, MT_TerrainManager, MT_VehicleManager,   MT_UserCreated = 512 }
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.

Member Function Documentation

void Mezzanine::WorldManager::_SetWorld ( World *  Parent)

virtual

Sets the world this manager belongs to.

Exceptions

If	this manager is already initialized, this method will throw an "INVALID_STATE_EXCEPTION".

Note

When hooking up to other subsystems this will be the world used to retrieve the other managers for those systems.

Parameters

Parent

The world that this manager will belong to.

Definition at line 80 of file worldmanager.cpp.

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

If	this 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, Mezzanine::Graphics::CameraManager, and Mezzanine::TerrainManager.

Definition at line 70 of file worldmanager.cpp.

bool 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

PL	A 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, Mezzanine::Graphics::CameraManager, and Mezzanine::TerrainManager.

Member Data Documentation

bool 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:

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/worldmanager.h
• /home/sqeaky/Code/Mezzanine/Mezzanine/src/worldmanager.cpp