notify.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: notify.h

    DESCRIPTION: Include file for event notification support

    CREATED BY: Tom Hudson

    HISTORY: Created 8 April 1995

 *> Copyright (c) 1995, All Rights Reserved.
 **********************************************************************/

#pragma once
#include "maxheap.h"
#include "coreexp.h"
#include "strbasic.h"

// forward declarations
class View;
class FrameRendParams;
class INode;
class ViewParams;

// Pre-defined Max system notification codes

#define NOTIFY_UNITS_CHANGE             0x00000001

#define NOTIFY_TIMEUNITS_CHANGE         0x00000002 

#define NOTIFY_VIEWPORT_CHANGE          0x00000003 

#define NOTIFY_SPACEMODE_CHANGE         0x00000004 

#define NOTIFY_SYSTEM_PRE_RESET         0x00000005 

#define NOTIFY_SYSTEM_POST_RESET        0x00000006 


#define NOTIFY_SYSTEM_PRE_NEW           0x00000007 


#define NOTIFY_SYSTEM_POST_NEW          0x00000008 

#define NOTIFY_FILE_PRE_OPEN            0x00000009 

#define NOTIFY_FILE_POST_OPEN           0x0000000A 


#define NOTIFY_FILE_PRE_MERGE           0x0000000B


#define NOTIFY_FILE_POST_MERGE          0x0000000C 

#define NOTIFY_FILE_PRE_SAVE            0x0000000D 

#define NOTIFY_FILE_POST_SAVE           0x0000000E 

#define NOTIFY_FILE_OPEN_FAILED         0x0000000F 

#define NOTIFY_FILE_PRE_SAVE_OLD        0x00000010 

#define NOTIFY_FILE_POST_SAVE_OLD       0x00000011 

#define NOTIFY_SELECTIONSET_CHANGED     0x00000012 


#define NOTIFY_BITMAP_CHANGED           0x00000013 

#define NOTIFY_PRE_RENDER               0x00000014 

#define NOTIFY_POST_RENDER              0x00000015 


#define NOTIFY_PRE_RENDERFRAME          0x00000016 


#define NOTIFY_POST_RENDERFRAME         0x00000017 


#define NOTIFY_PRE_IMPORT               0x00000018 

#define NOTIFY_POST_IMPORT              0x00000019 

#define NOTIFY_IMPORT_FAILED            0x0000001A 

#define NOTIFY_PRE_EXPORT               0x0000001B 

#define NOTIFY_POST_EXPORT              0x0000001C 

#define NOTIFY_EXPORT_FAILED            0x0000001D 





#define NOTIFY_NODE_RENAMED             0x0000001E 


#define NOTIFY_PRE_PROGRESS             0x0000001F 

#define NOTIFY_POST_PROGRESS            0x00000020 

#define NOTIFY_MODPANEL_SEL_CHANGED     0x00000021 

#define NOTIFY_HEIGHT_CHANGED           0x00000022 

#define NOTIFY_RENDPARAM_CHANGED        0x00000023


#define NOTIFY_MATLIB_PRE_OPEN          0x00000024 


#define NOTIFY_MATLIB_POST_OPEN         0x00000025 

#define NOTIFY_MATLIB_PRE_SAVE          0x00000026 

#define NOTIFY_MATLIB_POST_SAVE         0x00000027 

#define NOTIFY_MATLIB_PRE_MERGE         0x00000028 

#define NOTIFY_MATLIB_POST_MERGE        0x00000029 


#define NOTIFY_FILELINK_BIND_FAILED     0x0000002A 

#define NOTIFY_FILELINK_DETACH_FAILED   0x0000002B 

#define NOTIFY_FILELINK_RELOAD_FAILED   0x0000002C 

#define NOTIFY_FILELINK_ATTACH_FAILED   0x0000002D 

#define NOTIFY_FILELINK_PRE_BIND        0x00000030 

#define NOTIFY_FILELINK_POST_BIND       0x00000031 

#define NOTIFY_FILELINK_PRE_DETACH      0x00000032 

#define NOTIFY_FILELINK_POST_DETACH     0x00000033 

#define NOTIFY_FILELINK_PRE_RELOAD      0x00000034 

#define NOTIFY_FILELINK_POST_RELOAD     0x00000035 

#define NOTIFY_FILELINK_PRE_ATTACH      0x00000036 


#define NOTIFY_FILELINK_POST_ATTACH     0x00000037 

#define NOTIFY_AB_NAVIGATE_URL          0x00000038 


#define NOTIFY_RENDER_PREEVAL           0x00000039 

