fbplug.h

Go to the documentation of this file.

#ifndef __FBPLUG_H__
#define __FBPLUG_H__
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************/

#include <kaydaradef.h>

#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

// Global includes
#include <object/i/icallback.h>
#include <fbsdk/fbdefines.h>
#include <fbsdk/fbscriptwrapper.h>
#include <fbsdk/fbarray.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

#define __FBClassImplementation( ThisComponent,pInternalClassId )   \
    int ThisComponent::TypeInfo=__FBRegisterTypeInfo(pInternalClassId);\
    int ThisComponent::GetInternalClassId() { return pInternalClassId; }

#define __FBClassImplementationGroup( ThisComponent, pInternalClass )   \
    __FBClassImplementation( ThisComponent,pInternalClass::ClassId )\
    const char* ThisComponent::ClassGroupName = pInternalClass::ClassGroupName;

FB_FORWARD( FBPlug );

enum FBConnectionAction
{
    // 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,     
    kFBKeyingCurveChange,   
    kFBKeyingCurveEndChange,    

    // for backward compatibility
    kFBConnect = kFBConnectSrc,
    kFBConnected = kFBConnectedSrc,
    kFBDisconnect = kFBDisconnectSrc,
    kFBDisconnected = kFBDisconnectedSrc
};

FBSDK_DLL const char* FBGetConnectionActionString( FBConnectionAction pAction );

enum FBConnectionType
{
    kFBConnectionTypeNone,          
    kFBConnectionTypeSystem         
};

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
};

typedef FBArrayTemplate<FBPlug*> FBPlugList;

FBSDK_DLL FBPlugList* FBCreatePlugList();

FBSDK_DLL void FBDestroyPlugList( FBPlugList* pPlugList );

FBSDK_DLL const char* FBGetConnectionTypeString( FBConnectionType pType );

