#include <pyfbsdk.h>
Public Member Functions | |
int | __len__ () |
Returns the number of elements. | |
str | __getitem__ (int pIndex) |
Returns the ith component Corresponds to python: print v[1]. | |
__setitem__ (int pIndex, str pValue) | |
Sets the ith components Corresponds to python: v[1] = my_component. | |
bool | __contains__ (str pValue) |
Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList: | |
append (str pValue) | |
Append new str at end of list. | |
int | count () |
Returns the number of elements. | |
insert (int pIndex, str pValue) | |
Insert a new element in list. | |
remove (int pIndex) | |
Remove an element in list. | |
removeAll () | |
Remove all elements of list | |
str | pop () |
Remove last element of list. | |
str | pop (int pIndex) |
Remove an element in list. | |
int | findFromReference (int pReference) |
Find the index of an element from its attached reference. | |
setReferenceAt (int pReference) | |
Sets the reference value of an object. | |
int | getReferenceAt (int pIndex) |
Retrieve the reference of an object at ith position. | |
FBPropertyStringList () | |
Constructor. | |
![]() | |
int | __len__ () |
Returns the number of elements. | |
Element | __getitem__ (int pIndex) |
Returns the ith component Corresponds to python: print l[1]. | |
![]() | |
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 | |
![]() | |
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). | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Constructor.
Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:
pValue | Component to check for inclusion |
Returns the ith component Corresponds to python: print v[1].
pIndex | Index of the components to get (0 to 2) |
int __len__ | ( | ) |
Returns the number of elements.
Corresponds to python: len(object)
Sets the ith components Corresponds to python: v[1] = my_component.
pIndex | Index of the components to set |
pValue | a str to set |
append | ( | str | pValue | ) |
Append new str at end of list.
pValue | to append |
int count | ( | ) |
Returns the number of elements.
Corresponds to python: del propertyList[2]
Find the index of an element from its attached reference.
pReference | Reference of searched object. |
Retrieve the reference of an object at ith position.
pIndex | Index of the object to find reference. |
Insert a new element in list.
pIndex | Index where to insert string |
pValue | String to append |
str pop | ( | ) |
Remove last element of list.
Remove an element in list.
pIndex | Index where to remove element. |
remove | ( | int | pIndex | ) |
Remove an element in list.
pIndex | Index where to remove element. |
removeAll | ( | ) |
Remove all elements of list
setReferenceAt | ( | int | pReference | ) |
Sets the reference value of an object.
pReference | Reference of the object. |