OGRE  1.12.12
Object-Oriented Graphics Rendering Engine
Ogre::PropertySet Class Reference

Defines a complete set of properties for a single object instance. More...

#include <OgreProperty.h>

+ Inheritance diagram for Ogre::PropertySet:

Public Types

typedef std::map< String, PropertyBase * > PropertyMap
 

Public Member Functions

 PropertySet ()
 
 ~PropertySet ()
 
void addProperty (PropertyBase *prop)
 Adds a property to this set. More...
 
PropertyBasegetProperty (const String &name) const
 Gets the property object for a given property name. More...
 
template<typename T >
void getValue (const String &name, T &value) const
 Get a named property value. More...
 
PropertyValueMap getValueMap () const
 Gets an independently usable collection of property values from the current state. More...
 
bool hasProperty (const String &name) const
 Reports whether this property set contains a named property. More...
 
void removeProperty (const String &name)
 Removes the named property from the property set. More...
 
template<typename T >
void setValue (const String &name, const T *value)
 Set a named property value (via pointer to avoid copy). More...
 
template<typename T >
void setValue (const String &name, T value)
 Set a named property value. More...
 
void setValue (const String &name, const char *pChar)
 Special-case char*, convert to String automatically. More...
 
void setValueMap (const PropertyValueMap &values)
 Sets the current state from a given value map. More...
 

Detailed Description

Defines a complete set of properties for a single object instance.

Member Typedef Documentation

Constructor & Destructor Documentation

Ogre::PropertySet::PropertySet ( )
Ogre::PropertySet::~PropertySet ( )

Member Function Documentation

void Ogre::PropertySet::addProperty ( PropertyBase prop)

Adds a property to this set.

Remarks
The PropertySet is responsible for deleting this object.
PropertyBase* Ogre::PropertySet::getProperty ( const String name) const

Gets the property object for a given property name.

Remarks
Note that this property will need to be cast to a templated property compatible with the type you will be setting. You might find the overloaded set and get<type> methods quicker if you already know the type.
bool Ogre::PropertySet::hasProperty ( const String name) const

Reports whether this property set contains a named property.

void Ogre::PropertySet::removeProperty ( const String name)

Removes the named property from the property set.

PropertyValueMap Ogre::PropertySet::getValueMap ( ) const

Gets an independently usable collection of property values from the current state.

void Ogre::PropertySet::setValueMap ( const PropertyValueMap values)

Sets the current state from a given value map.

template<typename T >
void Ogre::PropertySet::getValue ( const String name,
T &  value 
) const
inline

Get a named property value.

References Ogre::PropertyDef::getTypeForValue().

template<typename T >
void Ogre::PropertySet::setValue ( const String name,
const T *  value 
)
inline

Set a named property value (via pointer to avoid copy).

References Ogre::PropertyDef::getTypeForValue().

template<typename T >
void Ogre::PropertySet::setValue ( const String name,
value 
)
inline

Set a named property value.

References Ogre::PropertyDef::getTypeForValue().

void Ogre::PropertySet::setValue ( const String name,
const char *  pChar 
)
inline

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