fbplug.h File Reference

---

Detailed Description

fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h fbplug.h

Definition of the class FBPlug and related enums and utility functions.

All the Open Reality objects that expose application objects will inherit from FBPlug.

Definition in file fbplug.h.

#include <kaydaradef.h>
#include <object/i/icallback.h>
#include <fbsdk/fbdefines.h>
#include <fbsdk/fbscriptwrapper.h>

Include dependency graph for fbplug.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	FBPlug
	Connections Basic Open Reality SDK Element. More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once.
Enumerations
enum	FBConnectionAction {    kFBRequestConnectSrc,    kFBRequestConnectDst,    kFBConnectSrc,    kFBConnectDst,    kFBConnectedSrc,    kFBConnectedDst,    kFBDisconnectSrc,    kFBDisconnectDst,    kFBDisconnectedSrc,    kFBDisconnectedDst,    kFBBeginReplaceSrc,    kFBEndReplaceSrc,    kFBBeginReplaceDst,    kFBEndReplaceDst,    kFBReorderSrc,    kFBReorderedSrc,    kFBBeginChange,    kFBEndChange,    kFBConnectedOwner,    kFBDisconnectOwner,    kFBCandidate,    kFBCandidated,    kFBCandidateGlobal,    kFBDetached,    kFBDestroy,    kFBSelect,    kFBUnselect,    kFBReselect,    kFBRename,    kFBRenamed,    kFBPrefixRename,    kFBPrefixRenamed,    kFBDescription,    kFBConnect = kFBConnectSrc,    kFBConnected = kFBConnectedSrc,    kFBDisconnect = kFBDisconnectSrc,    kFBDisconnected = kFBDisconnectedSrc }
	Possible actions when a notify plug event occurs. More...
enum	FBConnectionType {    kFBConnectionTypeNone,    kFBConnectionTypeSystem,    kFBConnectionTypeUnidirectional }
	Connection types available between plugs. More...
Functions
K_DLLIMPORT bool	FBConnect (HFBPlug pSrc, HFBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Request the connection two FBPlug objects.
K_DLLIMPORT bool	FBDisconnect (HFBPlug pSrc, HFBPlug pDst)
	Connect two FBPlug objects.

---

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once.

..

Definition at line 51 of file fbplug.h.

---

Enumeration Type Documentation

enum FBConnectionAction

Possible actions when a notify plug event occurs.

Enumerator:

kFBRequestConnectSrc	Request connection of source to destination.
kFBRequestConnectDst	Request connection of destination to source.
kFBConnectSrc	Connect source to destination.
kFBConnectDst	Connect destination to source.
kFBConnectedSrc	Connected source to destination.
kFBConnectedDst	Connected destination to source.
kFBDisconnectSrc	Disconnect source from destination.
kFBDisconnectDst	Disconnect destination from source.
kFBDisconnectedSrc	Disconnected source from destination.
kFBDisconnectedDst	Disconnected destination from source.
kFBBeginReplaceSrc	Begin replace source during merge.
kFBEndReplaceSrc	End replace source during merge.
kFBBeginReplaceDst	Begin replace destination during merge.
kFBEndReplaceDst	End replace destination during merge.
kFBReorderSrc	Reorder of source.
kFBReorderedSrc	Source has been reordered.
kFBBeginChange	Begin change on destination.
kFBEndChange	End change on destination.
kFBConnectedOwner	Connected owner to destination.
kFBDisconnectOwner	Disconnect owner from destination.
kFBCandidate	Data candidate event, before the data is set.
kFBCandidated	Data candidate event, after the data is set.
kFBCandidateGlobal	Data candidate event, global candidate.
kFBDetached	Component detached from scene.
kFBDestroy	Component destroy.
kFBSelect	Component selection.
kFBUnselect	Component de-selection.
kFBReselect	Component re-selection.
kFBRename	Component is going to be renamed.
kFBRenamed	Component has been renamed.
kFBPrefixRename	Component prefix is going to be renamed.
kFBPrefixRenamed	Component prefix has been renamed.
kFBDescription	Component description event.
kFBConnect
kFBConnected
kFBDisconnect
kFBDisconnected

Definition at line 70 of file fbplug.h.

enum FBConnectionType

Connection types available between plugs.

Enumerator:

kFBConnectionTypeNone	Default connection type.
kFBConnectionTypeSystem	System connection type.
kFBConnectionTypeUnidirectional	Unidirectional connection type.

Definition at line 120 of file fbplug.h.

---

Function Documentation

K_DLLIMPORT bool FBConnect	(	HFBPlug	pSrc,
		HFBPlug	pDst,
		FBConnectionType	pConnectionType = kFBConnectionTypeNone
	)

Request the connection two FBPlug objects.

Parameters:

	pSrc	Source plug.
	pDst	Destination plug.
	pConnectionType	Type of connection, taken from FBConnectionType.

Returns:

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

Remarks:

This global function is used primarily to connect connectors in a FBConstraintRelation.

K_DLLIMPORT bool FBDisconnect	(	HFBPlug	pSrc,
		HFBPlug	pDst
	)

Connect two FBPlug objects.

Parameters:

	pSrc	Source plug.
	pDst	Destination plug.

Returns:

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

Remarks:

This global function is used primarily to disconnect connectors in a FBConstraintRelation.

---

Please send us your comments about this page.