This reference page is linked to from the following overview topics: Plug-in Upgrade Guide, Asset File Path Resolution.

#include <IFileResolutionManager.h>

Inheritance diagram for IFileResolutionManager:

Public Member Functions
virtual MSTR	GetFullFilePath (const MCHAR *filePath, MaxSDK::AssetManagement::AssetType assetType, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual bool	GetFullFilePath (MaxSDK::Util::Path &filePath, MaxSDK::AssetManagement::AssetType assetType, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual bool	GetFullFilePath (const MaxSDK::AssetManagement::AssetUser &assetUser, MaxSDK::Util::Path &filePath, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual bool	GetFullFilePath (const MaxSDK::AssetManagement::AssetUser &assetUser, MSTR &filePath, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual bool	GetFullFilePath (const MaxSDK::AssetManagement::AssetId &assetID, MaxSDK::Util::Path &filePath, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual bool	GetFullFilePath (const MaxSDK::AssetManagement::AssetId &assetID, MSTR &filePath, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual MSTR	GetFullFilePath (const MaxSDK::AssetManagement::AssetUser &assetUser, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual MSTR	GetFullFilePath (const MaxSDK::AssetManagement::AssetId &assetId, bool byPassCache=false)=0
	Resolves the physical location of an asset file.
virtual DWORD	GetMaximumCacheDuration ()=0
	Returns the maximum age of cached data in milliseconds for it to be valid Cache data that is older that than this duration is not used of file asset resolution.
virtual void	SetMaximumCacheDuration (DWORD newMaxDuration)=0
	Sets the maximum age of valid cached data in milliseconds Cache data that is older that than this duration is not used of file asset resolution.
virtual bool	IsCachingEnabled ()=0
	Returns true if the file resolution manager is using cached data to resolve files.
virtual void	EnableCaching ()=0
	This makes the file resolution manager use cached results when resolving files.
virtual void	DisableCaching ()=0
	This makes the file resolution manager not use cached results when resolving files.
virtual void	PushAllowCachingOfUnresolvedResults (bool newVal)=0
	Pushes current state and sets whether caching of unresolved results is permitted Normally caching of unresolved results is off, and turned on only when loading a lot of asset files quickly, like at the beginning of a render.
virtual void	PopAllowCachingOfUnresolvedResults ()=0
	Pops state of whether caching of unresolved results is permitted.
virtual void	DoGetUniversalFileName (MaxSDK::Util::Path &aFullFilePath) const =0
	Transforms an absolute file path to a UNC path.
virtual void	DoGetUniversalFileName (MSTR &fullFilePath) const =0
	Transforms an absolute file path to a UNC path.
virtual void	UpdateDotIniFile ()=0
virtual int	GetNumAssetTypes () const =0
	Return the number of asset types currently registered.
virtual MaxSDK::AssetManagement::AssetType	GetAssetType (const MSTR &assetType) const =0
	Returns the asset type ID for the asset type name If the asset type does not exist, it registers the new asset type identified by the string passed in parameter and returns the asset type ID.
virtual const MCHAR *	GetAssetTypeString (MaxSDK::AssetManagement::AssetType assetType) const =0
	Returns the asset type name for the asset type If the asset type does not exist, a null pointer is returned.
Static Public Member Functions
static AssetMgmntExport IFileResolutionManager *	GetInstance ()
	Returns the only instance of this manager.
Protected Member Functions
virtual	~IFileResolutionManager ()

Constructor & Destructor Documentation

virtual ~IFileResolutionManager ( ) [inline, protected, virtual]

{}

Member Function Documentation

static AssetMgmntExport IFileResolutionManager* GetInstance ( ) [static]

Search for all occurrences

Returns the only instance of this manager.

virtual MSTR GetFullFilePath	(	const MCHAR *	filePath,
		MaxSDK::AssetManagement::AssetType	assetType,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	filePath	: is a possible location of the asset file. This location may be a relative or absolute file path. If filePath is a relative file path, it may rooted at the max project folder(by default the folder that contains the 3dsmax.exe file) or it may be rooted at the folder holds the scenefile, or it may be rooted at one of the User Paths for the specified assetType, in this order. filePath includes the asset's filename.
[in]	assetType,:	e.g. kXRefAsset, kBitmapAsset, kVideoPost, etc
[in]	byPassCache	: If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: a MSTR with an absolute path or the where the asset is located if successful; otherwise returns an empty MSTR if it fails to find the asset file

virtual bool GetFullFilePath	(	MaxSDK::Util::Path &	filePath,
		MaxSDK::AssetManagement::AssetType	assetType,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	filePath	: is a possible location of the asset file. This location may be a relative or absolute file path. If filePath is a relative file path, it may rooted at the max project folder(by default the folder that contains the 3dsmax.exe file) or it may be rooted at the folder holds the scenefile , or it may be rooted at one of the User Paths for the specified assetType, in this order. filePath includes the asset's filename.
[out]	filePath	: is set to an absolute UNC path if the asset file is found. If the asset file is not found it is left unchanged.
[in]	assetType,:	e.g. kXRefAsset, kBitmapAsset, kVideoPost, etc
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: true if the asset file is located successful; otherwise returns false

virtual bool GetFullFilePath	(	const MaxSDK::AssetManagement::AssetUser &	assetUser,
		MaxSDK::Util::Path &	filePath,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetUser	: the AssetUser to retrieve the asset file information from
[out]	filePath	: is set to an absolute UNC path if the asset file is found. If the asset file is not found it is left unchanged.
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: true if the asset file is located successful; otherwise returns false

virtual bool GetFullFilePath	(	const MaxSDK::AssetManagement::AssetUser &	assetUser,
		MSTR &	filePath,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetUser	: the AssetUser to retrieve the asset file information from
[out]	filePath	: is set to an absolute UNC path if the asset file is found. If the asset file is not found it is left unchanged.
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: true if the asset file is located successful; otherwise returns false

virtual bool GetFullFilePath	(	const MaxSDK::AssetManagement::AssetId &	assetID,
		MaxSDK::Util::Path &	filePath,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetID	: a unique ID that specifies a particular asset
[out]	filePath	: is set to an absolute UNC path if the asset file is found. If the asset file is not found it is left unchanged.
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: true if the asset file is located successful; otherwise returns false

virtual bool GetFullFilePath	(	const MaxSDK::AssetManagement::AssetId &	assetID,
		MSTR &	filePath,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetID	: a unique ID that specifies a particular asset
[out]	filePath	: is set to an absolute UNC path if the asset file is found. If the asset file is not found it is left unchanged.
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: true if the asset file is located successful; otherwise returns false

virtual MSTR GetFullFilePath	(	const MaxSDK::AssetManagement::AssetUser &	assetUser,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetUser	: the AssetUser to retrieve the asset file information from
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: a MSTR with an absolute path or the where the asset is located if successful; otherwise returns an empty MSTR if it fails to find the asset file

virtual MSTR GetFullFilePath	(	const MaxSDK::AssetManagement::AssetId &	assetId,
		bool	byPassCache = `false`
	)		`[pure virtual]`

Search for all occurrences

Resolves the physical location of an asset file.

Gets an absolute UNC path of an asset file

Parameters:

[in]	assetUser	: the AssetUser to retrieve the asset file information from
[in]	byPassCache,:	If set to true, the file resolution manager bypasses the cache and attempts to find the asset file on disk or network.

Returns:: a MSTR with an absolute path or the where the asset is located if successful; otherwise returns an empty MSTR if it fails to find the asset file

virtual DWORD GetMaximumCacheDuration ( ) [pure virtual]

Search for all occurrences

Returns the maximum age of cached data in milliseconds for it to be valid Cache data that is older that than this duration is not used of file asset resolution.

Returns:: the maximum age of cached data in milliseconds for it to be valid

virtual void SetMaximumCacheDuration ( DWORD newMaxDuration ) [pure virtual]

Search for all occurrences

Sets the maximum age of valid cached data in milliseconds Cache data that is older that than this duration is not used of file asset resolution.

Parameters:

[in] newMaxDuration : maximum age of valid cached data in milliseconds.

virtual bool IsCachingEnabled ( ) [pure virtual]

Search for all occurrences

Returns true if the file resolution manager is using cached data to resolve files.

Returns:: true if caching is used

virtual void EnableCaching ( ) [pure virtual]

Search for all occurrences

This makes the file resolution manager use cached results when resolving files.

virtual void DisableCaching ( ) [pure virtual]

Search for all occurrences

This makes the file resolution manager not use cached results when resolving files.

virtual void PushAllowCachingOfUnresolvedResults ( bool newVal ) [pure virtual]

Search for all occurrences

Pushes current state and sets whether caching of unresolved results is permitted Normally caching of unresolved results is off, and turned on only when loading a lot of asset files quickly, like at the beginning of a render.

Parameters:

[in] newVal : whether caching of unresolved results is permitted.

virtual void PopAllowCachingOfUnresolvedResults ( ) [pure virtual]

Search for all occurrences

Pops state of whether caching of unresolved results is permitted.

virtual void DoGetUniversalFileName ( MaxSDK::Util::Path & aFullFilePath ) const [pure virtual]

Search for all occurrences

Transforms an absolute file path to a UNC path.

Transforms an absolute file path to a UNC path

Parameters:

[in]	aFullFilePath	: an absolute file path.
[out]	aFullFilePath	: a UNC path. It is only converted to a UNC path if the user preference "Resolve Path to UNC" is turned on

virtual void DoGetUniversalFileName ( MSTR & fullFilePath ) const [pure virtual]

Search for all occurrences

Transforms an absolute file path to a UNC path.

Transforms an absolute file path to a UNC path

Parameters:

[in]	fullFilePath	: an absolute file path.
[out]	fullFilePath	: a UNC path. It is only converted to a UNC path if the user preference "Resolve Path to UNC" is turned on

virtual void UpdateDotIniFile ( ) [pure virtual]

Search for all occurrences

virtual int GetNumAssetTypes ( ) const [pure virtual]

Search for all occurrences

Return the number of asset types currently registered.

Returns:: number of currently registered types

virtual MaxSDK::AssetManagement::AssetType GetAssetType ( const MSTR & assetType ) const [pure virtual]

Search for all occurrences

Returns the asset type ID for the asset type name If the asset type does not exist, it registers the new asset type identified by the string passed in parameter and returns the asset type ID.

If the asset type is already registered, it returns the ID corresponding to the asset type name.

Parameters:

[in] assetType : the asset type name.

Returns:: the asset type ID

virtual const MCHAR* GetAssetTypeString ( MaxSDK::AssetManagement::AssetType assetType ) const [pure virtual]

Search for all occurrences

Returns the asset type name for the asset type If the asset type does not exist, a null pointer is returned.

Parameters:

[in] assetType : the asset type ID to return a name for

Returns:: the asset type name

IFileResolutionManager Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation