FBPropertyListObject Class Reference
FBPropertyListObject Class Reference
#include <mainpage.h>
Class Description
List of scene objects.
This list is a more generic container often used as object properties. The types of actual object that it can contain can be specialized.
In Python: This container supports most of the list interface, but is limited to contain only FBComponent objects. New objects can be added, or objects in the list can be removed. The cardinality of the list and the use of the contained object will vary according the container object type. This class supports slice access for query, but not for assignment.
Inheritance diagram for FBPropertyListObject:
Public Member Functions | |
| __reduce__ () | |
| SetSingleConnect (FBPropertyListObject arg1, object arg2) | |
| Set if the connection is single or multiple. More... | |
| bool | GetSingleConnect (FBPropertyListObject arg1) |
| Get if the connection support only one connection. More... | |
| __init__ (...) | |
| Public Member Functions inherited from FBPropertyListComponent | |
| __reduce__ () | |
| object | __getitem__ (FBPropertyListComponent arg1, object arg2) |
| int | __len__ (FBPropertyListComponent arg1) |
| __setitem__ (FBPropertyListComponent arg1, object arg2, object arg3) | |
| __delitem__ (FBPropertyListComponent arg1, int arg2) | |
| bool | __contains__ (FBPropertyListComponent arg1, object arg2) |
| append (FBPropertyListComponent arg1, object arg2) | |
| int | count (FBPropertyListComponent arg1, object arg2) |
| insert (FBPropertyListComponent arg1, int arg2, object arg3) | |
| remove (FBPropertyListComponent arg1, object arg2) | |
| removeAll (FBPropertyListComponent 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
| __init__ | ( | ... | ) |
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.
| __reduce__ | ( | ) |
| bool GetSingleConnect | ( | FBPropertyListObject | arg1 | ) |
Get if the connection support only one connection.
Python Docstring:
GetSingleConnect( (FBPropertyListObject)arg1) -> bool
C++ Signature:
int GetSingleConnect()
- Returns
- true is the connection support only one connection.
| SetSingleConnect | ( | FBPropertyListObject | arg1, |
| object | arg2 | ||
| ) |
Set if the connection is single or multiple.
Python Docstring:
SetSingleConnect( (FBPropertyListObject)arg1, (object)arg2) -> None
C++ Signature:
void SetSingleConnect(bool pSingleConnect)
- Parameters
-
pSingleConnect set to true for only one connection allowed.