Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::StringInterface Class Reference

Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers. More...

#include <OgreStringInterface.h>

Inheritance diagram for Ogre::StringInterface:

Ogre::ExternalTextureSource Ogre::OverlayElement Ogre::ParticleAffector Ogre::ParticleEmitter Ogre::ParticleSystem Ogre::ParticleSystemRenderer Ogre::Resource Ogre::OverlayContainer Ogre::TextAreaOverlayElement Ogre::ColourFaderAffector Ogre::ColourFaderAffector2 Ogre::ColourImageAffector Ogre::ColourInterpolatorAffector Ogre::LinearForceAffector Ogre::RotationAffector Ogre::ScaleAffector Ogre::AreaEmitter Ogre::PointEmitter Ogre::BillboardParticleRenderer Ogre::BspLevel Ogre::Font Ogre::GpuProgram Ogre::Material Ogre::Mesh Ogre::Skeleton Ogre::Texture List of all members.

Public Member Functions

virtual ~StringInterface ()
 Virtual desctructor, 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 &paramList)
 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

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.


Protected Attributes

String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses).


Static Protected Attributes

ParamDictionaryMap msDictionary
 Dictionary of parameters.

Detailed Description

Class defining the common interface which classes can use to present a reflection-style, self-defining parameter set to callers.

Remarks:
This class also holds a static map of class name to parameter dictionaries for each subclass to use. See ParamDictionary for details.

In order to use this class, each subclass must call createParamDictionary in their constructors which will create a parameter dictionary for the class if it does not exist yet.

Definition at line 152 of file OgreStringInterface.h.

Constructor & Destructor Documentation

virtual Ogre::StringInterface::~StringInterface (   )  [virtual]
 

Virtual desctructor, see Effective C++.

Definition at line 187 of file OgreStringInterface.h.

Member Function Documentation

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.

Remarks:
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters:
dest Pointer to object to have it's parameters set the same as this object.

Definition at line 296 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.

Remarks:
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
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 172 of file OgreStringInterface.h.

References Ogre::String.

const ParamDictionary* Ogre::StringInterface::getParamDictionary (  void   )  const
 

Definition at line 209 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary (  void   ) 
 

Retrieves the parameter dictionary for this class.

Remarks:
Only valid to call this after createParamDictionary.
Returns:
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 196 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter (  const String &  name  )  const [virtual]
 

Generic parameter retrieval method.

Remarks:
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters:
name The name of the parameter to get
Returns:
String value of parameter, blank if not found

Definition at line 265 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::String.

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.

virtual bool Ogre::StringInterface::setParameter (  const String &  name,
const String &  value
)  [virtual]
 

Generic parameter setting method.

Remarks:
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
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.

Remarks:
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters:
paramList Name/value pair list

Member Data Documentation

String Ogre::StringInterface::mParamDictName [protected]
 

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Definition at line 160 of file OgreStringInterface.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected]
 

Dictionary of parameters.

Definition at line 157 of file OgreStringInterface.h.

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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:04:10 2006