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

#include <ifnpub.h>

+ Inheritance diagram for FPActionDef:

Public Member Functions

CoreExport FPActionDef ()
 
CoreExport ~FPActionDef ()
 

Public Attributes

DWORD cbStruct
 
MSTR internal_cat
 
StringResID category
 
FunctionID isEnabled_id
 
FunctionID isChecked_id
 
FunctionID isVisible_id
 
ResID icon_resID
 
MSTR icon_file
 
short icon_index
 
MaxIconicon
 
StringResID button_text
 
StringResID tool_tip
 
StringResID menu_text
 
ControlType2 ctrl_type
 
ResID ctrl_pbID
 
MapID ctrl_mapID
 
int ctrl_id
 
COLORREF ctrl_hiCol
 
ACCEL shortcut
 
FPMacroEmittermacro_emitter
 

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

See also
Class FPInterface, Class FPInterfaceDesc, Class FPActionDef, Class FPParamDef, Template Class Tab, Class MaxIcon, Function Publishing, List of ControlType Choices, ParamType, ParamType2.

Description:
FPActionDef, contains extra descriptor info for Action interface functions.
Data Members:
MSTR internal_cat;

The fixed, internal category name.

StringResID category;

The localizable category string resource ID.

FunctionID isEnabled_id;

The interface function IDs for the isEnabled predicate for this action.

FunctionID isChecked_id;

The interface function IDs for the isChecked predicate for this action.

FunctionID isVisible_id;

The interface function IDs for the isVisible predicate for this action.

ResID icon_resID;

The icon as resource ID.

MSTR icon_file;

The icon as UI .bmp filename, index pair, as per CUI icon specifications.

short icon_index;

The index of the icon associated with the action.

MaxIcon* icon;

The MaxIcon class data associated with this action.

StringResID button_text;

The button text string resource ID, defaults to function description.

StringResID tool_tip;

The tooltip string resource ID, defaults to function description.

StringResID menu_text;

The menu item text string resource ID, defaults to buttonText or function description.

ControlType2 ctrl_type;

The type of UI control, if f_ui specified.

ResID ctrl_pbID;

The control's host parammap pblock ID.

MapID ctrl_mapID;

The control's host parammap map ID within the block.

int ctrl_id;

The control dialog item ID.

COLORREF ctrl_hiCol;

The highlight color if check button.

ACCEL shortcut;

The default keyboard shortcut.

Constructor & Destructor Documentation

◆ FPActionDef()

Remarks
Constructor.

This will initialize the members to their empty default values.

◆ ~FPActionDef()

Remarks
Destructor.

Member Data Documentation

◆ cbStruct

DWORD cbStruct

◆ internal_cat

MSTR internal_cat

◆ category

StringResID category

◆ isEnabled_id

FunctionID isEnabled_id

◆ isChecked_id

FunctionID isChecked_id

◆ isVisible_id

FunctionID isVisible_id

◆ icon_resID

ResID icon_resID

◆ icon_file

MSTR icon_file

◆ icon_index

short icon_index

◆ icon

MaxIcon* icon

◆ button_text

StringResID button_text

◆ tool_tip

StringResID tool_tip

◆ menu_text

StringResID menu_text

◆ ctrl_type

ControlType2 ctrl_type

◆ ctrl_pbID

ResID ctrl_pbID

◆ ctrl_mapID

MapID ctrl_mapID

◆ ctrl_id

int ctrl_id

◆ ctrl_hiCol

COLORREF ctrl_hiCol

◆ shortcut

ACCEL shortcut

◆ macro_emitter

FPMacroEmitter* macro_emitter