iXrefProxy.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 that support proxies
// AUTHOR: Attila Szabo - created Feb.09.2005
//***************************************************************************/

#pragma once

#include "..\iFnPub.h"
#include "..\AssetManagement\AssetUser.h"

// Foreward declarations
class IObjXRefRecord;

#define IID_XREF_PROXY Interface_ID(0x30d59df, 0x2f06322b)


class IXRefProxy : public FPMixinInterface
{
public:

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


    virtual const MCHAR* GetProxyItemName() const = 0;


    virtual IObjXRefRecord* GetProxyRecord() const = 0;


    virtual void SetUseForDisplay(bool bUseProxy) = 0;
    

    virtual bool GetUseForDisplay() const = 0;
    

    virtual void SetUseForRendering(bool bUseProxy) = 0;
    

    virtual bool GetUseForRendering() const = 0;


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

    using FPMixinInterface::GetInterface;

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

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

    enum {
        kfpGetProxyFileName, kfpSetProxyFileName,
        kfpGetProxyFileAssetId, kfpSetProxyFileAssetId,
        kfpGetProxyItemName, kfpSetProxyItemName,
        kfpGetProxyRecord,
        kfpGetUseForDisplay,
        kfpSetUseForDisplay,
        kfpGetUseForRendering,
        kfpSetUseForRendering,
    };

    BEGIN_FUNCTION_MAP
        PROP_FNS(kfpGetProxyFileName, FPGetProxyFileName, kfpSetProxyFileName, FPSetProxyFileName, TYPE_FILENAME);
        PROP_FNS(kfpGetProxyItemName, GetProxyItemName, kfpSetProxyItemName, FPSetProxyItemName, TYPE_STRING);
        RO_PROP_FN(kfpGetProxyRecord, GetProxyRecord, TYPE_INTERFACE);
        PROP_FNS(kfpGetUseForDisplay, GetUseForDisplay, kfpSetUseForDisplay, SetUseForDisplay, TYPE_bool);
        PROP_FNS(kfpGetUseForRendering, GetUseForRendering, kfpSetUseForRendering, SetUseForRendering, TYPE_bool);
    END_FUNCTION_MAP

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

protected:


    virtual void FPSetProxyFileName(const MCHAR* fileName) = 0;
    virtual const MCHAR* FPGetProxyFileName() const = 0;
    virtual void FPSetProxyItemName(const MCHAR* itemName) = 0;
};