Public Member Functions

IATSCustomDeps Class Reference

Search for all occurrences

Detailed Description

Interface to Asset Tracking Custom Dependencies.

This interface gives access to the list of files defined as Custom Dependencies. Custom Dependencies are reported as external file dependencies. Any file can be added to the Custom Dependency list.

#include <IATSCustomDeps.h>

Inheritance diagram for IATSCustomDeps:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool  LaunchDialog (HWND hParent)=0
  Launch Custom Dependency dialog.
virtual int  NumFiles ()=0
  Number of Custom Dependency files.
virtual const MCHAR *  GetFile (UINT iIndex)=0
  Get file by index.
virtual int  GetFiles (MaxSDK::Array< MSTR > &files)=0
  Get list of files.
virtual int  AddFile (const MCHAR *szFile)=0
  Add file to list.
virtual bool  SetFile (UINT iIndex, const MCHAR *szFile)=0
  Set file name in list.
virtual bool  RemoveFile (UINT iIndex)=0
  Remove file from list by index.
virtual bool  RemoveFile (const MCHAR *szFile)=0
  Remove file from list by name.
virtual bool  RemoveAll ()=0
  Remove all files from list.
virtual void  EnumAuxFiles (AssetEnumCallback &nameEnum, DWORD flags=FILE_ENUM_ALL)=0
  Internal EnumAuxFiles method.

Member Function Documentation

virtual bool LaunchDialog ( HWND  hParent ) [pure virtual]

Launch Custom Dependency dialog.

Parameters:
[in] hParent HWND of parent window
Returns:
true if success, false if failure
virtual int NumFiles ( ) [pure virtual]

Number of Custom Dependency files.

Returns:
Number of files
virtual const MCHAR* GetFile ( UINT  iIndex ) [pure virtual]

Get file by index.

Parameters:
[in] iIndex 0-based index into list of files.
Returns:
string containing the filename
virtual int GetFiles ( MaxSDK::Array< MSTR > &  files ) [pure virtual]

Get list of files.

Parameters:
[out] files reference to a Tab of TSTRs. This parameter will be filled with a copy of the Custom Dependency files.
Returns:
number files added to Tab.
virtual int AddFile ( const MCHAR *  szFile ) [pure virtual]

Add file to list.

Parameters:
[in] szFile string that contains a file name. If the file is already contained in the list, it will not be added.
Returns:
index of szFile in the file list
virtual bool SetFile ( UINT  iIndex,
const MCHAR *  szFile 
) [pure virtual]

Set file name in list.

Parameters:
[in] iIndex 0-based index into list of files.
[in] szFile string that contains a file name.
Returns:
true if success, false if failure
virtual bool RemoveFile ( UINT  iIndex ) [pure virtual]

Remove file from list by index.

Parameters:
[in] iIndex 0-based index into list of files.
Returns:
true if success, false if failure
virtual bool RemoveFile ( const MCHAR *  szFile ) [pure virtual]

Remove file from list by name.

Parameters:
[in] szFile string that contains a file name.
Returns:
true if success, false if failure
virtual bool RemoveAll ( ) [pure virtual]

Remove all files from list.

Returns:
true if success, false if failure
virtual void EnumAuxFiles ( AssetEnumCallback nameEnum,
DWORD  flags = FILE_ENUM_ALL 
) [pure virtual]

Internal EnumAuxFiles method.

Used internally to allow Custom Dependencies to be reported as external scene file dependencies.


IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps
IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps IATSCustomDeps