#include <IATSMax.h>

Class Description

Interface to Asset Tracking System.

This interface gives access to the Asset Tracking System. This includes control over the Asset Tracking dialog, support dialogs, and version control system integration. It also provides access to the Asset Repathing UI functionality and file dependency information. The version control system related methods (such as checkin, checkout, etc.) incorporate the common dialogs used for all providers. For lower level access to providers use the IATSProvider interface.

See also: IATSProvider, ATSFileList

Inheritance diagram for IATSMax:

Public Member Functions
Dialog Access
virtual bool	GetVisible ()=0
	Get visibility state of dialog. More...

virtual void	SetVisible (bool bVisible)=0
	Set visibility state of dialog. More...

virtual int	NumFilesSelected ()=0
	Number of files selected in dialog. More...

virtual int	GetSelectedFiles (MaxSDK::Array< MSTR > &fileList)=0
	Get selected files. More...

virtual int	GetFilesByFileSystemStatus (DWORD dwFSStatus, MaxSDK::Array< MSTR > &fileList)=0
	Get a tab of files based on their file system status. More...

virtual DWORD	GetFileSystemStatus (const MCHAR *szFilename)=0
	Return the file system status of the specified file. More...

virtual int	GetResolvedPaths (const MaxSDK::Array< MSTR > &fileList, MaxSDK::Array< MSTR > &resolvedFileList)=0
	Get the resolved file paths for a given list of files. More...

virtual int	GetDependencyFileList (Animatable *animatable, MaxSDK::Array< MSTR > &fileList, bool includeRefHierarchy)=0
	Get the list of files that are used by the given Animatable. More...

virtual int	NumFiles ()=0
	Number of files in dialog. More...

virtual int	GetFiles (MaxSDK::Array< MSTR > &fileList)=0
	Get files. More...

virtual int	GetATSFileList (ATSFileList &atsFileList, bool bSetAllActive, bool bTagExcluded)=0
	Populate an ATSFileList object. More...

virtual int	GetDependentFiles (const MCHAR *szFile, bool bRecurse, MaxSDK::Array< MSTR > &fileList, bool bIncludeOutputFiles=true)=0
	Get list of dependent files. More...

virtual bool	IsInputFile (const MCHAR *szFile)=0
	Determine if a file is an input file and a true dependent file. More...

virtual void	SelectFiles (const MaxSDK::Array< MSTR > &fileList)=0
	Select files. More...

virtual void	ClearSelection ()=0
	Clears all selections in dialog. More...

virtual void	Refresh ()=0
	Refreshes the dialog. More...

Options
virtual bool	GetDisabled ()=0
	Get disabled state of dialog. More...

virtual void	SetDisabled (bool bDisabled)=0
	Set disabled state of dialog. More...

virtual bool	GetSilent ()=0
	Get silent state of dialog. More...

virtual void	SetSilent (bool bSilent)=0
	Set silent state of dialog. More...

virtual bool	GetAutoLogin ()=0
	Get autologin state of dialog. More...

virtual void	SetAutoLogin (bool bAutoLogin)=0
	Set autologin state of dialog. More...

virtual bool	GetTreeView ()=0
	Get state of tree view. More...

virtual void	SetTreeView (bool bTreeView)=0
	Set state of tree view. More...

virtual bool	GetTableView ()=0
	Get state of table view. More...

virtual void	SetTableView (bool bTableView)=0
	Set state of table view. More...

virtual bool	GetCheckNetworkPaths () const =0
	Get state of Check Network Path property. More...

virtual void	SetCheckNetworkPaths (bool bCheckPaths)=0
	Set state of Check Network Path property. More...

virtual bool	GetDisplayExcluded ()=0
	Get display state of excluded files. More...

virtual void	SetDisplayExcluded (bool bDisplay)=0
	Set display state of excluded files. More...

virtual bool	GetExcludeOutputFiles ()=0
	Get the exclusion state of output files. More...

virtual void	SetExcludeOutputFiles (bool bExclude)=0
	Set the exclusion state of output files. More...

Aux Dialog
virtual void	ShowPromptsDialog ()=0
	Display Prompts dialog. More...

virtual void	ShowWorkingCommentDialog ()=0
	Display Working Comment dialog. More...

virtual void	ShowStatusLogDialog ()=0
	Display Status Log dialog. More...

Providers
virtual int	NumProviders ()=0
	Number of registered providers. More...

