iXRefObjRecord.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: Interface for working with xref records
// AUTHOR: Attila Szabo - created Dec.10.2004
//***************************************************************************/

#pragma once

#include "..\iFnPub.h"
#include "iXrefItem.h"
#include "..\tabtypes.h"

// --- Forward decls
class ReferenceTarget;
class ClassDesc;

// --- Type definitions

typedef unsigned long XRefRecordHandle;

const XRefRecordHandle kNullXRefRecordHandle = 0;

#define IID_XREF_OBJ_RECORD Interface_ID(0x1a457bd1, 0x7584ff0)


class IObjXRefRecord : public FPMixinInterface
{
public:



    virtual unsigned int ItemCount(IXRefItem::XRefItemType itemType) const = 0;
    

    virtual unsigned int GetItems(IXRefItem::XRefItemType itemType, Tab<ReferenceTarget*>& xrefItems) const = 0;


    virtual ReferenceTarget* GetItem(unsigned int i, IXRefItem::XRefItemType itemType) const = 0;


    virtual bool IsEmpty() const = 0;



    virtual unsigned int GetChildRecords(Tab<IObjXRefRecord*>& childRecords) const = 0;

    virtual unsigned int GetParentRecords(Tab<IObjXRefRecord*>& parentRecords) const = 0;

    virtual unsigned int GetRootRecords(Tab<IObjXRefRecord*>& rootRecords) const = 0;


    virtual bool IsNested() const = 0;



    virtual unsigned int GetXRefOptions() const = 0;


    virtual bool IsIncludeAll() const = 0;

    virtual void SetIncludeAll(bool bEnable) = 0;


    virtual bool IsEnabled() const = 0;

    virtual void SetEnable(bool bEnable) = 0;


    virtual bool IsAutoUpdate() const = 0;

    virtual void SetAutoUpdate(bool bEnable) = 0;


    virtual bool GetUpToDate() const = 0;

    virtual void SetUpToDate(bool bUpToDate) = 0;

    virtual bool CheckSrcFileChanged() = 0;
    

    virtual bool IsUnresolved() const = 0;


    virtual const MaxSDK::AssetManagement::AssetUser& GetSrcFile() const = 0;

    virtual const MSTR& GetParentSrcFileName()const = 0;




    virtual bool Update() = 0;


    virtual XRefRecordHandle GetHandle() const = 0;
    

    static IObjXRefRecord* GetInterface(InterfaceServer* is) {
        DbgAssert(is != NULL);
        return static_cast<IObjXRefRecord*>(is->GetInterface(IID_XREF_OBJ_RECORD));
    };

    // --- From FPMixinInterface
    // Retrieves the unique if of this interface class.
    virtual Interface_ID GetID() { return IID_XREF_OBJ_RECORD; }
    // Provides access to the metadata used to expose this interface class to maxscript
    virtual FPInterfaceDesc* GetDesc() { return &mFPInterfaceDesc; }

    // IDs of function published methods
    enum FPFuncIDs  
    { 
        kfpItemCount,
        kfpIsEmpty,
        kfpGetItem,
        kfpGetItems,
        kfpGetChildRecords, 
        kfpGetParentRecords,
        kfpGetRootRecords,
        kfpIsNested,
        kfpGetIncludeAll, kfpSetIncludeAll,
        kfpGetAutoUpdate, kfpSetAutoUpdate,
        kfpGetEnabled, kfpSetEnabled,
        kfpGetUpToDate, kfpSetUpToDate,
        kfpCheckSrcFileChanged,
        kfpIsUnresolved,
        kfpGetSrcFileName, kfpSetSrcFileName,
        kfpGetSrcFileAssetId, kfpSetSrcFileAssetId,
        kfpUpdate,
        kfpGetRecordId,
        kfpGetHandle,
        kfpGetXRefOptions,
    };

    // IDs of enumeration types used by function published methods
    enum FPEnums    
    { 
        kfpXRefItemTypes,
        kfpXRefItemTypesNoAll,
        kfpXrefOptions,
    };
#pragma warning(push)
#pragma warning(disable:4238)
    BEGIN_FUNCTION_MAP
        FN_1(kfpItemCount,  TYPE_DWORD, FPItemCount,    TYPE_ENUM_TAB_BR);
        FN_2(kfpGetItem,    TYPE_REFTARG,   FPGetItem,  TYPE_INDEX, TYPE_ENUM);
        FN_2(kfpGetItems,   TYPE_DWORD, FPGetItems, TYPE_ENUM_TAB_BR, TYPE_REFTARG_TAB_BR);
        FN_1(kfpGetChildRecords,    TYPE_DWORD, FPGetChildRecords,    TYPE_INTERFACE_TAB_BR);
        FN_1(kfpGetParentRecords,   TYPE_DWORD, FPGetParentRecords,   TYPE_INTERFACE_TAB_BR);
        FN_1(kfpGetRootRecords, TYPE_DWORD, FPGetRootRecords,     TYPE_INTERFACE_TAB_BR);
        FN_0(kfpCheckSrcFileChanged,    TYPE_bool,  CheckSrcFileChanged);
        FN_0(kfpUpdate, TYPE_bool,  Update);
        PROP_FNS(kfpGetIncludeAll, IsIncludeAll, kfpSetIncludeAll, SetIncludeAll, TYPE_bool);
        PROP_FNS(kfpGetAutoUpdate, IsAutoUpdate, kfpSetAutoUpdate, SetAutoUpdate, TYPE_bool);
        PROP_FNS(kfpGetEnabled, IsEnabled, kfpSetEnabled, SetEnable, TYPE_bool);
        PROP_FNS(kfpGetUpToDate, GetUpToDate, kfpSetUpToDate, SetUpToDate, TYPE_bool);
        RO_PROP_FN(kfpIsEmpty, IsEmpty, TYPE_bool);
        RO_PROP_FN(kfpIsUnresolved, IsUnresolved, TYPE_bool);
        PROP_FNS(kfpGetSrcFileName, FPGetSrcFileName, kfpSetSrcFileName, FPSetSrcFileName, TYPE_FILENAME);
        RO_PROP_FN(kfpGetHandle, GetHandle, TYPE_DWORD);
        RO_PROP_FN(kfpGetXRefOptions, FPGetXRefOptions, TYPE_ENUM_TAB_BV);
        RO_PROP_FN(kfpIsNested, IsNested, TYPE_bool);
    END_FUNCTION_MAP
#pragma warning(pop)
private:
    static FPInterfaceDesc mFPInterfaceDesc;
    unsigned int FPItemCount(IntTab& itemTypes) const;
    ReferenceTarget* FPGetItem(size_t i, unsigned int itemType) const;
    unsigned int FPGetItems(IntTab& itemTypes, Tab<ReferenceTarget*>& xrefItems) const;
    unsigned int FPGetChildRecords(Tab<FPInterface*>& childRecords) const;
    unsigned int FPGetParentRecords(Tab<FPInterface*>& parentRecords) const;
    unsigned int FPGetRootRecords(Tab<FPInterface*>& rootRecords) const;
    IntTab IObjXRefRecord::FPGetXRefOptions() const;
    void FPSetSrcFileName(const MCHAR* fileName);
    const MCHAR*  FPGetSrcFileName();
};