iXrefItem.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 to any xref scene entity
// AUTHOR: Attila Szabo - created Feb.09.2005
//***************************************************************************/

#pragma once

#include "..\iFnPub.h"
#include "..\tab.h"
#include "..\assetmanagement\AssetUser.h"

// Foreward declarations
class IObjXRefRecord;
class ReferenceMaker;
class ReferenceTarget;
class INodeTab;

#define IID_XREF_ITEM Interface_ID(0x5fa551f4, 0x442f057c)


class IXRefItem : public FPMixinInterface
{
public:

    enum XRefItemType
    {
        kType_Object            = 1<<0, 
        kType_Material      = 1<<1, 
        // Xref controller type - Unsupported
        kType_Controller    = 1<<2, 
        kType_Atmospheric   = 1<<3, 
        kType_All                   = (kType_Object | 
                                                kType_Material | 
                                                kType_Controller | 
                                                kType_Atmospheric),
        kType_All_No_Atmospherics   = (kType_Object | 
                                                kType_Material | 
                                                kType_Controller),
    };



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


    virtual const MCHAR* GetSrcItemName() const = 0;
    

    virtual ReferenceTarget* GetSrcItem(bool resolveNested = false) const = 0;


    virtual bool IsUnresolved() const = 0;


    virtual IObjXRefRecord* GetXRefRecord() const = 0;


    virtual void GetNodes(INodeTab& xrefNodes) const = 0;



    virtual unsigned int GetParentItems(Tab<ReferenceTarget*>& parentItems) const = 0;

    virtual unsigned int GetChildItems(Tab<ReferenceTarget*>& childItems) const = 0;

    virtual unsigned int GetRootItems(Tab<ReferenceTarget*>& rootItems) const = 0;

    virtual bool IsNested() const = 0;



    static bool IsIXRefItem(InterfaceServer& is) {
        return (is.GetInterface(IID_XREF_ITEM) != NULL);
    };

    using FPMixinInterface::GetInterface;

    static IXRefItem* GetInterface(InterfaceServer& is) {
        return static_cast<IXRefItem*>(is.GetInterface(IID_XREF_ITEM));
    };

    // --- Function publishing
    virtual Interface_ID GetID() { return IID_XREF_ITEM; }

    enum {
        kfpGetSrcFileName, kfpSetSrcFileName,
        kfpGetSrcItemName, kfpSetSrcItemName,
        kfpGetSrcItem,
        kfpGetParentItems,
        kfpGetChildItems,
        kfpGetRootItems,
        kfpGetXRefRecord,
        kfpIsUnresolved,
        kfpIsNested,
        kfpGetNodes,
        kfpLastID,
    };

    BEGIN_FUNCTION_MAP
        PROP_FNS(kfpGetSrcFileName, FPGetSrcFileName, kfpSetSrcFileName, FPSetSrcFileName, TYPE_FILENAME);
        PROP_FNS(kfpGetSrcItemName, GetSrcItemName, kfpSetSrcItemName, FPSetSrcItemName, TYPE_STRING);
        RO_PROP_FN(kfpGetXRefRecord, GetXRefRecord, TYPE_INTERFACE);
        RO_PROP_FN(kfpIsUnresolved, IsUnresolved, TYPE_bool);
        RO_PROP_FN(kfpIsNested, IsNested, TYPE_bool);
        FN_1(kfpGetSrcItem, TYPE_REFTARG, GetSrcItem, TYPE_bool);
        FN_1(kfpGetParentItems, TYPE_DWORD, GetParentItems, TYPE_REFTARG_TAB_BR);
        FN_1(kfpGetRootItems, TYPE_DWORD, GetRootItems, TYPE_REFTARG_TAB_BR);
        FN_1(kfpGetChildItems, TYPE_DWORD, GetChildItems, TYPE_REFTARG_TAB_BR);
        VFN_1(kfpGetNodes, FPGetNodes, TYPE_INODE_TAB_BR);
    END_FUNCTION_MAP

    // From FPMixinInterface
    virtual FPInterfaceDesc* GetDesc() { return &mFPInterfaceDesc; }
    static FPInterfaceDesc mFPInterfaceDesc;

    protected:


        virtual void FPSetSrcFileName(const MCHAR* fileName) = 0;
        virtual const MCHAR* FPGetSrcFileName() = 0;
        virtual void FPSetSrcItemName(const MCHAR* itemName) = 0;

    private:
        void FPGetNodes(Tab<INode*>& xrefNodes);
};