virtual IATSProvider *	GetProvider (int iProviderIndex)=0
	Get IATSProvider pointer. More...

virtual const MCHAR *	GetProviderName (int iProviderIndex)=0
	Get ATS Provider name. More...

virtual int	GetActiveProvider ()=0
	Get active ATS Provider index. More...

virtual void	SetActiveProvider (int iProviderIndex)=0
	Set active ATS Provider. More...

virtual bool	LoginProvider (int iProviderIndex)=0
	Login to specified ATS Provider. More...

virtual bool	LogoutProvider (int iProviderIndex)=0
	Logout of specified ATS Provider. More...

virtual bool	IsFileExcluded (int iProviderIndex, const MCHAR *szFile)=0
	Determine if a file is excluded by an ATS Provider. More...

virtual bool	IsFileShareLocked (int iProviderIndex, const MCHAR *szFile)=0
	Determine if a file is share locked by an ATS Provider. More...

virtual bool	Checkin (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList, MSTR &strComment)=0
	Checkin list of files to an ATS Provider. More...

virtual bool	Checkout (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList, MSTR &strComment)=0
	Checkout list of files to an ATS Provider. More...

virtual bool	UnCheckout (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList)=0
	Undo Checkout for list of files fr an ATS Provider. More...

virtual bool	AddFiles (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList, MSTR &strComment, Tab< bool > *pIsHidden=NULL)=0
	Add list of files to an ATS Provider. More...

virtual bool	GetLatest (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList)=0
	Get latest version of list of files for an ATS Provider. More...

Policies
virtual void	CheckForDependentFiles (int iProviderIndex, const MCHAR *szFilename)=0
	Policy check for dependent files. More...

virtual void	CheckForCheckedOutFiles (int iProviderIndex)=0
	Policy check for checked out files. More...

virtual void	CheckForUnControlledFiles (int iProviderIndex)=0
	Policy check for uncontrolled files. More...

virtual void	CheckForOutDatedFiles (int iProviderIndex)=0
	Policy check for out dated files. More...

virtual void	CheckForSceneFileCheckOut (int iProviderIndex)=0
	Policy check scene file. More...

Misc
virtual void	SetWorkingComment (const MCHAR *szComment)=0
	Set the current Working Comment. More...

virtual const MCHAR *	GetWorkingComment ()=0
	Get the current Working Comment. More...

virtual void	AppendStatusLog (const MCHAR *szStatus)=0
	Append status message to Status Log. More...

virtual void	ClearStatusLog ()=0
	Clear the contents of the Status Log. More...

virtual const MCHAR *	GetStatusLog ()=0
	Get the conents of the Status Log. More...

