This reference page is linked to from the following overview topics: Object Model, FBComponent - The Base Entity Class, FBPlug - Object Connection Management.

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.

Definition at line 136 of file fbplug.h.

#include <fbplug.h>

Inheritance diagram for FBPlug:

[legend]

List of all members.

Public Member Functions
	FBPlug (HIObject pObject)
	Constructor.
virtual	~FBPlug ()
	Destructor.
virtual HIObject	GetHIObject () const
	Return an internal pointer.
virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent)
	Assign component to an internal pointer.
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.
bool	ConnectSrc (HFBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
bool	ConnectDst (HFBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
bool	ConnectSrcAt (int pDst_SrcIndex, HFBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.
bool	ConnectDstAt (int pSrc_DstIndex, HFBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.
K_DEPRECATED bool	ConnectAt (HFBPlug pSrc, int pSrc_DstIndex, HFBPlug pDst, int pDst_SrcIndex, FBConnectionType pConnectionType=kFBConnectionTypeNone)
bool	DisconnectDst (HFBPlug pDst)
	Remove a destination connection.
bool	DisconnectSrc (HFBPlug pSrc)
	Remove a source connection.
void	DisconnectAllSrc ()
	Remove all source connections.
void	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, HFBPlug pDst)
	Replace a destination connection at a specifyed index.
bool	ReplaceSrcAt (int pIndex, HFBPlug 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 (HFBPlug pSrc, HFBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.
int	GetSrcCount ()
	Get source connection count.
HFBPlug	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.
HFBPlug	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.
void	EndChange ()
	Ends a change on multiple plugs.
HFBPlug	GetOwner ()
	Get the owner of this plug.
int	GetOwnerCount ()
	Get the owner count of this plug.
HFBPlug	GetOwned (int pIndex)
	Get the owned plug at specifyed index.
int	GetOwnedCount ()
	Get the owned plug count.
virtual char *	ClassName ()
	internal System vars.
virtual bool	Is (int pTypeId)
	Is( int pTypeId )
virtual int	GetTypeId ()
	GetTypeId( int pTypeId )
virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	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
bool	mAllocated
	Contain the Allocation State of the Component.
Static Public Attributes
static int	TypeInfo
	TypeInfo.
Protected Member Functions
virtual void	FBDelete ()
	Actual destructor for a FBPlug.
Static Protected Member Functions
static int	GetInternalClassId ()
	Internal class Id.
Protected Attributes
HIObject	mObject
	Handle on the Plug.
bool	mSDKComponent
	bool Plug is an SDK component.
Static Protected Attributes
static int	mGlobalTypeInfo
	Represente the Type Index.

Constructor & Destructor Documentation

FBPlug ( HIObject pObject )

Constructor.

virtual ~FBPlug ( ) [virtual]

Destructor.

Member Function Documentation

virtual HIObject GetHIObject ( ) const [virtual]

virtual bool SetHIObject	(	HIObject	pObject,
		bool	pSDKComponent
	)		`[virtual]`

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

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

bool ConnectDst	(	HFBPlug	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,
		HFBPlug	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,
		HFBPlug	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.

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

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

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

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

virtual bool PlugDataNotify	(	FBConnectionAction	pAction,
		FBPlug *	pThis,
		void *	pData = `NULL`,
		void *	pDataOld = `NULL`,
		int	pDataSize = `0`
	)		`[virtual]`

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.

virtual bool PlugStateNotify	(	FBConnectionAction	pAction,
		FBPlug *	pThis,
		void *	pData = `NULL`,
		void *	pDataOld = `NULL`,
		int	pDataSize = `0`
	)		`[virtual]`

virtual bool PlugNotify	(	FBConnectionAction	pAction,
		FBPlug *	pThis,
		int	pIndex,
		FBPlug *	pPlug = `NULL`,
		FBConnectionType	pConnectionType = `kFBConnectionTypeNone`,
		FBPlug *	pNewPlug = `NULL`
	)		`[virtual]`

FBPlug Class Reference

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation