IPathConfigMgr.h

Go to the documentation of this file.

/*
*       IPathConfigMgr.h - Public interface for modifying application paths.
*
*           Copyright (c) Autodesk, Inc, 2005.  David Cunningham.
*
*/

#pragma once

#include "iFnPub.h"
#include "Path.h"
#include "AssetManagement\AssetType.h"

// forward declarations
class AssetEnumCallback;
namespace MaxSDK
{
    namespace AssetManagement
    {
        class AssetUser;
    }
}

#define PATHCONFIG_INTERFACE   Interface_ID(0x490ddc99, 0xbe8dc96)

class IPathConfigMgr : public FPStaticInterface
{
public:

    virtual bool LoadPathConfiguration(const MCHAR* filename) = 0;

    virtual bool MergePathConfiguration(const MCHAR* filename) = 0;

    virtual bool SavePathConfiguration(const MCHAR* filename) = 0;

    virtual const MCHAR *GetDir(int which) const =0;        

    virtual bool SetDir(int which, const MCHAR *dir) = 0;

    virtual int GetPlugInEntryCount() const =0; 

    virtual const MCHAR *GetPlugInDesc(int i) const =0;

    virtual const MCHAR *GetPlugInDir(int i) const =0;  

    // asset path

    virtual int GetAssetDirCount(MaxSDK::AssetManagement::AssetType assetType) const =0;    

    virtual const MCHAR *GetAssetDir(int i, MaxSDK::AssetManagement::AssetType assetType) const =0;

    virtual bool AddAssetDir(const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType)=0;

    virtual bool AddAssetDir(const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType, int update) = 0;

    virtual bool DeleteAssetDir(int i, MaxSDK::AssetManagement::AssetType assetType, int update) = 0;

    virtual bool AddSessionAssetDir(const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType, int update)=0;

    virtual int GetSessionAssetDirCount(MaxSDK::AssetManagement::AssetType assetType) const =0;

    virtual const MCHAR *GetSessionAssetDir(int i, MaxSDK::AssetManagement::AssetType assetType) const =0;

    virtual bool DeleteSessionAssetDir(int i, MaxSDK::AssetManagement::AssetType assetType, int update)=0;

    virtual int GetCurAssetDirCount(MaxSDK::AssetManagement::AssetType assetType) const =0;

    virtual const MCHAR *GetCurAssetDir(int i, MaxSDK::AssetManagement::AssetType assetType) const =0;

    virtual void UpdateAssetSection(MaxSDK::AssetManagement::AssetType assetType) = 0;

    virtual MSTR GetMAXIniFile() const = 0; 

    virtual bool GetResolveUNC() const = 0;

    virtual void SetResolveUNC(bool aFlag) = 0;

    virtual bool GetResolveToRelative() const = 0;

    virtual void SetResolveToRelative(bool aFlag) = 0;

    virtual void AppendSlash ( MCHAR *path ) const = 0;

    virtual void RemoveSlash ( MCHAR *path ) const = 0;

    virtual void AppendSlash ( MSTR &path ) const = 0;

    virtual void RemoveSlash ( MSTR &path ) const = 0;

    virtual bool IsUsingProfileDirectories() const = 0;

    virtual bool IsUsingRoamingProfiles() const = 0;

    virtual const MaxSDK::Util::Path& GetCurrentProjectFolder() const = 0;

    virtual bool SetCurrentProjectFolder(const MaxSDK::Util::Path& aDirectory) = 0;

    virtual bool SetSessionProjectFolder(const MaxSDK::Util::Path& aDirectory) = 0;

    virtual bool DoProjectSetupSteps() const = 0;

    virtual bool DoProjectSetupStepsUsingDirectory(const MaxSDK::Util::Path& aDirectory) const = 0;

    virtual bool IsProjectFolder(const MaxSDK::Util::Path& aDirectoryToCheck) const = 0;

    virtual MaxSDK::Util::Path GetProjectFolderPath(const MaxSDK::Util::Path& aProjectRoot) const = 0;

    virtual MaxSDK::Util::Path GetCurrentProjectFolderPath() const = 0;

    virtual void MakePathRelativeToProjectFolder(MaxSDK::Util::Path& aPath) const = 0;

    virtual bool CreateDirectoryHierarchy(const MaxSDK::Util::Path& aPath) const = 0;

    virtual bool DoesFileExist(const MaxSDK::Util::Path& aPath) const = 0;

    virtual void NormalizePathAccordingToSettings(MaxSDK::Util::Path& aPath) const = 0;

    virtual void RecordInputAsset(
        const MaxSDK::AssetManagement::AssetUser& originalPath,
        AssetEnumCallback &nameEnum, 
        DWORD flags) const = 0;

    virtual void RecordOutputAsset(
        const MaxSDK::AssetManagement::AssetUser &originalAsset,
        AssetEnumCallback &nameEnum, 
        DWORD flags) const = 0;

    virtual int GetProjectSubDirectoryCount() const = 0;

    virtual const MCHAR* GetProjectSubDirectory(int aIndex) const = 0;

    virtual void AddProjectDirectoryCreateFilter(int aID) = 0;

    virtual void RemoveAllProjectDirectoryCreateFilters() = 0;

    virtual void RemoveProjectDirectoryCreateFilter(int aID) = 0;

    CoreExport static IPathConfigMgr* GetPathConfigMgr(); 
};