Ogre::PropertyDef Class Reference

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

#include <OgreProperty.h>

Inheritance diagram for Ogre::PropertyDef:

Public Member Functions
	PropertyDef (const String &name, const String &desc, PropertyType pType)
	Construct a property.
const String &	getDescription () const
	Get the description of the property.
const String &	getName () const
	Get the name of the property.
PropertyType	getType () const
	Get the type of the property.

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

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.

Constructor & Destructor Documentation

PropertyDef()

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

inline

Construct a property.

Parameters

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

Member Function Documentation

getName()

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

inline

Get the name of the property.

getDescription()

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

inline

Get the description of the property.

getType()

PropertyType Ogre::PropertyDef::getType ( ) const

inline

Get the type of the property.

getTypeName()

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

static

Get a string name of a property type.

getTypeForValue() [1/16]

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

inlinestatic

References Ogre::PROP_SHORT.

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

getTypeForValue() [2/16]

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

inlinestatic

References Ogre::PROP_UNSIGNED_SHORT.

getTypeForValue() [3/16]

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

inlinestatic

References Ogre::PROP_INT.

getTypeForValue() [4/16]

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

inlinestatic

References Ogre::PROP_UNSIGNED_INT.

getTypeForValue() [5/16]

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

inlinestatic

References Ogre::PROP_LONG.

getTypeForValue() [6/16]

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

inlinestatic

References Ogre::PROP_UNSIGNED_LONG.

getTypeForValue() [7/16]

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

inlinestatic

References Ogre::PROP_REAL.

getTypeForValue() [8/16]

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

inlinestatic

References Ogre::PROP_STRING.

getTypeForValue() [9/16]

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

inlinestatic

References Ogre::PROP_VECTOR2.

getTypeForValue() [10/16]

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

inlinestatic

References Ogre::PROP_VECTOR3.

getTypeForValue() [11/16]

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

inlinestatic

References Ogre::PROP_VECTOR4.

getTypeForValue() [12/16]

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

inlinestatic

References Ogre::PROP_COLOUR.

getTypeForValue() [13/16]

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

inlinestatic

References Ogre::PROP_BOOL.

getTypeForValue() [14/16]

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

inlinestatic

References Ogre::PROP_QUATERNION.

getTypeForValue() [15/16]

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

inlinestatic

References Ogre::PROP_MATRIX3.

getTypeForValue() [16/16]

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

inlinestatic

References Ogre::PROP_MATRIX4.

---

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

• OgreProperty.h