Ogre::PropertyDef Class Reference
Components » Property

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

`#include <OgreProperty.h>`

Inheritance diagram for Ogre::PropertyDef:
[legend]

## Public Member Functions

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

## Constructor & Destructor Documentation

## PropertyDef() [1/2]

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

Construct a property.

Parameters

  name | The name of the property
  desc | A (potentially) long description of the property
  pType | The type of the property

Definition at line 146 of file OgreProperty.h.

## PropertyDef() [2/2]

Ogre::PropertyDef::PropertyDef | ( |  | ) |

protected

Definition at line 180 of file OgreProperty.h.

## Member Function Documentation

## getDescription()

const String& Ogre::PropertyDef::getDescription | ( |  | ) | const

Get the description of the property.

Definition at line 153 of file OgreProperty.h.

## getName()

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

Get the name of the property.

Definition at line 150 of file OgreProperty.h.

## getType()

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

Get the type of the property.

Definition at line 156 of file OgreProperty.h.

## getTypeForValue() [1/16]

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

static

Definition at line 161 of file OgreProperty.h.

References Ogre::PROP_SHORT.

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

## getTypeForValue() [2/16]

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

static

Definition at line 162 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_SHORT.

## getTypeForValue() [3/16]

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

static

Definition at line 163 of file OgreProperty.h.

References Ogre::PROP_INT.

## getTypeForValue() [4/16]

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

static

Definition at line 164 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_INT.

## getTypeForValue() [5/16]

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

static

Definition at line 165 of file OgreProperty.h.

References Ogre::PROP_LONG.

## getTypeForValue() [6/16]

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

static

Definition at line 166 of file OgreProperty.h.

References Ogre::PROP_UNSIGNED_LONG.

## getTypeForValue() [7/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Real & | val | ) |

static

Definition at line 167 of file OgreProperty.h.

References Ogre::PROP_REAL.

## getTypeForValue() [8/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const String & | val | ) |

static

Definition at line 168 of file OgreProperty.h.

References Ogre::PROP_STRING.

## getTypeForValue() [9/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Vector2 & | val | ) |

static

Definition at line 169 of file OgreProperty.h.

References Ogre::PROP_VECTOR2.

## getTypeForValue() [10/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Vector3 & | val | ) |

static

Definition at line 170 of file OgreProperty.h.

References Ogre::PROP_VECTOR3.

## getTypeForValue() [11/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Vector4 & | val | ) |

static

Definition at line 171 of file OgreProperty.h.

References Ogre::PROP_VECTOR4.

## getTypeForValue() [12/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const ColourValue & | val | ) |

static

Definition at line 172 of file OgreProperty.h.

References Ogre::PROP_COLOUR.

## getTypeForValue() [13/16]

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

static

Definition at line 173 of file OgreProperty.h.

References Ogre::PROP_BOOL.

## getTypeForValue() [14/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Quaternion & | val | ) |

static

Definition at line 174 of file OgreProperty.h.

References Ogre::PROP_QUATERNION.

## getTypeForValue() [15/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Matrix3 & | val | ) |

static

Definition at line 175 of file OgreProperty.h.

References Ogre::PROP_MATRIX3.

## getTypeForValue() [16/16]

static PropertyType Ogre::PropertyDef::getTypeForValue | ( | const Matrix4 & | val | ) |

static

Definition at line 176 of file OgreProperty.h.

References Ogre::PROP_MATRIX4.

## getTypeName()

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().

## 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,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/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[]() [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,
|  | 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() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 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,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## Member Data Documentation

## mDesc

String Ogre::PropertyDef::mDesc

protected

Definition at line 183 of file OgreProperty.h.

## mName

String Ogre::PropertyDef::mName

protected

Definition at line 182 of file OgreProperty.h.

## mType

PropertyType Ogre::PropertyDef::mType

protected

Definition at line 184 of file OgreProperty.h.

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

- OgreProperty.h

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