FBPropertyManager Class Reference

Property Manager. More...

#include <fbproperties.h>

Public Member Functions
	FBPropertyManager ()
	Constructor. More...
	~FBPropertyManager ()
	Destructor. More...
int	Add (FBProperty *Property)
	Add a property to the property manager. More...
FBProperty *	operator[] (int pIndex)
	Overloaded [] operator. More...
int	GetCount ()
	Get the number of properties stored in property manager. More...
FBProperty *	Find (const char *pPropertyName, bool pMultilangLookup=true)
	Find a property, based on its name. More...
void	FindPropertiesByName (const char *pPropertyNamePattern, FBArrayTemplate< FBProperty * > &pPropList, bool pMultilangLookup=true)
	This function will query the property list for properties fulfilling a particular name pattern. More...
int	Remove (FBProperty *pProperty)
	Remove a property. More...
void	AddToCache (FBProperty *pProperty)
void	RemoveFromCache (KProperty *pProperty)
FBProperty *	FindInCache (KProperty *pProperty)

Detailed Description

Property Manager.

The property manager exists in all FBComponent objects, and contains an array of all the registered properties. These properties may be SDK properties, internal properties or both.

Definition at line 1124 of file fbproperties.h.

Constructor & Destructor Documentation

FBPropertyManager()

FBPropertyManager

(

)

Constructor.

~FBPropertyManager()

~FBPropertyManager

(

)

Destructor.

Member Function Documentation

Add()

int Add

(

FBProperty *

Property

)

Add a property to the property manager.

Parameters

Property

Handle to property to add.

Returns

Index in list where Property was added.

Find()

FBProperty* Find	(	const char *	pPropertyName,
		bool	pMultilangLookup = true
	)

Find a property, based on its name.

Parameters

pPropertyName	Name of property to look for.
pMultilangLookup	When searching, indicate if the name lookup should also be done on the property name as shown in the GUI. (default = true)

Returns

Handle to property found.

FindPropertiesByName()

void FindPropertiesByName	(	const char *	pPropertyNamePattern,
		FBArrayTemplate< FBProperty * > &	pPropList,
		bool	pMultilangLookup = true
	)

This function will query the property list for properties fulfilling a particular name pattern.

Parameters

pPropertyNamePattern	Indicate the name pattern to search. This pattern can contain any amount of *. (ex: *tr*mod*scene )
pPropList	List that contains the resulting properties matching the pattern
pMultilangLookup	When searching, indicate if the name lookup should also be done on the property name as shown in the GUI. (default = true)

Note

The script FindPropertiesWithWildcard.py shows how to use this function.

GetCount()

int GetCount

(

)

Get the number of properties stored in property manager.

Returns

Number of properties in manager.

operator[]()

FBProperty* operator[]

(

int

pIndex

)

Overloaded [] operator.

Access the property at pIndex.

Parameters

pIndex

Index of property to access.

Returns

Property stored at pIndex.

Remove()

int Remove

(

FBProperty *

pProperty

)

Remove a property.

Parameters

pProperty

Property to remove.

Returns

Index where property was found.

---

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

• fbproperties.h