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>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif


// FBPlug
FB_FORWARD( FBPlug );

enum FBConnectionAction
{
    // 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
{
    kFBConnectionTypeNone,          
    kFBConnectionTypeSystem         
};

class FBSDK_DLL FBPlug : public ICallback
                       , public FBWrapperHolder
{
public:
    FBPlug( HIObject pObject );

    virtual ~FBPlug();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    virtual HIObject GetHIObject() const;

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

    bool IsSDKComponent();

    bool                ConnectSrc( HFBPlug pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                ConnectDst( HFBPlug pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone );

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

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

    K_DEPRECATED bool                ConnectAt( HFBPlug pSrc, int pSrc_DstIndex, HFBPlug pDst, int pDst_SrcIndex, FBConnectionType pConnectionType=kFBConnectionTypeNone );

    bool                DisconnectDst( HFBPlug pDst );

    bool                DisconnectSrc( HFBPlug pSrc );

    void                DisconnectAllSrc();

    void                DisconnectAllDst();

    bool                DisconnectDstAt( int pIndex );

    bool                DisconnectSrcAt( int pIndex );

    bool                ReplaceDstAt( int pIndex, HFBPlug pDst );

    bool                ReplaceSrcAt( int pIndex, HFBPlug pSrc );

    bool                SwapSrc( int pIndexA, int pIndexB );

    bool                MoveSrcAt( int pIndex, int pAtIndex );

    bool                MoveSrcAt( HFBPlug pSrc, HFBPlug pAtSrc );

    int                 GetSrcCount();

    HFBPlug             GetSrc( int pIndex );

    FBConnectionType    GetSrcType( int pIndex );

    int                 GetDstCount();

    HFBPlug             GetDst( int pIndex );

    FBConnectionType    GetDstType( int pIndex );

    bool                BeginChange();

    void                EndChange();

    HFBPlug             GetOwner();

    int                 GetOwnerCount();

    HFBPlug             GetOwned( int pIndex );

    int                 GetOwnedCount();

    virtual char*       ClassName();

    virtual bool        Is( int pTypeId );


    virtual int        GetTypeId();

    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(Implementation);
    ICallback_Declare(Implementation);
#endif

protected:
    virtual void        FBDelete();

    static int          mGlobalTypeInfo;        
    static int          GetInternalClassId();   
    HIObject            mObject;                
    bool                mSDKComponent;          
};


// Connection related utility functions.

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

FBSDK_DLL bool FBDisconnect( HFBPlug pSrc, HFBPlug pDst );


#ifdef FBSDKUseNamespace
    }
#endif

#endif