class FBSDK_DLL FBPlug : public ICallback
    , public FBWrapperHolder
{
protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    FBPlug( HIObject pObject );
public:
    virtual ~FBPlug();

    virtual HIObject GetHIObject() const;

    virtual bool SetHIObject( HIObject pObject, bool pSDKComponent );
#endif

    bool IsSDKComponent();

    bool                ConnectSrc( FBPlug* pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                ConnectDst( FBPlug* pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                ConnectSrcAt( int pDst_SrcIndex, FBPlug* pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                ConnectDstAt( int pSrc_DstIndex, FBPlug* pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                DisconnectDst( FBPlug* pDst );

    bool                DisconnectSrc( FBPlug* pSrc );

    void                DisconnectAllSrc();

    void                DisconnectAllDst();

    bool                DisconnectDstAt( int pIndex );

    bool                DisconnectSrcAt( int pIndex );

    bool                ReplaceDstAt( int pIndex, FBPlug* pDst );

    bool                ReplaceSrcAt( int pIndex, FBPlug* pSrc );

    bool                SwapSrc( int pIndexA, int pIndexB );

    bool                MoveSrcAt( int pIndex, int pAtIndex );

    bool                MoveSrcAt( FBPlug* pSrc, FBPlug* pAtSrc );

    int                 GetSrcCount();

    FBPlug*             GetSrc( int pIndex );

    FBConnectionType    GetSrcType( int pIndex );

    int                 GetDstCount();

    FBPlug*             GetDst( int pIndex );

    FBConnectionType    GetDstType( int pIndex );

    bool                BeginChange();

    void                EndChange();

    void                SetSelfModified(FBPlugModificationFlag pFlag, bool pBool);

    bool                GetSelfModified(FBPlugModificationFlag pFlag);  

    void                SetContentModified(FBPlugModificationFlag pFlag, bool pBool);

    bool                GetContentModified(FBPlugModificationFlag pFlag);

    int                 GetPlugConnectionModifiedList(FBPlugList& pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove);

    bool                RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask);

    void                SetStatusFlag(FBPlugStatusFlag pStatus, bool pValue);

    bool                GetStatusFlag(FBPlugStatusFlag pStatus) const;

    FBPlug*             GetOwner();

    FBPlug*             GetOwned( int pIndex );

    int                 GetOwnedCount();

    virtual const char* ClassName();

    virtual bool        Is( int pTypeId );


    virtual int        GetTypeId();

    static const char* ClassGroupName;

    static int TypeInfo;

    bool            mAllocated;

    virtual bool PlugDataNotify(FBConnectionAction pAction,FBPlug* pThis,void* pData=NULL,void* pDataOld=NULL,int pDataSize=0);

    virtual bool PlugStateNotify(FBConnectionAction pAction,FBPlug* pThis,void* pData=NULL,void* pDataOld=NULL,int pDataSize=0);

    virtual bool PlugNotify(FBConnectionAction pAction,FBPlug* pThis,int pIndex,FBPlug* pPlug = NULL,FBConnectionType pConnectionType=kFBConnectionTypeNone,FBPlug* pNewPlug=NULL );

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    IObject_Declare(K_IMPLEMENTATION);
    ICallback_Declare(K_IMPLEMENTATION);

    static void   PrintClassDefinitions();

#endif

protected:
    virtual void        FBDelete();

    static int          mGlobalTypeInfo;        
    static int          GetInternalClassId();   
    HIObject            mObject;                
    bool                mSDKComponent;          
    FBSDK_DLL friend int __FBRegisterTypeInfo(int pInternalClassId);
};


// Connection related utility functions.

FBSDK_DLL bool FBConnect( FBPlug* pSrc, FBPlug* pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone );

FBSDK_DLL bool FBDisconnect( FBPlug* pSrc, FBPlug* pDst );

FBSDK_DLL FBPlug*       FBGetFBPlug( HIObject pObject, bool pAutoCreate=true );

FBSDK_DLL HIObject      FBGetFBObject( HIObject pObject, bool pAutoCreate=false );

template<class T> inline T* FBCast(HIObject pObject, bool pAutoCreate = false)
{
    HIObject lObject = FBGetFBObject(pObject, pAutoCreate);
    // Should also validate type but not available for now
    return (T*)lObject;
}

class FBSDK_DLL HdlFBPlug 
{
public:
    // CONSTRUCTOR/DESTRUCTOR
    HdlFBPlug();              
    HdlFBPlug(const FBPlug * pFBPlug); 
    HdlFBPlug(HdlFBPlug const &pFBPlug); 
    ~HdlFBPlug();             

    // VALIDATION
    bool Ok() const;


    bool Is( int pTypeId );

    //bool WasOk() const;
    //int   RefCount() const;

    // CASTING & ASSIGNATION
    HdlFBPlug&      operator= (const FBPlug*    pFBPlug); 
    HdlFBPlug&      operator= (const HdlFBPlug& pFBPlug); 

    // Comparison 
    bool            operator==(const HdlFBPlug& pFBPlug) const; 
    bool            operator!=(const HdlFBPlug& pFBPlug) const; 

    FBPlug*         GetPlug() const;
    inline  FBPlug* operator()() const { return GetPlug(); }
    inline  FBPlug* operator->() const { return GetPlug(); }

    inline operator FBPlug* () const 
    { 
        return (FBPlug *)GetPlug(); 
    }


protected:
    void SetPlug(const FBPlug*    pFBPlug); 

private:
    void * mData;
};

template <class T> class HdlFBPlugTemplate : public HdlFBPlug
{
public:
    HdlFBPlugTemplate()
    {
    }

    HdlFBPlugTemplate(HdlFBPlug const &pPlug)   
        : HdlFBPlug(pPlug) 
    {
    }

    HdlFBPlugTemplate(const FBPlug *pPlug)  
        : HdlFBPlug((FBPlug *)pPlug) 
    {
    }

    HdlFBPlugTemplate<T>& operator=(const HdlFBPlugTemplate<T>& pPlug)
    { 
        SetPlug(pPlug.GetPlug());
        return *this;
    }

    bool operator==(const HdlFBPlugTemplate<T>& pFBPlug) const
    {
        return GetPlug() == pFBPlug.GetPlug();
    }

    bool operator!=(const HdlFBPlugTemplate<T>& pFBPlug) const
    {
        return GetPlug() != pFBPlug.GetPlug();
    }

    T* operator()() const           
    { 
        return (T *)GetPlug(); 
    }

    T* operator->() const           
    { 
        return (T *)GetPlug(); 
    }

    operator T*() const 
    { 
        return (T *)GetPlug(); 
    }
};

#ifdef FBSDKUseNamespace
}
#endif

#endif