Open Reality Reference Guide
|
|
Go to the documentation of this file.
45 #include <kaydaradef.h>
51 #define FBSDK_DLL K_DLLIMPORT
55 #include <object/i/icallback.h>
57 #include <fbsdk/fbscriptwrapper.h>
60 #ifdef FBSDKUseNamespace
61 namespace FBSDKNamespace {;
67 #define __FBClassImplementation( ThisComponent,pInternalClassId ) \
68 int ThisComponent::TypeInfo=__FBRegisterTypeInfo(pInternalClassId);\
69 int ThisComponent::GetInternalClassId() { return pInternalClassId; }
71 #define __FBClassImplementationGroup( ThisComponent, pInternalClass ) \
72 __FBClassImplementation( ThisComponent,pInternalClass::ClassId )\
73 const char* ThisComponent::ClassGroupName = pInternalClass::ClassGroupName;
182 kFBAllModifiedMask = kFBSelfAllModifiedMask | kFBContentAllModifiedMask
224 #ifndef DOXYGEN_SHOULD_SKIP_THIS
229 FBPlug( HIObject pObject );
235 virtual HIObject GetHIObject()
const;
238 virtual bool SetHIObject( HIObject pObject,
bool pSDKComponent );
457 virtual bool Is(
int pTypeId );
505 #ifndef DOXYGEN_SHOULD_SKIP_THIS
506 IObject_Declare(
override);
507 ICallback_Declare(
override);
512 static void PrintClassDefinitions();
569 template<
class T>
inline T*
FBCast(HIObject pObject,
bool pAutoCreate =
false)
599 bool Is(
int pTypeId );
609 bool operator==(
const HdlFBPlug& pFBPlug)
const;
610 bool operator!=(
const HdlFBPlug& pFBPlug)
const;
613 inline FBPlug* operator()()
const {
return GetPlug(); }
614 inline FBPlug* operator->()
const {
return GetPlug(); }
616 inline operator FBPlug* ()
const
618 return (
FBPlug *)GetPlug();
623 void SetPlug(
const FBPlug* pFBPlug);
648 SetPlug(pPlug.GetPlug());
654 return GetPlug() == pFBPlug.GetPlug();
659 return GetPlug() != pFBPlug.GetPlug();
662 T* operator()()
const
664 return (T *)GetPlug();
667 T* operator->()
const
669 return (T *)GetPlug();
674 return (T *)GetPlug();
678 #ifdef FBSDKUseNamespace
@ kFBDisconnectDst
Disconnect destination from source.
virtual bool Is(int pTypeId)
Is( int pTypeId )
The purpose of this file is to hold all of the SDK general-purpose preprocessor definitions.
@ kFBPrefixRenamed
Component prefix has been renamed.
bool ReplaceDstAt(int pIndex, FBPlug *pDst)
Replace a destination connection at a specified index.
bool RevertModification(FBPlugModificationFlag pFlag=kFBAllModifiedMask)
Revert the plug's modification to original status.
@ kFBKeyingCandidate
Component keying candidate event.
K_DLLIMPORT friend int __FBRegisterTypeInfo(int pInternalClassId)
__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.
K_DLLIMPORT HIObject FBGetFBObject(HIObject pObject, bool pAutoCreate=false)
Get the SDK object from an Internal Object.
FBConnectionType GetSrcType(int pIndex)
Get a source connection's type at specified index.
bool GetSelfModified(FBPlugModificationFlag pFlag)
Tell if the plug's self has changed.
bool IsSDKComponent()
Return whether or not item is an SDK component.
@ kFBConnectedOwner
Connected owner to destination.
@ kFBDisconnectedDst
Disconnected destination from source.
bool DisconnectSrcAt(int pIndex)
Remove a source connection at a specified index.
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 ...
@ kFBSelfStateModified
Object/Property naming change.
FBArrayTemplate< FBPlug * > FBPlugList
typedef FBArrayTemplate<FBPlug*> FBPlugList;
FBPlug * GetOwned(int pIndex)
Get the owned plug at specified index.
@ kFBRequestConnectSrc
Request connection of source to destination.
void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's self modification flag.
FBConnectionType
Connection types available between plugs.
bool ConnectSrcAt(int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
Add a source connection.
static int GetInternalClassId()
Internal class Id.
@ kFBConnectedDst
Connected destination to source.
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 der...
bool DisconnectDst(FBPlug *pDst)
Remove a destination connection.
@ kFBCandidated
Data candidate event, after the data is set.
@ kFBKeyingDeleteKey
Component keying delete event.
@ kFBDetached
Component detached from scene.
@ kFBEndReplaceDst
End replace destination during merge.
bool mAllocated
Contain the Allocation State of the Component.
void DisconnectAllDst()
Remove all destination connections.
bool GetContentModified(FBPlugModificationFlag pFlag)
Tell if the plug's content has changed.
static int TypeInfo
TypeInfo.
bool ConnectDstAt(int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
Add a destination connection.
bool GetStatusFlag(FBPlugStatusFlag pStatus) const
Tell if the plug's status has changed.
@ kFBRequestPrefixRename
Compoent request Prefix Rename.
@ kFBPrefixRename
Component prefix is going to be renamed.
virtual int GetTypeId()
GetTypeId( int pTypeId )
bool DisconnectSrc(FBPlug *pSrc)
Remove a source connection.
@ kFBConnectDst
Connect destination to source.
@ kFBEndReplaceSrc
End replace source during merge.
@ kFBConnectionTypeSystem
System connection type.
HIObject mObject
Handle on the Plug.
FBPlug * GetSrc(int pIndex)
Get a source connection's plug at specified index.
@ kFBContentConnectionModified
Owner object/namespace has connection modified property/objects.
@ kFBSelect
Component selection.
bool ConnectSrc(FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
Add a source connection.
static const char * ClassGroupName
ClassGroupName of the object.
@ kFBPlugStatusFlagNone
Plug has no status set.
@ kFBContentDataModified
Owner object/Namespace has data dirty property/objects.
@ kFBCandidateGlobal
Data candidate event, global candidate.
int GetPlugConnectionModifiedList(FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
Get plug's modified src/dst property/object connection added/removed List.
@ kFBSelfConnectionDstPropertyModified
The dst property of this plug has been modified.
K_DLLIMPORT FBPlugList * FBCreatePlugList()
Create a FBPlugList object.
@ kFBDestroy
Component destroy.
K_DLLIMPORT void FBDestroyPlugList(FBPlugList *pPlugList)
Delete a FBPlugList object.
K_DLLIMPORT bool FBDisconnect(FBPlug *pSrc, FBPlug *pDst)
Connect two FBPlug objects.
@ kFBSelfDataModified
Object/Property itself has been dirty, in case of property get dirty, its owner object will be set di...
@ kFBSelfCustomPropertyModified
Object custom property change.
@ kFBBeginChange
Begin change on destination.
bool Is(int pTypeId)
Is( int pTypeId )
@ kFBRequestRename
Component request rename.
A template class for arrays.
@ kFBBeginReplaceDst
Begin replace destination during merge.
@ kFBSelfConnectionSrcPropertyModified
The src property of this plug has been modified.
@ kFBDisconnectOwner
Disconnect owner from destination.
bool MoveSrcAt(int pIndex, int pAtIndex)
Move source connection at pIndex to pAtIndex.
@ kFBSelfConnectionDstObjectModified
The dst object of this plug has been modified.
virtual const char * ClassName()
internal System vars.
@ kFBSelfConnectionSrcObjectModified
The src object of this plug has been modified.
@ kFBConnectedSrc
Connected source to destination.
@ kFBReorderedSrc
Source has been reordered.
bool ConnectDst(FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
Add a destination connection.
@ kFBBeginReplaceSrc
Begin replace source during merge.
T * FBCast(HIObject pObject, bool pAutoCreate=false)
Cast the SDK object using it's IObject interface into the proper class.
FBPlug * GetOwner()
Get the owner of this plug.
@ kFBDescription
Component description event.
FBConnectionAction
Possible actions when a notify plug event occurs.
@ kFBReorderSrc
Reorder of source.
@ kFBEndChange
End change on destination.
@ kFBCandidate
Data candidate event, before the data is set.
bool SwapSrc(int pIndexA, int pIndexB)
Swap source connection at index A with source connection at index B.
bool ReplaceSrcAt(int pIndex, FBPlug *pSrc)
Replace a source connection at a specified index.
void EndChange()
Ends a change on multiple plugs.
bool MoveSrcAt(FBPlug *pSrc, FBPlug *pAtSrc)
Move source connection pSrc to the position of pAtSrc.
@ kFBContentCustomPropertyModified
Owner object/Namespace has dirty property/objects.
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...
virtual void FBDelete()
Actual destructor for a FBPlug.
int GetOwnedCount()
Get the owned plug count.
Template class to contain an array of items.
int GetSrcCount()
Get source connection count.
@ kFBContentStateModified
Owner object/Namespace has state dirty property/objects.
K_DLLIMPORT FBPlug * FBGetFBPlug(HIObject pObject, bool pAutoCreate=true)
Get the FBPlug from an Internal Object.
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
@ kFBRequestConnectDst
Request connection of destination to source.
@ kFBSelfKeyingModified
Object/Property itself has been dirty, in case of property get dirty, its owner object will be set di...
@ kFBConnectionTypeNone
Default connection type.
@ kFBReselect
Component re-selection.
@ kFBPlugAllContent
None Modified.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
@ kFBOwnedByUndo
Plug is owned by undo framework.
@ kFBRequestDisconnectDst
Request disconnection of destination to source.
Connections Basic Open Reality SDK Element.
Handler of FBPlug object Use this handler object to gracefully take care of dangling pointer problem.
@ kFBDisconnectedSrc
Disconnected source from destination.
FBConnectionType GetDstType(int pIndex)
Get a destination connection's type at specified index.
@ kFBKeyingCurveChange
Component curve has changed.
@ kFBKeyingCurveEndChange
Component curve changes in Dopesheet completed.
@ kFBKeyingKey
Component keying add event.
void SetContentModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's owned property/object's modification flag.
bool DisconnectDstAt(int pIndex)
Remove a destination connection at a specified index.
int GetDstCount()
Get destination connection count.
@ kFBRenamed
Component has been renamed.
@ kFBRequestDisconnectSrc
Request disconnection of source to destination.
@ kFBConnectSrc
Connect source to destination.
@ kFBRename
Component is going to be renamed.
void SetStatusFlag(FBPlugStatusFlag pStatus, bool pValue)
Set the plug's status flag.
void DisconnectAllSrc()
Remove all source connections.
bool mSDKComponent
bool Plug is an SDK component.
bool BeginChange()
Begins a change on multiple plugs.
@ kFBDisconnectSrc
Disconnect source from destination.
@ kFBContentKeyingModified
Owner object/Namespace has data dirty property/objects.
static int mGlobalTypeInfo
Represente the Type Index.
K_DLLIMPORT bool FBConnect(FBPlug *pSrc, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
Request the connection two FBPlug objects.
FBPlug * GetDst(int pIndex)
Get a destination connection's plug at specified index.
@ kFBUnselect
Component de-selection.