IFileResolutionManager.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright 2008 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license agreement
// provided at the time of installation or download, or which otherwise accompanies 
// this software in either electronic or hard copy form.   

//**************************************************************************/
// DESCRIPTION: IFileResolutionManager.h - Public interface for resolving the 
// physical location of asset files
// AUTHOR: Peter Ochodo
// DATE: 2008-06-09 
//***************************************************************************/


#pragma once

#include "iFnPub.h"
#include "maxtypes.h"
#include "Path.h"
#include "AssetManagement\AssetType.h"
#include "AssetManagement\assetmanagementExport.h"
#include "Noncopyable.h"
#include "windows.h"
#include "AssetManagement\AssetUser.h"

#define FILERESOLUTIONMGR_INTERFACE Interface_ID(0x675b2cab, 0x19fe1fad)

/* \brief Finds the physical location of an asset file
    
    The File Resolution Manager(FRM) returns an absolute file path as soon as it finds the physical location of the asset file.
    This file path is converted to an absolute UNC path if the user preference "Resolve Path to UNC" 
    is turned on. See the IPathConfigMgr::SetResolveUNC(bool aFlag)

    If the asset filename is an absolute path:
    - the FRM first checks the absolute path for the asset file
    - then, if a scenefile is currently open, it checks whether the file is in the same 
      directory as the current scenefile 
    - then it checks the User Paths directories associated with the asset's AssetType
    - then, if a scenefile is currently open, it checks all the subdirectories of the folder that 
      contains this current scenefile
    - then it gives up

    If the asset filename is a relative path:
    - the FRM roots the relative path to the 3dsmax project folder and checks whether the file is there
    - then, if a scenefile is currently open, the FRM roots the relative path to the folder that
      holds this current scenefile, then checks if the file exists there
    - then, if a scenefile is currently open, the FRM checks if the asset filename (without the relative
      path) exists in the folder that holds this current scenefile
    - then, the FRM roots the relative path to the User Paths directories associated with the asset's AssetType
      and checks whether the file exists there
    - then, if a scenefile is currently open, the FRM checks for the asset filename (without relative path) in
      all the subdirectories of the folder that contains this current scenefile.
    - then it gives up

*/
class IFileResolutionManager : public FPStaticInterface, public MaxSDK::Util::Noncopyable
{
public:

    AssetMgmntExport static IFileResolutionManager* GetInstance();

    virtual MSTR GetFullFilePath(const MCHAR* filePath,MaxSDK::AssetManagement::AssetType assetType, bool byPassCache = false) = 0;

    virtual bool GetFullFilePath(MaxSDK::Util::Path& filePath, MaxSDK::AssetManagement::AssetType assetType, bool byPassCache = false) = 0;

    virtual bool GetFullFilePath(const MaxSDK::AssetManagement::AssetUser& assetUser, MaxSDK::Util::Path& filePath,
                                 bool byPassCache = false) = 0;

    virtual bool GetFullFilePath(const MaxSDK::AssetManagement::AssetUser& assetUser, MSTR& filePath,
                                bool byPassCache = false) = 0;
    
    virtual bool GetFullFilePath(const MaxSDK::AssetManagement::AssetId& assetID, MaxSDK::Util::Path& filePath,
                                 bool byPassCache = false) = 0;

    virtual bool GetFullFilePath(const MaxSDK::AssetManagement::AssetId& assetID, MSTR& filePath, bool byPassCache = false) = 0;

    virtual MSTR GetFullFilePath(const MaxSDK::AssetManagement::AssetUser& assetUser, bool byPassCache = false) = 0;

    virtual MSTR GetFullFilePath(const MaxSDK::AssetManagement::AssetId& assetId, bool byPassCache = false) = 0;
    
    virtual DWORD GetMaximumCacheDuration() = 0;

    virtual void SetMaximumCacheDuration(DWORD newMaxDuration) = 0;

    virtual bool IsCachingEnabled() = 0;

    virtual void EnableCaching() = 0;

    virtual void DisableCaching() = 0;

    virtual void PushAllowCachingOfUnresolvedResults(bool newVal) = 0;

    virtual void PopAllowCachingOfUnresolvedResults() = 0;

    virtual void DoGetUniversalFileName(MaxSDK::Util::Path& aFullFilePath) const = 0;

    virtual void DoGetUniversalFileName(MSTR& fullFilePath) const = 0;

    /* \brief Writes File Resolution Manager's settings to the 3dsmax's .ini file

    Writes whether or not the FRM has caching enabled. Also writes the maximum caching duration
    that the FRM uses to validate cached data 
    */
    virtual void UpdateDotIniFile() = 0;
    
    virtual int GetNumAssetTypes()const = 0;

    virtual MaxSDK::AssetManagement::AssetType GetAssetType(const MSTR& assetType)const = 0;

    virtual const MCHAR* GetAssetTypeString(MaxSDK::AssetManagement::AssetType assetType)const = 0;


protected:
    // virtual destructor
    virtual ~IFileResolutionManager(){}

};