Connections Basic Open Reality SDK Element.
Most elements that are available in the SDK inherit from this base class since FBComponent and FBProperty inherit from FBPlug. Basically, all objects can be connected together because they are all "plugs". To simplify the graph, you can think of a "source" connection as a child, and a "destination" connection as a parent. Also, it is correct to assume that a source affect/work on its destination. For example, a shader applied on an object would be seen as the source while the object is the destination. So FBPlug is a set of functions that enables you to control those connections with flexibility and ease.
Public Member Functions | |
__del__ () | |
Destructor. | |
object | GetHIObject () |
Return an internal pointer. | |
bool | SetHIObject (object pObject, bool pSDKComponent) |
Assign component to an internal pointer. | |
bool | IsSDKComponent () |
Return whether or not item is an SDK component. | |
bool | ConnectSrc (FBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. | |
bool | ConnectDst (FBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. | |
bool | ConnectSrcAt (int pDst_SrcIndex, FBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. | |
bool | ConnectDstAt (int pSrc_DstIndex, FBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. | |
bool | DisconnectDst (FBPlug pDst) |
Remove a destination connection. | |
bool | DisconnectSrc (FBPlug pSrc) |
Remove a source connection. | |
DisconnectAllSrc () | |
Remove all source connections. | |
DisconnectAllDst () | |
Remove all destination connections. | |
bool | DisconnectDstAt (int pIndex) |
Remove a destination connection at a specified index. | |
bool | DisconnectSrcAt (int pIndex) |
Remove a source connection at a specified index. | |
bool | ReplaceDstAt (int pIndex, FBPlug pDst) |
Replace a destination connection at a specified index. | |
bool | ReplaceSrcAt (int pIndex, FBPlug pSrc) |
Replace a source connection at a specified index. | |
bool | SwapSrc (int pIndexA, int pIndexB) |
Swap source connection at index A with source connection at index B. | |
bool | MoveSrcAt (int pIndex, int pAtIndex) |
Move source connection at pIndex to pAtIndex. | |
bool | MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc) |
Move source connection pSrc to the position of pAtSrc. | |
int | GetSrcCount () |
Get source connection count. | |
FBPlug | GetSrc (int pIndex) |
Get a source connection's plug at specified index. | |
FBConnectionType | GetSrcType (int pIndex) |
Get a source connection's type at specified index. | |
int | GetDstCount () |
Get destination connection count. | |
FBPlug | GetDst (int pIndex) |
Get a destination connection's plug at specified index. | |
FBConnectionType | GetDstType (int pIndex) |
Get a destination connection's type at specified index. | |
bool | BeginChange () |
Begins a change on multiple plugs. | |
EndChange () | |
Ends a change on multiple plugs. | |
SetSelfModified (FBPlugModificationFlag pFlag, bool pBool) | |
Set the plug's self modification flag. | |
bool | GetSelfModified (FBPlugModificationFlag pFlag) |
Tell if the plug's self has changed. | |
SetContentModified (FBPlugModificationFlag pFlag, bool pBool) | |
Set the plug's owned property/object's modification flag. | |
bool | GetContentModified (FBPlugModificationFlag pFlag) |
Tell if the plug's content has changed. | |
int | GetPlugConnectionModifiedList (tuple pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) |
Get plug's modified src/dst property/object connection added/removed List. | |
bool | RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask) |
Revert the plug's modification to original status. | |
SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue) | |
Set the plug's status flag. | |
bool | GetStatusFlag (FBPlugStatusFlag pStatus) |
Tell if the plug's status has changed. | |
FBPlug | GetOwner () |
Get the owner of this plug. | |
FBPlug | GetOwned (int pIndex) |
Get the owned plug at specified index. | |
int | GetOwnedCount () |
Get the owned plug count. | |
str | ClassName () |
internal System vars. | |
bool | Is (int pTypeId) |
Is( int pTypeId ). | |
int | GetTypeId () |
GetTypeId( int pTypeId ). | |
bool | PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, pData=None, pDataOld=None, int pDataSize=0) |
PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. | |
bool | PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, pData=None, pDataOld=None, int pDataSize=0) |
PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. | |
bool | PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=None, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug pNewPlug=None) |
PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. | |
IObject_Declare (K_IMPLEMENTATION) | |
ICallback_Declare (K_IMPLEMENTATION) | |
PrintClassDefinitions () | |
Print out internal Class (ID) Definition table. | |
Public Attributes | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
bool | mAllocated |
Contain the Allocation State of the Component. | |
Protected Member Functions | |
__init__ (object pObject) | |
! Constructor Internal use only. | |
FBDelete () | |
Actual destructor for a FBPlug. | |
int | GetInternalClassId () |
Internal class Id. | |
Protected Attributes | |
int | mGlobalTypeInfo |
Represente the Type Index. | |
object | mObject |
Handle on the Plug. | |
bool | mSDKComponent |
bool Plug is an SDK component. |
__init__ | ( | object | pObject | ) | [protected] |
! Constructor Internal use only.
User code shouldn't instantiate FBPlug directly.
Reimplemented in FBApplication, FBAudioIn, FBAudioOut, FBBoxPlaceHolder, FBComponent, FBFCurve, FBFilter, FBGenericMenu, FBGenericMenuItem, FBKeyControl, FBModelPlaceHolder, FBModelTemplate, FBPlayerControl, FBProfiler, FBReferenceTime, FBRenderer, FBVideoGrabber, FBVideoIn, and FBVideoOut.
FBDelete | ( | ) | [protected] |
Actual destructor for a FBPlug.
It should never be called from client code. This is meant for internal use only!
Reimplemented in FBActor, FBActorFace, FBAnimationLayer, FBAudioClip, FBCharacter, FBCharacterExtension, FBCharacterFace, FBComponent, FBFCurve, FBFolder, FBGenericMenu, FBGroup, FBImage, FBKeyingGroup, FBLayeredTexture, FBModel, FBMotionClip, FBSet, FBStoryClip, FBStoryFolder, FBStoryTrack, FBTake, FBTexture, and FBVideoClip.
__del__ | ( | ) |
object GetHIObject | ( | ) |
Return an internal pointer.
bool IsSDKComponent | ( | ) |
Return whether or not item is an SDK component.
bool ConnectSrc | ( | FBPlug | pSrc, |
FBConnectionType | pConnectionType = kFBConnectionTypeNone |
||
) |
Add a source connection.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool ConnectDst | ( | FBPlug | pDst, |
FBConnectionType | pConnectionType = kFBConnectionTypeNone |
||
) |
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool ConnectSrcAt | ( | int | pDst_SrcIndex, |
FBPlug | pSrc, | ||
FBConnectionType | pConnectionType = kFBConnectionTypeNone |
||
) |
Add a source connection.
pDst_SrcIndex | Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end. |
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool ConnectDstAt | ( | int | pSrc_DstIndex, |
FBPlug | pDst, | ||
FBConnectionType | pConnectionType = kFBConnectionTypeNone |
||
) |
Add a destination connection.
pSrc_DstIndex | Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
Remove a destination connection.
pDst | Destination plug. |
Remove a source connection.
pSrc | Source plug. |
DisconnectAllSrc | ( | ) |
Remove all source connections.
DisconnectAllDst | ( | ) |
Remove all destination connections.
Remove a destination connection at a specified index.
pIndex | Destination plug index. |
Remove a source connection at a specified index.
pIndex | Source plug index. |
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
Move source connection at pIndex to pAtIndex.
pIndex | Plug current index. |
pAtIndex | Plug new index. |
Move source connection pSrc to the position of pAtSrc.
pSrc | Plug. |
pAtSrc | Plug that mark where we want to insert (will insert before this one). |
int GetSrcCount | ( | ) |
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
FBConnectionType GetSrcType | ( | int | pIndex | ) |
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
int GetDstCount | ( | ) |
Get destination connection count.
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
FBConnectionType GetDstType | ( | int | pIndex | ) |
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
bool BeginChange | ( | ) |
Begins a change on multiple plugs.
EndChange | ( | ) |
Ends a change on multiple plugs.
SetSelfModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) |
Set the plug's self modification flag.
pFlag | bitwise AND of self modification flags. |
pBool | true if self changed. |
bool GetSelfModified | ( | FBPlugModificationFlag | pFlag | ) |
Tell if the plug's self has changed.
pFlag | bitwise AND of self modification flags. |
SetContentModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) |
Set the plug's owned property/object's modification flag.
pFlag | bitwise AND of content modification flags. |
pBool | true if content has modification. |
bool GetContentModified | ( | FBPlugModificationFlag | pFlag | ) |
Tell if the plug's content has changed.
pFlag | bitwise AND of content modification flags. |
int GetPlugConnectionModifiedList | ( | tuple | pPlugList, |
FBPlugModificationFlag | pConnectionModificatonFlag, | ||
bool | pAddRemove | ||
) |
Get plug's modified src/dst property/object connection added/removed List.
pPlugList | plug list to fill up. |
pConnectionModificatonFlag | Src/Dst Property/Object connection modification flag. |
pAddRemove | Ask for the added list if true, removed list if false. |
bool RevertModification | ( | FBPlugModificationFlag | pFlag = kFBAllModifiedMask | ) |
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
SetStatusFlag | ( | FBPlugStatusFlag | pStatus, |
bool | pValue | ||
) |
Set the plug's status flag.
pStatus | bitwise AND of status flags. |
pValue | true if status has modification. |
bool GetStatusFlag | ( | FBPlugStatusFlag | pStatus | ) |
Tell if the plug's status has changed.
pStatus | bitwise AND of self modification flags. |
FBPlug GetOwner | ( | ) |
Get the owner of this plug.
Very useful for properties since they are plugs too.
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
int GetOwnedCount | ( | ) |
str ClassName | ( | ) |
pTypeId | Type Identification. |
Reimplemented in FBComponent.
int GetTypeId | ( | ) |
bool PlugDataNotify | ( | FBConnectionAction | pAction, |
FBPlug | pThis, | ||
pData | = None , |
||
pDataOld | = None , |
||
int | pDataSize = 0 |
||
) |
PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pData | Current data, meaning depends of plug action. |
pDataOld | Previous data, meaning depends of plug action. |
pDataSize | Size of data. |
bool PlugStateNotify | ( | FBConnectionAction | pAction, |
FBPlug | pThis, | ||
pData | = None , |
||
pDataOld | = None , |
||
int | pDataSize = 0 |
||
) |
PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pData | Current data, meaning depends of plug action. |
pDataOld | Previous data, meaning depends of plug action. |
pDataSize | Size of data. |
bool PlugNotify | ( | FBConnectionAction | pAction, |
FBPlug | pThis, | ||
int | pIndex, | ||
FBPlug | pPlug = None , |
||
FBConnectionType | pConnectionType = kFBConnectionTypeNone , |
||
FBPlug | pNewPlug = None |
||
) |
PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
pAction | Plug action, the event type. |
pThis | Plug concerned. |
pIndex | Index of the plug. |
pPlug | Other plug concerned. |
pConnectionType | Connection type between the plugs. |
pNewPlug | New plug (for the replace event). |
IObject_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented in FBActorFace, FBAssetFile, FBAssetFolder, FBAssetMng, FBBox, FBCharacter, FBCharacterFace, FBComponent, FBConstraint, FBDeck, FBDevice, FBMotionClip, and FBShader.
ICallback_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented in FBComponent, and FBModel.
PrintClassDefinitions | ( | ) |
Print out internal Class (ID) Definition table.
For internal debug purpose only.
int GetInternalClassId | ( | ) | [protected] |
ClassGroupName of the object.
Contain the Allocation State of the Component.
int mGlobalTypeInfo [protected] |
Represente the Type Index.
Handle on the Plug.
bool mSDKComponent [protected] |
bool Plug is an SDK component.