iXrefObj.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 xref objects
// AUTHOR: Attila Szabo - created Feb.09.2005
//***************************************************************************/

#pragma once

#include "..\object.h"
#include "..\assetmanagement\AssetUser.h"

// Forward declarations
class IObjXRefRecord;
class Animatable;

/* Although this interface is still supported, it is recommended that IXRefObject8 
and IXRefItem is used instead.
*/
class IXRefObject : public Object 
{
    public:
        Class_ID ClassID() {return XREFOBJ_CLASS_ID;}
        SClass_ID SuperClassID() {return SYSTEM_CLASS_ID;}

        // Initialize a new XRef object
        virtual void Init(const MaxSDK::AssetManagement::AssetUser &asset, const MSTR &oname, Object *ob, BOOL asProxy=FALSE)=0;

        virtual void SetFile(const MaxSDK::AssetManagement::AssetUser &asset, BOOL proxy=FALSE, BOOL update=TRUE)=0;
        virtual void SetObjName(MCHAR *name, BOOL proxy=FALSE)=0;
        virtual void SetUseProxy(BOOL onOff,BOOL redraw=TRUE)=0;
        virtual void SetRenderProxy(BOOL onOff)=0;
        virtual void SetUpdateMats(BOOL onOff)=0;
        virtual void SetIgnoreAnim(BOOL onOff,BOOL redraw=TRUE)=0;
        
        virtual const MaxSDK::AssetManagement::AssetUser& GetFile(BOOL proxy=FALSE) const =0;
        virtual MSTR GetObjName(BOOL proxy=FALSE) const =0;
        virtual const MaxSDK::AssetManagement::AssetUser& GetCurFile() const =0;
        virtual void SetCurFile(const MaxSDK::AssetManagement::AssetUser&)=0;
        virtual const MSTR &GetCurObjName() const =0;
        virtual void SetCurObjName(const MCHAR* name)=0;
        virtual BOOL GetUseProxy() =0;
        virtual BOOL GetRenderProxy() =0;
        virtual BOOL GetUpdateMats() =0;
        virtual BOOL GetIgnoreAnim() =0;        
        
        // Causes browse dialogs to appear
        virtual void BrowseObject(BOOL proxy)=0;
        virtual void BrowseFile(BOOL proxy)=0;

        // Try to reload ref
        virtual void ReloadXRef()=0;
};


#define IID_XREF_OBJECT8 Interface_ID(0x470145ad, 0x3daa64e1)


// Needs to derive from the IXrefObject in order to preserve sdk backward compatibility
class IXRefObject8 : public IXRefObject, public FPMixinInterface
{
public:

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

    virtual const MCHAR* GetActiveObjName() const = 0;


    virtual IObjXRefRecord* GetActiveRecord() const = 0;


    virtual Object* GetSourceObject(bool resolveNested = false, Tab<Modifier*> *modifiers = NULL) const = 0;


    static bool Is_IXRefObject8(Animatable& animatable);

    using FPMixinInterface::GetInterface;

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

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

    enum {
        kfpGetActiveFileName,
        kfpGetActiveObjName,
        kfpGetActiveRecord,
        kfpGetSourceObject,
    };

    BEGIN_FUNCTION_MAP
        RO_PROP_FN(kfpGetActiveFileName, FPGetActiveFileName, TYPE_FILENAME);
        RO_PROP_FN(kfpGetActiveObjName, GetActiveObjName, TYPE_STRING);
        RO_PROP_FN(kfpGetActiveRecord, GetActiveRecord, TYPE_INTERFACE);
        FN_2(kfpGetSourceObject, TYPE_REFTARG, FPGetSourceObject, TYPE_bool, TYPE_REFTARG_TAB_BR);
    END_FUNCTION_MAP

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

    private:
        virtual const MCHAR* FPGetActiveFileName() const = 0;
        Object* FPGetSourceObject(bool resolveNestedXRef, Tab<ReferenceTarget*> &modifiers);
    protected:
        // Deprecated methods
        virtual void Init(const MaxSDK::AssetManagement::AssetUser &asset, const MSTR &oname, Object *ob, BOOL asProxy=FALSE)=0;
        virtual void SetFile(const MaxSDK::AssetManagement::AssetUser& asset, BOOL proxy=FALSE, BOOL update=TRUE)=0;
        virtual void SetObjName(MCHAR *name, BOOL proxy=FALSE)=0;
        virtual const MaxSDK::AssetManagement::AssetUser& GetFile(BOOL proxy=FALSE) const =0;
        virtual MSTR GetObjName(BOOL proxy=FALSE) const =0;
        // Exposed by class IXrefProxy
        virtual void SetUseProxy(BOOL onOff,BOOL redraw=TRUE)=0;
        virtual void SetRenderProxy(BOOL onOff)=0;
        virtual BOOL GetUseProxy() =0;
        virtual BOOL GetRenderProxy() =0;
        // Replaced by IXRefObject8::Get\SetCurFileName
        virtual const MaxSDK::AssetManagement::AssetUser& GetCurFile() const =0;
        virtual const MSTR &GetCurObjName() const =0;
};

inline bool IXRefObject8::Is_IXRefObject8(Animatable& animatable) {
    return ((animatable.SuperClassID() == SYSTEM_CLASS_ID) 
                    && (animatable.ClassID() == XREFOBJ_CLASS_ID));
}