IRefTargMonitor.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: Defines a class for monitoring a ReferenceTarget by holding a weak reference to it
// (IsRealDependency returns false) and passing NotifyRefChanged messages to the owner of the
// class instance. 
// AUTHOR: Larry.Minton - created May.14.2004
//***************************************************************************/

#pragma once
#include "maxheap.h"
#include "ref.h"

#define IID_REFTARG_MONITOR 0x3070552c


#define REFMSG_REFTARGMONITOR_TARGET_SET    REFMSG_USER + 0x3070552c  


class IRefTargMonitor: public MaxHeapOperators {
public:

    virtual RefResult ProcessRefTargMonitorMsg(
                        Interval changeInt, 
                        RefTargetHandle hTarget, 
                        PartID& partID,  
                        RefMessage message,
                        bool fromMonitoredTarget) = 0;


    virtual int ProcessEnumDependents(DependentEnumProc* dep) = 0;
};


class RefTargMonitorRefMaker: public ReferenceMaker, public PostPatchProc {
private:
    IRefTargMonitor &mOwner;    // the owner of this instance
    RefTargetHandle mpTarget;   // the object being monitored

    ~RefTargMonitorRefMaker();

public:
    CoreExport Class_ID ClassID();


    CoreExport RefTargMonitorRefMaker(IRefTargMonitor &myOwner, RefTargetHandle theTarget = NULL);


    CoreExport void SetRef(RefTargetHandle theTarget);


    CoreExport RefTargetHandle GetRef();


    IOResult Save(ISave *isave);


    IOResult Load(ILoad *iload);


    int Proc(RemapDir& remap);

    // ReferenceMaker Methods

    RefResult NotifyRefChanged( Interval changeInt, RefTargetHandle hTarget, PartID& partID, RefMessage message );


    int NumRefs();


    RefTargetHandle GetReference(int i);


protected:
    virtual void SetReference(int i, RefTargetHandle rtarg);
public:


    BOOL IsRealDependency(ReferenceTarget *rtarg);


    int DoEnumDependentsImpl(DependentEnumProc* dep);

    void DeleteThis();
};