Detailed Description

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 applyed 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.

Examples: BasicOperations/FBConstraintManager.py, BasicOperations/FBFolder.py

Inheritance diagram for FBPlug:

[legend]

List of all members.

Public Member Functions
	__init__ (object pObject)
	Constructor.
	__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	ConnectAt (FBPlug pSrc, int pSrc_DstIndex, FBPlug pDst, int pDst_SrcIndex, FBConnectionType pConnectionType=kFBConnectionTypeNone)
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 specifyed index.
bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specifyed index.
bool	ReplaceDstAt (int pIndex, FBPlug pDst)
	Replace a destination connection at a specifyed index.
bool	ReplaceSrcAt (int pIndex, FBPlug pSrc)
	Replace a source connection at a specifyed 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 specifyed index.
FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specifyed index.
int	GetDstCount ()
	Get destination connection count.
FBPlug	GetDst (int pIndex)
	Get a destination connection's plug at specifyed index.
FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specifyed index.
bool	BeginChange ()
	Begins a change on multiple plugs.
	EndChange ()
	Ends a change on multiple plugs.
FBPlug	GetOwner ()
	Get the owner of this plug.
int	GetOwnerCount ()
	Get the owner count of this plug.
FBPlug	GetOwned (int pIndex)
	Get the owned plug at specifyed 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 (Implementation)
	ICallback_Declare (Implementation)
Public Attributes
int	TypeInfo
	TypeInfo.
bool	mAllocated
	Contain the Allocation State of the Component.
Protected Member Functions
	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.

Member Function Documentation

__init__ ( object pObject )

bool ConnectSrc	(	FBPlug	pSrc,
		FBConnectionType	pConnectionType = `kFBConnectionTypeNone`
	)

pSrc	Source plug.
pConnectionType	Type of connection, taken from FBConnectionType. Default value should work in all cases.

bool ConnectDst	(	FBPlug	pDst,
		FBConnectionType	pConnectionType = `kFBConnectionTypeNone`
	)

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`
	)

pDst_SrcIndex	Index that tells where to add this source connection in the destination's connection list.
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`
	)

pSrc_DstIndex	Index that tells where to add this destination connection in the source's connection list.
pDst	Destination plug.
pConnectionType	Type of connection, taken from FBConnectionType. Default value should work in all cases.

bool ConnectAt	(	FBPlug	pSrc,
		int	pSrc_DstIndex,
		FBPlug	pDst,
		int	pDst_SrcIndex,
		FBConnectionType	pConnectionType = `kFBConnectionTypeNone`
	)

pIndex	Destination plug index.
pDst	Plug that will replace the other at index.

pSrc	Plug.
pAtSrc	Plug that mark where we want to insert (will insert before this one).

pIndex	Source plug index.
pSrc	Plug that will replace the other at index.

bool PlugDataNotify	(	FBConnectionAction	pAction,
		FBPlug	pThis,
		pData	= `None`,
		pDataOld	= `None`,
		int	pDataSize = `0`
	)

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`
	)

bool PlugNotify	(	FBConnectionAction	pAction,
		FBPlug	pThis,
		int	pIndex,
		FBPlug	pPlug = `None`,
		FBConnectionType	pConnectionType = `kFBConnectionTypeNone`,
		FBPlug	pNewPlug = `None`
	)

FBPlug Class Reference

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation