fbassetmng.h

Go to the documentation of this file.

#ifndef __FBASSETMNG_H__
#define __FBASSETMNG_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

#include <fbsdk/fbcomponent.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif


__FB_FORWARD( FBAssetItem );
__FB_FORWARD( FBAssetFile );
__FB_FORWARD( FBAssetFolder );
__FB_FORWARD( FBAssetMng );


// FBAssetItem

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

    FBAssetItem( const char* pName, HIObject pObject=NULL );

    virtual FBString GetName() const = 0;

    virtual FBString GetLocalPath() const = 0;

    virtual FBString GetServerPath() const = 0;

    virtual FBAssetFolder* GetParent() const = 0;

    virtual bool GetLatest( bool pReplaceCheckedOut = false, bool pSilent = false ) = 0;

    virtual bool CheckIn( const FBString& pComment = "", bool pKeepCheckedOut = false, bool pSilent = false ) = 0;

    virtual bool CheckOut( const FBString& pComment = "", bool pDontGetLocal = false, bool pSilent = false ) = 0;

    virtual bool UndoCheckOut( bool pReplaceLocalFile = true, bool pSilent = false ) = 0;

    virtual void ShowHistory() const = 0;

    virtual void ShowProperties() const = 0;

    FBString                    LastError;      
};


// FBAssetFile

#define FBRegisterAssetFile( UniqueNameStr, ClassName, Label, Desc, IconFilename ) \
    HIObject RegisterAssetFile##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->mAllocated = true; \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetItem/AssetFile",Label,Desc,RegisterAssetFile##ClassName, true, IconFilename );  \
    }

#define FBAssetFileDeclare( ClassName, Parent  ) \
    FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

#define FBAssetFileImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBAssetFile

class FBSDK_DLL FBAssetFile : public FBAssetItem
{
    __FBClassDeclare( FBAssetFile, FBAssetItem );
public:
    FBAssetFile( const char* pName, HIObject pObject=NULL );

    IObject_Declare(K_IMPLEMENTATION);      // Interface to IObject.

    virtual bool FBCreate();

    virtual bool IsCheckedOut() const = 0;

    virtual bool IsCheckedOutByMe() const = 0;

    virtual FBString GetCheckedOutBy() const = 0;
};


// FBAssetFolder

#define FBRegisterAssetFolder( UniqueNameStr, ClassName, Label, Desc, IconFilename ) \
    HIObject RegisterAssetFolder##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->mAllocated = true; \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetItem/AssetFolder",Label,Desc,RegisterAssetFolder##ClassName, true, IconFilename );  \
    }

#define FBAssetFolderDeclare( ClassName, Parent  ) \
    FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

#define FBAssetFolderImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBAssetFolder

class FBSDK_DLL FBAssetFolder : public FBAssetItem
{
    __FBClassDeclare( FBAssetFolder, FBAssetItem );
public:
    FBAssetFolder( const char* pName, HIObject pObject=NULL );

    IObject_Declare(K_IMPLEMENTATION);      // Interface to IObject.

    virtual bool FBCreate();

    virtual int GetChildCount() const = 0;

    virtual FBAssetItem* GetChild( int pIndex ) = 0;

    virtual FBAssetFile* GetFile( const FBString& pName ) = 0;

    virtual FBAssetFolder* GetFolder( const FBString& pName ) = 0;

    virtual FBAssetFile* AddFile( const FBString& pLocalPath, const FBString& pComment = "", bool pCheckOut = false, bool pSilent = false ) = 0;

    virtual FBAssetFolder* AddFolder( const FBString& pName, const FBString& pComment = "", bool pSilent = false ) = 0;
};


// FBAssetMng

#define FBRegisterAssetMng( UniqueNameStr, ClassName, Label, Desc, IconFilename ) \
    HIObject RegisterAssetMng##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->mAllocated = true; \
        Class->Name = UniqueNameStr; \
        Class->Description = Desc; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Asset/AssetMng",Label,Desc,RegisterAssetMng##ClassName, false, IconFilename ); \
    }

