Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:
Inheritance graph
[legend]

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 String & getDescription () const
 Get the description of the property. More...
 
const String & getName () 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, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
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 *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
virtual void set (T val)
 Set the property value. More...
 

Protected Member Functions

 Property ()
 
 ~Property ()
 

Protected Attributes

PropertyDef * mDef
 
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 221 of file OgreProperty.h.

Member Typedef Documentation

◆ getter_func

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

Definition at line 225 of file OgreProperty.h.

◆ setter_func

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

Definition at line 226 of file OgreProperty.h.

◆ value_type

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

Definition at line 224 of file OgreProperty.h.

Constructor & Destructor Documentation

◆ Property() [1/2]

template<typename T >
Ogre::Property< T >::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.

Definition at line 231 of file OgreProperty.h.

◆ Property() [2/2]

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

Definition at line 257 of file OgreProperty.h.

◆ ~Property()

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

Definition at line 258 of file OgreProperty.h.

Member Function Documentation

◆ get()

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

Definition at line 245 of file OgreProperty.h.

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

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

◆ getDescription()

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

Get the description of the property.

Definition at line 204 of file OgreProperty.h.

◆ getName()

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

Get the name of the property.

Definition at line 201 of file OgreProperty.h.

◆ getType()

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

Get the type of the property.

Definition at line 207 of file OgreProperty.h.

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

◆ getValue()

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

Return the current value as an Any.

Implements Ogre::PropertyBase.

Definition at line 250 of file OgreProperty.h.

References Ogre::Property< T >::get().

◆ operator delete() [1/3]

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/2]

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/2]

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ set()

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

Set the property value.

Definition at line 240 of file OgreProperty.h.

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

Member Data Documentation

◆ mDef

PropertyDef* Ogre::PropertyBase::mDef
protectedinherited

Definition at line 215 of file OgreProperty.h.

◆ mGetter

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

Definition at line 260 of file OgreProperty.h.

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

◆ mSetter

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

Definition at line 261 of file OgreProperty.h.

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


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.