AssetUser.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright 2008 Autodesk, Inc.  All rights reserved.
// 
// Use of this software is subject to the terms of the Autodesk license agreement
// provided at the time of installation or download, or which otherwise accompanies 
// this software in either electronic or hard copy form.   

//**************************************************************************/
// DESCRIPTION: Contains definitions of classes used in asset management
// AUTHOR: Chloe Mignot
// DATE: 2008-07-14 (YYYY-MM-DD) 
//***************************************************************************/

#ifndef _MAXSDK_ASSET_USER_H_
#define _MAXSDK_ASSET_USER_H_


#include "..\maxheap.h"
#include "..\strclass.h"
#include "..\path.h"
#include "..\ifnpub.h"
#include "..\autoptr.h"
#include "AssetType.h"
#include "AssetId.h"
#include "assetmanagementExport.h"

// forward declarations
class FileResolutionMgrImp;

#define IID_IASSET_USER Interface_ID(0x32f7bccf, 0xf1881566)

namespace MaxSDK
{
    namespace AssetManagement
    {
        class AssetUser: public IObject, public FPMixinInterface
        {
        private:
            class AssetUserImp;
            AutoPtr<AssetUserImp> mImpl;
            unsigned int m_referencesHeld; // IObject ref count
            static UINT64 num_created;
            static UINT64 num_alive;
        public:

            CoreExport AssetUser();

            CoreExport AssetUser(const AssetId& assetId);

            CoreExport AssetUser(const AssetUser& assetU);

            CoreExport AssetUser& operator=(const AssetUser& assetU);

            CoreExport const AssetId& GetId()const;

            CoreExport MSTR GetIdAsString()const;

            CoreExport AssetType GetType() const;

            CoreExport const MSTR& GetFileName()const;

            CoreExport MSTR GetFullFilePath()const;

            CoreExport bool GetFullFilePath(MaxSDK::Util::Path& filePath)const;

            CoreExport bool GetFullFilePath(MSTR& filePath)const;

            CoreExport void SetUsedInFileSave();

            CoreExport void Reset();


            CoreExport IOResult Save(ISave* isave) const;

            CoreExport ~AssetUser();

            static CoreExport UINT64 GetNumCreated();

            static CoreExport UINT64 GetNumAlive();


            // this will enable the FRMImp class to invoke the protected functions below
            friend class ::FileResolutionMgrImp;

            // IObject virtual methods
            BaseInterface* GetInterface(Interface_ID id);
            BaseInterface * GetInterfaceAt(int i)const;
            MCHAR * GetIObjectName() { return _M("AssetUser");}
            int NumInterfaces()const;
            void AcquireIObject();
            void ReleaseIObject();
            void DeleteIObject();

            // FPMixinInterface virtual methods
            LifetimeType     LifetimeControl() { return wantsRelease; }
            FPInterfaceDesc* GetDescByID(Interface_ID id);
            Interface_ID     GetID() { return IID_IASSET_USER; }
            FPInterfaceDesc* GetDesc() { return GetDescByID(IID_IASSET_USER); }

            // FP-published symbolic enumerations
            enum {  asset_type };

            // Function IDs for function publishing
            enum
            {
                kGetAssetId,
                kGetFileName,
                kGetType,
                kCanGetFullFilePath,
                kGetFullFilePath,
            };
            #pragma warning(push)
            #pragma warning(disable:4238)
            BEGIN_FUNCTION_MAP
                FN_0(kGetAssetId, TYPE_TSTR_BV, GetIdAsString);
                FN_0(kGetFileName, TYPE_TSTR_BV, GetFileName);
                FN_0(kGetType, TYPE_ENUM, GetType);
                FN_1(kCanGetFullFilePath, TYPE_bool, GetFullFilePath, TYPE_TSTR_BR);
                FN_0(kGetFullFilePath, TYPE_TSTR_BV, GetFullFilePath);
            END_FUNCTION_MAP
            #pragma warning(pop)

        protected:
            CoreExport const MSTR& GetResolvedAssetPath() const;

            CoreExport bool SetResolvedAssetPath(const MSTR& resolvedPath);

            /* \brief Returns the time in milliseconds that the asset was last resolved by the file resolution manager

            This is the time since Windows started. 

            If the asset has not yet been resolved, it returns 0

            Note: the asset referred to here is the asset that this AssetUser instance points to

            \return the time in milliseconds that the asset was last resolved
            */
            CoreExport DWORD GetTimePathWasResolved() const;

            /* \brief Sets the time that the asset's location was most recently resolved

            newTime can be obtained by a call to the Win32 function, timeGetTime(VOID). It
            is the time in milliseconds since Windows was started.

            param[in] newTime the time in milliseconds that the asset was most recently resolved

            Note: the asset referred to here is the asset that this AssetUser instance points to
            */
            CoreExport void SetTimePathWasResolved(DWORD newTime);

        };

    }
}

#if !defined(NDEBUG) && defined(BUILD_WITH_IMPL)
// Debug and Hybrid builds can pull in implementation details
#include "..\..\..\core\AssetUserImp.h"
#endif

#endif