Python Reference Guide
 
Loading...
Searching...
No Matches
FBPropertyList Class Reference

Tuple-like structure for system elements. More...

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyList:

Public Member Functions

int __len__ ()
 Returns the number of elements.
 
Element __getitem__ (int pIndex)
 Returns the ith component Corresponds to python: print l[1].
 

Detailed Description

Tuple-like structure for system elements.

These list objects are used to expose system wide or instance specific list of objects. Two examples of this are FBSystem's list of Cameras and a FBModel's list of Shaders. These lists have been exposed to Python as tuple, whose content cannot be modified directly. This is due to the specific nature of each type of list and the access control required by the owner of the list. For example, creating a new FBCamera object will automatically add it to the list of FBSystem's Cameras. The user does not have to add it to the list. The same being true for the destruction of the camera which should be done by calling 'FBDelete()' on the object itself. Not by atempting to remove it from the list of cameras.

# Supported list operations:
len(propertyList)
print propertyList[0]

Member Function Documentation

◆ __getitem__()

Element __getitem__ ( int  pIndex)

Returns the ith component Corresponds to python: print l[1].

Parameters
pIndexIndex of the components to get
Returns
Element contain in property list

◆ __len__()

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)