Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. More...
#include <OgreStringInterface.h>

Public Member Functions | |
| StringInterface () | |
| virtual | ~StringInterface () |
| Virtual destructor, see Effective C++. | |
| ParamDictionary * | getParamDictionary (void) |
| Retrieves the parameter dictionary for this class. | |
| const ParamDictionary * | getParamDictionary (void) const |
| const ParameterList & | getParameters (void) const |
| Retrieves a list of parameters valid for this object. | |
| virtual bool | setParameter (const String &name, const String &value) |
| Generic parameter setting method. | |
| virtual void | setParameterList (const NameValuePairList ¶mList) |
| Generic multiple parameter setting method. | |
| virtual String | getParameter (const String &name) const |
| Generic parameter retrieval method. | |
| virtual void | copyParametersTo (StringInterface *dest) const |
| Method for copying this object's parameters to another object. | |
Static Public Member Functions | |
| 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. | |
Protected Member Functions | |
| bool | createParamDictionary (const String &className) |
| Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Private Attributes | |
| String | mParamDictName |
| Class name for this instance to be used as a lookup (must be initialised by subclasses) | |
| ParamDictionary * | mParamDict |
Static Private Attributes | |
| static ParamDictionaryMap | msDictionary |
| Dictionary of parameters. | |
Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.
Definition at line 161 of file OgreStringInterface.h.
Definition at line 205 of file OgreStringInterface.h.
| virtual Ogre::StringInterface::~StringInterface | ( | ) | [virtual] |
Virtual destructor, see Effective C++.
Definition at line 208 of file OgreStringInterface.h.
| 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 [virtual] |
Method for copying this object's parameters to another object.
| dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 301 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and setParameter().
| bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected] |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
| className | the name of the class using the dictionary |
Definition at line 184 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
Retrieves the parameter dictionary for this class.
Definition at line 217 of file OgreStringInterface.h.
| const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const |
Definition at line 222 of file OgreStringInterface.h.
| virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual] |
Generic parameter retrieval method.
| name | The name of the parameter to get |
Definition at line 270 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
| const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const |
Retrieves a list of parameters valid for this object.
| virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, |
| const String & | value | ||
| ) | [virtual] |
Generic parameter setting method.
| 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. |
Referenced by copyParametersTo().
| virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual] |
Generic multiple parameter setting method.
| paramList | Name/value pair list |
ParamDictionary* Ogre::StringInterface::mParamDict [private] |
Definition at line 171 of file OgreStringInterface.h.
String Ogre::StringInterface::mParamDictName [private] |
Class name for this instance to be used as a lookup (must be initialised by subclasses)
Definition at line 170 of file OgreStringInterface.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, private] |
Dictionary of parameters.
Definition at line 167 of file OgreStringInterface.h.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:41