VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Types | Protected Attributes
makVrv::DtEffectManager Class Reference

The effect manager provides a way of creating and sharing effects. More...

List of all members.

Public Member Functions

 DtEffectManager ()
 CTOR.
 ~DtEffectManager ()
 DTOR.
void releaseResources ()
 Release all resources.
DtEffectcreateEffect (const std::string &effectName, DtEffectCreator::CreateParameters *params=0) const
 Attempts to create a new effect using the given effect name.
DtEffectfindSharedEffect (const std::string &effectName, DtEffectCreator::CreateParameters *params=0)
 Attempts to find a shared effect, if the shared effect is not yet created, it will attempt to create the effect.
void registerEffectCreator (const std::string &effectName, DtEffectCreator *creator)
 Register an effect creator.

Protected Types

typedef boost::unordered_map
< std::string, DtEffectCreator * > 
CreatorMap
typedef boost::unordered_map
< std::string, DtEffect * > 
EffectMap

Protected Attributes

CreatorMap myEffectCreators
EffectMap mySharedEffects

Detailed Description

The effect manager provides a way of creating and sharing effects.


Member Typedef Documentation

typedef boost::unordered_map<std::string,DtEffectCreator*> makVrv::DtEffectManager::CreatorMap [protected]
typedef boost::unordered_map<std::string,DtEffect*> makVrv::DtEffectManager::EffectMap [protected]

Constructor & Destructor Documentation

CTOR.

DTOR.


Member Function Documentation

Release all resources.

DtEffect* makVrv::DtEffectManager::createEffect ( const std::string &  effectName,
DtEffectCreator::CreateParameters params = 0 
) const

Attempts to create a new effect using the given effect name.

The effect object is not shared, and must be deallocated by the owner.

Returns:
NULL if no effect creator for the given effect name is registered.
DtEffect* makVrv::DtEffectManager::findSharedEffect ( const std::string &  effectName,
DtEffectCreator::CreateParameters params = 0 
)

Attempts to find a shared effect, if the shared effect is not yet created, it will attempt to create the effect.

The returned effect is shared and should not be deallocated.

Returns:
NULL if no effect creator for the given effect name is registered.
void makVrv::DtEffectManager::registerEffectCreator ( const std::string &  effectName,
DtEffectCreator creator 
)

Register an effect creator.

If an effect creator was previously registered with the same name, it is first deleted.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)