FBPropertyManager Class Reference

FBPropertyManager Class Reference

#include <mobu-python-api.h>

Class 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.

+ Inheritance diagram for FBPropertyManager:

Public Member Functions

 __reduce__ ()
 
object Find (FBPropertyManager arg1, str arg2, object arg3)
 Find a property, based on its name. More...
 
 FindPropertiesByName (FBPropertyManager arg1, str arg2, list arg3, object arg4)
 This function will query the property list for properties fulfilling a particular name pattern. More...
 
int __len__ (FBPropertyManager arg1)
 
object __getitem__ (FBPropertyManager arg1, object arg2)
 
 __init__ (...)
 Constructor. More...
 

Member Function Documentation

object __getitem__ ( FBPropertyManager  arg1,
object  arg2 
)

Python Docstring:

__getitem__( (FBPropertyManager)arg1, (object)arg2) -> object 
__init__ (   ...)

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

 FBPropertyManager() 
int __len__ ( FBPropertyManager  arg1)

Python Docstring:

__len__( (FBPropertyManager)arg1) -> int 
__reduce__ ( )
object Find ( FBPropertyManager  arg1,
str  arg2,
object  arg3 
)

Find a property, based on its name.

Python Docstring:

Find( (FBPropertyManager)arg1, (str)arg2 [, (object)arg3]) -> object 

C++ Signature:

ORSDK2018::FBProperty * Find(const char * pPropertyName, bool pMultilangLookup = true) 
Parameters
pPropertyNameName of property to look for.
pMultilangLookupWhen 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 ( FBPropertyManager  arg1,
str  arg2,
list  arg3,
object  arg4 
)

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

Python Docstring:

FindPropertiesByName( (FBPropertyManager)arg1, (str)arg2, (list)arg3 [, (object)arg4]) -> None 

C++ Signature:

void FindPropertiesByName(const char * pPropertyNamePattern, ORSDK2018::FBArrayTemplate< ORSDK2018::FBProperty * > & pPropList, bool pMultilangLookup = true) 
Parameters
pPropertyNamePatternIndicate the name pattern to search. This pattern can contain any amount of *. (ex: *tr*mod*scene )
pPropListList that contains the resulting properties matching the pattern
pMultilangLookupWhen 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.