FBPlug Class Reference

#include <mobu-python-api.h>

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

See the C++ reference

Inheritance diagram for FBPlug:

Public Member Functions
	__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 FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__

(

...

)

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

__reduce__

(

)

bool BeginChange

(

FBPlug

arg1

)

Begins a change on multiple plugs.

Python Docstring:

BeginChange( (FBPlug)arg1) -> bool 

C++ Signature:

bool BeginChange() 

Returns

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

See the C++ reference

str ClassName

(

FBPlug

arg1

)

internal System vars.

Python Docstring:

ClassName( (FBPlug)arg1) -> str 

C++ Signature:

const char * ClassName() 

See the C++ reference

bool ConnectDst	(	FBPlug	arg1,
		FBPlug	arg2,
		FBConnectionType	arg3
	)

Add a destination connection.

Python Docstring:

ConnectDst( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectDst(ORSDK2018::FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

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)

See the C++ reference

bool ConnectDstAt	(	FBPlug	arg1,
		object	arg2,
		FBPlug	arg3,
		FBConnectionType	arg4
	)

Add a destination connection.

Python Docstring:

ConnectDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

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

Parameters

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.

Returns

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

See the C++ reference

bool ConnectSrc	(	FBPlug	arg1,
		FBPlug	arg2,
		FBConnectionType	arg3
	)

Add a source connection.

Python Docstring:

ConnectSrc( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectSrc(ORSDK2018::FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

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

See the C++ reference

bool ConnectSrcAt	(	FBPlug	arg1,
		object	arg2,
		FBPlug	arg3,
		FBConnectionType	arg4
	)

Add a source connection.

Python Docstring:

ConnectSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

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

Parameters

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.

Returns

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

See the C++ reference

DisconnectAllDst

(

FBPlug

arg1

)

Remove all destination connections.

Python Docstring:

DisconnectAllDst( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllDst() 

See the C++ reference

DisconnectAllSrc

(

FBPlug

arg1

)

Remove all source connections.

Python Docstring:

DisconnectAllSrc( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllSrc() 

See the C++ reference

bool DisconnectDst	(	FBPlug	arg1,
		FBPlug	arg2
	)

Remove a destination connection.

Python Docstring:

DisconnectDst( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectDst(ORSDK2018::FBPlug * pDst) 

Parameters

pDst	Destination plug.

Returns

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

See the C++ reference

bool DisconnectDstAt	(	FBPlug	arg1,
		object	arg2
	)

Remove a destination connection at a specified index.

Python Docstring:

DisconnectDstAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectDstAt(int pIndex) 

Parameters

pIndex

Destination plug index.

Returns

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

See the C++ reference

bool DisconnectSrc	(	FBPlug	arg1,
		FBPlug	arg2
	)

Remove a source connection.

Python Docstring:

DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectSrc(ORSDK2018::FBPlug * pSrc) 

Parameters

pSrc	Source plug.

Returns

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

See the C++ reference

bool DisconnectSrcAt	(	FBPlug	arg1,
		object	arg2
	)

Remove a source connection at a specified index.

Python Docstring:

DisconnectSrcAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectSrcAt(int pIndex) 

Parameters

pIndex

Source plug index.

Returns

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

See the C++ reference

EndChange

(

FBPlug

arg1

)

Ends a change on multiple plugs.

Python Docstring:

EndChange( (FBPlug)arg1) -> None 

C++ Signature:

void EndChange() 

See the C++ reference

bool GetContentModified	(	FBPlug	arg1,
		FBPlugModificationFlag	arg2
	)

Tell if the plug's content has changed.

Python Docstring:

GetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetContentModified(FBPlugModificationFlag pFlag) 

Parameters

pFlag

bitwise AND of content modification flags.

Returns

true if content connection changed.

See the C++ reference

object GetDst	(	FBPlug	arg1,
		object	arg2
	)

Get a destination connection's plug at specified index.

Python Docstring:

GetDst( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

ORSDK2018::FBPlug * GetDst(int pIndex) 

Parameters

pIndex

Index of the destination connection's plug.

Returns

Destination plug at specified index.

See the C++ reference

int GetDstCount

(

FBPlug

arg1

)

Get destination connection count.

Python Docstring:

GetDstCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetDstCount() 

Returns

Total destinations connections count.

See the C++ reference

FBConnectionType GetDstType	(	FBPlug	arg1,
		object	arg2
	)

Get a destination connection's type at specified index.

Python Docstring:

GetDstType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetDstType(int pIndex) 

Parameters

pIndex

Index of the destination connection's type.

Returns

Destination connection's type at specified index.

See the C++ reference

object GetOwned	(	FBPlug	arg1,
		object	arg2
	)

Get the owned plug at specified index.

Python Docstring:

GetOwned( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

ORSDK2018::FBPlug * GetOwned(int pIndex) 

Parameters

pIndex

Index of the owned plug to get.

Returns

The owned plug at specified index.

See the C++ reference

int GetOwnedCount

(

FBPlug

arg1

)

Get the owned plug count.

Python Docstring:

GetOwnedCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetOwnedCount() 

Returns

The owned plug count.

See the C++ reference

object GetOwner

(

FBPlug

arg1

)

Get the owner of this plug.

Python Docstring:

GetOwner( (FBPlug)arg1) -> object 

C++ Signature:

ORSDK2018::FBPlug * GetOwner() 

Very useful for properties since they are plugs too.

Returns

The owner of this plug.

See the C++ reference

int GetPlugConnectionModifiedList	(	FBPlug	arg1,
		FBPlugList	arg2,
		FBPlugModificationFlag	arg3,
		object	arg4
	)

Get plug's modified src/dst property/object connection added/removed List.

Python Docstring:

GetPlugConnectionModifiedList( (FBPlug)arg1, (FBPlugList)arg2, (FBPlugModificationFlag)arg3, (object)arg4) -> int 

C++ Signature:

int GetPlugConnectionModifiedList(FBPlugList & pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) 

Parameters

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.

Returns

count of list;

See the C++ reference

bool GetSelfModified	(	FBPlug	arg1,
		FBPlugModificationFlag	arg2
	)

Tell if the plug's self has changed.

Python Docstring:

GetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetSelfModified(FBPlugModificationFlag pFlag) 

Parameters

pFlag

bitwise AND of self modification flags.

Returns

true if self changed

See the C++ reference

object GetSrc	(	FBPlug	arg1,
		object	arg2
	)

Get a source connection's plug at specified index.

Python Docstring:

GetSrc( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

ORSDK2018::FBPlug * GetSrc(int pIndex) 

Parameters

pIndex

Index of the source connection's plug.

Returns

Source plug at specified index.

See the C++ reference

int GetSrcCount

(

FBPlug

arg1

)

Get source connection count.

Python Docstring:

GetSrcCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetSrcCount() 

Returns

Total sources connections count.

See the C++ reference

FBConnectionType GetSrcType	(	FBPlug	arg1,
		object	arg2
	)

Get a source connection's type at specified index.

Python Docstring:

GetSrcType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetSrcType(int pIndex) 

Parameters

pIndex

Index of the source connection's type.

Returns

Source connection's type at specified index.

See the C++ reference

bool Is	(	FBPlug	arg1,
		object	arg2
	)

Is( int pTypeId )

Python Docstring:

Is( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool Is(int pTypeId) 

Parameters

pTypeId

Type Identification.

Returns

True if Plug is a Instance of pTypeId.

See the C++ reference

bool IsSDKComponent

(

FBPlug

arg1

)

Return whether or not item is an SDK component.

Python Docstring:

IsSDKComponent( (FBPlug)arg1) -> bool 

C++ Signature:

bool IsSDKComponent() 

See the C++ reference

MoveSrcAt

(

...

)

Python Docstring:

MoveSrcAt( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool

MoveSrcAt( (FBPlug)arg1, (FBPlug)arg2, (FBPlug)arg3) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool MoveSrcAt(int pIndex, int pAtIndex)
bool MoveSrcAt(ORSDK2018::FBPlug * pSrc, ORSDK2018::FBPlug * pAtSrc)

bool ReplaceDstAt	(	FBPlug	arg1,
		object	arg2,
		FBPlug	arg3
	)

Replace a destination connection at a specified index.

Python Docstring:

ReplaceDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceDstAt(int pIndex, ORSDK2018::FBPlug * pDst) 

Parameters

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

Returns

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

See the C++ reference

bool ReplaceSrcAt	(	FBPlug	arg1,
		object	arg2,
		FBPlug	arg3
	)

Replace a source connection at a specified index.

Python Docstring:

ReplaceSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceSrcAt(int pIndex, ORSDK2018::FBPlug * pSrc) 

Parameters

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

Returns

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

See the C++ reference

bool RevertModification	(	FBPlug	arg1,
		FBPlugModificationFlag	arg2
	)

Revert the plug's modification to original status.

Python Docstring:

RevertModification( (FBPlug)arg1 [, (FBPlugModificationFlag)arg2]) -> bool 

C++ Signature:

bool RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask) 

Parameters

pFlag

the type of modification to be reverted.

Returns

true if revert successfully.

See the C++ reference

SetContentModified	(	FBPlug	arg1,
		FBPlugModificationFlag	arg2,
		object	arg3
	)

Set the plug's owned property/object's modification flag.

Python Docstring:

SetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetContentModified(FBPlugModificationFlag pFlag, bool pBool) 

Parameters

pFlag	bitwise AND of content modification flags.
pBool	true if content has modification.

See the C++ reference

SetSelfModified	(	FBPlug	arg1,
		FBPlugModificationFlag	arg2,
		object	arg3
	)

Set the plug's self modification flag.

Python Docstring:

SetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool) 

Parameters

pFlag	bitwise AND of self modification flags.
pBool	true if self changed.

See the C++ reference

method staticmethod

(

function

)

Python Docstring:

staticmethod(function) -> method

Convert a function to be a static method.

A static method does not receive an implicit first argument.
To declare a static method, use this idiom:

     class C:
     def f(arg1, arg2, ...): ...
     f = staticmethod(f)

It can be called either on the class (e.g. C.f()) or on an instance
(e.g. C().f()).  The instance is ignored except for its class.

Static methods in Python are similar to those found in Java or C++.
For a more advanced concept, see the classmethod builtin. 

bool SwapSrc	(	FBPlug	arg1,
		object	arg2,
		object	arg3
	)

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

Python Docstring:

SwapSrc( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool SwapSrc(int pIndexA, int pIndexB) 

Parameters

pIndexA	Plug index.
pIndexB	Other plug index.

Returns

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

See the C++ reference