fbplug.h File Reference
This reference page is linked to from the following overview topics: Your First Python Program, Rigid Body Physics, Joint Chains.
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>#include <fbsdk/fbarray.h>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... |
|
Typedefs |
|
| typedef FBArrayTemplate< FBPlug * > | FBPlugList |
| typedef FBArrayTemplate<FBPlug*>
FBPlugList; |
|
Enumerations |
|
| enum | FBConnectionAction
{ kFBRequestConnectSrc = 0, kFBRequestConnectDst, kFBConnectSrc, kFBConnectDst, kFBConnectedSrc, kFBConnectedDst, kFBRequestDisconnectSrc, kFBRequestDisconnectDst, kFBDisconnectSrc, kFBDisconnectDst, kFBDisconnectedSrc, kFBDisconnectedDst, kFBBeginReplaceSrc, kFBEndReplaceSrc, kFBBeginReplaceDst, kFBEndReplaceDst, kFBReorderSrc, kFBReorderedSrc, kFBBeginChange, kFBEndChange, kFBConnectedOwner, kFBDisconnectOwner, kFBCandidate, kFBCandidated, kFBCandidateGlobal, kFBDetached, kFBDestroy, kFBSelect, kFBUnselect, kFBReselect, kFBRequestRename, kFBRename, kFBRenamed, kFBRequestPrefixRename, kFBPrefixRename, kFBPrefixRenamed, kFBDescription, kFBKeyingKey, kFBKeyingDeleteKey, kFBKeyingCandidate, kFBConnect = kFBConnectSrc, kFBConnected = kFBConnectedSrc, kFBDisconnect = kFBDisconnectSrc, kFBDisconnected = kFBDisconnectedSrc } |
|
Possible actions when a notify plug event occurs. More... |
|
| enum | FBConnectionType { kFBConnectionTypeNone, kFBConnectionTypeSystem } |
|
Connection types available between plugs. More... |
|
| enum | FBPlugModificationFlag
{ kFBPlugAllContent = 0, kFBSelfDataModified = 1 << 8, kFBContentDataModified = 1 << 9, kFBAllDataModified = kFBSelfDataModified | kFBContentDataModified, kFBSelfKeyingModified = 1 << 10, kFBContentKeyingModified = 1 << 11, kFBAllKeyingModified = kFBSelfKeyingModified | kFBContentKeyingModified, kFBSelfStateModified = 1 << 12, kFBContentStateModified = 1 << 13, kFBAllStateModified = kFBSelfStateModified | kFBContentStateModified, kFBSelfConnectionSrcObjectModified = 1 << 14, kFBSelfConnectionSrcPropertyModified = 1 << 15, kFBSelfConnectionDstObjectModified = 1 << 16, kFBSelfConnectionDstPropertyModified = 1 << 17, kFBSelfConnectionModifiedMask = kFBSelfConnectionSrcObjectModified | kFBSelfConnectionSrcPropertyModified | kFBSelfConnectionDstObjectModified | kFBSelfConnectionDstPropertyModified, kFBContentConnectionModified = 1 << 18, kFBAllConnectionModified = kFBSelfConnectionModifiedMask | kFBContentConnectionModified, kFBSelfAllModifiedMask = kFBSelfDataModified | kFBSelfKeyingModified | kFBSelfStateModified | kFBSelfConnectionModifiedMask, kFBContentAllModifiedMask = kFBContentDataModified | kFBContentKeyingModified | kFBContentStateModified | kFBContentConnectionModified, kFBAllModifiedMask = kFBSelfAllModifiedMask | kFBContentAllModifiedMask } |
Functions |
|
| FB_FORWARD (FBPlug) | |
| FBSDK_DLL const char * | FBGetConnectionActionString (FBConnectionAction pAction) |
| FBSDK_DLL const char * | FBGetConnectionTypeString (FBConnectionType pType) |
| FBSDK_DLL bool | FBConnect (FBPlug *pSrc, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
| Request the connection two FBPlug objects.
|
|
| FBSDK_DLL bool | FBDisconnect (FBPlug *pSrc, FBPlug *pDst) |
| Connect two FBPlug objects.
|
|
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...
Typedef Documentation
| typedef FBArrayTemplate<FBPlug*> FBPlugList |
typedef FBArrayTemplate<FBPlug*> FBPlugList;
Enumeration Type Documentation
| enum FBConnectionAction |
Possible actions when a notify plug event occurs.
- Enumerator:
Definition at line 71 of file fbplug.h.
{
// Connection notify actions
kFBRequestConnectSrc = 0,
kFBRequestConnectDst,
kFBConnectSrc,
kFBConnectDst,
kFBConnectedSrc,
kFBConnectedDst,
kFBRequestDisconnectSrc,
kFBRequestDisconnectDst,
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,
kFBRequestRename,
kFBRename,
kFBRenamed,
kFBRequestPrefixRename,
kFBPrefixRename,
kFBPrefixRenamed,
kFBDescription,
// Keying Notify actions
kFBKeyingKey,
kFBKeyingDeleteKey,
kFBKeyingCandidate,
// for backward compatibility
kFBConnect = kFBConnectSrc,
kFBConnected = kFBConnectedSrc,
kFBDisconnect = kFBDisconnectSrc,
kFBDisconnected = kFBDisconnectedSrc
};
| enum FBConnectionType |
- Enumerator:
Definition at line 144 of file fbplug.h.
{
kFBPlugAllContent = 0,
kFBSelfDataModified = 1 << 8,
kFBContentDataModified = 1 << 9,
kFBAllDataModified = kFBSelfDataModified | kFBContentDataModified,
kFBSelfKeyingModified = 1 << 10,
kFBContentKeyingModified = 1 << 11,
kFBAllKeyingModified = kFBSelfKeyingModified | kFBContentKeyingModified,
kFBSelfStateModified = 1 << 12,
kFBContentStateModified = 1 << 13,
kFBAllStateModified = kFBSelfStateModified | kFBContentStateModified,
kFBSelfConnectionSrcObjectModified = 1 << 14,
kFBSelfConnectionSrcPropertyModified = 1 << 15,
kFBSelfConnectionDstObjectModified = 1 << 16,
kFBSelfConnectionDstPropertyModified = 1 << 17,
kFBSelfConnectionModifiedMask = kFBSelfConnectionSrcObjectModified | kFBSelfConnectionSrcPropertyModified | kFBSelfConnectionDstObjectModified | kFBSelfConnectionDstPropertyModified,
kFBContentConnectionModified = 1 << 18,
kFBAllConnectionModified = kFBSelfConnectionModifiedMask | kFBContentConnectionModified,
kFBSelfAllModifiedMask = kFBSelfDataModified | kFBSelfKeyingModified | kFBSelfStateModified | kFBSelfConnectionModifiedMask,
kFBContentAllModifiedMask = kFBContentDataModified | kFBContentKeyingModified | kFBContentStateModified | kFBContentConnectionModified,
kFBAllModifiedMask = kFBSelfAllModifiedMask | kFBContentAllModifiedMask
};
Function Documentation
| FB_FORWARD | ( | FBPlug | ) |
| FBSDK_DLL const char* FBGetConnectionActionString | ( | FBConnectionAction | pAction | ) |
| FBSDK_DLL const char* FBGetConnectionTypeString | ( | FBConnectionType | pType | ) |
| FBSDK_DLL bool FBConnect | ( | FBPlug * | pSrc, |
| FBPlug * | 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.
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.
