OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 >:
+ Collaboration diagram for Ogre::Property< T >:

Public Types

typedef boost::function< T(void) > getter_func
 
typedef boost::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...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void set (T val)
 Set the property value. More...
 

Protected Member Functions

 Property ()
 
 ~Property ()
 

Protected Attributes

PropertyDefmDef
 
getter_func mGetter
 
setter_func mSetter
 

Detailed Description

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

Property instance with passthrough calls to a given object.

Definition at line 216 of file OgreProperty.h.

Member Typedef Documentation

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

Definition at line 220 of file OgreProperty.h.

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

Definition at line 221 of file OgreProperty.h.

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

Definition at line 219 of file OgreProperty.h.

Constructor & Destructor Documentation

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.

Definition at line 226 of file OgreProperty.h.

template<typename T >
Ogre::Property< T >::Property ( )
inlineprotected

Definition at line 252 of file OgreProperty.h.

template<typename T >
Ogre::Property< T >::~Property ( )
inlineprotected

Definition at line 253 of file OgreProperty.h.

Member Function Documentation

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

Definition at line 240 of file OgreProperty.h.

References Ogre::Property< T >::mGetter.

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

Get the description of the property.

Definition at line 199 of file OgreProperty.h.

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

Get the name of the property.

Definition at line 196 of file OgreProperty.h.

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

Get the type of the property.

Definition at line 202 of file OgreProperty.h.

Referenced by Ogre::PropertySet::getPropertyImpl(), and Ogre::PropertySet::setPropertyImpl().

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

Return the current value as an Any.

Implements Ogre::PropertyBase.

Definition at line 245 of file OgreProperty.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Set the property value.

Definition at line 235 of file OgreProperty.h.

References Ogre::Property< T >::mSetter.

Member Data Documentation

PropertyDef* Ogre::PropertyBase::mDef
protectedinherited

Definition at line 210 of file OgreProperty.h.

template<typename T >
getter_func Ogre::Property< T >::mGetter
protected

Definition at line 255 of file OgreProperty.h.

Referenced by Ogre::Property< T >::get().

template<typename T >
setter_func Ogre::Property< T >::mSetter
protected

Definition at line 256 of file OgreProperty.h.

Referenced by Ogre::Property< T >::set().


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