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

Ogre::ParamDictionary Class Reference

Class to hold a dictionary of parameters for a single class. More...

#include <OgreStringInterface.h>

List of all members.

Public Methods

 ParamDictionary ()
void addParameter (const ParameterDef &paramDef, ParamCommand *paramCmd)
 Method for adding a parameter definition for this class. More...

const ParameterListgetParameters (void)
 Retrieves a list of parameters valid for this object. More...


Protected Methods

ParamCommandgetParamCommand (const String &name)
 Retrieves the parameter command object for a named parameter. More...


Protected Attributes

ParameterList mParamDefs
 Definitions of parameters. More...

ParamCommandMap mParamCommands
 Command objects to get/set. More...


Friends

class StringInterface


Detailed Description

Class to hold a dictionary of parameters for a single class.


Constructor & Destructor Documentation

Ogre::ParamDictionary::ParamDictionary   [inline]
 


Member Function Documentation

void Ogre::ParamDictionary::addParameter const ParameterDef   paramDef,
ParamCommand   paramCmd
[inline]
 

Method for adding a parameter definition for this class.

Parameters:
paramDef  A ParameterDef object defining the parameter
paramCmd  Pointer to a ParamCommand subclass to handle the getting / setting of this parameter. NB this class will not destroy this on shutdown, please ensure you do

ParamCommand* Ogre::ParamDictionary::getParamCommand const String   name [inline, protected]
 

Retrieves the parameter command object for a named parameter.

const ParameterList& Ogre::ParamDictionary::getParameters void    [inline]
 

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.


Friends And Related Function Documentation

friend class StringInterface [friend]
 


Member Data Documentation

ParamCommandMap Ogre::ParamDictionary::mParamCommands [protected]
 

Command objects to get/set.

ParameterList Ogre::ParamDictionary::mParamDefs [protected]
 

Definitions of parameters.

Copyright © 2002 by The OGRE Team