INodeMonitor.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 an interface that uses the RefTargMonitorRefMaker class to monitor a node for 
// deletion. If the NodeMonitor instance is saved as part of a partial save, or loaded as a partial load, 
// the node pointed to by the NodeMonitor is not forced to be saved or loaded.
// AUTHOR: Larry.Minton - created Jan.11.2006
//***************************************************************************/

#pragma once

#include "iFnPub.h"
#include "IRefTargMonitor.h"

#define NODEMONITOR_CLASS_ID            Class_ID(0x18f81903, 0x19033fd2)

#define IID_NODEMONITOR             Interface_ID(0x18f81903, 0x19033fd2)

#define REFMSG_NODEMONITOR_TARGET_DELETED               REFMSG_USER + 0x18f81903

#define REFMSG_NODEMONITOR_TARGET_SET REFMSG_REFTARGMONITOR_TARGET_SET 


class INodeMonitor : public FPMixinInterface  {
public:

    virtual INode* GetNode() = 0;

    virtual void SetNode(INode *theNode) = 0;

    // --- Function publishing
    FPInterfaceDesc* GetDesc();    // <-- must implement 
    virtual Interface_ID GetID() { return IID_NODEMONITOR; }

    enum {  
        kfpGetnode, kfpSetnode,
    };

    BEGIN_FUNCTION_MAP
        PROP_FNS(kfpGetnode, GetNode, kfpSetnode, SetNode, TYPE_INODE);
    END_FUNCTION_MAP

};