OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::Property< T > Class Template Reference

Property instance with passthrough calls to a given object. More...

#include <OgreProperty.h>

+ Inheritance diagram for Ogre::Property< T >:

Public Types

typedef function< T(void) > getter_func
 
typedef function< void(T) > setter_func
 
typedef T value_type
 

Public Member Functions

 Property (PropertyDef *def, getter_func getter, setter_func setter)
 Construct a property which is able to directly call a given getter and setter on a specific object instance, via functors. More...
 
virtual T get () const
 
const StringgetDescription () const
 Get the description of the property. More...
 
const StringgetName () const
 Get the name of the property. More...
 
PropertyType getType () const
 Get the type of the property. More...
 
Ogre::Any getValue () const
 Return the current value as an Any. More...
 
virtual void set (T val)
 Set the property value. More...
 

Detailed Description

template<typename T>
class Ogre::Property< T >

Property instance with passthrough calls to a given object.

Member Typedef Documentation

◆ value_type

template<typename T >
typedef T Ogre::Property< T >::value_type

◆ getter_func

template<typename T >
typedef function< T (void) > Ogre::Property< T >::getter_func

◆ setter_func

template<typename T >
typedef function< void (T) > Ogre::Property< T >::setter_func

Constructor & Destructor Documentation

◆ Property()

template<typename T >
Ogre::Property< T >::Property ( PropertyDef def,
getter_func  getter,
setter_func  setter 
)
inline

Construct a property which is able to directly call a given getter and setter on a specific object instance, via functors.

Member Function Documentation

◆ set()

template<typename T >
virtual void Ogre::Property< T >::set ( val)
inlinevirtual

Set the property value.

◆ get()

template<typename T >
virtual T Ogre::Property< T >::get ( void  ) const
inlinevirtual

◆ getValue()

template<typename T >
Ogre::Any Ogre::Property< T >::getValue ( ) const
inlinevirtual

Return the current value as an Any.

Implements Ogre::PropertyBase.

◆ getName()

const String& Ogre::PropertyBase::getName ( void  ) const
inlineinherited

Get the name of the property.

◆ getDescription()

const String& Ogre::PropertyBase::getDescription ( ) const
inlineinherited

Get the description of the property.

◆ getType()

PropertyType Ogre::PropertyBase::getType ( void  ) const
inlineinherited

Get the type of the property.

Referenced by Ogre::PropertySet::setValue().


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