Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
More...
#include <OgreStringInterface.h>
|
static void | cleanupDictionary () |
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
|
|
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
Definition at line 163 of file OgreStringInterface.h.
Ogre::StringInterface::StringInterface |
( |
| ) |
|
|
inline |
virtual Ogre::StringInterface::~StringInterface |
( |
| ) |
|
|
inlinevirtual |
static void Ogre::StringInterface::cleanupDictionary |
( |
| ) |
|
|
static |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
virtual void Ogre::StringInterface::copyParametersTo |
( |
StringInterface * |
dest | ) |
const |
|
inlinevirtual |
bool Ogre::StringInterface::createParamDictionary |
( |
const String & |
className | ) |
|
|
inlineprotected |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
- Parameters
-
className | the name of the class using the dictionary |
- Returns
- true if a new dictionary was created, false if it was already there
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
Retrieves the parameter dictionary for this class.
- Returns
- Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.
Definition at line 219 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary |
( |
void |
| ) |
const |
|
inline |
virtual String Ogre::StringInterface::getParameter |
( |
const String & |
name | ) |
const |
|
inlinevirtual |
const ParameterList& Ogre::StringInterface::getParameters |
( |
void |
| ) |
const |
Retrieves a list of parameters valid for this object.
- Returns
- A reference to a static list of ParameterDef objects.
Ogre::StringInterface::OGRE_STATIC_MUTEX |
( |
msDictionaryMutex |
| ) |
|
|
private |
virtual bool Ogre::StringInterface::setParameter |
( |
const String & |
name, |
|
|
const String & |
value |
|
) |
| |
|
virtual |
Generic parameter setting method.
- Parameters
-
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
- Returns
- true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)
Referenced by copyParametersTo().
virtual void Ogre::StringInterface::setParameterList |
( |
const NameValuePairList & |
paramList | ) |
|
|
virtual |
Generic multiple parameter setting method.
- Parameters
-
paramList | Name/value pair list |
String Ogre::StringInterface::mParamDictName |
|
private |
Class name for this instance to be used as a lookup (must be initialised by subclasses)
Definition at line 172 of file OgreStringInterface.h.
The documentation for this class was generated from the following file: