IATSMax.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2005 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Interfaces for ATSMax (Asset Tracking System)
// AUTHOR: Michael Russo - created December 15, 2004
//***************************************************************************/

#pragma once

#include "..\iFnPub.h"
#include "IATSProvider.h"
#include "..\containers\Array.h"
// forward declarations
class Animatable;

//
// Consts and Typedefs
//

//
// Local file system status flags
//
const DWORD kATSFSStatusUnknown             = 0x000;
const DWORD kATSFSStatusOk                  = 0x001;
const DWORD kATSFSStatusMissing             = 0x002;
const DWORD kATSFSStatusResolved            = 0x004;
const DWORD kATSFSStatusNetPathNoCheck      = 0x008;


//
// class IATSMax
//

#define IATSMAX_INTERFACE   Interface_ID(0x20235822, 0x2632197)


class IATSMax : public FPStaticInterface {

public:
    //
    // Dialog Access
    //




    virtual bool            GetVisible() = 0;

    virtual void            SetVisible( bool bVisible ) = 0;


    virtual int             NumFilesSelected() = 0;

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


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


    virtual DWORD           GetFileSystemStatus( const MCHAR* szFilename ) = 0;


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


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


    virtual int             NumFiles() = 0;

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

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


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


    virtual bool            IsInputFile( const MCHAR* szFile ) = 0;


    virtual void            SelectFiles( const MaxSDK::Array<MSTR> &fileList ) = 0;
    virtual void            ClearSelection() = 0;


    virtual void            Refresh() = 0;

    //
    // Options
    //



    virtual bool            GetDisabled() = 0;

    virtual void            SetDisabled( bool bDisabled ) = 0;


    virtual bool            GetSilent() = 0;

    virtual void            SetSilent( bool bSilent ) = 0;


    virtual bool            GetAutoLogin() = 0;

    virtual void            SetAutoLogin( bool bAutoLogin ) = 0;


    virtual bool            GetTreeView() = 0;

    virtual void            SetTreeView( bool bTreeView ) = 0;


    virtual bool            GetTableView() = 0;

    virtual void            SetTableView( bool bTableView ) = 0;

    virtual bool            GetCheckNetworkPaths() const = 0;

    virtual void            SetCheckNetworkPaths(bool bCheckPaths) = 0;


    virtual bool            GetDisplayExcluded() = 0;

    virtual void            SetDisplayExcluded( bool bDisplay ) = 0;


    virtual bool            GetExcludeOutputFiles() = 0;

    virtual void            SetExcludeOutputFiles( bool bExclude ) = 0;

    //
    // Aux Dialogs
    //



    virtual void            ShowPromptsDialog() = 0;
    virtual void            ShowWorkingCommentDialog() = 0;
    virtual void            ShowStatusLogDialog() = 0;

    //
    // Providers
    //



    virtual int             NumProviders() = 0;

    virtual IATSProvider*   GetProvider( int iProviderIndex ) = 0;

    virtual const MCHAR*    GetProviderName( int iProviderIndex ) = 0;

    virtual int             GetActiveProvider() = 0;

    virtual void            SetActiveProvider( int iProviderIndex ) = 0;

    virtual bool            LoginProvider( int iProviderIndex ) = 0;

    virtual bool            LogoutProvider( int iProviderIndex ) = 0;

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

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

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

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

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

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

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

    //
    // Policies
    //




    virtual void            CheckForDependentFiles( int iProviderIndex, MCHAR *szFilename ) = 0;

    virtual void            CheckForCheckedOutFiles( int iProviderIndex ) = 0;

    virtual void            CheckForUnControlledFiles( int iProviderIndex ) = 0;

    virtual void            CheckForOutDatedFiles( int iProviderIndex ) = 0;

    virtual void            CheckForSceneFileCheckOut( int iProviderIndex ) = 0;

    //
    // Misc
    //




    virtual void            SetWorkingComment( const MCHAR* szComment ) = 0;

    virtual const MCHAR*    GetWorkingComment() = 0;


    virtual void            AppendStatusLog( const MCHAR* szStatus ) = 0;
    virtual void            ClearStatusLog() = 0;

    virtual const MCHAR*    GetStatusLog() = 0;




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

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


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

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

    virtual bool RetargetSelection(const MCHAR* aNewPath, bool aCreateOutputFolder = false) =0;
    
    //  regardless of the current application setting.

    virtual bool ResolveSelectionToUNC() =0;


    virtual bool ResolveSelectionRelativeToProjectFolder() =0;


    virtual bool ResolveSelectionToAbsolute() =0;




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

#define GetIATSMax() ((IATSMax*)GetCOREInterface(IATSMAX_INTERFACE))