DtPropertySetter Namespace Reference

Namespace for methods which set a property from a Lua object to DtRwVariableBindings and vice-versa. More...

Typedefs
typedef bool(*	luaToPropFnc )(const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
	Function signature for Lua-to-property conversion functions. More...
typedef bool(*	propToLuaFnc )(lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
	Function signature for Property-to-Lua conversion functions. More...
typedef DtPropertyInterface *(*	luaToPropCreatorFnc )(const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
	Function signature for Lua-to-property creation functions. More...
typedef std::map< DtString, luaToPropFnc >	DtPropFromLuaFcnMap
typedef std::map< DtString, propToLuaFnc >	DtLuaFromPropFcnMap
typedef std::map< int, luaToPropCreatorFnc >	DtPropFromLuaCreatorFcnMap

Functions
bool	setPropertyFromLua (const DtString &propertyName, const luabind::object &inProp, DtRwProperties *outProps)
	Sets the named property property from a Lua property. More...
bool	setOrAddPropertyFromLua (const DtString &propertyName, const luabind::object &inProp, DtRwProperties *outProps)
	Sets the named property from a Lua property, adding it if it's not found. More...
bool	setPropertyListItemFromLua (const DtString &propertyName, const luabind::object &keyValues, const luabind::object &inProp, DtRwProperties *outProps)
	Finds the item in the named list property that matches the specified keyValues and updates it with the contents of inProp. More...
bool	setPropertyListItemFromLua (const DtString &propertyName, int index, const luabind::object &inProp, DtRwProperties *outProps)
	Finds the item in the named list property at the given index (where the Lua input starts at index 1) and updates it with the contents of inProp. More...
bool	setPropertyMapItemFromLua (const DtString &propertyName, const luabind::object &keyValue, const luabind::object &inProp, DtRwProperties *outProps)
	Finds the item in the named map property that matches the specified keyValues and updates it with the contents of inProp. More...
bool	setLuaFromProperty (lua_State *L, const DtString &propertyName, const DtRwProperties *inProps, luabind::object &outProp)
	Sets the named Lua property from a property. More...
bool	setLuaListItemFromProperty (lua_State *L, const DtString &propertyName, const luabind::object &keyValues, const DtRwProperties *inProps, luabind::object &outItem, int &index)
	Finds the item in the named list property that matches the specified keyValues and sets outItem with its contents. More...
bool	setLuaListItemFromProperty (lua_State *L, const DtString &propertyName, int index, const DtRwProperties *inProps, luabind::object &outItem)
	Finds the item in the named list property at the given index and sets outItem with its contents. More...
bool	setLuaMapItemFromProperty (lua_State *L, const DtString &propertyName, const luabind::object &keyValue, const DtRwProperties *inProps, luabind::object &outItem)
	Finds the item in the named map property that matches the specified keyValue and sets outItem with its contents. More...
bool	setPropertyFromLua (const luabind::object &inProp, DtPropertyInterface *outProp)
	Sets the given property from a Lua object. More...
bool	setLuaFromProperty (lua_State *L, const DtPropertyInterface *inProps, luabind::object &outProp)
	Sets the given Lua object from a property. More...
const DtPropertyInterface *	findConstListItemByKeys (const DtRwPropertiesList *propList, const luabind::object &keyValues, int &index)
	Called by findConstListItem in the case where keyValues is a table of keys that match fields in the structure that defines the format of each item in the list property. More...
const DtPropertyInterface *	findConstListItemByValue (const DtRwPropertiesList *propList, const luabind::object &keyValues, int &index)
	Called by findConstListItem in the case where keyValues is just a single value that matches a simple data type that matches the type of each item in the list property. More...
DtString	convertMapKey (const DtRwPropertiesMap *propMap, const luabind::object &keyValue)
	Converts the Lua object to a string to be used as a key to the specified DtRwPropertiesMap. More...
DtPropFromLuaFcnMap &	propertyFromLuaFcnMap ()
	The Lua-to-Property by type. More...
DtLuaFromPropFcnMap &	luaFromPropertyFcnMap ()
	The Property-to-Lua by type. More...
DtPropFromLuaCreatorFcnMap &	propertyFromLuaCreatorFcnMap ()
	The Lua-to-Property creator by type. More...
bool	setStringPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
	Lua-to-Property conversion functions. More...
bool	setUUIDPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setEntityTypePropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setObjectTypePropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setVerticesPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setOffsetVerticesPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setIntPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setDoublePropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setBoolPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setVectorPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setStructPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setListPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)
bool	setLuaFromStringProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
	Property-to-Lua conversion functions. More...
bool	setLuaFromEntityTypeProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromObjectTypeProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromVerticesProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromOffsetVerticesProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromIntProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromDoubleProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromBoolProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromVectorProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromStructProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
bool	setLuaFromListProp (lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)
DtPropertyInterface *	createStringPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
	Lua-to-Property creation functions. More...
DtPropertyInterface *	createDoublePropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createBoolPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createTablePropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createCustomPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createStructPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createListPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
DtPropertyInterface *	createMapPropFromLua (const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)
const DtPropertyInterface *	findConstListItem (const DtRwPropertiesList *propList, const luabind::object &keyValues, int &index)
	Find the item in the list that matches the given keys defined in the keyValues Lua object. More...
DtPropertyInterface *	findListItem (DtRwPropertiesList *propList, const luabind::object &keyValues, int &index)
const DtPropertyInterface *	findConstMapItem (const DtRwPropertiesMap *propMap, const luabind::object &keyValue)
	Find the item in the map that matches the given key defined in the keyValue Lua object. More...
DtPropertyInterface *	findMapItem (DtRwPropertiesMap *propMap, const luabind::object &keyValue)

Detailed Description

Namespace for methods which set a property from a Lua object to DtRwVariableBindings and vice-versa.

Typedef Documentation

typedef bool(* DtPropertySetter::luaToPropFnc)(const DtString &propertyName, luabind::object const &inProp, DtPropertyInterface *outProp)

Function signature for Lua-to-property conversion functions.

typedef bool(* DtPropertySetter::propToLuaFnc)(lua_State *L, const DtString &propertyName, const DtPropertyInterface *inProp, luabind::object &outProp)

Function signature for Property-to-Lua conversion functions.

typedef DtPropertyInterface*(* DtPropertySetter::luaToPropCreatorFnc)(const DtString &propertyName, luabind::object const &inProp, DtRwProperties *parent)

Function signature for Lua-to-property creation functions.

typedef std::map<DtString, luaToPropFnc> DtPropertySetter::DtPropFromLuaFcnMap

typedef std::map<DtString, propToLuaFnc> DtPropertySetter::DtLuaFromPropFcnMap

typedef std::map<int, luaToPropCreatorFnc> DtPropertySetter::DtPropFromLuaCreatorFcnMap

Function Documentation

bool DtPropertySetter::setPropertyFromLua	(	const DtString &	propertyName,
		const luabind::object &	inProp,
		DtRwProperties *	outProps
	)

Sets the named property property from a Lua property.

Returns true if successful.

bool DtPropertySetter::setOrAddPropertyFromLua	(	const DtString &	propertyName,
		const luabind::object &	inProp,
		DtRwProperties *	outProps
	)

Sets the named property from a Lua property, adding it if it's not found.

Returns true if successful.

bool DtPropertySetter::setPropertyListItemFromLua	(	const DtString &	propertyName,
		const luabind::object &	keyValues,
		const luabind::object &	inProp,
		DtRwProperties *	outProps
	)

Finds the item in the named list property that matches the specified keyValues and updates it with the contents of inProp.

Returns true if successful.

bool DtPropertySetter::setPropertyListItemFromLua	(	const DtString &	propertyName,
		int	index,
		const luabind::object &	inProp,
		DtRwProperties *	outProps
	)

Finds the item in the named list property at the given index (where the Lua input starts at index 1) and updates it with the contents of inProp.

Returns true if successful.

bool DtPropertySetter::setPropertyMapItemFromLua	(	const DtString &	propertyName,
		const luabind::object &	keyValue,
		const luabind::object &	inProp,
		DtRwProperties *	outProps
	)

Finds the item in the named map property that matches the specified keyValues and updates it with the contents of inProp.

Returns true if successful.

bool DtPropertySetter::setLuaFromProperty	(	lua_State *	L,
		const DtString &	propertyName,
		const DtRwProperties *	inProps,
		luabind::object &	outProp
	)

Sets the named Lua property from a property.

Returns true if successful.

bool DtPropertySetter::setLuaListItemFromProperty	(	lua_State *	L,
		const DtString &	propertyName,
		const luabind::object &	keyValues,
		const DtRwProperties *	inProps,
		luabind::object &	outItem,
		int &	index
	)

Finds the item in the named list property that matches the specified keyValues and sets outItem with its contents.

Returns true if successful, along with the index of the item found.

bool DtPropertySetter::setLuaListItemFromProperty	(	lua_State *	L,
		const DtString &	propertyName,
		int	index,
		const DtRwProperties *	inProps,
		luabind::object &	outItem
	)

Finds the item in the named list property at the given index and sets outItem with its contents.

Returns true if successful.

bool DtPropertySetter::setLuaMapItemFromProperty	(	lua_State *	L,
		const DtString &	propertyName,
		const luabind::object &	keyValue,
		const DtRwProperties *	inProps,
		luabind::object &	outItem
	)

Finds the item in the named map property that matches the specified keyValue and sets outItem with its contents.

Returns true if successful.

bool DtPropertySetter::setPropertyFromLua	(	const luabind::object &	inProp,
		DtPropertyInterface *	outProp
	)

Sets the given property from a Lua object.

Returns true if successful.

bool DtPropertySetter::setLuaFromProperty	(	lua_State *	L,
		const DtPropertyInterface *	inProps,
		luabind::object &	outProp
	)

Sets the given Lua object from a property.

Returns true if successful.

bool DtPropertySetter::setStringPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

Lua-to-Property conversion functions.

bool DtPropertySetter::setUUIDPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setEntityTypePropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setObjectTypePropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setVerticesPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setOffsetVerticesPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setIntPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setDoublePropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setBoolPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setVectorPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setStructPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setListPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtPropertyInterface *	outProp
	)

bool DtPropertySetter::setLuaFromStringProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

Property-to-Lua conversion functions.

bool DtPropertySetter::setLuaFromEntityTypeProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromObjectTypeProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromVerticesProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromOffsetVerticesProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromIntProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromDoubleProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromBoolProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromVectorProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromStructProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

bool DtPropertySetter::setLuaFromListProp	(	lua_State *	L,
		const DtString &	propertyName,
		const DtPropertyInterface *	inProp,
		luabind::object &	outProp
	)

DtPropertyInterface* DtPropertySetter::createStringPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

Lua-to-Property creation functions.

DtPropertyInterface* DtPropertySetter::createDoublePropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createBoolPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createTablePropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createCustomPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createStructPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createListPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

DtPropertyInterface* DtPropertySetter::createMapPropFromLua	(	const DtString &	propertyName,
		luabind::object const &	inProp,
		DtRwProperties *	parent
	)

const DtPropertyInterface* DtPropertySetter::findConstListItem	(	const DtRwPropertiesList *	propList,
		const luabind::object &	keyValues,
		int &	index
	)

Find the item in the list that matches the given keys defined in the keyValues Lua object.

Sets the index parameter to the Lua index (where the first item is at index 1).

DtPropertyInterface* DtPropertySetter::findListItem	(	DtRwPropertiesList *	propList,
		const luabind::object &	keyValues,
		int &	index
	)

const DtPropertyInterface* DtPropertySetter::findConstListItemByKeys	(	const DtRwPropertiesList *	propList,
		const luabind::object &	keyValues,
		int &	index
	)

Called by findConstListItem in the case where keyValues is a table of keys that match fields in the structure that defines the format of each item in the list property.

const DtPropertyInterface* DtPropertySetter::findConstListItemByValue	(	const DtRwPropertiesList *	propList,
		const luabind::object &	keyValues,
		int &	index
	)

Called by findConstListItem in the case where keyValues is just a single value that matches a simple data type that matches the type of each item in the list property.

DtString DtPropertySetter::convertMapKey	(	const DtRwPropertiesMap *	propMap,
		const luabind::object &	keyValue
	)

Converts the Lua object to a string to be used as a key to the specified DtRwPropertiesMap.

const DtPropertyInterface* DtPropertySetter::findConstMapItem	(	const DtRwPropertiesMap *	propMap,
		const luabind::object &	keyValue
	)

Find the item in the map that matches the given key defined in the keyValue Lua object.

DtPropertyInterface* DtPropertySetter::findMapItem	(	DtRwPropertiesMap *	propMap,
		const luabind::object &	keyValue
	)

DtPropFromLuaFcnMap& DtPropertySetter::propertyFromLuaFcnMap

(

)

The Lua-to-Property by type.

DtLuaFromPropFcnMap& DtPropertySetter::luaFromPropertyFcnMap

(

)

The Property-to-Lua by type.

DtPropFromLuaCreatorFcnMap& DtPropertySetter::propertyFromLuaCreatorFcnMap

(

)

The Lua-to-Property creator by type.