#define NOTIFY_NODE_CREATED             0x0000003A 

#define NOTIFY_NODE_LINKED              0x0000003B 

#define NOTIFY_NODE_UNLINKED            0x0000003C 

#define NOTIFY_NODE_HIDE                0x0000003D 

#define NOTIFY_NODE_UNHIDE              0x0000003E 

#define NOTIFY_NODE_FREEZE              0x0000003F 

#define NOTIFY_NODE_UNFREEZE            0x00000040 

#define NOTIFY_NODE_PRE_MTL             0x00000041 

#define NOTIFY_NODE_POST_MTL            0x00000042 

#define NOTIFY_SCENE_ADDED_NODE         0x00000043 

#define NOTIFY_SCENE_PRE_DELETED_NODE   0x00000044 

#define NOTIFY_SCENE_POST_DELETED_NODE  0x00000045 

#define NOTIFY_SEL_NODES_PRE_DELETE     0x00000046 

#define NOTIFY_SEL_NODES_POST_DELETE    0x00000047 

#define NOTIFY_WM_ENABLE                0x00000048 

#define NOTIFY_SYSTEM_SHUTDOWN          0x00000049 

#define NOTIFY_SYSTEM_STARTUP           0x00000050 

#define NOTIFY_PLUGIN_LOADED            0x00000051 


#define NOTIFY_SYSTEM_SHUTDOWN2         0x00000052 

#define NOTIFY_ANIMATE_ON               0x00000053 

#define NOTIFY_ANIMATE_OFF              0x00000054 


#define NOTIFY_COLOR_CHANGE             0x00000055 


#define NOTIFY_PRE_EDIT_OBJ_CHANGE      0x00000056 


#define NOTIFY_POST_EDIT_OBJ_CHANGE     0x00000057 


#define NOTIFY_RADIOSITYPROCESS_STARTED 0x00000058 


#define NOTIFY_RADIOSITYPROCESS_STOPPED 0x00000059 


#define NOTIFY_RADIOSITYPROCESS_RESET   0x0000005A 


#define NOTIFY_RADIOSITYPROCESS_DONE    0x0000005B 

#define NOTIFY_LIGHTING_UNIT_DISPLAY_SYSTEM_CHANGE      0x0000005C 

// #define NOTIFY_INSTANCE_CREATED          0x00000053 // Sent when a new plugin instance is created via Interface::CreateInstance(), callParam is ptr to CreateInstanceCallParam (see below)

// 10/29/01 - 1:57pm --MQM-- 
// These are helpful for any plugins needing to know when we're starting a reflect/refract map,
// or when we're starting the actual frame.

#define NOTIFY_BEGIN_RENDERING_REFLECT_REFRACT_MAP  0x0000005D 

#define NOTIFY_BEGIN_RENDERING_ACTUAL_FRAME         0x0000005E 

#define NOTIFY_BEGIN_RENDERING_TONEMAPPING_IMAGE    0x0000005F 

#define NOTIFY_RADIOSITY_PLUGIN_CHANGED     0x00000060 

// [LAM - 3/13/02] Broadcast on scene undo/redo
#define NOTIFY_SCENE_UNDO                   0x00000061 

#define NOTIFY_SCENE_REDO                   0x00000062 

#define NOTIFY_MANIPULATE_MODE_OFF          0x00000063 

#define NOTIFY_MANIPULATE_MODE_ON           0x00000064 

// 020607  --prs.

#define NOTIFY_SCENE_XREF_PRE_MERGE         0x00000065 

#define NOTIFY_SCENE_XREF_POST_MERGE        0x00000066 

#define NOTIFY_OBJECT_XREF_PRE_MERGE        0x00000067 

#define NOTIFY_OBJECT_XREF_POST_MERGE       0x00000068 


// [J.Zhao - 6/10/02]

#define NOTIFY_PRE_MIRROR_NODES             0x00000069 


#define NOTIFY_POST_MIRROR_NODES            0x0000006A 

// [bayboro | 1may2002] Broadcast on node cloning
#define NOTIFY_NODE_CLONED                  0x0000006B  

// [J.Zhao - 10/4/02] The following two notifications may be broadcast
// when NotifyDependents from outside the recursion, that is, not during
// the traversal of reference targets.
// Right now, for examples, the very sources of NotifyDependents() of
//  - \ref REFMSG_MOUSE_CYCLE_STARTED
//  - \ref REFMSG_MOUSE_CYCLE_COMPLETED
// are bracketed by the notifications.