#define FBAssetMngDeclare( ClassName, Parent  ) \
    FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

#define FBAssetMngImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBAssetMng

enum FBAssetMngMenuOptions      {   
    kMenuOpenFromDatabase   = 1<<0,     
    kMenuAddToDatabase      = 1<<1,     
    kMenuUploadToDatabase   = 1<<2,     
    kMenuGetLatest          = 1<<3,     
    kMenuCheckIn            = 1<<4,     
    kMenuCheckOut           = 1<<5,     
    kMenuUndoCheckOut       = 1<<6,     
    kMenuShowHistory        = 1<<7,     
    kMenuShowProperties     = 1<<8,     
    kMenuShowExplorer       = 1<<9,     
    kMenuShowReferenceMng   = 1<<10,    
    kMenuShowSettings       = 1<<11,    
    kMenuEnable             = 1<<12,    

    kMenuFileAll            = kMenuOpenFromDatabase | kMenuAddToDatabase | kMenuUploadToDatabase,

    kMenuSourceControlAll   = kMenuGetLatest | kMenuCheckIn | kMenuCheckOut | kMenuUndoCheckOut |
                              kMenuShowHistory | kMenuShowProperties | kMenuShowExplorer |
                              kMenuShowReferenceMng | kMenuShowSettings | kMenuEnable,

    kMenuSourceControlMin   =  kMenuGetLatest | kMenuCheckIn | kMenuCheckOut | kMenuUndoCheckOut |
                               kMenuShowSettings | kMenuEnable,

    kMenuAll                = 0xFFFFFFFF
};


enum FBAssetMngFileOptions  {
    kFileCheckOutOnLoad     = 1<<0,     
    kFileCheckOutOnLoad_Ask = 1<<1,     
    kFileUploadOnSave       = 1<<2,     
    kFileUploadOnSave_Ask   = 1<<3,     
    kFileAddOnNewSave       = 1<<4,     
    kFileAddOnNewSave_Ask   = 1<<5,     
    kFileCheckInOnClose     = 1<<6,     
    kFileCheckInOnClose_Ask = 1<<7,     
    kFileOptionsAll         = 0xFFFFFFFF
};


FB_DEFINE_COMPONENT( FBSDK_DLL, AssetMng );

class FBSDK_DLL FBAssetMng : public FBComponent {
    __FBClassDeclare( FBAssetMng, FBComponent );
public:
    FBAssetMng( const char* pName, HIObject pObject=NULL );

    IObject_Declare(K_IMPLEMENTATION);      // Interface to IObject.

    virtual bool Initialize() = 0;

    virtual FBAssetFile* BrowseForFile() = 0;

    virtual FBAssetFolder* BrowseForFolder() = 0;

    virtual FBAssetFolder* CreateServerPath( const FBString& pServerPath ) = 0;
    
    virtual bool FileIsManaged( const FBString& pFilename ) = 0;
    
    virtual bool WithinManagedPath( const FBString& pLocalPath ) = 0;
    
    virtual FBString MapLocalPathToServerPath( const FBString& pLocalPath ) = 0;

    virtual FBAssetFile* GetAssetFile( const FBString& pServerFilename ) = 0;
    
    virtual FBAssetFile* GetAssetFileFromLocalPath( const FBString& pLocalFilename ) = 0;

    virtual FBAssetFolder* GetAssetFolder( const FBString& pServerPath ) = 0;
    
    virtual FBAssetFolder* GetAssetFolderFromLocalPath( const FBString& pLocalPath ) = 0;

    virtual void ShowSettings() = 0;

    virtual int GetFileOptions() = 0;

    virtual bool CheckAvailability() const = 0;
    
    FBPropertyString            Name;           
    FBPropertyString            Description;    
    FBPropertyInt               MenuFlags;      
    FBString                    LastError;      
};

#ifdef FBSDKUseNamespace
    }
#endif
#endif  /* __FBASSETMNG_H__ */