ISceneEventManager.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 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.
//**************************************************************************/
// FILE:        SceneEventListener.h
// DESCRIPTION: Scene Event Notification Manager
// AUTHOR:      Michaelson Britt
// HISTORY:     Created 5 February 2007
//**************************************************************************/

#pragma once


#include "MaxTypes.h"
#include "Tab.h"
#include "BaseInterface.h"
#include "Export.h"
#include "CoreExp.h"
#include "plugapi.h"
#include "Animatable.h"

// forward declarations
class INode;

#define ISCENEEVENTCALLBACK_INTERFACE_ID    Interface_ID(0x36cd4b33, 0x36ef01e4)

class INodeEventCallback;
#define INODEEVENTCALLBACK_INTERFACE_ID     Interface_ID(0x6a173454, 0x4b420bbc)

class ISceneEventManager;
#define ISCENEEVENTMANAGER_INTERFACE_ID     Interface_ID(0x3f375083, 0x63ea3a86)




//===========================================================================
//
// Namespace SceneEventNamespace
//
//===========================================================================

namespace SceneEventNamespace {
    typedef DWORD CallbackKey;
};


//===========================================================================
//
// Namespace NodeEventNamespace
//
//===========================================================================

namespace NodeEventNamespace {
    typedef AnimHandle NodeKey;
    typedef Tab<NodeKey> NodeKeyTab;
    typedef SceneEventNamespace::CallbackKey CallbackKey;

    // ---------- Helper Functions ----------
    inline NodeKey GetKeyByNode( INode* node ) {
        if( node!=NULL )
             return Animatable::GetHandleByAnim((Animatable*)node);
        else return 0;
    }
    inline INode* GetNodeByKey( NodeKey nodeKey ) {
        Animatable* anim = Animatable::GetAnimByHandle(nodeKey);
        if( (anim!=NULL) && (anim->SuperClassID()==BASENODE_CLASS_ID) )
             return (INode*)anim;
        else return NULL;
    }
};


//===========================================================================
//
// Class SceneEventCallback
// Base class class for all EventCallback types
//
//===========================================================================
class ISceneEventCallback : public BaseInterface {
    public:
        INodeEventCallback* GetINodeEventCallback()                 { return (INodeEventCallback*)(this->GetInterface(INODEEVENTCALLBACK_INTERFACE_ID)); }
};


//===========================================================================
//
// Class NodeEventCallback
//
//===========================================================================

class INodeEventCallback : public ISceneEventCallback {
    public:
        typedef NodeEventNamespace::NodeKeyTab NodeKeyTab;
        #pragma warning(push)
        #pragma warning(disable:4100)
        // ---------- Hierarchy Events ----------




        virtual void Added( NodeKeyTab& nodes )                     {}
        virtual void Deleted( NodeKeyTab& nodes )                   {}
        virtual void LinkChanged( NodeKeyTab& nodes )               {}
        virtual void LayerChanged( NodeKeyTab& nodes )              {}
        virtual void GroupChanged( NodeKeyTab& nodes )              {}
        virtual void HierarchyOtherEvent( NodeKeyTab& nodes )       {}

        // ---------- Model Events ----------




        virtual void ModelStructured( NodeKeyTab& nodes )           {}
        virtual void GeometryChanged( NodeKeyTab& nodes )           {}
        virtual void TopologyChanged( NodeKeyTab& nodes )           {}
        virtual void MappingChanged( NodeKeyTab& nodes )            {}
        virtual void ExtentionChannelChanged( NodeKeyTab& nodes )   {}
        virtual void ModelOtherEvent( NodeKeyTab& nodes )           {}

        // ---------- Material Events ----------




        virtual void MaterialStructured( NodeKeyTab& nodes )        {}
        virtual void MaterialOtherEvent( NodeKeyTab& nodes )        {}

        // ---------- Controller Events ----------





        virtual void ControllerStructured( NodeKeyTab& nodes )      {}
        virtual void ControllerOtherEvent( NodeKeyTab& nodes )      {}

        // ---------- Property Events ----------




        virtual void NameChanged( NodeKeyTab& nodes )               {}
        virtual void WireColorChanged( NodeKeyTab& nodes )          {}
        virtual void RenderPropertiesChanged( NodeKeyTab& nodes )   {} // Includes PART_GI_xxx, PART_REND_xxx, PART_DISP_APPROX, and render elements
        virtual void DisplayPropertiesChanged( NodeKeyTab& nodes )  {} // Includes PART_DISP_xxx, PART_GFX_DATA
        virtual void UserPropertiesChanged( NodeKeyTab& nodes )     {}
        virtual void PropertiesOtherEvent( NodeKeyTab& nodes )      {} // All other property events

        // ---------- Display/Interaction Events ----------




        virtual void SubobjectSelectionChanged( NodeKeyTab& nodes ) {}
        virtual void SelectionChanged( NodeKeyTab& nodes )          {}
        virtual void HideChanged( NodeKeyTab& nodes )               {}
        virtual void FreezeChanged( NodeKeyTab& nodes )             {}
        virtual void DisplayOtherEvent( NodeKeyTab& nodes )         {}
        #pragma warning(pop)
        // ---------- Other callback methods ----------
        virtual void CallbackBegin()                                {}
        virtual void CallbackEnd()                                  {}

        // ---------- Callback Settings ----------
        virtual BOOL VerboseDeleted()                               {return FALSE;}

        // ---------- Support for Future Expansion ----------
        Interface_ID GetID()                                        { return INODEEVENTCALLBACK_INTERFACE_ID; }
        BaseInterface* GetInterface(Interface_ID id)
            { if (id == INODEEVENTCALLBACK_INTERFACE_ID) return this; else return BaseInterface::GetInterface(id); }
};


//===========================================================================
//
// Class SceneEventManager
//
//===========================================================================
class ISceneEventManager : public BaseInterface {
    public:
        typedef SceneEventNamespace::CallbackKey CallbackKey;

        virtual CallbackKey RegisterCallback( ISceneEventCallback* callback, BOOL polling=FALSE, DWORD delayMilliseconds=0, BOOL mouseUp=FALSE ) = 0;
        virtual void UnRegisterCallback( CallbackKey callbackKey ) = 0;
        virtual ISceneEventCallback* GetCallbackByKey( CallbackKey callbackKey ) = 0;
        virtual CallbackKey GetKeyByCallback( ISceneEventCallback* callback ) = 0;

        virtual void TriggerMessages( CallbackKey callbackKey ) = 0;
        virtual void ResetMessages( CallbackKey callbackKey ) = 0;
};

CoreExport ISceneEventManager* GetISceneEventManager();