#define NOTIFY_PRE_NOTIFYDEPENDENTS         0x0000006C 


#define NOTIFY_POST_NOTIFYDEPENDENTS        0x0000006D 

//[hutchij 10/26/02]
#define NOTIFY_MTL_REFADDED                 0x0000006E 

#define NOTIFY_MTL_REFDELETED               0x0000006F 


//watje TIMERANGE CALLBACK
//watje time range call back for CS
#define NOTIFY_TIMERANGE_CHANGE             0x00000070 

//aszabo|dec.04.02|

#define NOTIFY_PRE_MODIFIER_ADDED           0x00000071 


#define NOTIFY_POST_MODIFIER_ADDED          0x00000072 


#define NOTIFY_PRE_MODIFIER_DELETED         0x00000073 


#define NOTIFY_POST_MODIFIER_DELETED        0x00000074 

// See Node Property Change Notifications, below (codes 0x74 through 0x85)

// CA - 1/23/03

#define NOTIFY_FILELINK_POST_RELOAD_PRE_PRUNE   0x00000085

// aszabo|jan.24.03|

#define NOTIFY_PRE_NODES_CLONED             0x00000086 


#define NOTIFY_POST_NODES_CLONED            0x00000087 
#define NOTIFY_POST_MERGE_PROCESS           0x00000088

// xavier robitaille | 03.02.07

#define NOTIFY_SYSTEM_PRE_DIR_CHANGE        0x00000089 


#define NOTIFY_SYSTEM_POST_DIR_CHANGE       0x0000008A 


#define NOTIFY_SV_SELECTIONSET_CHANGED      0x0000008C 


#define NOTIFY_SV_DOUBLECLICK_GRAPHNODE     0x0000008D 

#define NOTIFY_PRE_RENDERER_CHANGE          0x0000008E 

#define NOTIFY_POST_RENDERER_CHANGE         0x0000008F 


#define NOTIFY_SV_PRE_LAYOUT_CHANGE         0x00000090 


#define NOTIFY_SV_POST_LAYOUT_CHANGE        0x00000091 


#define NOTIFY_BY_CATEGORY_DISPLAY_FILTER_CHANGED   0x00000092 


#define NOTIFY_CUSTOM_DISPLAY_FILTER_CHANGED    0x00000093 


#define NOTIFY_LAYER_CREATED                0x00000094 

#define NOTIFY_LAYER_DELETED                0x00000095 


#define NOTIFY_NODE_LAYER_CHANGED           0x00000096 
 

#define NOTIFY_TABBED_DIALOG_CREATED        0x00000097 


#define NOTIFY_TABBED_DIALOG_DELETED        0x00000098 


#define NOTIFY_NODE_NAME_SET                0x00000099 

/* This allows the standard material to force a rebuild of the hardware shader.  
Param is a pointer to the material being effected. */
#define NOTIFY_HW_TEXTURE_CHANGED           0x0000009A 


#define NOTIFY_MXS_STARTUP                  0x0000009B 

#define NOTIFY_MXS_POST_STARTUP             0x0000009C 

#define NOTIFY_ACTION_ITEM_PRE_EXEC         0x0000009D 

#define NOTIFY_ACTION_ITEM_POST_EXEC        0x0000009E 
// NotifyInfo::callParam is ActionItem*

// CCJ - 12.7.2004

#define NOTIFY_SCENESTATE_PRE_SAVE          0x0000009F 

#define NOTIFY_SCENESTATE_POST_SAVE         0x000000A0 

#define NOTIFY_SCENESTATE_PRE_RESTORE       0x000000A1 

#define NOTIFY_SCENESTATE_POST_RESTORE      0x000000A2 

#define NOTIFY_SCENESTATE_DELETE            0x000000A3 



#define NOTIFY_SCENESTATE_RENAME            0x000000A4 


// NH 20-Dec-04

#define NOTIFY_SCENE_PRE_UNDO               0x000000A5 


#define NOTIFY_SCENE_PRE_REDO               0x000000A6 

#define NOTIFY_SCENE_POST_UNDO NOTIFY_SCENE_UNDO 

#define NOTIFY_SCENE_POST_REDO NOTIFY_SCENE_REDO 


// Added LAM 19-Jan-05

#define NOTIFY_MXS_SHUTDOWN                 0x000000A7 

//Added NH 21-Jan-05

#define NOTIFY_D3D_PRE_DEVICE_RESET         0x000000A8 


#define NOTIFY_D3D_POST_DEVICE_RESET        0x000000A9 

// JH 2-18-05

