3ds Max C++ API Reference
|
Interface to Asset Tracking System. More...
#include <IATSMax.h>
Public Member Functions | |
Dialog Access | |
Get visibility state of dialog | |
virtual bool | GetVisible ()=0 |
virtual void | SetVisible (bool bVisible)=0 |
Set visibility state of dialog. | |
virtual int | NumFilesSelected ()=0 |
Number of files selected in dialog. | |
virtual int | GetSelectedFiles (MaxSDK::Array< MSTR > &fileList)=0 |
Get selected files. | |
virtual int | GetFilesByFileSystemStatus (DWORD dwFSStatus, MaxSDK::Array< MSTR > &fileList)=0 |
Get a tab of files based on their file system status. | |
virtual DWORD | GetFileSystemStatus (const MCHAR *szFilename)=0 |
Return the file system status of the specified file. | |
virtual int | GetResolvedPaths (const MaxSDK::Array< MSTR > &fileList, MaxSDK::Array< MSTR > &resolvedFileList)=0 |
Get the resolved file paths for a given list of files. | |
virtual int | GetDependencyFileList (Animatable *animatable, MaxSDK::Array< MSTR > &fileList, bool includeRefHierarchy, bool caseSensitiveFilenames=true, bool getResolvedFileNames=true)=0 |
Get the list of unique filenames that are used by the given Animatable. | |
virtual int | NumFiles ()=0 |
Number of files in dialog. | |
virtual int | GetFiles (MaxSDK::Array< MSTR > &fileList)=0 |
Get files. | |
virtual int | GetATSFileList (ATSFileList &atsFileList, bool bSetAllActive, bool bTagExcluded)=0 |
Populate an ATSFileList object. | |
virtual int | GetDependentFiles (const MCHAR *szFile, bool bRecurse, MaxSDK::Array< MSTR > &fileList, bool bIncludeOutputFiles=true)=0 |
Get list of dependent files. | |
virtual bool | IsInputFile (const MCHAR *szFile)=0 |
Determine if a file is an input file and a true dependent file. | |
virtual void | SelectFiles (const MaxSDK::Array< MSTR > &fileList, bool useResolvedFileNames=true)=0 |
Select files. | |
virtual void | ClearSelection ()=0 |
Clears all selections in dialog. | |
virtual void | Refresh ()=0 |
Refreshes the dialog. | |
Options | |
Get disabled state of dialog | |
virtual bool | GetDisabled ()=0 |
virtual void | SetDisabled (bool bDisabled)=0 |
Set disabled state of dialog. | |
virtual bool | GetSilent ()=0 |
Get silent state of dialog. | |
virtual void | SetSilent (bool bSilent)=0 |
Set silent state of dialog. | |
virtual bool | GetAutoLogin ()=0 |
Get autologin state of dialog. | |
virtual void | SetAutoLogin (bool bAutoLogin)=0 |
Set autologin state of dialog. | |
virtual bool | GetTreeView ()=0 |
Get state of tree view. | |
virtual void | SetTreeView (bool bTreeView)=0 |
Set state of tree view. | |
virtual bool | GetTableView ()=0 |
Get state of table view. | |
virtual void | SetTableView (bool bTableView)=0 |
Set state of table view. | |
virtual bool | GetCheckNetworkPaths () const =0 |
Get state of Check Network Path property. | |
virtual void | SetCheckNetworkPaths (bool bCheckPaths)=0 |
Set state of Check Network Path property. | |
virtual bool | GetDisplayExcluded ()=0 |
Get display state of excluded files. | |
virtual void | SetDisplayExcluded (bool bDisplay)=0 |
Set display state of excluded files. | |
virtual bool | GetExcludeOutputFiles ()=0 |
Get the exclusion state of output files. | |
virtual void | SetExcludeOutputFiles (bool bExclude)=0 |
Set the exclusion state of output files. | |
Aux Dialog | |
Display Prompts dialog | |
virtual void | ShowPromptsDialog ()=0 |
Display Working Comment dialog. | |
virtual void | ShowWorkingCommentDialog ()=0 |
Display Working Comment dialog. | |
virtual void | ShowStatusLogDialog ()=0 |
Display Status Log dialog. | |
Providers | |
Number of registered providers | |
virtual int | NumProviders ()=0 |
virtual IATSProvider * | GetProvider (int iProviderIndex)=0 |
Get IATSProvider pointer. | |
virtual const MCHAR * | GetProviderName (int iProviderIndex)=0 |
Get ATS Provider name. | |
virtual int | GetActiveProvider ()=0 |
Get active ATS Provider index. | |
virtual void | SetActiveProvider (int iProviderIndex)=0 |
Set active ATS Provider. | |
virtual bool | LoginProvider (int iProviderIndex)=0 |
Login to specified ATS Provider. | |
virtual bool | LogoutProvider (int iProviderIndex)=0 |
Logout of specified ATS Provider. | |
virtual bool | IsFileExcluded (int iProviderIndex, const MCHAR *szFile)=0 |
Determine if a file is excluded by an ATS Provider. | |
virtual bool | IsFileShareLocked (int iProviderIndex, const MCHAR *szFile)=0 |
Determine if a file is share locked by an ATS Provider. | |
virtual bool | Checkin (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList, MSTR &strComment)=0 |
Checkin list of files to an ATS Provider. | |
virtual bool | Checkout (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList, MSTR &strComment)=0 |
Checkout list of files to an ATS Provider. | |
virtual bool | UnCheckout (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList)=0 |
Undo Checkout for list of files fr an ATS Provider. | |
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. | |
virtual bool | GetLatest (int iProviderIndex, const MaxSDK::Array< MSTR > &fileList)=0 |
Get latest version of list of files for an ATS Provider. | |
Policies | |
Policy check for dependent files | |
virtual void | CheckForDependentFiles (int iProviderIndex, const MCHAR *szFilename)=0 |
This will verify that the dependent files, as reported by the ATS Provider, are up to date on the user's machine. | |
virtual void | CheckForCheckedOutFiles (int iProviderIndex)=0 |
Policy check for checked out files. | |
virtual void | CheckForUnControlledFiles (int iProviderIndex)=0 |
Policy check for uncontrolled files. | |
virtual void | CheckForOutDatedFiles (int iProviderIndex)=0 |
Policy check for out dated files. | |
virtual void | CheckForSceneFileCheckOut (int iProviderIndex)=0 |
Policy check scene file. | |
Misc | |
Set the current Working Comment | |
virtual void | SetWorkingComment (const MCHAR *szComment)=0 |
virtual const MCHAR * | GetWorkingComment ()=0 |
Get the current Working Comment. | |
virtual void | AppendStatusLog (const MCHAR *szStatus)=0 |
Append status message to Status Log. | |
virtual void | ClearStatusLog ()=0 |
Clear the contents of the Status Log. | |
virtual const MCHAR * | GetStatusLog ()=0 |
Get the conents of the Status Log. | |
Repathing functionality - via UI | |
Sets the path on all listed assets to the passed in path | |
virtual bool | SetPath (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Sets the path component of all listed assets to the value passed in to this function. | |
virtual bool | SetPathOnSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Sets the path on the asset selection set. | |
virtual bool | RetargetCommonRoot (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Retargets the common-root portion of all assets listed in the ATS. | |
virtual bool | RetargetCommonRootOfSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Retargets the common-root portion of assets selected in the ATS. | |
virtual bool | RetargetSelection (const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Retargets single-asset selection to the value passed in. | |
virtual bool | ResolveSelectionToUNC ()=0 |
Resolve the current selection set to its UNC equivalent,. | |
virtual bool | ResolveSelectionRelativeToProjectFolder ()=0 |
Converts the current selection set to relative paths. | |
virtual bool | ResolveSelectionToAbsolute ()=0 |
Converts the current selection set to absolute paths. | |
Repathing functionality - generic | |
Generically remaps assets declared by a ReferenceTarget. | |
virtual bool | RetargetAssets (ReferenceTarget &refTarget, const MCHAR *aOldPath, const MCHAR *aNewPath, bool aCreateOutputFolder=false)=0 |
Generically remaps assets declared by ReferenceTarget whose path value is equal to aOldPath (case-insensitive comparison), to the value aNewPath passed-in. | |
![]() | |
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. | |
CoreExport void | AppendProperty (int id,...) |
Add a new property to this interface descriptor. | |
CoreExport void | AppendEnum (int id,...) |
Add a new enum to this interface descriptor. | |
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) |
![]() | |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDesc ()=0 |
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) |
virtual ActionTable * | GetActionTable () |
virtual void | EnableActions (BOOL onOff) |
![]() | |
virtual UtilExport | ~BaseInterface () |
Destructor. | |
UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
virtual UtilExport Interface_ID | GetID () |
virtual LifetimeType | LifetimeControl () |
virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual BaseInterface * | AcquireInterface () |
virtual void | ReleaseInterface () |
virtual void | DeleteInterface () |
virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
![]() | |
virtual UtilExport | ~InterfaceServer () |
Destructor. | |
virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
template<class InterfaceType > | |
InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
![]() | |
enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
![]() | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
![]() | |
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 CoreExport FPInterfaceDesc | nullInterface |
![]() | |
CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
![]() | |
virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
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.
|
pure virtual |
|
pure virtual |
Set visibility state of dialog.
[in] | bVisible | true to display dialog, false to hide dialog |
|
pure virtual |
Number of files selected in dialog.
|
pure virtual |
Get selected files.
[out] | fileList | reference to a Tab of MSTRs. This parameter will be filled with a copy of the selected files names |
|
pure virtual |
Get a tab of files based on their file system status.
[in] | dwFSStatus | is a mask of kATSFSStatusXXX flags used to match against file entries. |
[out] | fileList | reference to a Tab of MSTRs. This parameter will be filled with a copy of the files matching the dwFSStatus flags. |
|
pure virtual |
Return the file system status of the specified file.
[in] | szFilename | string containing the filename to retrieve status from. |
|
pure virtual |
Get the resolved file paths for a given list of files.
[in] | fileList | reference to a Tab of MSTRs. |
[out] | resolvedFileList | reference to a Tab of MSTRs 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. |
|
pure virtual |
Get the list of unique filenames that are used by the given Animatable.
[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 of 'animatable'; set to false to limit the list to 'animatable'. |
[in] | caseSensitiveFilenames | Set to false for method to handle asset filenames in a case insensitive manner when comparing filenames for determining uniqueness. |
[in] | getResolvedFileNames | Set to false for method to collect the assets' specified filenames. If true, if the filename can be resolved then the resolved filename is collected otherwise the specified filename is collected. |
|
pure virtual |
Get files.
[out] | fileList | reference to a Tab of MSTRs. This parameter will be filled with a copy of the files names in the dialog |
|
pure virtual |
Populate an ATSFileList object.
[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) |
|
pure virtual |
Get list of dependent files.
[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 MSTRs. 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 |
|
pure virtual |
Determine if a file is an input file and a true dependent file.
[in] | szFile | string that contains the file name |
|
pure virtual |
Select files.
[in] | fileList | reference to a Tab of MSTRs. This parameter specifies the list of files to select in the dialog. |
[in] | useResolvedFileNames | Set to false if fileList contains unresolved filenames and only files in the dialog that match that unresolved filename will be selected. If true, all files in the dialog that resolve to the filenames in the fileList will be selected. If a file in the dialog cannot be resolved the unresolved filename will be used for comparison. |
|
pure virtual |
Clears all selections in dialog.
|
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
|
pure virtual |
|
pure virtual |
Set disabled state of dialog.
[in] | bDisabled | true to disable, false to enable |
|
pure virtual |
Get silent state of dialog.
If connected to an ATS Provider, the provider might not respect the silent flag and display dialogs.
|
pure virtual |
Set silent state of dialog.
[in] | bSilent | true to silent, false to enable |
|
pure virtual |
Get autologin state of dialog.
This will attempt to login to all registered ATS Providers when a project (scene file) is open.
|
pure virtual |
Set autologin state of dialog.
[in] | bAutoLogin | true to auto login, false to enable |
|
pure virtual |
Get state of tree view.
|
pure virtual |
Set state of tree view.
[in] | bTreeView | true to display tree view, false to display table view |
|
pure virtual |
Get state of table view.
|
pure virtual |
Set state of table view.
[in] | bTableView | true to display table view, false to display tree view |
|
pure virtual |
Get state of Check Network Path property.
|
pure virtual |
|
pure virtual |
Get display state of excluded files.
|
pure virtual |
Set display state of excluded files.
[in] | bDisplay | true to display excluded, false to hide excluded files |
|
pure virtual |
Get the exclusion state of output files.
|
pure virtual |
Set the exclusion state of output files.
[in] | bExclude | true to exclude output files, false to include output files |
|
pure virtual |
Display Working Comment dialog.
|
pure virtual |
Display Working Comment dialog.
|
pure virtual |
Display Status Log dialog.
|
pure virtual |
Get IATSProvider pointer.
[in] | iProviderIndex | 0-based index of ATS Provider |
|
pure virtual |
|
pure virtual |
|
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.
[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 |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Add list of files to an ATS Provider.
[in] | iProviderIndex | 0-based index of ATS Provider |
[in] | fileList | reference to a Tab of MSTRs. |
[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). |
|
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.
[in] | iProviderIndex | 0-based index of ATS Provider |
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.
[in] | iProviderIndex | 0-based index of ATS Provider |
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.
[in] | iProviderIndex | 0-based index of ATS Provider |
[in] | szComment | string that contains the comment |
|
pure virtual |
Get the current Working Comment.
Append status message to Status Log.
[in] | szStatus | string that contains the status message |
|
pure virtual |
Clear the contents of the Status Log.
|
pure virtual |
Get the conents of the Status Log.
|
pure virtual |
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.
[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). |
|
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.
[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). |
|
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.
[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). |
|
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.
[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). |
|
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.
[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). |
|
pure virtual |
Resolve the current selection set to its UNC equivalent,.
Resolves the current selection set to UNC, regardless of the current application setting.
|
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.
|
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.
|
pure virtual |
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.
[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). |