fbplug.h File Reference
This reference page is linked to from the following overview topics: Your First Python Program.
Definition of the class FBPlug and related enums and utility functions. More...
#include
<kaydaradef.h>#include <object/i/icallback.h>#include <fbsdk/fbdefines.h>#include <fbsdk/fbscriptwrapper.h>Go to the source code of this file.
Detailed Description
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.
Define Documentation
| #define FBSDK_DLL K_DLLIMPORT |
Be sure that FBSDK_DLL is defined only once...
Enumeration Type Documentation
| enum FBConnectionAction |
Possible actions when a notify plug event occurs.
- Enumerator:
Definition at line 70 of file fbplug.h.
{
// Connection notify actions
kFBRequestConnectSrc,
kFBRequestConnectDst,
kFBConnectSrc,
kFBConnectDst,
kFBConnectedSrc,
kFBConnectedDst,
kFBDisconnectSrc,
kFBDisconnectDst,
kFBDisconnectedSrc,
kFBDisconnectedDst,
kFBBeginReplaceSrc,
kFBEndReplaceSrc,
kFBBeginReplaceDst,
kFBEndReplaceDst,
kFBReorderSrc,
kFBReorderedSrc,
kFBBeginChange,
kFBEndChange,
kFBConnectedOwner,
kFBDisconnectOwner,
// Data notify actions
kFBCandidate,
kFBCandidated,
kFBCandidateGlobal,
// State notify actions
kFBDetached,
kFBDestroy,
kFBSelect,
kFBUnselect,
kFBReselect,
kFBRename,
kFBRenamed,
kFBPrefixRename,
kFBPrefixRenamed,
kFBDescription,
// for backward compatibility
kFBConnect = kFBConnectSrc,
kFBConnected = kFBConnectedSrc,
kFBDisconnect = kFBDisconnectSrc,
kFBDisconnected = kFBDisconnectedSrc
};
| enum FBConnectionType |
Function Documentation
| FB_FORWARD | ( | FBPlug | ) |
| FBSDK_DLL 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.
| FBSDK_DLL 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.
