This reference page is linked to from the following overview topics: Modifying the Items in a Referenced Object, Your First Python Program, Rigid Body Physics, Joint Chains, MotionBuilder 2014.
#include <kaydaradef.h>
#include <object/i/icallback.h>
#include <fbsdk/fbdefines.h>
#include <fbsdk/fbscriptwrapper.h>
#include <fbsdk/fbarray.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.
Classes |
|
class | FBPlug |
Connections Basic Open Reality SDK Element.
More... |
|
class | HdlFBPlug |
Handler of FBPlug object Use
this handler object to gracefully take care of dangling pointer
problem. More... |
|
class | HdlFBPlugTemplate< T > |
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, kFBSelfCustomPropertyModified = 1 << 19, kFBContentCustomPropertyModified = 1 << 20, kFBAllCustomPropertyModified = kFBSelfCustomPropertyModified | kFBContentCustomPropertyModified, kFBSelfAllModifiedMask = kFBSelfDataModified | kFBSelfKeyingModified | kFBSelfStateModified | kFBSelfCustomPropertyModified | kFBSelfConnectionModifiedMask, kFBContentAllModifiedMask = kFBContentDataModified | kFBContentKeyingModified | kFBContentStateModified | kFBContentCustomPropertyModified | kFBContentConnectionModified, kFBAllModifiedMask = kFBSelfAllModifiedMask | kFBContentAllModifiedMask } |
enum | FBPlugStatusFlag { kFBPlugStatusFlagNone = 0, kFBOwnedByUndo = 1<<21, kFBPlugStatusFlagMask = kFBOwnedByUndo } |
Functions |
|
FB_FORWARD (FBPlug) | |
K_DLLIMPORT const char * | FBGetConnectionActionString (FBConnectionAction pAction) |
K_DLLIMPORT const char * | FBGetConnectionTypeString (FBConnectionType pType) |
K_DLLIMPORT bool | FBConnect (FBPlug *pSrc, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Request the connection two FBPlug objects.
|
|
K_DLLIMPORT bool | FBDisconnect (FBPlug *pSrc, FBPlug *pDst) |
Connect two FBPlug objects.
|
#define FBSDK_DLL K_DLLIMPORT |
Be sure that FBSDK_DLL is defined only once...
typedef FBArrayTemplate<FBPlug*> FBPlugList |
typedef FBArrayTemplate<FBPlug*> FBPlugList;
enum FBConnectionAction |
Possible actions when a notify plug event occurs.
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 |
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, kFBSelfCustomPropertyModified = 1 << 19, kFBContentCustomPropertyModified = 1 << 20, kFBAllCustomPropertyModified = kFBSelfCustomPropertyModified | kFBContentCustomPropertyModified, kFBSelfAllModifiedMask = kFBSelfDataModified | kFBSelfKeyingModified | kFBSelfStateModified | kFBSelfCustomPropertyModified | kFBSelfConnectionModifiedMask, kFBContentAllModifiedMask = kFBContentDataModified | kFBContentKeyingModified | kFBContentStateModified | kFBContentCustomPropertyModified | kFBContentConnectionModified, kFBAllModifiedMask = kFBSelfAllModifiedMask | kFBContentAllModifiedMask };
enum FBPlugStatusFlag |
kFBPlugStatusFlagNone |
Plug has no status set. |
kFBOwnedByUndo |
Plug is owned by undo framework. |
kFBPlugStatusFlagMask |
Definition at line 176 of file fbplug.h.
{ kFBPlugStatusFlagNone = 0, kFBOwnedByUndo = 1<<21, kFBPlugStatusFlagMask = kFBOwnedByUndo };
FB_FORWARD | ( | FBPlug | ) |
K_DLLIMPORT const char* FBGetConnectionActionString | ( | FBConnectionAction | pAction | ) |
K_DLLIMPORT const char* FBGetConnectionTypeString | ( | FBConnectionType | pType | ) |
K_DLLIMPORT bool FBConnect | ( | FBPlug * | pSrc, |
FBPlug * | pDst, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) |
Request the connection two FBPlug objects.
pSrc | Source plug. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. |
Connect two FBPlug objects.
pSrc | Source plug. |
pDst | Destination plug. |