3ds Max C++ API Reference
|
ATS Provider Interface. More...
#include <IATSProvider.h>
Public Member Functions | |
virtual | ~IATSProvider () |
Destructor. | |
virtual const MCHAR * | GetProviderName ()=0 |
Get provider name. | |
virtual ATSOption | GetSupportOptions ()=0 |
Get provider's support options. | |
virtual bool | IsInitialized ()=0 |
Get initialization status. | |
virtual bool | IsProjectOpen ()=0 |
Get project status. | |
virtual ATSResult | Initialize (ATSClientInfo &atsClientInfo, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Initialize. | |
virtual ATSResult | Uninitialize (ATSOption atsOptions=ATS::kATSOptNone)=0 |
Uninitialize. | |
virtual ATSResult | OpenProject (const MCHAR *szPath, const MCHAR *szComment, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Open project. | |
virtual ATSResult | CloseProject (ATSOption atsOptions=ATS::kATSOptNone)=0 |
Close project. | |
virtual const MCHAR * | GetWorkingFolder ()=0 |
Get working folder. | |
virtual ATSResult | SetWorkingFolder (const MCHAR *szWorkingFolder)=0 |
Set working folder. | |
virtual ATSResult | Checkin (ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Checkin files. | |
virtual ATSResult | Checkout (ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Checkout files. | |
virtual ATSResult | UndoCheckout (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Undo checkout. | |
virtual ATSResult | GetLatest (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get latest. | |
virtual ATSResult | GetVersionRange (ATSFileList &atsFileList, ATSVersion &verMin, ATSVersion &verMax, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get version range. | |
virtual ATSResult | GetVersion (ATSFileList &atsFileList, ATSVersion ver, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get version. | |
virtual ATSResult | AddFiles (ATSFileList &atsFileList, const MCHAR *szComment, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Add files. | |
virtual ATSResult | History (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Show version history. | |
virtual ATSResult | Properties (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Show file properties. | |
virtual ATSResult | GetFileStatus (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get file status. | |
virtual ATSResult | GetLockedFileUserList (ATSFileList &atsFileList, ATSUserList &atsUserList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get name of users that have files locked. | |
virtual ATSResult | ExploreProvider (ATSFileList &atsFileList, ATSExploreProviderParams &exploreParams, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Explore provider. | |
virtual ATSResult | ShowProviderOptions (ATSOption atsOptions=ATS::kATSOptNone)=0 |
Show provider options. | |
virtual ATSResult | LaunchProvider (ATSOption atsOptions=ATS::kATSOptNone)=0 |
Launch provider. | |
virtual ATSResult | GetAssociatedFiles (ATSFileList &atsFileList, ATSOption atsOptions=ATS::kATSOptNone)=0 |
Get associated files. | |
virtual bool | IsATSMSSCCWrapper ()=0 |
Is provider using MSSCC interface. | |
Additional Inherited Members | |
![]() | |
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. | |
This is the main interface for interacting with an ATS Provider. It provides for basic version control functionality, retrieval of status, connections, dependency reporting, etc.
|
inlinevirtual |
Destructor.
|
pure virtual |
Get provider name.
|
pure virtual |
Get provider's support options.
This allows the provider to specify whether or not they support some of the more advanced version control method, such as dependency reporting and exploring. See kATSSupport* flags.
|
pure virtual |
Get initialization status.
|
pure virtual |
Get project status.
|
pure virtual |
Initialize.
This is called when the user has decided to connect or logon to the provider. At this point, the provider should be prepared to open a project, launch provider, explorer provider, or show options. The provider might also ask the user to login if neccessary, although that can be delayed until a project is opened.
[in] | atsClientInfo | reference to ATSClientInfo object. Any data of interested should be copied locally to the provider. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Uninitialize.
This is called when the user has decided to disconnect or logout of the provider.
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Open project.
This is called when the client has opened a project. At this point a project path has been determined from document or document related project files. For certain providers, the specified path might be used to determine if the project can be resolved to a workspace by the provider.
[in,out] | szPath | string containing the path to the project. This typically is the path in which the document was opened. |
[in] | szComment | string containing any initial or default comment for the project. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Close project.
This is called when the client has closed a project. This occurs when the user has opened a new document or is closing down the client application.
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Get working folder.
Set working folder.
The working folder for most providers is used to map the root folder in the version provider's file system to the local file system.
[in] | szWorkingFolder | string containing the new working folder. |
|
pure virtual |
Checkin files.
Active files in the ATSFileList object should be checked in to the provider.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | szComment | string containing the comment to include with this version. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent and kATSOptKeepCheckedOut are valid. |
|
pure virtual |
Checkout files.
Active files in the ATSFileList object should be checked out from the provider.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | szComment | string containing the comment to include with this version. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent and kATSOptReplaceLocalCopy are valid. |
|
pure virtual |
Undo checkout.
Active files in the ATSFileList object should no longer be checked out by the provider.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent and kATSOptReplaceLocalCopy are valid. |
|
pure virtual |
Get latest.
Active files in the ATSFileList object should have their latest version downloaded.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Get version range.
Get the range of version numbers. If multiple active file entries are in atsFileList, the verMin is the minimum of all the files, and verMax is the maximum of all the files.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[out] | verMin | minimum version number |
[out] | verMax | maximum version number |
[in] | atsOptions | default value kATSOptNone. |
|
pure virtual |
Get version.
Downloads the specified version for the active files in the ATSFileList object.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | ver | version number |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Add files.
Active files in the ATSFileList object should be added to the provider.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | szComment | string containing the comment to include with this version. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent and kATSOptKeepCheckedOut are valid. |
|
pure virtual |
Show version history.
The version history of the active files in the ATSFileList object should be shown. If multiple histories can not be displayed, the first active file should be displayed.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Show file properties.
The properties of the active files in the ATSFileList object should be shown. If multiple file properties can not be displayed, the first active file should be displayed.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Get file status.
The status of the active files in the ATSFileList object should be updated. The status should be placed in the Out flags of the ATSFileEntry.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent is valid. |
|
pure virtual |
Get name of users that have files locked.
For each active file in the ATSFileList object, a corresponding atsUserList entry will be created. The provider will fill in an ATSUserEntry object with information about the user that has the active file locked or checked out. If a file in the active list is not locked, the provider will create a blank ATSUserEntry object in place.
[in,out] | atsFileList | reference to ATSFileList object. The active file list should be used. |
[out] | atsUserList | reference to ATSUserList object. This will be populated by the provider. |
[in] | atsOptions | default value kATSOptNone. |
|
pure virtual |
Explore provider.
If supported, the provider should display a dialog to allow the user to explorer the contents of the provider. The file or files selected by the user will be returned and optionally downloaded.
[in,out] | atsFileList | reference to ATSFileList object. Active entries should be created for the selected files. |
[in] | exploreParams | reference to ATSExploreProviderParams object that defines the parameters for the explorer provider dialog. |
[in] | atsOptions | default value kATSOptNone. |
|
pure virtual |
Show provider options.
The provider should optional display a dialog containing any options.
[in] | atsOptions | default value kATSOptNone. |
|
pure virtual |
Launch provider.
The provider should optional launch an associated client application.
[in] | atsOptions | default value kATSOptNone. |
|
pure virtual |
Get associated files.
This method provides for specifying file associations. If supported, the provider should add the specified associated files for each file in the list as child for that ATSFileEntry. It should clear any children already in the list before adding its own.
[in,out] | atsFileList | reference to ATSFileList object. If supported, the provider should add the specified associated files for each file in the list as child for that ATSFileEntry. It should clear any children already in the list before adding its own. |
[in] | atsOptions | default value kATSOptNone. kATSOptSilent, kATSOptAssocChildren, kATSOptAssocParents, kATSOptAssocRecurse and are valid. |
|
pure virtual |
Is provider using MSSCC interface.
This specifies whether an ATS Provider is directly supporting the IATSProvider interface or if the ATS core is supplying IATSProvider support through an MSSCC interface.