FBPropertyList Class Reference
FBPropertyList Class Reference
#include <mainpage.h>
Class 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]
Inheritance diagram for FBPropertyList:
Public Member Functions | |
| __reduce__ () | |
| object | __getitem__ (FBPropertyList arg1, object arg2) |
| int | __len__ (FBPropertyList arg1) |
| __setitem__ (FBPropertyList arg1, object arg2, object arg3) | |
| __delitem__ (FBPropertyList arg1, int arg2) | |
| bool | __contains__ (FBPropertyList arg1, object arg2) |
| append (FBPropertyList arg1, object arg2) | |
| int | count (FBPropertyList arg1, object arg2) |
| insert (FBPropertyList arg1, int arg2, object arg3) | |
| remove (FBPropertyList arg1, object arg2) | |
| removeAll (FBPropertyList arg1) | |
| pop (...) | |
| __init__ (...) | |
| Public Member Functions inherited from FBProperty | |
| __reduce__ () | |
| FBStringList | GetEnumStringList (FBProperty arg1, object arg2) |
| String list for enum properties. More... | |
| str | GetName (FBProperty arg1) |
| Get the property's name. More... | |
| SetName (FBProperty arg1, str arg2) | |
| Set the property's name. More... | |
| FBPropertyType | GetPropertyType (FBProperty arg1) |
| Get the property's type. More... | |
| ModifyPropertyFlag (FBProperty arg1, FBPropertyFlag arg2, object arg3) | |
| ModifyPropertyFlag. More... | |
| int | GetPropertyFlags (FBProperty arg1) |
| GetPropertyFlags. More... | |
| bool | GetPropertyFlag (FBProperty arg1, FBPropertyFlag arg2) |
| GetPropertyFlag. More... | |
| str | GetPropertyTypeName (FBProperty arg1) |
| Get the property's type name. More... | |
| str | AsString (FBProperty arg1, FBDataAsStringFlag arg2) |
| Get the property value as a string. More... | |
| bool | SetString (FBProperty arg1, str arg2) |
| Set the property value from a string. More... | |
| str | OriValueAsString (FBProperty arg1) |
| Get the property original value (before any modification) as string. More... | |
| bool | IsAnimatable (FBProperty arg1) |
| bool | IsInternal (FBProperty arg1) |
| bool | IsList (FBProperty arg1) |
| Verify if property is of this type. More... | |
| bool | IsObjectList (FBProperty arg1) |
| Indicate if is an instance of FBPropertyListObject. More... | |
| bool | IsReadOnly (FBProperty arg1) |
| Is property read-only? More... | |
| bool | IsMinClamp (FBProperty arg1) |
| Indicate if minimum value clamping will be applied on user input value. More... | |
| bool | IsMaxClamp (FBProperty arg1) |
| Indicate if maximum value clamping will be applied on user input value. More... | |
| bool | IsTextureConnectableProperty (FBProperty arg1) |
| bool | IsReferenceProperty (FBProperty arg1) |
| bool | IsUserProperty (FBProperty arg1) |
| SetMin (FBProperty arg1, object arg2, object arg3) | |
| SetMin. More... | |
| SetMax (FBProperty arg1, object arg2, object arg3) | |
| SetMax. More... | |
| float | GetMin (FBProperty arg1) |
| GetMin. More... | |
| float | GetMax (FBProperty arg1) |
| GetMax. More... | |
| bool | AllowsLocking (FBProperty arg1) |
| AllowsLocking. More... | |
| bool | HasSomethingLocked (FBProperty arg1) |
| HasSomethingLocked. More... | |
| bool | IsLocked (FBProperty arg1) |
| IsLocked. More... | |
| bool | IsMemberLocked (FBProperty arg1, object arg2) |
| IsMemberLocked. More... | |
| SetLocked (FBProperty arg1, object arg2) | |
| SetLocked. More... | |
| SetMemberLocked (FBProperty arg1, object arg2, object arg3) | |
| SetMemberLocked. More... | |
| int | GetSubMemberCount (FBProperty arg1) |
| GetSubMemberCount. More... | |
| str | EnumList (FBProperty arg1, object arg2) |
| Return the string of an enum value. More... | |
| NotifyEnumStringListChanged (FBProperty arg1) | |
| Notify system that the enum list was modified. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBPlug | |
| __reduce__ () | |
| bool | BeginChange (FBPlug arg1) |
| Begins a change on multiple plugs. More... | |
| str | ClassName (FBPlug arg1) |
| internal System vars. More... | |
| bool | ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a destination connection. More... | |
| bool | ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a destination connection. More... | |
| bool | ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a source connection. More... | |
| bool | ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a source connection. More... | |
| DisconnectAllDst (FBPlug arg1) | |
| Remove all destination connections. More... | |
| DisconnectAllSrc (FBPlug arg1) | |
| Remove all source connections. More... | |
| bool | DisconnectDst (FBPlug arg1, FBPlug arg2) |
| Remove a destination connection. More... | |
| bool | DisconnectDstAt (FBPlug arg1, object arg2) |
| Remove a destination connection at a specified index. More... | |
| bool | DisconnectSrc (FBPlug arg1, FBPlug arg2) |
| Remove a source connection. More... | |
| bool | DisconnectSrcAt (FBPlug arg1, object arg2) |
| Remove a source connection at a specified index. More... | |
| EndChange (FBPlug arg1) | |
| Ends a change on multiple plugs. More... | |
| object | GetDst (FBPlug arg1, object arg2) |
| Get a destination connection's plug at specified index. More... | |
| int | GetDstCount (FBPlug arg1) |
| Get destination connection count. More... | |
| FBConnectionType | GetDstType (FBPlug arg1, object arg2) |
| Get a destination connection's type at specified index. More... | |
| object | GetOwned (FBPlug arg1, object arg2) |
| Get the owned plug at specified index. More... | |
| int | GetOwnedCount (FBPlug arg1) |
| Get the owned plug count. More... | |
| object | GetOwner (FBPlug arg1) |
| Get the owner of this plug. More... | |
| object | GetSrc (FBPlug arg1, object arg2) |
| Get a source connection's plug at specified index. More... | |
| int | GetSrcCount (FBPlug arg1) |
| Get source connection count. More... | |
| FBConnectionType | GetSrcType (FBPlug arg1, object arg2) |
| Get a source connection's type at specified index. More... | |
| bool | Is (FBPlug arg1, object arg2) |
| Is( int pTypeId ) More... | |
| bool | IsSDKComponent (FBPlug arg1) |
| Return whether or not item is an SDK component. More... | |
| MoveSrcAt (...) | |
| bool | ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a destination connection at a specified index. More... | |
| bool | ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a source connection at a specified index. More... | |
| bool | SwapSrc (FBPlug arg1, object arg2, object arg3) |
| Swap source connection at index A with source connection at index B. More... | |
| SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's self modification flag. More... | |
| bool | GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's self has changed. More... | |
| SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's owned property/object's modification flag. More... | |
| bool | GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's content has changed. More... | |
| int | GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4) |
| Get plug's modified src/dst property/object connection added/removed List. More... | |
| bool | RevertModification (FBPlug arg1, FBPlugModificationFlag arg2) |
| Revert the plug's modification to original status. More... | |
| __init__ (...) | |
| method | staticmethod (function) |
| Public Member Functions inherited from FBPythonWrapper | |
| __reduce__ () | |
| __init__ (...) | |
Additional Inherited Members | |
| Public Attributes inherited from FBProperty | |
| object | Data |
| ORSDK2018::FBString | Name |
| Return to the default scope (private) More... | |
| Public Attributes inherited from FBPythonWrapper | |
| object | OnUnbind |
Member Function Documentation
| bool __contains__ | ( | FBPropertyList | arg1, |
| object | arg2 | ||
| ) |
Python Docstring:
__contains__( (FBPropertyList)arg1, (object)arg2) -> bool
| __delitem__ | ( | FBPropertyList | arg1, |
| int | arg2 | ||
| ) |
Python Docstring:
__delitem__( (FBPropertyList)arg1, (int)arg2) -> None
| object __getitem__ | ( | FBPropertyList | arg1, |
| object | arg2 | ||
| ) |
Python Docstring:
__getitem__( (FBPropertyList)arg1, (object)arg2) -> object
| __init__ | ( | ... | ) |
Python Docstring:
Raises an exception This class cannot be instantiated from Python
| int __len__ | ( | FBPropertyList | arg1 | ) |
Python Docstring:
__len__( (FBPropertyList)arg1) -> int
| __reduce__ | ( | ) |
| __setitem__ | ( | FBPropertyList | arg1, |
| object | arg2, | ||
| object | arg3 | ||
| ) |
Python Docstring:
__setitem__( (FBPropertyList)arg1, (object)arg2, (object)arg3) -> None
| append | ( | FBPropertyList | arg1, |
| object | arg2 | ||
| ) |
Python Docstring:
append( (FBPropertyList)arg1, (object)arg2) -> None
| int count | ( | FBPropertyList | arg1, |
| object | arg2 | ||
| ) |
Python Docstring:
count( (FBPropertyList)arg1, (object)arg2) -> int
| insert | ( | FBPropertyList | arg1, |
| int | arg2, | ||
| object | arg3 | ||
| ) |
Python Docstring:
insert( (FBPropertyList)arg1, (int)arg2, (object)arg3) -> None
| pop | ( | ... | ) |
Python Docstring:
pop( (FBPropertyList)arg1) -> object pop( (FBPropertyList)arg1, (object)arg2) -> object
| remove | ( | FBPropertyList | arg1, |
| object | arg2 | ||
| ) |
Python Docstring:
remove( (FBPropertyList)arg1, (object)arg2) -> None
| removeAll | ( | FBPropertyList | arg1 | ) |
Python Docstring:
removeAll( (FBPropertyList)arg1) -> None