FBPlug Class Reference

FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug FBPlug

Inheritance diagram for FBPlug:

[legend]

List of all members.

---

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.

See samples: FBConstraintManager.py, FBFolder.py.

Public Member Functions
	FBPlug ()
	Constructor.
bool	BeginChange ()
	Begins a change on multiple plugs.
str	ClassName ()
	internal System vars.
K_DEPRECATED bool	ConnectAt (FBPlug pSrc, int pSrc_DstIndex, FBPlug pDst, int pDst_SrcIndex, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Make connection between to plug, specifying the connection index.
bool	ConnectDst (FBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
bool	ConnectDstAt (int pSrc_DstIndex, FBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
bool	ConnectSrc (FBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
	DisconnectAllDst ()
	Remove all destination connections.
	DisconnectAllSrc ()
	Remove all source connections.
bool	DisconnectDst (FBPlug pDst)
	Remove a destination connection.
bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specifyed index.
bool	DisconnectSrc (FBPlug pSrc)
	Remove a source connection.
bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specifyed index.
	EndChange ()
	Ends a change on multiple plugs.
FBPlug	GetDst (int pIndex)
	Get a destination connection's plug at specifyed index.
int	GetDstCount ()
	Get destination connection count.
FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specifyed index.
FBPlug	GetOwned (int pIndex)
	Get the owned plug at specifyed index.
int	GetOwnedCount ()
	Get the owned plug count.
FBPlug	GetOwner ()
	Get the owner of this plug.
int	GetOwnerCount ()
	Get the owner count of this plug.
FBPlug	GetSrc (int pIndex)
	Get a source connection's plug at specifyed index.
int	GetSrcCount ()
	Get source connection count.
FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specifyed index.
bool	Is (int pTypeId)
	Is( int pTypeId ).
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.
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.
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.

---

Constructor & Destructor Documentation

FBPlug

(

)

Constructor.

---

Member Function Documentation

bool BeginChange

(

)

Begins a change on multiple plugs.

Returns:

A boolean indicating success (True) or failure (False).

str ClassName

(

)

internal System vars.

Reimplemented in FBComponent.

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

Make connection between to plug, specifying the connection index.

(Deprecated)

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

bool ConnectDst	(	FBPlug	pDst,
		FBConnectionType	pConnectionType = kFBConnectionTypeNone
	)

Add a destination connection.

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

bool ConnectDstAt	(	int	pSrc_DstIndex,
		FBPlug	pDst,
		FBConnectionType	pConnectionType = kFBConnectionTypeNone
	)

Add a destination connection.

Parameters:

	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.

Returns:

A boolean indicating success (True) or failure (False).

bool ConnectSrc	(	FBPlug	pSrc,
		FBConnectionType	pConnectionType = kFBConnectionTypeNone
	)

Add a source connection.

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

bool ConnectSrcAt	(	int	pDst_SrcIndex,
		FBPlug	pSrc,
		FBConnectionType	pConnectionType = kFBConnectionTypeNone
	)

Add a source connection.

Parameters:

	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.

Returns:

A boolean indicating success (True) or failure (False).

DisconnectAllDst

(

)

Remove all destination connections.

DisconnectAllSrc

(

)

Remove all source connections.

bool DisconnectDst

(

FBPlug

pDst

)

Remove a destination connection.

Parameters:

pDst

Destination plug.

Returns:

A boolean indicating success (True) or failure (False).

bool DisconnectDstAt

(

int

pIndex

)

Remove a destination connection at a specifyed index.

Parameters:

pIndex

Destination plug index.

Returns:

A boolean indicating success (True) or failure (False).

bool DisconnectSrc

(

FBPlug

pSrc

)

Remove a source connection.

Parameters:

pSrc

Source plug.

Returns:

A boolean indicating success (True) or failure (False).

bool DisconnectSrcAt

(

int

pIndex

)

Remove a source connection at a specifyed index.

Parameters:

pIndex

Source plug index.

Returns:

A boolean indicating success (True) or failure (False).

EndChange

(

)

Ends a change on multiple plugs.

FBPlug GetDst

(

int

pIndex

)

Get a destination connection's plug at specifyed index.

Parameters:

pIndex

Index of the destination connection's plug.

Returns:

Destination plug at specifyed index.

int GetDstCount

(

)

Get destination connection count.

Returns:

Total destinations connections count.

FBConnectionType GetDstType

(

int

pIndex

)

Get a destination connection's type at specifyed index.

Parameters:

pIndex

Index of the destination connection's type.

Returns:

Destination connection's type at specifyed index.

FBPlug GetOwned

(

int

pIndex

)

Get the owned plug at specifyed index.

Parameters:

pIndex

Index of the owned plug to get.

Returns:

The owned plug at specifyed index.

int GetOwnedCount

(

)

Get the owned plug count.

Returns:

The owned plug count.

FBPlug GetOwner

(

)

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:

The owner of this plug.

int GetOwnerCount

(

)

Get the owner count of this plug.

(Obsolete)

Returns:

The owner count of this plug (will always return 1).

FBPlug GetSrc

(

int

pIndex

)

Get a source connection's plug at specifyed index.

Parameters:

pIndex

Index of the source connection's plug.

Returns:

Source plug at specifyed index.

int GetSrcCount

(

)

Get source connection count.

Returns:

Total sources connections count.

FBConnectionType GetSrcType

(

int

pIndex

)

Get a source connection's type at specifyed index.

Parameters:

pIndex

Index of the source connection's type.

Returns:

Source connection's type at specifyed index.

bool Is

(

int

pTypeId

)

Is( int pTypeId ).

Parameters:

pTypeId

Type Identifiant.

Returns:

True if Plug is a Instance of pTypeId.

Reimplemented in FBComponent.

bool IsSDKComponent

(

)

Return whether or not item is an SDK component.

bool MoveSrcAt	(	int	pIndex,
		int	pAtIndex
	)

Move source connection at pIndex to pAtIndex.

Parameters:

	pIndex	Plug current index.
	pAtIndex	Plug new index.

Returns:

A boolean indicating success (True) or failure (False).

Remarks:

This is not like the swap function since the connection at pAtIndex is untouched.

bool MoveSrcAt	(	FBPlug	pSrc,
		FBPlug	pAtSrc
	)

Move source connection pSrc to the position of pAtSrc.

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

Remarks:

This is not like the swap function since the connection at pAtSrc is untouched.

bool ReplaceDstAt	(	int	pIndex,
		FBPlug	pDst
	)

Replace a destination connection at a specifyed index.

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

bool ReplaceSrcAt	(	int	pIndex,
		FBPlug	pSrc
	)

Replace a source connection at a specifyed index.

Parameters:

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

Returns:

A boolean indicating success (True) or failure (False).

bool SwapSrc	(	int	pIndexA,
		int	pIndexB
	)

Swap source connection at index A with source connection at index B.

Parameters:

	pIndexA	Plug index.
	pIndexB	Other plug index.

Returns:

A boolean indicating success (True) or failure (False).

---