Interface: ATSOps
This Core Interface provided access to the Asset Tracking System.
Available in 3ds Max 8 and higher .
Interface: ATSOps
Properties:
ATSOps.Visible: boolean : Read|Write
Get/set the visibility of the Asset Tracking dialog.
ATSOps.Silent: boolean : Read|Write
Get/set the silent mode of the Asset Tracking dialog.
If connected to an ATS Provider, the provider might not respect the silent flag and display dialogs.
ATSOps.Disabled: boolean : Read|Write
Enable/disable asset tracking.
Corresponds to the Options>Disable Asset Tracking menu item in the Asset Tracking dialog.
ATSOps.AutoLogin: boolean : Read|Write
Enable/disable auto-login.
When true, the Asset Tracker will attempt to login to all registered ATS Providers when a project (scene file) is open.
Corresponds to the Options>Auto Login menu item in the Asset Tracking dialog.
ATSOps.TreeView: boolean : Read|Write
Enable/disable tree view display.
Corresponds to the Options>Tree View menu item in the Asset Tracking dialog.
If in table view and the .TreeView
property has been set to true, the .TableView
property will be set to false automatically.
ATSOps.TableView: boolean : Read|Write
Enable/disable table view display.
Corresponds to the Options>Table View menu item in the Asset Tracking dialog.
If in tree view and the .TableView
property has been set to true, the .TreeView
property will be set to false automatically.
ATSOps.DisplayExcluded: boolean : Read|Write
Enable/disable the display of excluded files.
Corresponds to the Options>Display Excluded Files item in the Asset Tracking dialog.
ATSOps.ExcludeOutputFiles: boolean : Read|Write
Enable/disable the exclusion of output files.
Corresponds to the Options>Exclude Output Files item in the Asset Tracking dialog.
ATSOps.CheckNetworkPaths: boolean : Read|Write
Enable/disable the checking of network paths.
When set to true,theAsset Tracker system checks for the existence of files on network drives.
Available in 3ds Max 9 and higher.
Methods:
<void>ATSOps.Refresh()
Refreshes the Asset Tracking dialog.
This method both updates the dependent file list and if connected to an ATS Provider it will also query the server for updated version control status.
<void>ATSOps.ShowPromptsDialog()
Opens the Prompts dialog.
<void>ATSOps.ShowWorkingCommentDialog()
Opens the Working Comment dialog. Corresponds to the File>Working Comment... option in the Asset Tracking dialog's menu.
<void>ATSOps.ShowStatusLogDialog()
Opens the Asset Tracking Log dialog.
Provider
<integer>ATSOps.NumProviders()
Returns the number of registered ATS providers.
<string>ATSOps.GetProviderName <index>ProviderIndex
Returns the name of the indexed provider as string.
If the index is less than 1 and higher than the number of available providers, returns undefined.
<index>ATSOps.GetActiveProvider()
Returns the index of the active provider.
<void>ATSOps.SetActiveProvider <index>ProviderIndex
Sets the the active provider to the indexed provider.
<boolean>ATSOps.IsInitialized <index>ProviderIndex
Returns true if the indexed provider is initialized, false otherwise.
<void>ATSOps.Login <index>ProviderIndex
Logs in to the indexed provider.
Corresponds to the Server>Log in... option in the Asset Tracking dialog's menu.
<void>ATSOps.Logout <index>ProviderIndex
Logs out of the indexed provider.
Corresponds to the Server>Logout option in the Asset Tracking dialog's menu.
<void>ATSOps.LaunchProvider<index>ProviderIndex
Launches the indexed provider.
Corresponds to the Server>Launch Provider... option in the Asset Tracking dialog's menu.
<index>ATSOps.GetNotificationProviderIndex()
Returns the notification provider index.
<void>ATSOps.LaunchOptions <index>ProviderIndex
Opens the Options dialog of the indexed provider.
Corresponds to the Server>Options... option in the Asset Tracking dialog's menu.
Asset Selection Access
<integer>ATSOps.NumFilesSelected()
Returns the number of selected files.
<integer>GetSelectedFiles <&filename array>FileList
FileListis In and Out parameter
Collects the selected files into the by-reference FileList array.
Returns the number of files collected.
<void>ATSOps.SelectFiles <filename array>FileList useResolvedFileNames:<boolean>
SelectFiles - no automatic redraw after invoked
useResolvedFileNames default value: true
Selects the asset files specified by the by-reference FileList
array.
When useResolvedFileNames
is set to true (the default), files are selected based on their resolved file names. When false, the files are selected based on their specified file names. Available in in 3ds Max 2022 and later
The method does not clear the existing selection, but adds to it. To replace the existing selection, call ATSOps.ClearSelection()
beforehand.
<void>ATSOps.ClearSelection()
Clears the selection in the Asset Tracking dialog.
Asset Files Access
<integer>ATSOps.NumFiles()
Returns the total number of files in the Asset Tracking dialog.
<integer>ATSOps.GetFiles <&filename array>FileList
FileList is In and Out parameter
Collects all files in the Asset Tracker into the by-reference FileList array.
Returns the number of files collected.
<integer>ATSOps.GetDependentFiles <string>Filename <boolean>Recurse <&filename array>FileList IncludeOutputFiles:<boolean>
FileList is In and Out parameter
IncludeOutputFiles default value: true
Collects the dependent files of the specified filename into the by-reference FileList array.
If the Recurse boolean parameter is set to true, also recurses through all collected files, collecting their dependent files too.
If the IncludeOutputFiles:
optional keyword argument is not specified or specified and set to true, output files will also be included in the dependency list. If it is specified and set to false, output files will not be included.
Returns the number of files collected in the FileList array.
Open and Close Projects
<void>ATSOps.OpenFromVault()
Launches the Opens from Autodesk Vault dialog.
<void>ATSOps.OpenProject <index>ProviderIndex <filename>ProjectPath
Opens the specified project using the indexed provider.
The call to atsops.openproject()
is required in order to stay compliant with MSSCC and 3 rd party providers like Perforce, Alienbrain, VSS etc. For consistency, Autodesk Vault also requires a call to atsops.openproject()
if no scene file is open in 3ds Max.
FOR EXAMPLE:
atsops.login 2 --using the second provider... atsops.openproject 2 "C:\\myVault\\3dsmax\\DWFTest"--open the project fl = #("C:\\myVault\\3dsmax\\DWFTest\\noload.max")--define a file list atsops.addfiles 2 fl "comment" --add the file list atsops.logout 2 --log out from the second provider
<boolean>ATSOps.IsProjectOpen <index>ProviderIndex
Returns true if a project is open for the indexed provider, false otherwise.
<void>ATSOps.CloseProject <index>ProviderIndex
Closes the current project in the indexed provider.
<void>ATSOps.GetFromProvider <index>ProviderIndex <string>FilterName <string>FilterExtensions <boolean>AddAllFilesFilter <boolean>MultiSelect <boolean>Download <&filename array>FileList
FileList is In and Out parameter
Opens the Gets Files dialog from the indexed provider using the specified filter Name and filter Extensions strings to initialize the dialog.
If the AddAllFilesFilter parameter is supplied as true, adds the All files (.) filter to the dialog.
If MultiSelect is supplied as true, allows multiple selections.
The FileList array passed by-reference will contain the resulting list of files returned by the provider.
Test File Status
<boolean>ATSOps.IsFileExcluded <index>ProviderIndex <string>Filename
Returns true if the specified file is excluded by the indexed provider, false otherwise.
<boolean>ATSOps.IsFileShareLocked <index>ProviderIndex <filename>Filename
Returns true 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.
Provider Index is the index of ATS Provider. If ProviderIndex is -1, the method will check all providers for a share locked status.
Filename is the string that contains the file name.
Available in 3ds Max 9 and higher.
<boolean>ATSOps.IsInputFile <filename>Filename
Returns true if the specified file is an input file and a true dependent file, false if it is an output file or if it is not found.
Available in 3ds Max 9 and higher.
<namesarray>ATSOps.GetFileStatus <index>ProviderIndex <string>Filename
Returns an array of Name Literals based on the status of the file.
ProviderIndex is the index of ATS Provider. If ProviderIndex is -1, the method will check all providers for the status.
Status | Description |
---|---|
#Unknown |
The status of the file is unknown |
#NotControlled |
The file is not controlled by the Provider |
#Controlled |
The file is version controlled by the Provider |
#CheckedOut |
The file is checked out by the user |
#CheckedOutOther |
The file is checked out by another user |
#OutOfDate |
The file is out of date |
#Deleted |
The file has been deleted from server |
#Missing |
The file does not exist locally |
#Modified |
The file has been modified locally |
#Hidden |
The file is hidden |
#ShareLock |
The file is shared and locked by another user |
#CanCheckin |
The file can be checked in |
#CanCheckout |
The file can be checked out |
#CanUndoCheckout |
The checkout of the file can be undone |
#CanGetLatest |
The latest version of the file can be returned by the Provider |
#CanAddFile |
The file can be added |
#CanShowHistory |
The History of the file can be shown |
#CanShowProperties |
The Properties of the file can be shown |
Available in 3ds Max 9 and higher.
FOR EXAMPLE:
myStatus = ATSOps.GetFileStatus 1"C:\\myVault\\myScene.max" #(#Controlled, #OutOfDate, #Modified)
<boolean>ATSOps.TestFileStatus <index>ProviderIndex <string>Filename <enum>Status
Status enums : {#Unknown | #NotControlled | #Controlled | #CheckedOut | #CheckedOutOther | #OutOfDate | #Deleted | #Missing | #Modified | #Hidden | #ShareLock | #CanCheckin | #CanCheckout | #CanUndoCheckout | #CanGetLatest | #CanAddFile | #CanShowHistory | #CanShowProperties}
Returns true if the specified file has the supplied status on the indexed provider.
<void>ATSOps.GetFilesByStatus<index>ProviderIndex <enum>Status <&filename array>FileList
Status enums: {#Unknown | #NotControlled | #Controlled | #CheckedOut | #CheckedOutOther | #OutOfDate | #Deleted | #Missing | #Modified | #Hidden | #ShareLock | #CanCheckin | #CanCheckout | #CanUndoCheckout | #CanGetLatest | #CanAddFile | #CanShowHistory | #CanShowProperties}
FileList is In and Out parameter
Returns all files that have the supplied status on the indexed provider into the by-reference FileList array.
<namesarray>ATSOps.GetFileSystemStatus <string>Filename
Returns an array of Name Literals based on the system status of the file.
Possible status Name Literals are:
Status | Description |
---|---|
#Unknown |
The status of the file is unknown |
#Ok |
The file was found at the specified location |
#Missing |
The file was not found at the specified location nor in the search paths |
#Found |
The file was not found at the specified location but was found in one of the search paths. |
#NetworkPath |
The file is on a network path |
Available in 3ds Max 9 and higher.
<boolean>ATSOps.TestFileSystemStatus <filename>Filename <enum>Status
Status enums: {#Unknown | #Ok | #Missing | #Found | #NetworkPath}
Returns true if the given file name has the specified status, false otherwise.
See table above for details.
Available in 3ds Max 9 and higher.
<integer>ATSOps.GetFilesByFileSystemStatus <enum>Status <&filename array>FileList
Status enums: {#Unknown | #Ok | #Missing | #Found | #NetworkPath}
FileListis In and Out parameter
Returns the number of files with the specified system status and and array of the file names via the by-reference parameter FileList.
Checking Files In and Out
<boolean>ATSOps.Checkin <index>ProviderIndex <filename array>FileList <&string>Comment
Checkin - no automatic redraw after invoked
Comment is In and Out parameter
Checks in the files specified by the by-reference FileList array of strings using the by-reference Comment string into the indexed provider.
In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.
ATSOps.GetFileStatus()
or ATSOps.Refresh()
for a server update.<boolean>ATSOps.Checkout <index>ProviderIndex <filename array>FileList <&string>Comment
Checkout - no automatic redraw after invoked
Comment is In and Out parameter
Checks out the files specified by the by-reference FileList array of strings using the by-reference Comment string into the indexed provider.
In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.
ATSOps.GetFileStatus()
or ATSOps.Refresh()
for a server update.<boolean>ATSOps.UndoCheckout <index>ProviderIndex <filename array>FileList
FileList is In and Out parameter
Undoes the check out of the files specified by the by-reference FileList array of strings on the indexed provider.
In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.
ATSOps.GetFileStatus()
or ATSOps.Refresh()
for a server update.<boolean>ATSOps.GetLatest <index>ProviderIndex <filename array>FileList
FileList is In and Out parameter
Gets the latest version of the files specified by the by-reference FileList array of strings from the indexed provider.
Corresponds to the File>Get Latest option in the Asset Tracking dialog's menu.
In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.
ATSOps.GetFileStatus()
or ATSOps.Refresh()
for a server update.<boolean>ATSOps.AddFiles <index>ProviderIndex <filename array>FileList <&string>Comment IsHidden:<boolean array>
AddFiles - no automatic redraw after invoked
Comment is In and Out parameter
IsHidden default value: #()
Adds the files specified by the by-reference FileList array of strings to the indexed provider, using the by-reference Comment string.
The optional isHidden:
keyword argument can be used to provide an array of Boolean values, one for each file on the FileList. A value of true means that the file will be added with a hidden status (if supported by the Provider).
In 3ds Max 9 and higher, returns true if the action can be performed, false otherwise.
ATSOps.GetFileStatus()
or ATSOps.Refresh()
for a server update.<void>ATSOps.Properties <index>ProviderIndex <filename array>FileList
FileList is In and Out parameter
Opens the Properties... dialog for the files specified by the by-reference FileList array of strings with the indexed provider.
Corresponds to the File>Properties... option in the Asset Tracking dialog's menu.
<void>ATSOps.ShowHistory <index>ProviderIndex <filename array>FileList
FileList is In and Out parameter
Opens the History... dialog for the files specified by the by-reference FileList array of strings with the indexed provider.
Corresponds to the File>History... option in the Asset Tracking dialog's menu.
The following 8 methods are implemented as menu utility functions which return true when a file is selected in the ATS dialog and the corresponding operation can be performed. When automating ATS functionality using MAXScript, these methods will generally return false! You can use the atsops.TestFileStatus()
method to perform these tests as described in the notes below.
<boolean>ATSOps.CanCheckin()
Returns true if checking in is possible in the ATS dialog, false otherwise.
To test whether the atsops.Checkin()
method can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanCheckin
<boolean>ATSOps.CanCheckout()
Returns true if checking out is possible in the ATS dialog, false otherwise.
To test whether the atsops.Checkout()
method can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanCheckout
<boolean>ATSOps.CanUndoCheckout()
Returns true if checking out can be undone in the ATS dialog, false otherwise.
To test whether the atsops.undoCheckout()
method can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanUndoCheckout
<boolean>ATSOps.CanGetLatest()
Returns true if getting latest is possible in the ATS dialog, false otherwise.
To test whether the atsops.getLatest()
method can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanGetLatest
<boolean>ATSOps.CanAddFiles()
Returns true if adding files is possible in the ATS dialog, false otherwise.
To test whether the method atsops.addFiles()
can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanAddFile
<boolean>ATSOps.CanProperties()
Returns true if getting the properties is possible in the ATS dialog, false otherwise.
To test whether the method atsops.Properties()
can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanProperties
<boolean>ATSOps.CanShowHistory()
Returns true if showing history is possible in the ATS dialog, false otherwise.
To test whether the method atsops.showHistory()
can be called successfully, you should use
atsops.TestFileStatus providerIndex filename #CanShowHistory
<boolean>ATSOps.CanGetFromProvider <index>ProviderIndex
Returns true if getting from provider is possible in the ATS dialog, false otherwise.
<void>ATSOps.CheckForDependentFiles <index>ProviderIndex <string>Filename
Checks for files dependent on the supplied file in the indexed provider.
<void>ATSOps.CheckForCheckedOutFiles <index>ProviderIndex
Checks for checked out files in the indexed provider.
<void>ATSOps.CheckForUnControlledFiles <index>ProviderIndex
Checks for uncontrolled files in the indexed provider.
<void>ATSOps.CheckForOutDatedFiles <index>ProviderIndex
Checks for outdated files in the indexed provider.
<void>ATSOps.CheckForSceneFileCheckOut <index>ProviderIndex
Checks for scene file check-out in the indexed provider.
Working Comments
<void>ATSOps.SetWorkingComment <string>Comment
Sets the working comment to the supplied string.
<string>ATSOps.GetWorkingComment()
Returns the working comment as string.
Status Log
<void>ATSOps.AppendStatusLog <string>Status
Adds the supplied string to the Status Log.
<void>ATSOps.ClearStatusLog()
Clears the Status Log.
<string>ATSOps.GetStatusLog()
Returns the Status Log as string.
Notifications
<boolean>ATSOps.RegisterNotification <value>Callback <integer>ID
Registers a notification callback with the specified integer ID.
ID | Enum | Notification IsSent... |
---|---|---|
1 | #NotifyPreLogin |
Before Login |
2 | #NotifyPostLogin |
After Login |
3 | #NotifyPreLogout |
Before Logging out |
4 | #NotifyPostLogout |
After Logging out |
5 | #NotifyPreOpenProject |
Before Opening a Project |
6 | #NotifyPostOpenProject |
After Opening a Project |
7 | #NotifyPreCloseProject |
Before Closing a Project |
8 | #NotifyPostCloseProject |
After Closing a Project |
9 | #NotifyPreLaunchOptions |
Before Launching the Options |
10 | #NotifyPostLaunchOptions |
After Launching the Options |
11 | #NotifyPreLaunchProvider |
Before Launching a Provider |
12 | #NotifyPostLaunchProvider |
After Launching a Provider |
13 | #NotifyPreCheckin |
Before Checking In a File |
14 | #NotifyPostCheckin |
After Checking In a File |
15 | #NotifyPreCheckout |
Before Checking Out a File |
16 | #NotifyPostCheckout |
After Checking Out a File |
17 | #NotifyPreUndoCheckout |
Before a Checkout is Undone |
18 | #NotifyPostUndoCheckout |
After a Checkout is Undone |
19 | #NotifyPreAddFiles |
Before Files are Added |
20 | #NotifyPostAddFiles |
After Files are Added |
21 | #NotifyPreGetLatest |
Before Getting Latest Version |
22 | #NotifyPostGetLatest |
After Getting Latest Version |
23 | #NotifyPreProperties |
Before Getting Properties |
24 | #NotifyPostProperties |
After Getting Properties |
25 | #NotifyPreShowHistory |
Before Showing History |
26 | #NotifyPostShowHistory |
After Showing History |
27 | #NotifyFileListUpdate |
On File List Update |
28 | #NotifyPreExploreProvider |
Before Exploring a Provider |
29 | #NotifyPostExploreProvider |
After Exploring a Provider |
30 | #NotifyPreGetVersion |
Before Getting File Version |
31 | #NotifyPostGetVersion |
After Getting File Version |
<void>ATSOps.UnRegisterNotification <integer>ID
Unregisters the notification callback with the specified ID.
<enum>ATSOps.GetNotificationID()
GetNotificationID enums: {#NotifyPreLogin | #NotifyPostLogin | #NotifyPreLogout | #NotifyPostLogout | #NotifyPreOpenProject | #NotifyPostOpenProject | #NotifyPreCloseProject | #NotifyPostCloseProject | #NotifyPreLaunchOptions | #NotifyPostLaunchOptions | #NotifyPreLaunchProvider | #NotifyPostLaunchProvider | #NotifyPreCheckin | #NotifyPostCheckin | #NotifyPreCheckout | #NotifyPostCheckout | #NotifyPreUndoCheckout | #NotifyPostUndoCheckout | #NotifyPreAddFiles | #NotifyPostAddFiles | #NotifyPreGetLatest | #NotifyPostGetLatest | #NotifyPreProperties | #NotifyPostProperties | #NotifyPreShowHistory | #NotifyPostShowHistory | #NotifyFileListUpdate | #NotifyPreExploreProvider | #NotifyPostExploreProvider | #NotifyPreGetVersion | #NotifyPostGetVersion}
Returns the notification ID as a Name Literal.
See table above for description and Integer ID value of the enum.
<integer>ATSOps.GetNotificationFileList <&filename array>FileList
FileList is In and Out parameter
Writes the notification file list into the by-reference array of strings.
<boolean>ATSOps.AddAttachmentToNotificationFileListEntry <index>FileListIndex <string>Filename
Adds the file specified by the supplied Filename string as an attachment to the indexed file in the notification file list.
<boolean>ATSOps.IsNotificationCancelled()
Returns true if notification was cancelled, false otherwise.
If a message is cancelled by an object that has registered for notifications, all objects that received the notification before it was cancelled will be notified again, but this method will return true to allow the objects to perform any cleanup or undo any action taken.
<boolean>ATSOps.AddFileToNotificationFileList <string>Filename
Adds the supplied file name string to the notification file list. Returns true on success, false otherwise.
<boolean>ATSOps.RemoveFileFromNotificationFileList <index>FileListIndex
Removes the indexed file name from the notification file list.
Returns true on success, false otherwise.
Re-targetting
<boolean>ATSOps.SetPathOnSelection <filename>NewPath CreateOutputFolder :<boolean>
CreateOutputFolder default value: false
Assigns the new path to the selection.If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
Note that calling this method will clear the existing selection.
<boolean>ATSOps.RetargetCommonRootOfSelection <filename>NewPath CreateOutputFolder:<boolean>
CreateOutputFolder default value: false
The method will retarget the common root of assets selected in the Asset Tracker 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 re-pathed.
All selected assets must have a common-root portion.
NewPath is the path portion that will be prepended in place of the common root.
If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
Returns true if the action succeeded and the assets were re-pathed.
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.
<boolean>ATSOps.RetargetSelection <filename>NewPath CreateOutputFolder :<boolean>
CreateOutputFolder default value: false
Retargets a single selected asset to a new path and file name.
The newPath argument must specify both the path and the file name.
If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
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.
<boolean>ATSOps.SetPath <filename>NewPath CreateOutputFolder :<boolean>
CreateOutputFolder default value: false
Sets the path component of all listed assets to the path passed as first argument.
NewPath is the path value that will be applied to all listed assets.
If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
Returns true if the action succeeds and the asset(s) are re-pathed.
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.
<boolean>ATSOps.RetargetCommonRoot <filename>NewPath CreateOutputFolder :<boolean>
CreateOutputFolder default value: false
Retargets the common root of all assets listed in the Asset Tracker dialog.
For example, if all assets belong to C:\ but are found in different sub-directories of C:\, then only the C:\ portion of the path will be re-pathed.
All editable assets must have some common root portion.
NewPath is the path portion that will be prepended in place of the common root.
If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
Returns true if the action succeeded and the assets were re-pathed.
<boolean>ATSOps.RetargetAssets <&maxObject>AssetOwner <filename>OldPath <filename>NewPath CreateOutputFolder :<boolean>
AssetOwner is In and Out parameter
CreateOutputFolder default value: false
Retargets the assets of the specified asset owner from the given old path to the new path.
AssetOwner
- The ReferenceTarget object from which assets are declared
OldPath
- Used to determine which asset to retarget. Any asset declared with this path will be retargeted to NewPath.
NewPath
- The retarget value.
If the optional CreateOutputFolder:
keyword parameter is supplied and is true, the new path will be created if it does not exist.
This method calls the EnumAuxFiles implementation of ReferenceTarget to get a listing of assets.
Returns true if the action succeeded and at least one assets was re-pathed, false if no asset was re-pathed.
File Resolution
<boolean>ATSOps.ResolveSelectionToUNC()
Resolve the paths of the currently selected assets in the Asset Tracker dialog to their UNC equivalents regardless of the current application setting.
One or more assets must be selected in the Asset Tracker dialog - one of the assets must have an absolute path.
Returns true if one or more assets have been resolved to UNC.
Available in 3ds Max 9 and higher.
<boolean>ATSOps.ResolveSelectionRelativeToProjectFolder()
Converts paths selected in the Asset Tracker dialog to relative paths with respect to the project folder.
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. Otherwise, the absolute path is converted to a relative path relative to the current Project Folder setting, if possible.
One or more assets must be selected and at least one of the assets must have an absolute path.
Returns true if one or more assets are 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.
Available in 3ds Max 9 and higher.
<boolean>ATSOps.ResolveSelectionToAbsolute()
Converts the paths of one or more assets selected in the Asset Tracker dialog to absolute paths. At least one of the selected assets must have a relative path.
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.
Returns true if one or more assets have been resolved to absolute paths.
Available in 3ds Max 9 and higher.
<integer>ATSOps.GetResolvedPaths <filename array>FileList <&filename array>ResolvedFileList
GetResolvedPaths - no automatic redraw after invoked
ResolvedFileList is Out parameter
Returns the number of resolved paths.
Resolved files are files not found in the location specified within the scene file but found using the standard and user defined search paths.
The list of the files to check should be passed via the FileList parameter.
The by-reference ResolvedFileList parameter will be filled with the resolved file names.
If the file was found at the original location or is still missing (could not be resolved via the search paths), the entry in resolvedFileList will be the same as in fileList.
If the file was resolved the entry in resolvedFileList will contain the resolved file path.
Available in 3ds Max 9 and higher.
<integer>ATSOps.GetDependencyFileList <maxObject>Dependent <&filename array>FileList <boolean>includeRefHierarchy \
caseSensitiveFilenames:<boolean> getResolvedFileNames:<boolean>
GetDependencyFileList - no automatic redraw after invoked
FileList is Out parameter
caseSensitiveFilenames default value: true
getResolvedFileNames default value: true
Gets the list of files that are used by the given maxObject. Duplicate files are not included.
Dependent
is the maxObject for which the file dependencies are to be listed.
fileList
is the by-reference array through which the file list is returned.
When includeRefHierarchy
is set to true, the method will list dependencies of the entire reference hierarchy. When set to false, the list will be limited to the maxObject itself.
When caseSensitiveFilenames
is set to true (the default), two files with the same name are considered different if there is a difference in the letter case of the filenames. Setting this parameter to false can reduce the number of files returned by detecting duplicates. Available in in 3ds Max 2022 and later
When getResolvedFileNames
is set to true (the default), files names returned are the resolved file names. When false, the files returned are the specified file names. Available in in 3ds Max 2022 and later
Returns the number of files found.
Working Folder Access
<void>ATSOps.SetWorkingFolder <index>ProviderIndex <filename>Folder
Sets the working folder of the indexed provider to the specified file name.
Available in 3ds Max 9 and higher.
<filename>ATSOps.GetWorkingFolder <index>ProviderIndex
Returns the working folder file name of the indexed provider.
Available in 3ds Max 9 and higher.
VersionAccess
<integer>ATSOps.GetMinVersion <index>ProviderIndex <filename>Filename
Returns the lowest version of the given filename using the indexed provider.
<integer>ATSOps.GetMaxVersion <index>ProviderIndex <filename>Filename
Returns the highest version of the given filename using the indexed provider.
<boolean>ATSOps.GetVersion <index>ProviderIndex <filename>Filename <integer>VersionNumber
Gets the specified version of the given file using the indexed provider.
Returns true on success, false otherwise.