#define NOTIFY_TOOLPALETTE_MTL_SUSPEND      0x000000AA


#define NOTIFY_TOOLPALETTE_MTL_RESUME       0x000000AB

// Added LAM 04-Mar-05

#define NOTIFY_CLASSDESC_REPLACED           0x000000AC

// Added russom 08-Mar-05
#define NOTIFY_FILE_PRE_OPEN_PROCESS        0x000000AD
#define NOTIFY_FILE_POST_OPEN_PROCESS       0x0000008B
#define NOTIFY_FILE_PRE_SAVE_PROCESS        0x000000AE
#define NOTIFY_FILE_POST_SAVE_PROCESS       0x000000AF


// Added LAM 15-Mar-05

#define NOTIFY_CLASSDESC_LOADED             0x000000B0

// Added MAB 7-June-05
#define NOTIFY_TOOLBARS_PRE_LOAD                0x000000B1

#define NOTIFY_TOOLBARS_POST_LOAD               0x000000B2


#define NOTIFY_ATS_PRE_REPATH_PHASE             0x000000B3

#define NOTIFY_ATS_POST_REPATH_PHASE            0x000000B4


#define NOTIFY_PROXY_TEMPORARY_DISABLE_START    0x000000B5
#define NOTIFY_PROXY_TEMPORARY_DISABLE_END      0x000000B6


// Added russom 11-Apr-06
#define NOTIFY_FILE_CHECK_STATUS                0x000000B7




#define NOTIFY_NAMED_SEL_SET_CREATED            0x000000B8


#define NOTIFY_NAMED_SEL_SET_DELETED            0x000000B9



#define NOTIFY_NAMED_SEL_SET_RENAMED            0x000000BC




#define NOTIFY_NAMED_SEL_SET_PRE_MODIFY         0x000000CA


#define NOTIFY_NAMED_SEL_SET_POST_MODIFY        0x000000CB


#define NOTIFY_MODPANEL_SUBOBJECTLEVEL_CHANGED  0x000000BA

// NH 13-May-2006


#define NOTIFY_FAILED_DIRECTX_MATERIAL_TEXTURE_LOAD     0x000000BB


#define NOTIFY_RENDER_PREEVAL_FRAMEINFO                 0x000000BC


#define NOTIFY_POST_SCENE_RESET                         0x000000BD


#define NOTIFY_ANIM_LAYERS_ENABLED                          0x000000BE


#define NOTIFY_ANIM_LAYERS_DISABLED                         0x000000BF


#define NOTIFY_ACTION_ITEM_PRE_START_OVERRIDE                   0x000000C0


#define NOTIFY_ACTION_ITEM_POST_START_OVERRIDE                  0x000000C1


#define NOTIFY_ACTION_ITEM_PRE_END_OVERRIDE                 0x000000C2


#define NOTIFY_ACTION_ITEM_POST_END_OVERRIDE                    0x000000C3

//aszabo|dec.11.02|

#define NOTIFY_PRE_NODE_GENERAL_PROP_CHANGED    0x00000075 // Encompasses Render, Display, and Basic props below
#define NOTIFY_POST_NODE_GENERAL_PROP_CHANGED   0x00000076 // Encompasses Render, Display, and Basic props below
#define NOTIFY_PRE_NODE_GI_PROP_CHANGED         0x00000077
#define NOTIFY_POST_NODE_GI_PROP_CHANGED        0x00000078
#define NOTIFY_PRE_NODE_MENTALRAY_PROP_CHANGED  0x00000079
#define NOTIFY_POST_NODE_MENTALRAY_PROP_CHANGED 0x00000080
#define NOTIFY_PRE_NODE_BONE_PROP_CHANGED       0x00000081
#define NOTIFY_POST_NODE_BONE_PROP_CHANGED      0x00000082
#define NOTIFY_PRE_NODE_USER_PROP_CHANGED       0x00000083
#define NOTIFY_POST_NODE_USER_PROP_CHANGED      0x00000084

#define NOTIFY_PRE_NODE_RENDER_PROP_CHANGED     0x000000C4
#define NOTIFY_POST_NODE_RENDER_PROP_CHANGED    0x000000C5
#define NOTIFY_PRE_NODE_DISPLAY_PROP_CHANGED    0x000000C6
#define NOTIFY_POST_NODE_DISPLAY_PROP_CHANGED   0x000000C7
#define NOTIFY_PRE_NODE_BASIC_PROP_CHANGED      0x000000C8
#define NOTIFY_POST_NODE_BASIC_PROP_CHANGED     0x000000C9