Repathing functionality - via UI
virtual bool	SetPath (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0
	Sets the path on all listed assets to the passed in path. More...

virtual bool	SetPathOnSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0
	Sets the path on the asset selection set. More...

virtual bool	RetargetCommonRoot (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0
	Retargets the common-root portion of all assets listed in the ATS. More...

virtual bool	RetargetCommonRootOfSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0
	Retargets the common-root portion of assets selected in the ATS. More...

virtual bool	RetargetSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0
	Retargets single-asset selection to the value passed in. More...

virtual bool	ResolveSelectionToUNC ()=0
	Resolve the current selection set to its UNC equivalent,. More...

virtual bool	ResolveSelectionRelativeToProjectFolder ()=0
	Converts the current selection set to relative paths. More...

virtual bool	ResolveSelectionToAbsolute ()=0
	Converts the current selection set to absolute paths. More...

Repathing functionality - generic
virtual bool	RetargetAssets (ReferenceTarget &refTarget, const MCHAR aOldPath, const MCHAR aNewPath, bool aCreateOutputFolder=false)=0
	Generically remaps assets declared by a ReferenceTarget. More...

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Function Documentation

virtual bool GetVisible ( )

pure virtual

Get visibility state of dialog.

Returns: true if visible, false if not

virtual void SetVisible ( bool bVisible )

pure virtual

Set visibility state of dialog.

Parameters

[in] bVisible true to display dialog, false to hide dialog

virtual int NumFilesSelected ( )

pure virtual

Number of files selected in dialog.

Returns: number of files selected in dialog

virtual int GetSelectedFiles ( MaxSDK::Array< MSTR > & fileList )

pure virtual

Get selected files.

Parameters

[out] fileList reference to a Tab of TSTRs. This parameter will be filled with a copy of the selected files names

Returns: number of files selected in dialog

virtual int GetFilesByFileSystemStatus	(	DWORD	dwFSStatus,
		MaxSDK::Array< MSTR > &	fileList
	)

pure virtual

Get a tab of files based on their file system status.

Parameters

[in]	dwFSStatus	is a mask of kATSFSStatusXXX flags used to match against file entries.
[out]	fileList	reference to a Tab of TSTRs. This parameter will be filled with a copy of the files matching the dwFSStatus flags.

Returns: number of files found

virtual DWORD GetFileSystemStatus ( const MCHAR * szFilename )

pure virtual

Return the file system status of the specified file.

Parameters

[in] szFilename string containing the filename to retrieve status from.

Returns: file system status flag

virtual int GetResolvedPaths	(	const MaxSDK::Array< MSTR > &	fileList,
		MaxSDK::Array< MSTR > &	resolvedFileList
	)

pure virtual

Get the resolved file paths for a given list of files.

Parameters

[in]	fileList	reference to a Tab of TSTRs.
[out]	resolvedFileList	reference to a Tab of TSTRs that contains the same number of entries in fileList. If the file was found or is still missing the entry in resolvedFileList will be the same as fileList. If the file was resolved the entry in resolvedFileList will contains the resolved file path. Resolved files are files not found in the location specified within the scene file but are found using the standard and user defined search paths.

Returns: the number of resolved paths

virtual int GetDependencyFileList	(	Animatable *	animatable,
		MaxSDK::Array< MSTR > &	fileList,
		bool	includeRefHierarchy
	)

pure virtual

Get the list of files that are used by the given Animatable.

Parameters

[in]	animatable	The animatable for which the file dependencies are to be listed.
[out]	fileList	The table through which the file list is returned.
[in]	includeRefHierarchy	Set to true to list dependencies of the entire reference hierarchy; set to false to limit the list to 'animatable'.

virtual int NumFiles ( )

pure virtual

Number of files in dialog.

Returns: number of files in dialog

virtual int GetFiles ( MaxSDK::Array< MSTR > & fileList )

pure virtual

Get files.

Parameters

[out] fileList reference to a Tab of TSTRs. This parameter will be filled with a copy of the files names in the dialog

Returns: number of files in dialog

virtual int GetATSFileList	(	ATSFileList &	atsFileList,
		bool	bSetAllActive,
		bool	bTagExcluded
	)

pure virtual

Populate an ATSFileList object.

See also: ATSFileList

Parameters

[out]	atsFileList	reference to an ATSFileList object.
[in]	bSetAllActive	specifies if all of the files added to the ATSFileList object will be marked as active (kATSStatusActive)
[in]	bTagExcluded	specifies if files excluded from the current provider should be marked as excluded (kATSStatusExcluded)

Returns: number of files added to atsFileList

virtual int GetDependentFiles	(	const MCHAR *	szFile,
		bool	bRecurse,
		MaxSDK::Array< MSTR > &	fileList,
		bool	bIncludeOutputFiles = `true`
	)

pure virtual

Get list of dependent files.

Parameters

[in]	szFile	string containing the filename to list dependent files from
[in]	bRecurse	specifies if method should include all dependent files
[out]	fileList	reference to a Tab of TSTRs. This parameter will be filled with a copy of the dependent files names
[in]	bIncludeOutputFiles	specifies if output files should be included in dependency list

Returns: number of files added to fileList

virtual bool IsInputFile ( const MCHAR * szFile )

pure virtual

Determine if a file is an input file and a true dependent file.

Parameters

[in] szFile string that contains the file name

Returns: true if the file is an input file, or false if it is an output or not found

virtual void SelectFiles ( const MaxSDK::Array< MSTR > & fileList )

pure virtual

Select files.

Parameters

[in] fileList reference to a Tab of TSTRs. This parameter specifies the list of files to select in the dialog.

virtual void ClearSelection ( )

pure virtual

Clears all selections in dialog.

virtual void Refresh ( )

pure virtual

Refreshes the dialog.

This method both updates the dependent file list and if connected to an ATS Provider it will query the server for updated version control status

virtual bool GetDisabled ( )

pure virtual

Get disabled state of dialog.

Returns: true if disabled, false if not

virtual void SetDisabled ( bool bDisabled )

pure virtual

Set disabled state of dialog.

Parameters

[in] bDisabled true to disable, false to enable

virtual bool GetSilent ( )

pure virtual

Get silent state of dialog.

If connected to an ATS Provider, the provider might not respect the silent flag and display dialogs.

Returns: true if silent, false if not

virtual void SetSilent ( bool bSilent )

pure virtual

Set silent state of dialog.

Parameters

[in] bSilent true to silent, false to enable

virtual bool GetAutoLogin ( )

pure virtual

Get autologin state of dialog.

This will attempt to login to all registered ATS Providers when a project (scene file) is open.

Returns: true if autologin is enabled, false if not

virtual void SetAutoLogin ( bool bAutoLogin )

pure virtual

Set autologin state of dialog.

Parameters

[in] bAutoLogin true to auto login, false to enable

virtual bool GetTreeView ( )

pure virtual

Get state of tree view.

Returns: true if tree view is display, false if not

virtual void SetTreeView ( bool bTreeView )

pure virtual

Set state of tree view.

Parameters

[in] bTreeView true to display tree view, false to display table view

virtual bool GetTableView ( )

pure virtual

Get state of table view.

Returns: true if table view is display, false if not

virtual void SetTableView ( bool bTableView )

pure virtual

Set state of table view.

Parameters

[in] bTableView true to display table view, false to display tree view

virtual bool GetCheckNetworkPaths ( ) const

pure virtual

Get state of Check Network Path property.

Returns: true if the ATS system checks for the existence of files on network drives

virtual void SetCheckNetworkPaths ( bool bCheckPaths )

pure virtual

Set state of Check Network Path property.

Parameters

[in] bCheckPaths true if the ATS should check for the existence of files on network drives

virtual bool GetDisplayExcluded ( )

pure virtual

Get display state of excluded files.

Returns: true if excluded files are display, false if they are not

virtual void SetDisplayExcluded ( bool bDisplay )

pure virtual

Set display state of excluded files.

Parameters

[in] bDisplay true to display excluded, false to hide excluded files

virtual bool GetExcludeOutputFiles ( )

pure virtual

Get the exclusion state of output files.

Returns: true if output files are excluded, false if they are not

virtual void SetExcludeOutputFiles ( bool bExclude )

pure virtual

Set the exclusion state of output files.

Parameters

[in] bExclude true to exclude output files, false to include output files

virtual void ShowPromptsDialog ( )

pure virtual

Display Prompts dialog.

virtual void ShowWorkingCommentDialog ( )

pure virtual

Display Working Comment dialog.

virtual void ShowStatusLogDialog ( )

pure virtual

Display Status Log dialog.

virtual int NumProviders ( )

pure virtual

Number of registered providers.

Returns: number of registered ATS providers

virtual IATSProvider* GetProvider ( int iProviderIndex )

pure virtual

Get IATSProvider pointer.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

Returns: pointer to IATSProvider interface

virtual const MCHAR* GetProviderName ( int iProviderIndex )

pure virtual

Get ATS Provider name.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

Returns: string that contains name of provider

virtual int GetActiveProvider ( )

pure virtual

Get active ATS Provider index.

Returns: index of active ATS Provider

virtual void SetActiveProvider ( int iProviderIndex )

pure virtual

Set active ATS Provider.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

virtual bool LoginProvider ( int iProviderIndex )

pure virtual

Login to specified ATS Provider.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

Returns: true if the login was successful

virtual bool LogoutProvider ( int iProviderIndex )

pure virtual

Logout of specified ATS Provider.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

Returns: true if the logout was successful

virtual bool IsFileExcluded	(	int	iProviderIndex,
		const MCHAR *	szFile
	)

pure virtual

Determine if a file is excluded by an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	szFile	string that contains the file name

Returns: true if the file is excluded by the provider, false if it is not

virtual bool IsFileShareLocked	(	int	iProviderIndex,
		const MCHAR *	szFile
	)

pure virtual

Determine if a file is share locked by an ATS Provider.

A file is considered share locked if the file is checked out by another user at a shared location. Share locked files should be treated as read-only by users who are accessing the file and are not the owner of the lock.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider. If iProviderIndex is -1, the method will check all providers for a share locked status.
[in]	szFile	string that contains the file name

Returns: true if the file is share locked by the provider, false if it is not

virtual bool Checkin	(	int	iProviderIndex,
		const MaxSDK::Array< MSTR > &	fileList,
		MSTR &	strComment
	)

pure virtual

Checkin list of files to an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	fileList	reference to a Tab of TSTRs.
[in]	strComment	reference to MSTR

Returns: true if status from version control provider was successful, false if otherwise

virtual bool Checkout	(	int	iProviderIndex,
		const MaxSDK::Array< MSTR > &	fileList,
		MSTR &	strComment
	)

pure virtual

Checkout list of files to an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	fileList	reference to a Tab of TSTRs.
[in]	strComment	reference to MSTR

Returns: true if status from version control provider was successful, false if otherwise

virtual bool UnCheckout	(	int	iProviderIndex,
		const MaxSDK::Array< MSTR > &	fileList
	)

pure virtual

Undo Checkout for list of files fr an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	fileList	reference to a Tab of TSTRs.

Returns: true if status from version control provider was successful, false if otherwise

virtual bool AddFiles	(	int	iProviderIndex,
		const MaxSDK::Array< MSTR > &	fileList,
		MSTR &	strComment,
		Tab< bool > *	pIsHidden = `NULL`
	)

pure virtual

Add list of files to an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	fileList	reference to a Tab of TSTRs.
[in]	strComment	reference to MSTR
[in]	pIsHidden	optional pointer to Tab<bool> that corresponds to the fileList. A true entry indicates that the file will be added with a hidden status (if supported by the provider).

Returns: true if status from version control provider was successful, false if otherwise

virtual bool GetLatest	(	int	iProviderIndex,
		const MaxSDK::Array< MSTR > &	fileList
	)

pure virtual

Get latest version of list of files for an ATS Provider.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	fileList	reference to a Tab of TSTRs.

Returns: true if status from version control provider was successful, false if otherwise

virtual void CheckForDependentFiles	(	int	iProviderIndex,
		const MCHAR *	szFilename
	)

pure virtual

Policy check for dependent files.

This will verify that the dependent files, as reported by the ATS Provider, are up to date on the user's machine.

Parameters

[in]	iProviderIndex	0-based index of ATS Provider
[in]	szFilename	string that contains the file name to check dependent files for

virtual void CheckForCheckedOutFiles ( int iProviderIndex )

pure virtual

Policy check for checked out files.

This will warn the user of any files that are currently checked out. This is typically called when a scene is about to be closed and the user should check in any checked out files.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

virtual void CheckForUnControlledFiles ( int iProviderIndex )

pure virtual

Policy check for uncontrolled files.

This will warn the user of any files that are not under version control. This is typically called when a scene is about to be closed and the user should add any uncontrolled files to the ATS provider.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

virtual void CheckForOutDatedFiles ( int iProviderIndex )

pure virtual

Policy check for out dated files.

This will warn the user of any files that are not up to date. This is typically called when a scene is loaded and the user should update outdated files.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

virtual void CheckForSceneFileCheckOut ( int iProviderIndex )

pure virtual

Policy check scene file.

This will warn the user if the scene file is under control and it is not checked out. This is typically called when a scene is loaded.

Parameters

[in] iProviderIndex 0-based index of ATS Provider

virtual void SetWorkingComment ( const MCHAR * szComment )

pure virtual

Set the current Working Comment.

Parameters

[in] szComment string that contains the comment

virtual const MCHAR* GetWorkingComment ( )

pure virtual

Get the current Working Comment.

Returns: string that contains the comment

virtual void AppendStatusLog ( const MCHAR * szStatus )

pure virtual

Append status message to Status Log.

Parameters

[in] szStatus string that contains the status message

virtual void ClearStatusLog ( )

pure virtual

Clear the contents of the Status Log.

virtual const MCHAR* GetStatusLog ( )

pure virtual

Get the conents of the Status Log.

Returns: string that contains the contains the status log

virtual bool SetPath	(	const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Sets the path on all listed assets to the passed in path.

Sets the path component of all listed assets to the value passed in to this function.

Note: If the Resolve files and folders to UNC paths option is turned on then this function will automatically convert mapped-drive paths to their UNC equivalent.

Parameters

[in]	aNewPath	The path value that will be applied to all listed assets.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed

virtual bool SetPathOnSelection	(	const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Sets the path on the asset selection set.

Sets the path component of selected assets to the value passed in to this function.

Note: If the Resolve files and folders to UNC paths option is turned on then this function will automatically convert mapped-drive paths to their UNC equivalent.

Precondition: 1+ assets should be selected in the ATS (see SelectFiles above)

Parameters

[in]	aNewPath	The path value that will be applied to all selected assets.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed

virtual bool RetargetCommonRoot	(	const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Retargets the common-root portion of all assets listed in the ATS.

Will retarget the common-root of all assets to the value passed in. For example, if all assets belong to C:\ but are found in different sub-directories of C:\, then only the C:\ will be repathed.

Note: If the Resolve files and folders to UNC paths option is turned on then this function will automatically convert mapped-drive paths to their UNC equivalent.

Precondition: That all editable assets have some common-root portion

Parameters

[in]	aNewPath	The path portion that will be prepended in the place of the common-root.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed

virtual bool RetargetCommonRootOfSelection	(	const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Retargets the common-root portion of assets selected in the ATS.

Will retarget the common-root of selected assets to the value passed in. For example, if the selected assets belong to C:/resources/projectA/ but are found in different sub-directories of that folder, then only the C:/resources/projectA/ portion will be repathed.

Note: If the Resolve files and folders to UNC paths option is turned on then this function will automatically convert mapped-drive paths to their UNC equivalent.

Precondition: That all selected assets have some common-root portion

Parameters

[in]	aNewPath	The path portion that will be prepended in the place of the common-root.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed

virtual bool RetargetSelection	(	const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Retargets single-asset selection to the value passed in.

Retargets a single asset to the value passed-into this function.

Note: If the Resolve files and folders to UNC paths option is turned on then this function will automatically convert mapped-drive paths to their UNC equivalent.

Precondition: That 1 asset only be selected in the ATS.

Postcondition: The single asset is retargeted to the value passed into this function.

Parameters

[in]	aNewPath	The value (including filename) that the single asset should be retargetd to.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed

virtual bool ResolveSelectionToUNC ( )

pure virtual

Resolve the current selection set to its UNC equivalent,.

Resolves the current selection set to UNC, regardless of the current application setting.

Precondition: That one or more assets be selected in the ATS - one of the assets must be an absolute path

Postcondition: One or more assets is resolved to UNC.

Returns: true if the action succeeds and the asset(s) are resolved

virtual bool ResolveSelectionRelativeToProjectFolder ( )

pure virtual

Converts the current selection set to relative paths.

Converts the current selection set to relative paths. If the asset is Found (meaning that it is found in the search path) in a location other than that pointed to by the absolute path, then the relative path will be calculated based on this Found location. If not, then the absolute path is converted to an relative path relative to the current Project Folder setting, if possible.

Precondition: That one or more assets be selected in the ATS - one of the assets must be an absolute path.

Postcondition: One or more assets is resolved to a path relative to the current Project Folder setting, as long as the absolute path exists on the same drive (or UNC) as the current Project Folder.

Returns: true if the action succeeds and the asset(s) are resolved

virtual bool ResolveSelectionToAbsolute ( )

pure virtual

Converts the current selection set to absolute paths.

Converts the current selection set paths to absolute paths. If the asset is Found (meaning that it is found in the search path), then the absolute path will point to the found location. If not, then the relative path is converted to an absolute path relative to the current Project Folder setting.

Precondition: That one or more assets be selected in the ATS - one of the assets must be a relative path

Postcondition: One or more assets is resolved to an absolute path.

Returns: true if the action succeeds and the asset(s) are resolved

virtual bool RetargetAssets	(	ReferenceTarget &	refTarget,
		const MCHAR *	aOldPath,
		const MCHAR *	aNewPath,
		bool	aCreateOutputFolder = `false`
	)

pure virtual

Generically remaps assets declared by a ReferenceTarget.

Generically remaps assets declared by ReferenceTarget whose path value is equal to aOldPath (case-insensitive comparison), to the value aNewPath passed-in. This method calls the EnumAuxFiles implementation of ReferenceTarget to get a listing of assets.

Parameters

[in]	refTarget	The ReferenceTarget object from which assets are declared
[in]	aOldPath	Used to determine which asset to retarget. Any asset declared with this path will be retargeted to aNewPath.
[in]	aNewPath	The retarget value.
[in]	aCreateOutputFolder	If repathing an output directory, and the path being repathed to does not exist, create path folder(s).

Returns: true if the action succeeds and the asset(s) are repathed, false is returned if no asset is repathed

IATSMax Class Reference

Class Description

Public Member Functions

Additional Inherited Members

Member Function Documentation