DefaultActions.H

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// ----------------
// File ....: DefaultActions.h
// ----------------
// Author...: Larry Minton
// Date ....: June 2003
//
// History .: June, 19 2003 - Started
//
//-----------------------------------------------------------------------------
        
#pragma once
#include "maxheap.h"
#include <WTypes.h>
#include "strclass.h"

#define DEFAULTACTIONS_DEFAULT_MSG_LOG_MAXSIZE 500

// Actions - set as bits in a DWORD
#define DEFAULTACTIONS_LOGTOFILE        0x00000001 //!< Messages get logged to a file "<3dsMaxInstallPath>\network\Max.log"
#define DEFAULTACTIONS_LOGMSG           0x00000002 //!< Messages get logged to the Default Action System and can be retrived via DefaultActionSys::GetMsgLogMsg
#define DEFAULTACTIONS_ABORT            0x00000004 //!< The process that generated the event associated with this action is cancelled
#define DEFAULTACTIONS_RESERVED_4       0x00000008
#define DEFAULTACTIONS_RESERVED_5       0x00000010
#define DEFAULTACTIONS_RESERVED_6       0x00000020
#define DEFAULTACTIONS_RESERVED_7       0x00000040
#define DEFAULTACTIONS_RESERVED_8       0x00000080



#define TYPE_MISSING_EXTERNAL_FILES             1 //!< External assets cannot be found
#define TYPE_MISSING_DLL_FILES                  2 //!< Plugin dlls cannot be found
#define TYPE_MISSING_XREF_FILES                 3 //!< Xref assets (.max files) cannot be found
#define TYPE_MISSING_UVWS                       4 //!< UVW coordinates cannot be found
#define TYPE_UNSUPPORTED_RENDEREFFECT           5 //!< Unsupported render effects have been found
#define TYPE_INVALID_XREF_FILES                 6 //!< Files not suitable for xrefing were detected
#define DEFAULTACTIONS_MAX_DEFINED_ACTION       (TYPE_INVALID_XREF_FILES) //!< DEFAULTACTIONS_MAX_DEFINED_ACTION must contain the largest internally used value


//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
//


class DefaultActionSys: public MaxHeapOperators {

 public:

    virtual BOOL    GetAction (DWORD eventID, DWORD &action) = 0;


    virtual BOOL    SetAction ( DWORD eventID, DWORD action, MCHAR* title = NULL, DWORD *oldAction = NULL) = 0;


    virtual BOOL    DeleteAction (DWORD eventID) = 0;


    virtual int     GetActionCount() = 0;


    virtual MSTR    GetActionTitle(DWORD eventID) = 0;


    virtual MSTR    GetActionTitleByIndex(int index) = 0;

    // Returns the indexed default action event's ID.

    virtual DWORD   GetActionIDByIndex(int index) = 0;


    virtual BOOL    LogEntry(DWORD eventID, MCHAR *message) = 0;


    virtual void    MsgLogClear(DWORD eventID) = 0;


    virtual int     GetMsgLogCount(DWORD eventID) = 0;


    virtual MSTR    GetMsgLogMsg(DWORD eventID, int index) = 0;


    virtual DWORD   GetMsgLogID(int index) = 0;


    virtual int     SetMsgLogMaxCount(int count) = 0;
};


//-- EOF: DefaultActions.h ---------------------------------------------------------------