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].
Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.
bool	AllowsLocking ()
	AllowsLocking.
str	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.
str	EnumList (int pIndex)
	Return the string of an enum value.
FBStringList	GetEnumStringList (bool pCreateIt=False)
	String list for enum properties.
float	GetMax ()
	GetMax.
float	GetMin ()
	GetMin.
str	GetName ()
	Get the property's name.
bool	GetPropertyFlag (FBFlag pFlag)
	GetPropertyFlag.
FBFlag	GetPropertyFlags ()
	GetPropertyFlags.
FBType	GetPropertyType ()
	Get the property's type.
str	GetPropertyTypeName ()
	Get the property's type name.
FBProperty	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).
int	GetSubMemberCount ()
	GetSubMemberCount.
bool	HasSomethingLocked ()
	HasSomethingLocked.
bool	IsAnimatable ()
bool	IsInternal ()
bool	IsList ()
	Verify if property is of this type.
bool	IsLocked ()
	IsLocked.
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.
bool	IsMemberLocked (int pIndex)
	IsMemberLocked.
bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value.
bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject.
bool	IsReadOnly ()
	Is property read-only?
bool	IsReferenceProperty ()
bool	IsTextureConnectableProperty ()
bool	IsUserProperty ()
	ModifyPropertyFlag (FBFlag pFlag, bool pValue)
	ModifyPropertyFlag.
	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified.
str	OriValueAsString ()
	Get the property original value (before any modification) as string.
	SetLocked (bool pLocked)
	SetLocked.
	SetMax (float pMax, bool pForceMaxClamp=False)
	SetMax.
	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked.
	SetMin (float pMin, bool pForceMinClamp=False)
	SetMin.
	SetName (str pName)
	Set the property's name.
bool	SetString (str pString)
	Set the property value from a string.

Additional Inherited Members
Public Attributes inherited from FBProperty
str	Name
	Read Property: The property's name.
object	Data
	Read Write Property: The property data value. Type of this depends on the subclass of FBProperty (ex: in a FBPropertyInt, Data is of type int).
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

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

pIndex

Index of the components to get

Returns

Element contain in property list

__len__()

int __len__

(

)

Returns the number of elements.

Corresponds to python: len(object)