fbcomponent.h

Go to the documentation of this file.

#ifndef __FBBASE_H__
#define __FBBASE_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>

// This include directive is necessary because of the definition of the
// FBLibrary class.
#include <fbsdk/fblibrary.h>

#ifndef FBSDK_DLL

    #define FBSDK_DLL K_DLLIMPORT
#endif

// Global includes
#include <fbsdk/fbplug.h>
#include <fbsdk/fbarray.h>
#include <fbsdk/fbstring.h>
#include <fbsdk/fbproperties.h>

#ifdef _MSC_VER
//   #pragma warning (disable: 4800)// non dll-interface class "X" used as base for dll-interface class for "Y" (performance warning) 
    #pragma warning (disable: 4275) // 'int' : forcing value to bool 'true' or 'false' (performance warning) 
    #pragma warning (disable: 4661) // no suitable definition provided for explicit template instantiation request
#endif

K_FORWARD( IRegister );
K_FORWARD( IError );
K_FORWARD( IStore );
K_FORWARD( IKtView );
K_FORWARD( KEventBase );
K_FORWARD( KGlobalNamedEvent );

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

#ifndef FBINCLUDE
// Section that must be exported
#else
#endif

#define FB_DEFAULT_SDK_ICON "openreality_noicon.png"

// For internal use only.
#define __FBClassInit mLocalPtr = NULL;        

// For internal use only.
#define __FBClassInitSDKComponent( pObjectToWrappedIsAllocated ) \
    __FBClassInit; \
    mSDKComponent = pObjectToWrappedIsAllocated;


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


#define __FBClassDeclare( Name,Parent ) \
  public: \
\
    typedef Parent  __FBParentClass;\
\
    typedef Name    __FBClassType;\
