OpenPolygon  1.0.0
OpenPolygon is a Rendering Engine
Public Member Functions | Static Public Member Functions | List of all members
Engine::OverlayManager Class Reference

The OverlayManager class. More...

#include <overlaymanager.h>

Public Member Functions

void finish (void)
 
OverlaycreateOverlay (const std::string &overlay_name)
 createOverlay More...
 
OverlaygetOverlay (const std::string &overlay_name) throw ( std::runtime_error)
 getOverlay More...
 
void removeOverlay (const std::string &overlay_name) throw ( std::runtime_error)
 removeOverlay More...
 
void removeOverlay (Overlay *overlay)
 removeOverlay More...
 
Overlays getOverlays (void)
 getOverlays More...
 

Static Public Member Functions

static OverlayManagergetSingletonPtr (void)
 getSingletonPtr More...
 

Detailed Description

The OverlayManager class.

Management of Overlays

Member Function Documentation

Overlay * OverlayManager::createOverlay ( const std::string &  overlay_name)

createOverlay

Create Overlay with name

Parameters
overlay_name
Returns
Overlay * OverlayManager::getOverlay ( const std::string &  overlay_name)
throw (std::runtime_error
)

getOverlay

Return Overlay Object by overlay_name

Parameters
overlay_name
Returns
Overlays OverlayManager::getOverlays ( void  )

getOverlays

Return all Overlays

Returns
OverlayManager * OverlayManager::getSingletonPtr ( void  )
static

getSingletonPtr

Return OverlayManager Singleton Instance

Returns
void Engine::OverlayManager::removeOverlay ( const std::string &  overlay_name)
throw (std::runtime_error
)

removeOverlay

Remove a Overlay Object by Name

Parameters
overlay_name
void OverlayManager::removeOverlay ( Overlay overlay)

removeOverlay

Remove a Overlay Object

Parameters
overlay

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