#define NOTIFY_SELECTION_LOCK                   0x000000D0


#define NOTIFY_SELECTION_UNLOCK                 0x000000D1


#define NOTIFY_PRE_IMAGE_VIEWER_DISPLAY         0x000000D2


#define NOTIFY_POST_IMAGE_VIEWER_DISPLAY        0x000000D3


#define NOTIFY_IMAGE_VIEWER_UPDATE              0x000000D4


#define NOTIFY_CUSTOM_ATTRIBUTES_ADDED          0x000000D5

#define NOTIFY_CUSTOM_ATTRIBUTES_REMOVED        0x000000D6


#define NOTIFY_OS_THEME_CHANGED                 0x000000D7


#define NOTIFY_ACTIVE_VIEWPORT_CHANGED          0x000000D8

#define NOTIFY_PRE_MAXMAINWINDOW_SHOW           0x000000DB

#define NOTIFY_POST_MAXMAINWINDOW_SHOW          0x000000DC


#define NOTIFY_CLASSDESC_ADDED          0x000000DD


#define NOTIFY_OBJECT_DEFINITION_CHANGE_BEGIN           0x000000DE


#define NOTIFY_OBJECT_DEFINITION_CHANGE_END         0x000000DF



#define NOTIFY_MTLBASE_PARAMDLG_PRE_OPEN            0x000000E0


#define NOTIFY_MTLBASE_PARAMDLG_POST_CLOSE          0x000000E1


#define NOTIFY_APP_FRAME_THEME_CHANGED              0x000000E2


// Note #1: If you add more built-in notification codes, consider
//    increasing NUM_BUILTIN_NOTIFIERS in core\notify.cpp - currently 0x00E7

// Note #2: If you add more built-in notification codes, consider
//    adding them to MAXScript. See maxscrpt\maxcallbacks.cpp

// Start of messages for internal use only.
#define NOTIFY_INTERNAL_USE_START               0x70000000


#define PRE_NEW_NEW_ALL 0x1

#define PRE_NEW_KEEP_OBJECTS 0x2

#define PRE_NEW_KEEP_OBJECTS_AND_HIERARCHY 0x3


// Added russom 08-Mar-05
//* \brief iProcessType value for scene file save/load
#define FILE_PROCESS_SCENE                  0x1
//* \brief iProcessType value for hold/fetch
#define FILE_PROCESS_HOLD_FETCH             0x2
//* \brief iProcessType value for auto backup
#define FILE_PROCESS_AUTOBAK                0x3


//  Added russom 11-Apr-06
//* \brief iStatus value for NOTIFY_FILE_CHECK_STATUS
/*  \see NOTIFY_FILE_CHECK_STATUS  */
#define FILE_STATUS_READONLY                0x1




// Notification information structure -- Passed to NOTIFYPROC to inform it what
// it's being notified about...
struct NotifyInfo: public MaxHeapOperators {
    int intcode;
    void *callParam;  // this param can be passed in with BroadcastNotification;
};

// The notification callback function
typedef void (* NOTIFYPROC)(void *param, NotifyInfo *info);

// Integer versions -- For pre-defined MAX codes
CoreExport int RegisterNotification(NOTIFYPROC proc, void *param, int code);
CoreExport int UnRegisterNotification(NOTIFYPROC proc, void *param, int code);
CoreExport void BroadcastNotification(int code);
CoreExport void BroadcastNotification(int code, void *callParam);

// Unregister a callback from all codes
CoreExport int UnRegisterNotification(NOTIFYPROC proc, void *param);

class ClassDesc;

class CreateInstanceCallParam: public MaxHeapOperators {
public:
    void* instance;
    ClassDesc* cd;
    CreateInstanceCallParam (void* i, ClassDesc* cd) : instance(i), cd(cd) { }
}; 

struct NotifyPreEval_FrameInfo : public MaxHeapOperators {
    View* view;
    FrameRendParams* frp;
    INode* viewNode;
    ViewParams* viewParams;
};


struct NameChange{ 
    MCHAR* oldname;
    MCHAR* newname;
};


struct ObjectDefinitionChangeNotificationParam : public MaxHeapOperators
{
    enum ObjectDefinitionType{ 
        kScriptedPlugin = 0 
    };
    ObjectDefinitionType m_type;
    void* m_definition;
    ObjectDefinitionChangeNotificationParam(ObjectDefinitionType type, void* definition) : m_type(type), m_definition(definition) {}
private:
    ObjectDefinitionChangeNotificationParam();
};