\
    virtual char* ClassName() override { return #Name; } \
\
    virtual bool Is( int pTypeId ) override { return (pTypeId==TypeInfo) ? true : Parent::Is( pTypeId ); } \
    virtual int GetTypeId() override { return TypeInfo; } \
\
    static  int GetInternalClassId(); \
\
    Data##Name* mLocalPtr; \
    virtual ~Name(); \
    static int TypeInfo; \


#define FBStorableClassImplementation(ClassName, Type)\
    char* ClassName::FbxGetObjectSubType(){ return #ClassName; }\
    HIObject RegisterStorable##ClassName##Create(HIObject /*pOwner*/, char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        if( Class->FBCreate() ){\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##Storable){\
        FBString lGroup = "FbxStorable/";\
        lGroup += #Type;\
        FBRegisterObject(ClassName##R2, lGroup, #ClassName, "", RegisterStorable##ClassName##Create, true, NULL);}

#define FBElementClassImplementation(ClassName,IconFileName)\
    HIObject RegisterElement##ClassName##Create(HIObject /*pOwner*/, char* pName, void* /*pData*/){\
        ClassName* Class = new ClassName(pName);\
        Class->mAllocated = true;\
        if( Class->FBCreate() ){\
            return Class->GetHIObject();\
        } else {\
            delete Class;\
            return NULL;}}\
    FBLibraryModule(ClassName##Element){\
        FBRegisterObject(ClassName##R2, "Browsing/Templates/Elements", #ClassName, "", RegisterElement##ClassName##Create, true, IconFileName);}

#define FBStorableClassDeclare(Name, Parent)\
    FBClassDeclare(Name, Parent);\
public:\
    virtual char* FbxGetObjectSubType();


#define FBPropertyInitComponent( Param,Type,PropName,Get,Set ) \
    { \
        PropertyAdd(PropName.Init( (void *)Param,#PropName,(H##Type (*)(void *))Get,(void (*)(void *,H##Type))Set )); \
        PropName.TypeInfo = &Type::TypeInfo; \
    }

#define FBIS( Component,ComponentType ) \
    ((Component) && (Component)->Is( ComponentType::TypeInfo ))

// Utility function
// For internal use only.
__FB_FORWARD( FBComponent );
__FB_FORWARD( FBVisualComponent );

FBSDK_DLL FBComponent* GetFBComponent( const HIObject Object );

#if !defined(K_NO_UI)

FBSDK_DLL FBVisualComponent*  FBGetFBVisualComponent( HIKtView pObject,bool pAutoCreate=true );
#endif

FBSDK_DLL FBComponent*  FBGetFBComponent( HIObject pObject, bool pAutoCreate=true );

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

typedef FBArrayTemplate<FBComponent*> FBComponentList;
FBSDK_DLL FBArrayTemplate<FBComponent*>& FBGetComponentArray();

// Registration macros

#define FBRegisterEvent     ( Object, EventId, EventProc )  IQ( Object,IRegister)->Register     ( EventId,(HICallback)this,(kICallbackHandler)EventProc );

#define FBUnregisterEvent   ( Object, EventId, EventProc )  IQ( Object,IRegister)->Unregister   ( EventId,(HICallback)this,(kICallbackHandler)EventProc );

FBSDK_DLL void FBSetStoreableCustomModelReigstered();
FBSDK_DLL bool FBGetStoreableCustomModelReigstered();

FBSDK_DLL bool FBObject_Register  ( char * pGroupName,char * pEntryName,char * pDescription, kObjectCreatorFnc pCreatorFnc, bool pIsMultipleAllowed,char * pIconFilename);
FBSDK_DLL bool FBObject_Unregister( char * pGroupName,char * pEntryName, int nth=0 );

FBSDK_DLL FBComponent* FBCreateObject( char* pGroupName, char* pEntryName, char* pName, void* pData = NULL, int nth = 0 );

inline  bool FBUnregisterObject( char * pGroupName,char * pEntryName, int nth=0 ) { return FBObject_Unregister( pGroupName,pEntryName,nth ); }
#define FBRegisterObject( LocalId,Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename ) \
    static int __R##LocalId = FBObject_Register( Path,Name,Description,Constructor,IsMultipleAllowed,IconFilename )

typedef HIRegister  HISender;
typedef HKEventBase HKEvent;
typedef void (ICallback::*FBCallback)(HISender pSender,HKEvent pEvent);

FBSDK_DLL int FBRegister_ClassId(char* pClassName);
#define FBDeclareUserObject(ClassName)\
public:\
    static int      ClassId;\
    virtual int     GetUserClassId();\
    virtual char*   FbxGetObjectSubType()

// FBComponent
#ifdef new

    #define RENEW new
    #undef new
#endif

// FBSceneList
FB_FORWARD( FBPropertyListComponent );
__FB_FORWARD( FBComponent );
FB_DEFINE_LIST( FBSDK_DLL, Component );

FB_FORWARD( FBFolder );
FB_DEFINE_COMPONENT( FBSDK_DLL, Folder );

enum FBObjectFlag
{
    kFBFlagSelectable = (1 << 0),           
    kFBFlagDeletable = (1 << 1),            
    kFBFlagSavable = (1 << 2),              
    kFBFlagVisible = (1 << 3),              
    kFBFlagClonable = (1 << 4),             
    kFBFlagSystem = (1 << 5),               
    kFBFlagNewable = (1 << 6),              
    kFBFlagRenamable = (1 << 7),            
    kFBFlagMergeable = (1 << 8),            
    kFBFlagBrowsable = (1 << 9),            
    kFBFlagDetachable = (1 << 10),          
    kFBFlagUndoable = (1 << 11),            
    kFBFlagKeyable = (1 << 12),             
    kFBFlagAllocated = (1 << 13),           

    // Temporary/VersionTransition Flags
    kFBFlagStory = (1 << 14),               
    kFBFlagStorable6 = (1 << 15),           
    kFBFlagStorableData6 = (1 << 16),       
    kFBFlagStorableBlindData  = (1 << 17),  
    kFBFlagUniqueName = (1 << 18),          
    kFBFlagNotSelectableNameSpace = (1 << 19),  
    kFBFlagCustomNode = (1 << 20),              
};

enum FBObjectStatus {
    kFBStatusNone       = 0,        
    kFBStatusCreating   = (1 << 0), 
    kFBStatusStoring    = (1 << 1), 
    kFBStatusRetrieving = (1 << 2), 
    kFBStatusMerging    = (1 << 3), 
    kFBStatusDestroying = (1 << 4), 
    kFBStatusOwnedByUndo= (1 << 5)  
};

enum FBNamespaceAction
{
    kFBConcatNamespace,                     
    kFBReplaceNamespace,                    
    kFBRemoveAllNamespace                   
};

FB_DEFINE_ENUM(FBSDK_DLL, ConnectionType);
FB_DEFINE_ENUM(FBSDK_DLL, ConnectionAction);
FB_DEFINE_ENUM(FBSDK_DLL, ObjectFlag);

class FBSDK_DLL FBPropertyListComponentBase : public FBPropertyBasicList
{
  protected:
    int     mClassId;
    bool mParents;
  public:
    FBPropertyListComponentBase();
    virtual int Add( FBComponent* pItem );
    virtual void RemoveAt( int pIndex );
    virtual FBComponent* GetAt(int pIndex)=0;
    FBComponent* operator[](int pIndex);
    virtual int GetCount();

    virtual int Find( FBComponent* pItem );

    virtual int Remove( FBComponent* pItem );

    // Internal functions
    void SetClassId( int pClassId );
    int  GetClassId( );
    void SetListOfParents( bool pListOfParents );
    bool GetIsListOfParents();

    virtual FBPropertyType GetPropertyType( ) override { return kFBPT_object; }
};
class FBSDK_DLL FBPropertyListComponent : public FBPropertyListComponentBase
{
  public:
    virtual FBComponent* GetAt(int pIndex);
};

// FBPropertyListObject

FB_FORWARD( FBPropertyListObject );

class FBSDK_DLL FBPropertyListObject : public FBPropertyListComponent
{
  public:
    FBPropertyListObject();

    virtual int GetCount();


    virtual FBComponent* operator[]( int pIndex );
    virtual FBComponent* GetAt( int pIndex );

    virtual int Add( FBComponent* pObject );

    virtual int SetAt(int pIndex, FBComponent* pObject);

    virtual void RemoveAt( int pIndex );

    virtual int InsertAt(int pIndex, FBComponent* pObject);

    virtual void Clear();

    virtual void SetSingleConnect(bool pSingleConnect);

    virtual int GetSingleConnect();

    void SetFilter(int pInternalClassId);

    int FBPropertyListObject::GetFilter();

private:

    FBPropertyListObject( const FBPropertyListObject& );
    const FBPropertyListObject& operator =( const FBPropertyListObject& );
};

class FBSDK_DLL FBComponent : public FBPlug
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    HDataFBComponent mLocalPtr;                 
protected:
    FBString        mName;
#endif
    
public:
    static int      TypeInfo;

    static int GetInternalClassId();

    FBComponent( HIObject pObject );        

    virtual ~FBComponent();                             

    virtual bool FBCreate();

    virtual void FBDestroy();

    virtual void FBDelete();

    virtual bool SetHIObject(HIObject pObject, bool pSDKComponent);

    virtual int PropertyAdd( FBProperty *Property );

    void PropertyRemove( FBProperty* Property );

    FBProperty* PropertyCreate( char* pName, FBPropertyType pType, char * pDataType, bool pAnimatable, bool pIsUser = false, FBProperty* pReferenceSource = NULL  );

    FBObjectFlag GetObjectFlags();

    void SetObjectFlags(FBObjectFlag pFlags);

    bool HasObjectFlags(FBObjectFlag pFlags);

    void EnableObjectFlags(FBObjectFlag pFlags);

    void DisableObjectFlags(FBObjectFlag pFlags);

    void SetObjectStatus(FBObjectStatus pStatus, bool pValue);

    bool GetObjectStatus(FBObjectStatus pStatus);

    void ProcessNamespaceHierarchy( FBNamespaceAction pNamespaceAction, const char* pNamespaceName, const char* pReplaceTo=NULL, bool pAddRight=true );

    void ProcessObjectNamespace ( FBNamespaceAction pNamespaceAction, const char* pNamespaceName, const char* pReplaceTo=NULL, bool pAddRight=true );

    virtual char* ClassName();

    void HardSelect();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    // Overloaded allocation/destruction operator.
    void *operator new( size_t stAllocateBlock );
    void operator delete( void *pvMem );

    void *operator new( size_t stAllocateBlock, int blockType, const char *filename, int linenumber  );
#if _MSC_VER >= 1200
    void operator delete( void *pvMem, int blockType, const char *filename, int linenumber  );
#endif


    // Used to manage sub property events.
    void RegisterPropertyEvent(FBPropertyEvent* pPropertyEvent);
    void UnregisterPropertyEvent(FBPropertyEvent* pPropertyEvent);
    void InvalidatePropertyEventsParents();
#endif

    FBPropertyManager       PropertyList;   
    FBPropertyListComponent Components;     
    FBPropertyListComponent Parents;        
    FBPropertyBool          Selected;       
    FBPropertyString        Name;           
    FBPropertyString        LongName;       

#if !defined(K_NO_FOLDER)
    FBPropertyFolder        Folder;         
#endif

public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    IObject_Declare(Implementation);
    ICallback_Declare(Implementation);
#endif

    virtual bool Is( int pTypeId );
    virtual int GetTypeId();

    static void FBComponentSetName( HFBComponent pObject, char *pName );
    static char* FBComponentGetName( HFBComponent pObject );

    static void FBComponentSetLongName( HFBComponent pObject, char *pName );
    static char* FBComponentGetLongName( HFBComponent pObject );


public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    KObject*    mDummyObject;
    void KObjectEvent(HIRegister pView, HKEventBase pEvent);
#endif
};

typedef FBComponent FBObject;

#ifdef RENEW
    #define new new( _NORMAL_BLOCK, __FILE__, __LINE__)
    #undef RENEW
#endif

// FBEvent
__FB_FORWARD( FBEvent );

class FBSDK_DLL FBEvent
{
public:
    FBEvent( HKEvent pEvent );

    FBPropertyInt   Type;               
#ifndef DOXYGEN_SHOULD_SKIP_THIS
protected:
    HKEventBase mEvent;
public:
    void PropertyAdd( FBProperty* ) {};
#endif
};

// FBEventConnectionNotify
__FB_FORWARD( FBEventConnectionNotify );

class FBSDK_DLL FBEventConnectionNotify : public FBEvent
{
public:
    FBEventConnectionNotify(HKEventBase pEvent);

    FBPropertyConnectionAction  Action;         
    FBPropertyInt               SrcIndex;       
    FBPropertyConnectionType    ConnectionType; 
    FBPropertyPlug              SrcPlug;        
    FBPropertyPlug              DstPlug;        
    FBPropertyPlug              NewPlug;        
};

// FBEventConnectionDataNotify
__FB_FORWARD( FBEventConnectionDataNotify );

class FBSDK_DLL FBEventConnectionDataNotify : public FBEvent
{
public:
    FBEventConnectionDataNotify(HKEventBase pEvent);

    FBPropertyConnectionAction  Action;         
    FBPropertyPlug              Plug;           
    void*                       GetData();      
    void*                       GetOldData();   
};

// FBEventConnectionStateNotify
__FB_FORWARD( FBEventConnectionStateNotify );

class FBSDK_DLL FBEventConnectionStateNotify : public FBEvent
{
public:
    FBEventConnectionStateNotify(HKEventBase pEvent);

    FBPropertyConnectionAction  Action;         
    FBPropertyPlug              Plug;           
    void*                       GetData();      
    void*                       GetOldData();   
};

// FBLibrary

class FBSDK_DLL FBLibraryBase : public ICallback
{
public:
    FBLibraryBase();
    virtual ~FBLibraryBase();
    IObject_Declare(Implementation);
    ICallback_Declare(Implementation);

    virtual bool LibInit();

    virtual bool LibOpen();

    virtual bool LibReady();

    virtual bool LibClose();

    virtual bool LibRelease();
    KGlobalNamedEvent  *mLibrary_Open,      
                       *mLibrary_Ready, 
                       *mLibrary_Close, 
                       *mLibrary_Release;   

    void Library_OpenHandler(HIRegister pCaller,HKEventBase pEvent);
    void Library_ReadyHandler(HIRegister pCaller,HKEventBase pEvent);
    void Library_CloseHandler(HIRegister pCaller,HKEventBase pEvent);
    void Library_ReleaseHandler(HIRegister pCaller,HKEventBase pEvent);
};

// FBLibrary

class FBLibrary : public FBLibraryBase
{
public:
    virtual bool LibInit();

    virtual bool LibOpen();

    virtual bool LibReady();

    virtual bool LibClose();

    virtual bool LibRelease();
};

#if defined(K_NODLL)
    #define FBLibraryDeclare( LibName ) \
    FB_DLL_INIT( LibName, Operation )               \
    {                                               \
        switch( Operation )                         \
        {                                           \
            case kFBDllLoad:                        \
            {                                       \

#else
    #define FBLibraryDeclare( LibName ) \
    static FBLibrary LibName##GlobalFBLibrary; \
    extern "C" {    \
        K_DLLEXPORT bool LIBRARY_INIT(HIError /*Error*/) \
        { \
            FB_EXT_INIT( LibName ); if (LibName##GlobalFBLibrary.LibInit()) return true; return false; \
        } \
    } \
    FB_DLL_INIT( LibName, Operation )               \
    {                                               \
        switch( Operation )                         \
        {                                           \
            case kFBDllLoad:                        \
            {               
#endif

#define FBLibraryModule(Name)                   \
    void FBModule##Name()

#define FBLibraryRegister( ClassName )          \
    extern void FBModule##ClassName( );         \
    FBModule##ClassName( );

#define FBLibraryRegisterStorable( ClassName )          \
    extern void FBModule##ClassName##Storable( );           \
    FBModule##ClassName##Storable( );

#define FBLibraryRegisterElement( ClassName )           \
    extern void FBModule##ClassName##Element( );            \
    FBModule##ClassName##Element( );

#define FBLibraryDeclareEnd                     \
        }                                       \
        break;                                  \
        default:                                \
        break;                                  \
    }                                           \
}

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

#define FBCustomManagerImplementation( ThisComponent )  \
    FBClassImplementation( ThisComponent )              \


#define FBRegisterCustomManager( ClassName )            \
    FBLibraryModule( ClassName )                        \
    {                                                   \
        static ClassName g##ClassName;                  \
        g##ClassName.FBCreate();                        \
        g##ClassName.RegisterManager();                 \
    }                                                   \


#define FBCustomManagerDeclare( ClassName )             \
FBClassDeclare( ClassName, FBCustomManager );           \
    public:                                             \
    ClassName() : FBCustomManager() { FBClassInit; }    \
    private:                                            \


// FBCustomManager

__FB_FORWARD( FBCustomManager );

class FBSDK_DLL FBCustomManager : public FBComponent {
    __FBClassDeclare( FBCustomManager, FBComponent );
public:
    FBCustomManager();

    void RegisterManager();

    virtual bool FBCreate();

    virtual bool     Init()   ;

    virtual bool     Open()   ;

    virtual bool     Clear()  ;

    virtual bool     Close()  ;

};


#ifdef FBSDKUseNamespace
    }
#endif

#endif