3ds Max C++ API Reference
Loading...
Searching...
No Matches
DefaultActionSys Class Referenceabstract

The Default Action System interface. More...

#include <DefaultActions.H>

+ Inheritance diagram for DefaultActionSys:

Public Member Functions

virtual BOOL GetAction (DWORD eventID, DWORD &action)=0
 Retrieves the action associated with an event.
 
virtual BOOL SetAction (DWORD eventID, DWORD action, const MCHAR *title=NULL, DWORD *oldAction=NULL)=0
 Sets the default action and descriptive title for an event.
 
virtual BOOL DeleteAction (DWORD eventID)=0
 Deletes the specified default action event.
 
virtual int GetActionCount ()=0
 Retrieves the number of events registered with the Default Action System.
 
virtual MSTR GetActionTitle (DWORD eventID)=0
 Retrieves the title of the specified event.
 
virtual MSTR GetActionTitleByIndex (int index)=0
 Retrieves the title of an event specified by its index in the Default Action System.
 
virtual DWORD GetActionIDByIndex (int index)=0
 Retrieves the id of an event specified by its index in the Default Action System.
 
virtual BOOL LogEntry (DWORD eventID, const MCHAR *message)=0
 Logs a message for the specified event.
 
virtual void MsgLogClear (DWORD eventID)=0
 Clears logged messages.
 
virtual int GetMsgLogCount (DWORD eventID)=0
 Retrieves the number of logged messages.
 
virtual MSTR GetMsgLogMsg (DWORD eventID, int index)=0
 Retrives a specified logged message.
 
virtual DWORD GetMsgLogID (int index)=0
 Retrieves the event for a logged message.
 
virtual int SetMsgLogMaxCount (int count)=0
 Sets the total maximum number of messages that can be logged with the Default Action Sustem.
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 

Detailed Description

The Default Action System interface.

This interface allows for associating default actions to be taken by the system (3ds Max) when certain predefined events occur, and managing these associations. Note that the default actions are carried out only when the system is runing in quiet mode, i.e. no dialogs are displayed.

See also
LogSys

Member Function Documentation

◆ GetAction()

virtual BOOL GetAction ( DWORD  eventID,
DWORD &  action 
)
pure virtual

Retrieves the action associated with an event.

Parameters
[in]eventIDIdentifier of a predefined event or a user defined one.
[out]actionIf an action was specified for the given event, it is returned through this argument. The default action value for events which have not had an action set is DEFAULTACTIONS_LOGTOFILE The returned value can be a combination of the following predefined actions
Returns
- TRUE if an action was specified for the given event, otherwise FALSE.

◆ SetAction()

virtual BOOL SetAction ( DWORD  eventID,
DWORD  action,
const MCHAR title = NULL,
DWORD *  oldAction = NULL 
)
pure virtual

Sets the default action and descriptive title for an event.

Parameters
[in]eventIDIdentifier of a predefined event or a user defined one.
[in]actionThe actions to be taken when the specified event occurs.
[in]titleThe event's title. Appears in the log file or dialog displaying the messages associated with the event.
[in,out]oldActionThe old action value can be returned via this argument
Returns
Returns TRUE if a default action was previously associated with the event

◆ DeleteAction()

virtual BOOL DeleteAction ( DWORD  eventID)
pure virtual

Deletes the specified default action event.

Parameters
[in]eventIDIdentifier of a predefined event or a user defined one.
Returns
Returns TRUE if the event was found and deleted

◆ GetActionCount()

virtual int GetActionCount ( )
pure virtual

Retrieves the number of events registered with the Default Action System.

Returns
The number of events registered with the Default Action System.

◆ GetActionTitle()

virtual MSTR GetActionTitle ( DWORD  eventID)
pure virtual

Retrieves the title of the specified event.

Parameters
[in]eventIDIdentifier of a predefined event or a user defined one.
Returns
The title of the specified event, or an empty string if the event is not found.

◆ GetActionTitleByIndex()

virtual MSTR GetActionTitleByIndex ( int  index)
pure virtual

Retrieves the title of an event specified by its index in the Default Action System.

Parameters
[in]indexThe index of an event registered with the Default Action System
Returns
The title of the event at the specified index, or an empty string if there's no event with the specified index.

◆ GetActionIDByIndex()

virtual DWORD GetActionIDByIndex ( int  index)
pure virtual

Retrieves the id of an event specified by its index in the Default Action System.

Parameters
[in]indexThe index of an event registered with the Default Action System
Returns
The id of the event at the specified index.

◆ LogEntry()

virtual BOOL LogEntry ( DWORD  eventID,
const MCHAR message 
)
pure virtual

Logs a message for the specified event.

Parameters
[in]eventIDIdentifier of a predefined event or a user defined one
[in]messageThe message to log for the specified event. The message is kept within the Defautl Action System. Use GetMsgLogMsg to retrieve messages logged for an event.
Returns
Returns TRUE if message was successfully logged.

◆ MsgLogClear()

virtual void MsgLogClear ( DWORD  eventID)
pure virtual

Clears logged messages.

Parameters
[in]eventIDIdentifier of a predefined or a user defined event. If eventID is 0, all messages are deleted, otherwise only messages for the specific event are deleted.

◆ GetMsgLogCount()

virtual int GetMsgLogCount ( DWORD  eventID)
pure virtual

Retrieves the number of logged messages.

Parameters
[in]eventIDIdentifier of a predefined or a user defined event. If eventID is 0, all messages are counted, otherwise only messages for the specific event are counted.
Returns
The number of messages

◆ GetMsgLogMsg()

virtual MSTR GetMsgLogMsg ( DWORD  eventID,
int  index 
)
pure virtual

Retrives a specified logged message.

Parameters
[in]eventIDIdentifier of a predefined or a user defined event.
[in]indexThe index of a logged message to be retrieved.
Returns
The message logged for the specified event, found at the specified index.

◆ GetMsgLogID()

virtual DWORD GetMsgLogID ( int  index)
pure virtual

Retrieves the event for a logged message.

Parameters
[in]indexThe index of a message logged with the Default Action System.
Returns
The id of the event for which the message at the specified index was logged.

◆ SetMsgLogMaxCount()

virtual int SetMsgLogMaxCount ( int  count)
pure virtual

Sets the total maximum number of messages that can be logged with the Default Action Sustem.

Parameters
[in]countThe maximum number of messages that can be logged.
Returns
The previous maximum number of messages.