OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PropertyDef Class Reference

Definition of a property of an object. More...

#include <OgreProperty.h>

+ Inheritance diagram for Ogre::PropertyDef:
+ Collaboration diagram for Ogre::PropertyDef:

Public Member Functions

 PropertyDef (const String &name, const String &desc, PropertyType pType)
 Construct a property. More...
 
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...
 
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)
 

Static Public Member Functions

static PropertyType getTypeForValue (const short &val)
 
static PropertyType getTypeForValue (const unsigned short &val)
 
static PropertyType getTypeForValue (const int &val)
 
static PropertyType getTypeForValue (const unsigned int &val)
 
static PropertyType getTypeForValue (const long &val)
 
static PropertyType getTypeForValue (const unsigned long &val)
 
static PropertyType getTypeForValue (const Real &val)
 
static PropertyType getTypeForValue (const String &val)
 
static PropertyType getTypeForValue (const Vector2 &val)
 
static PropertyType getTypeForValue (const Vector3 &val)
 
static PropertyType getTypeForValue (const Vector4 &val)
 
static PropertyType getTypeForValue (const ColourValue &val)
 
static PropertyType getTypeForValue (const bool &val)
 
static PropertyType getTypeForValue (const Quaternion &val)
 
static PropertyType getTypeForValue (const Matrix3 &val)
 
static PropertyType getTypeForValue (const Matrix4 &val)
 
static const StringgetTypeName (PropertyType theType)
 Get a string name of a property type. More...
 

Protected Member Functions

 PropertyDef ()
 

Protected Attributes

String mDesc
 
String mName
 
PropertyType mType
 

Detailed Description

Definition of a property of an object.

Remarks
This definition is shared between all instances of an object and therefore has no value. Property contains values.

Definition at line 132 of file OgreProperty.h.

Constructor & Destructor Documentation

Ogre::PropertyDef::PropertyDef ( const String name,
const String desc,
PropertyType  pType 
)
inline

Construct a property.

Parameters
nameThe name of the property
descA (potentially) long description of the property
pTypeThe type of the property

Definition at line 141 of file OgreProperty.h.

Ogre::PropertyDef::PropertyDef ( )
inlineprotected

Definition at line 175 of file OgreProperty.h.

Member Function Documentation

const String& Ogre::PropertyDef::getDescription ( void  ) const
inline

Get the description of the property.

Definition at line 148 of file OgreProperty.h.

const String& Ogre::PropertyDef::getName ( void  ) const
inline

Get the name of the property.

Definition at line 145 of file OgreProperty.h.

PropertyType Ogre::PropertyDef::getType ( void  ) const
inline

Get the type of the property.

Definition at line 151 of file OgreProperty.h.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const short &  val)
inlinestatic

Definition at line 156 of file OgreProperty.h.

References Ogre::PROP_SHORT.

Referenced by Ogre::PropertySet::getValue(), and Ogre::PropertySet::setValue().

static PropertyType Ogre::PropertyDef::getTypeForValue ( const unsigned short &  val)
inlinestatic

Definition at line 157 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_SHORT.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const int &  val)
inlinestatic

Definition at line 158 of file OgreProperty.h.

References Ogre::PROP_INT.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const unsigned int &  val)
inlinestatic

Definition at line 159 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_INT.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const long &  val)
inlinestatic

Definition at line 160 of file OgreProperty.h.

References Ogre::PROP_LONG.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const unsigned long &  val)
inlinestatic

Definition at line 161 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_LONG.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Real val)
inlinestatic

Definition at line 162 of file OgreProperty.h.

References Ogre::PROP_REAL.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const String val)
inlinestatic

Definition at line 163 of file OgreProperty.h.

References Ogre::PROP_STRING.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Vector2 val)
inlinestatic

Definition at line 164 of file OgreProperty.h.

References Ogre::PROP_VECTOR2.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Vector3 val)
inlinestatic

Definition at line 165 of file OgreProperty.h.

References Ogre::PROP_VECTOR3.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Vector4 val)
inlinestatic

Definition at line 166 of file OgreProperty.h.

References Ogre::PROP_VECTOR4.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const ColourValue val)
inlinestatic

Definition at line 167 of file OgreProperty.h.

References Ogre::PROP_COLOUR.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const bool &  val)
inlinestatic

Definition at line 168 of file OgreProperty.h.

References Ogre::PROP_BOOL.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Quaternion val)
inlinestatic

Definition at line 169 of file OgreProperty.h.

References Ogre::PROP_QUATERNION.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Matrix3 val)
inlinestatic

Definition at line 170 of file OgreProperty.h.

References Ogre::PROP_MATRIX3.

static PropertyType Ogre::PropertyDef::getTypeForValue ( const Matrix4 val)
inlinestatic

Definition at line 171 of file OgreProperty.h.

References Ogre::PROP_MATRIX4.

static const String& Ogre::PropertyDef::getTypeName ( PropertyType  theType)
static

Get a string name of a property type.

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

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.

Member Data Documentation

String Ogre::PropertyDef::mDesc
protected

Definition at line 178 of file OgreProperty.h.

String Ogre::PropertyDef::mName
protected

Definition at line 177 of file OgreProperty.h.

PropertyType Ogre::PropertyDef::mType
protected

Definition at line 179 of file OgreProperty.h.


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