ActionItem Class Reference

Represents an operation contained in an ActionTable. More...

#include <actiontable_REMOTE_92.h>

Inheritance diagram for ActionItem:

Public Types
enum	IconSize {   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount , k16x16 ,   k24x24 , k30x30 , k32x32 , k36x36 ,   k48x48 , kIconSizeCount , k16x16 , k24x24 ,   k30x30 , k32x32 , k36x36 , k48x48 ,   kIconSizeCount , k16x16 , k24x24 , k30x30 ,   k32x32 , k36x36 , k48x48 , kIconSizeCount ,   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount }
	Icon size parameter. More...
enum	ActionItemFps {   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetDescription_prop , kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop ,   kGetIconFileName_prop , kGetIconIndex_prop , kActionTableID , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetDescription_prop ,   kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop , kGetIconFileName_prop ,   kGetIconIndex_prop , kActionTableID , kGetId , kIsVisible ,   kIsEnabled , kIsChecked , kGetDescription , kGetCategory ,   kGetButtonText , kGetMenuText , kHasIcon , kGetIconFileName ,   kGetIconIndex , kGetPersistentActionId }
	Function IDs for function published (Fps) methods and properties. More...
enum	IconSize {   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount , k16x16 ,   k24x24 , k30x30 , k32x32 , k36x36 ,   k48x48 , kIconSizeCount , k16x16 , k24x24 ,   k30x30 , k32x32 , k36x36 , k48x48 ,   kIconSizeCount , k16x16 , k24x24 , k30x30 ,   k32x32 , k36x36 , k48x48 , kIconSizeCount ,   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount }
	Icon size parameter. More...
enum	ActionItemFps {   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetDescription_prop , kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop ,   kGetIconFileName_prop , kGetIconIndex_prop , kActionTableID , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetDescription_prop ,   kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop , kGetIconFileName_prop ,   kGetIconIndex_prop , kActionTableID , kGetId , kIsVisible ,   kIsEnabled , kIsChecked , kGetDescription , kGetCategory ,   kGetButtonText , kGetMenuText , kHasIcon , kGetIconFileName ,   kGetIconIndex , kGetPersistentActionId }
	Function IDs for function published (Fps) methods and properties. More...
enum	IconSize {   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount , k16x16 ,   k24x24 , k30x30 , k32x32 , k36x36 ,   k48x48 , kIconSizeCount , k16x16 , k24x24 ,   k30x30 , k32x32 , k36x36 , k48x48 ,   kIconSizeCount , k16x16 , k24x24 , k30x30 ,   k32x32 , k36x36 , k48x48 , kIconSizeCount ,   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount }
	Icon size parameter. More...
enum	ActionItemFps {   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetDescription_prop , kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop ,   kGetIconFileName_prop , kGetIconIndex_prop , kActionTableID , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetDescription_prop ,   kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop , kGetIconFileName_prop ,   kGetIconIndex_prop , kActionTableID , kGetId , kIsVisible ,   kIsEnabled , kIsChecked , kGetDescription , kGetCategory ,   kGetButtonText , kGetMenuText , kHasIcon , kGetIconFileName ,   kGetIconIndex , kGetPersistentActionId }
	Function IDs for function published (Fps) methods and properties. More...
enum	IconSize {   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount , k16x16 ,   k24x24 , k30x30 , k32x32 , k36x36 ,   k48x48 , kIconSizeCount , k16x16 , k24x24 ,   k30x30 , k32x32 , k36x36 , k48x48 ,   kIconSizeCount , k16x16 , k24x24 , k30x30 ,   k32x32 , k36x36 , k48x48 , kIconSizeCount ,   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount }
	Icon size parameter. More...
enum	ActionItemFps {   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetDescription_prop , kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop ,   kGetIconFileName_prop , kGetIconIndex_prop , kActionTableID , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetDescription_prop ,   kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop , kGetIconFileName_prop ,   kGetIconIndex_prop , kActionTableID , kGetId , kIsVisible ,   kIsEnabled , kIsChecked , kGetDescription , kGetCategory ,   kGetButtonText , kGetMenuText , kHasIcon , kGetIconFileName ,   kGetIconIndex , kGetPersistentActionId }
	Function IDs for function published (Fps) methods and properties. More...
enum	IconSize {   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount , k16x16 ,   k24x24 , k30x30 , k32x32 , k36x36 ,   k48x48 , kIconSizeCount , k16x16 , k24x24 ,   k30x30 , k32x32 , k36x36 , k48x48 ,   kIconSizeCount , k16x16 , k24x24 , k30x30 ,   k32x32 , k36x36 , k48x48 , kIconSizeCount ,   k16x16 , k24x24 , k30x30 , k32x32 ,   k36x36 , k48x48 , kIconSizeCount }
	Icon size parameter. More...
enum	ActionItemFps {   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetId , kIsVisible , kIsEnabled , kIsChecked ,   kGetDescription , kGetCategory , kGetButtonText , kGetMenuText ,   kHasIcon , kGetIconFileName , kGetIconIndex , kGetPersistentActionId ,   kGetDescription_prop , kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop ,   kGetIconFileName_prop , kGetIconIndex_prop , kActionTableID , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetId ,   kIsVisible , kIsEnabled , kIsChecked , kGetDescription ,   kGetCategory , kGetButtonText , kGetMenuText , kHasIcon ,   kGetIconFileName , kGetIconIndex , kGetPersistentActionId , kGetDescription_prop ,   kGetCategory_prop , kGetButtonText_prop , kGetMenuText_prop , kGetIconFileName_prop ,   kGetIconIndex_prop , kActionTableID , kGetId , kIsVisible ,   kIsEnabled , kIsChecked , kGetDescription , kGetCategory ,   kGetButtonText , kGetMenuText , kHasIcon , kGetIconFileName ,   kGetIconIndex , kGetPersistentActionId }
	Function IDs for function published (Fps) methods and properties. More...
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
CoreExport	ActionItem ()
	Constructor.
virtual CoreExport	~ActionItem ()
	Destructor.
virtual int	GetId ()=0
	Retrieves a unique identifier for the action.
virtual BOOL	ExecuteAction ()=0
	Executes the operation associated with the action item.
virtual CoreExport void	EmitMacro ()
	Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.
CoreExport BOOL	Execute ()
	Calls ExecuteAction() and handles macro recording etc.
virtual void	GetButtonText (MSTR &buttonText)=0
	Retrieves the text that will be used when the ActionItem is on a text button.
virtual void	GetMenuText (MSTR &menuText)=0
	Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
virtual void	GetDescriptionText (MSTR &descText)=0
	Retrieves the text that will be used for tool tips and menu help.
virtual void	GetCategoryText (MSTR &catText)=0
	Retrieves the text for the category of the operation.
CoreExport void	GetPersistentActionId (MSTR &persistentActionId)
	Retrieves the persistent action id text.
CoreExport MSTR	GetPersistentActionId ()
	Retrieves the persistent action id text.
virtual BOOL	IsChecked ()=0
	Returns whether a menu item is in a checked state, or if a button is in a pressed state.
virtual BOOL	IsIndeterminate ()
	Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.
virtual BOOL	IsItemVisible ()=0
	Determines if an item is visible on a context menu.
virtual BOOL	IsEnabled ()=0
	Determines if the operation is available to the user.
CoreExport MaxIcon *	GetIcon ()
	Returns an icon associated with an ActionItem.
virtual void	DeleteThis ()=0
	Called by 3ds Max to delete the ActionItem.
virtual CoreExport ActionTable *	GetTable ()
	Returns a pointer to the table that owns the ActionItem.
virtual CoreExport void	SetTable (ActionTable *pTable)
	Sets the table that owns the item.
CoreExport const MCHAR *	GetShortcutString ()
	Returns the string that describes all the keyboard shortcuts associated with the item.
virtual CoreExport MacroEntry *	GetMacroScript ()
	Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.
virtual CoreExport BOOL	IsDynamicMenu ()
	Determines if a menu is created or if an action takes place.
virtual CoreExport void	SetIsDynamicMenu ()
	This method may be called after an action item is created to tell the system that it is a dynamic menu action.
virtual CoreExport IMenu *	GetDynamicMenu (HWND hwnd, IPoint2 &m)
	If the ActionItem does produce a menu, this method is called to return a pointer to the menu.
virtual CoreExport BOOL	IsDynamicAction ()
	ActionItems that are deleted after they execute should return TRUE.
CoreExport BOOL	HasIcon ()
	Returns TRUE if the ActionItem specifies an icon.
CoreExport bool	GetIconFileName (MSTR &fileName)
	If the ActionItem specifies an icon, accesses the icon filename.
CoreExport int	GetIconIndex ()
	If the ActionItem specifies an icon, returns the icon index.
CoreExport MSTR	GetTooltipKey ()
	Get the Action's tooltip key.
CoreExport void	SetTooltipKey (const MCHAR *tooltipKey)
	Set the Action's tooltip key.
CoreExport MaxSDK::Util::Path	GetIconPath (IconSize size)
	Get the Action's path to the icon of size specified by param.
CoreExport void	SetIconPath (IconSize size, const MaxSDK::Util::Path &path)
	Sets the Action's path to the icon of size specified by the input param.
CoreExport MSTR	GetMetadata ()
	Gets the Action's metadata.
CoreExport void	SetMetadata (const MCHAR *metadata)
	Sets the Action's metadata.
virtual CoreExport FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual CoreExport FPInterfaceDesc *	GetDesc ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
virtual CoreExport Interface_ID	GetID ()
CoreExport	ActionItem ()
	Constructor.
virtual CoreExport	~ActionItem ()
	Destructor.
virtual int	GetId ()=0
	Retrieves a unique identifier for the action.
which is a	WORD (16 bit unsigned short). */virtual int GetId()=0
virtual a406e112cf287e51abdbba7f88b8e4b91e0a64e7 BOOL	ExecuteAction ()=0
	Executes the operation associated with the action item.
virtual CoreExport void	EmitMacro ()
	Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.
CoreExport BOOL	Execute ()
	Calls ExecuteAction() and handles macro recording etc.
virtual bool	SupportsAltExecute () const
	Returns true if the action supports AltExecute.
virtual bool	AltExecute ()
	Returns true if AltExecute ran successfully.
virtual bool	SupportsCloseDialogs () const
	Returns true if the action supports CloseDialogs.
virtual bool	CloseDialogs ()
	Returns true if CloseDialogs ran successfully.
virtual void	GetButtonText (MSTR &buttonText)=0
	Retrieves the text that will be used when the ActionItem is on a text button.
virtual void	GetMenuText (MSTR &menuText)=0
	Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
virtual void	GetDescriptionText (MSTR &descText)=0
	Retrieves the text that will be used for tool tips and menu help.
virtual void	GetCategoryText (MSTR &catText)=0
	Retrieves the text for the category of the operation.
CoreExport void	GetPersistentActionId (MSTR &persistentActionId)
	Retrieves the persistent action id text.
CoreExport MSTR	GetPersistentActionId ()
	Retrieves the persistent action id text.
virtual BOOL	IsChecked ()=0
	Returns whether a menu item is in a checked state, or if a button is in a pressed state.
virtual BOOL	IsIndeterminate ()
	Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.
virtual BOOL	IsItemVisible ()=0
	Determines if an item is visible on a context menu.
virtual BOOL	IsEnabled ()=0
	Determines if the operation is available to the user.
CoreExport MaxIcon *	GetIcon ()
	Returns an icon associated with an ActionItem.
virtual void	DeleteThis ()=0
	Called by 3ds Max to delete the ActionItem.
virtual CoreExport ActionTable *	GetTable ()
	Returns a pointer to the table that owns the ActionItem.
virtual CoreExport void	SetTable (ActionTable *pTable)
	Sets the table that owns the item.
CoreExport const MCHAR *	GetShortcutString ()
	Returns the string that describes all the keyboard shortcuts associated with the item.
virtual CoreExport MacroEntry *	GetMacroScript ()
	Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.
virtual CoreExport BOOL	IsDynamicMenu ()
	Determines if a menu is created or if an action takes place.
virtual CoreExport void	SetIsDynamicMenu ()
	This method may be called after an action item is created to tell the system that it is a dynamic menu action.
	__declspec (deprecated) virtual IMenu *GetDynamicMenu(HWND
virtual CoreExport void	PopulateDynamicMenu (MaxSDK::CUI::ICuiDynamicMenu *dynMenu, HWND hWnd, const IPoint2 &cursorPos)
	If the ActionItem does produce a dynamic menu (i.e.
virtual CoreExport void	DynamicMenuItemSelected (int itemId)
	If the ActionItem does produce a menu (i.e.
virtual CoreExport BOOL	IsDynamicAction ()
	ActionItems that are deleted after they execute should return TRUE.
CoreExport BOOL	HasIcon ()
	Returns TRUE if the ActionItem specifies an icon.
CoreExport bool	GetIconFileName (MSTR &fileName)
	If the ActionItem specifies an icon, accesses the icon filename.
CoreExport int	GetIconIndex ()
	If the ActionItem specifies an icon, returns the icon index.
CoreExport MSTR	GetTooltipKey ()
	Get the Action's tooltip key.
CoreExport void	SetTooltipKey (const MCHAR *tooltipKey)
	Set the Action's tooltip key.
CoreExport MaxSDK::Util::Path	GetIconPath (IconSize size)
	Get the Action's path to the icon of size specified by param.
CoreExport void	SetIconPath (IconSize size, const MaxSDK::Util::Path &path)
	Sets the Action's path to the icon of size specified by the input param.
CoreExport MSTR	GetMetadata ()
	Gets the Action's metadata.
CoreExport void	SetMetadata (const MCHAR *metadata)
	Sets the Action's metadata.
virtual CoreExport FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual CoreExport FPInterfaceDesc *	GetDesc ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
virtual CoreExport Interface_ID	GetID ()
CoreExport	ActionItem ()
	Constructor.
virtual CoreExport	~ActionItem ()
	Destructor.
virtual int	GetId ()=0
	Retrieves a unique identifier for the action.
virtual BOOL	ExecuteAction ()=0
	Executes the operation associated with the action item.
virtual CoreExport void	EmitMacro ()
	Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.
CoreExport BOOL	Execute ()
	Calls ExecuteAction() and handles macro recording etc.
virtual void	GetButtonText (MSTR &buttonText)=0
	Retrieves the text that will be used when the ActionItem is on a text button.
virtual void	GetMenuText (MSTR &menuText)=0
	Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
virtual void	GetDescriptionText (MSTR &descText)=0
	Retrieves the text that will be used for tool tips and menu help.
virtual void	GetCategoryText (MSTR &catText)=0
	Retrieves the text for the category of the operation.
CoreExport void	GetPersistentActionId (MSTR &persistentActionId)
	Retrieves the persistent action id text.
CoreExport MSTR	GetPersistentActionId ()
	Retrieves the persistent action id text.
virtual BOOL	IsChecked ()=0
	Returns whether a menu item is in a checked state, or if a button is in a pressed state.
virtual BOOL	IsIndeterminate ()
	Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.
virtual BOOL	IsItemVisible ()=0
	Determines if an item is visible on a context menu.
virtual BOOL	IsEnabled ()=0
	Determines if the operation is available to the user.
CoreExport MaxIcon *	GetIcon ()
	Returns an icon associated with an ActionItem.
virtual void	DeleteThis ()=0
	Called by 3ds Max to delete the ActionItem.
virtual CoreExport ActionTable *	GetTable ()
	Returns a pointer to the table that owns the ActionItem.
virtual CoreExport void	SetTable (ActionTable *pTable)
	Sets the table that owns the item.
CoreExport const MCHAR *	GetShortcutString ()
	Returns the string that describes all the keyboard shortcuts associated with the item.
virtual CoreExport MacroEntry *	GetMacroScript ()
	Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.
virtual CoreExport BOOL	IsDynamicMenu ()
	Determines if a menu is created or if an action takes place.
virtual CoreExport void	SetIsDynamicMenu ()
	This method may be called after an action item is created to tell the system that it is a dynamic menu action.
virtual CoreExport IMenu *	GetDynamicMenu (HWND hwnd, IPoint2 &m)
	If the ActionItem does produce a menu, this method is called to return a pointer to the menu.
virtual CoreExport BOOL	IsDynamicAction ()
	ActionItems that are deleted after they execute should return TRUE.
CoreExport BOOL	HasIcon ()
	Returns TRUE if the ActionItem specifies an icon.
CoreExport bool	GetIconFileName (MSTR &fileName)
	If the ActionItem specifies an icon, accesses the icon filename.
CoreExport int	GetIconIndex ()
	If the ActionItem specifies an icon, returns the icon index.
CoreExport MSTR	GetTooltipKey ()
	Get the Action's tooltip key.
CoreExport void	SetTooltipKey (const MCHAR *tooltipKey)
	Set the Action's tooltip key.
CoreExport MaxSDK::Util::Path	GetIconPath (IconSize size)
	Get the Action's path to the icon of size specified by param.
CoreExport void	SetIconPath (IconSize size, const MaxSDK::Util::Path &path)
	Sets the Action's path to the icon of size specified by the input param.
CoreExport MSTR	GetMetadata ()
	Gets the Action's metadata.
CoreExport void	SetMetadata (const MCHAR *metadata)
	Sets the Action's metadata.
virtual CoreExport FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual CoreExport FPInterfaceDesc *	GetDesc ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
virtual CoreExport Interface_ID	GetID ()
CoreExport	ActionItem ()
	Constructor.
virtual CoreExport	~ActionItem ()
	Destructor.
virtual int	GetId ()=0
	Retrieves a unique identifier for the action.
virtual BOOL	ExecuteAction ()=0
	Executes the operation associated with the action item.
virtual CoreExport void	EmitMacro ()
	Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.
CoreExport BOOL	Execute ()
	Calls ExecuteAction() and handles macro recording etc.
virtual bool	SupportsAltExecute () const
	Returns true if the action supports AltExecute.
virtual bool	AltExecute ()
	Returns true if AltExecute ran successfully.
virtual bool	SupportsCloseDialogs () const
	Returns true if the action supports CloseDialogs.
virtual bool	CloseDialogs ()
	Returns true if CloseDialogs ran successfully.
virtual void	GetButtonText (MSTR &buttonText)=0
	Retrieves the text that will be used when the ActionItem is on a text button.
virtual void	GetMenuText (MSTR &menuText)=0
	Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
virtual void	GetDescriptionText (MSTR &descText)=0
	Retrieves the text that will be used for tool tips and menu help.
virtual void	GetCategoryText (MSTR &catText)=0
	Retrieves the text for the category of the operation.
CoreExport void	GetPersistentActionId (MSTR &persistentActionId)
	Retrieves the persistent action id text.
CoreExport MSTR	GetPersistentActionId ()
	Retrieves the persistent action id text.
virtual BOOL	IsChecked ()=0
	Returns whether a menu item is in a checked state, or if a button is in a pressed state.
virtual BOOL	IsIndeterminate ()
	Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.
virtual BOOL	IsItemVisible ()=0
	Determines if an item is visible on a context menu.
virtual BOOL	IsEnabled ()=0
	Determines if the operation is available to the user.
CoreExport MaxIcon *	GetIcon ()
	Returns an icon associated with an ActionItem.
virtual void	DeleteThis ()=0
	Called by 3ds Max to delete the ActionItem.
virtual CoreExport ActionTable *	GetTable ()
	Returns a pointer to the table that owns the ActionItem.
virtual CoreExport void	SetTable (ActionTable *pTable)
	Sets the table that owns the item.
CoreExport const MCHAR *	GetShortcutString ()
	Returns the string that describes all the keyboard shortcuts associated with the item.
virtual CoreExport MacroEntry *	GetMacroScript ()
	Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.
virtual CoreExport BOOL	IsDynamicMenu ()
	Determines if a menu is created or if an action takes place.
virtual CoreExport void	SetIsDynamicMenu ()
	This method may be called after an action item is created to tell the system that it is a dynamic menu action.
	__declspec (deprecated) virtual IMenu *GetDynamicMenu(HWND
virtual CoreExport void	PopulateDynamicMenu (MaxSDK::CUI::ICuiDynamicMenu *dynMenu, HWND hWnd, const IPoint2 &cursorPos)
	If the ActionItem does produce a dynamic menu (i.e.
virtual CoreExport void	DynamicMenuItemSelected (int itemId)
	If the ActionItem does produce a menu (i.e.
virtual CoreExport BOOL	IsDynamicAction ()
	ActionItems that are deleted after they execute should return TRUE.
CoreExport BOOL	HasIcon ()
	Returns TRUE if the ActionItem specifies an icon.
CoreExport bool	GetIconFileName (MSTR &fileName)
	If the ActionItem specifies an icon, accesses the icon filename.
CoreExport int	GetIconIndex ()
	If the ActionItem specifies an icon, returns the icon index.
CoreExport MSTR	GetTooltipKey ()
	Get the Action's tooltip key.
CoreExport void	SetTooltipKey (const MCHAR *tooltipKey)
	Set the Action's tooltip key.
CoreExport MaxSDK::Util::Path	GetIconPath (IconSize size)
	Get the Action's path to the icon of size specified by param.
CoreExport void	SetIconPath (IconSize size, const MaxSDK::Util::Path &path)
	Sets the Action's path to the icon of size specified by the input param.
CoreExport MSTR	GetMetadata ()
	Gets the Action's metadata.
CoreExport void	SetMetadata (const MCHAR *metadata)
	Sets the Action's metadata.
virtual CoreExport FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual CoreExport FPInterfaceDesc *	GetDesc ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
virtual CoreExport Interface_ID	GetID ()
CoreExport	ActionItem ()
	Constructor.
virtual CoreExport	~ActionItem ()
	Destructor.
virtual int	GetId ()=0
	Retrieves a unique identifier for the action.
virtual BOOL	ExecuteAction ()=0
	Executes the operation associated with the action item.
virtual CoreExport void	EmitMacro ()
	Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.
CoreExport BOOL	Execute ()
	Calls ExecuteAction() and handles macro recording etc.
virtual void	GetButtonText (MSTR &buttonText)=0
	Retrieves the text that will be used when the ActionItem is on a text button.
virtual void	GetMenuText (MSTR &menuText)=0
	Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).
virtual void	GetDescriptionText (MSTR &descText)=0
	Retrieves the text that will be used for tool tips and menu help.
virtual void	GetCategoryText (MSTR &catText)=0
	Retrieves the text for the category of the operation.
CoreExport void	GetPersistentActionId (MSTR &persistentActionId)
	Retrieves the persistent action id text.
CoreExport MSTR	GetPersistentActionId ()
	Retrieves the persistent action id text.
virtual BOOL	IsChecked ()=0
	Returns whether a menu item is in a checked state, or if a button is in a pressed state.
virtual BOOL	IsIndeterminate ()
	Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.
virtual BOOL	IsItemVisible ()=0
	Determines if an item is visible on a context menu.
virtual BOOL	IsEnabled ()=0
	Determines if the operation is available to the user.
CoreExport MaxIcon *	GetIcon ()
	Returns an icon associated with an ActionItem.
virtual void	DeleteThis ()=0
	Called by 3ds Max to delete the ActionItem.
virtual CoreExport ActionTable *	GetTable ()
	Returns a pointer to the table that owns the ActionItem.
virtual CoreExport void	SetTable (ActionTable *pTable)
	Sets the table that owns the item.
CoreExport const MCHAR *	GetShortcutString ()
	Returns the string that describes all the keyboard shortcuts associated with the item.
virtual CoreExport MacroEntry *	GetMacroScript ()
	Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.
virtual CoreExport BOOL	IsDynamicMenu ()
	Determines if a menu is created or if an action takes place.
virtual CoreExport void	SetIsDynamicMenu ()
	This method may be called after an action item is created to tell the system that it is a dynamic menu action.
virtual CoreExport IMenu *	GetDynamicMenu (HWND hwnd, IPoint2 &m)
	If the ActionItem does produce a menu, this method is called to return a pointer to the menu.
virtual CoreExport BOOL	IsDynamicAction ()
	ActionItems that are deleted after they execute should return TRUE.
CoreExport BOOL	HasIcon ()
	Returns TRUE if the ActionItem specifies an icon.
CoreExport bool	GetIconFileName (MSTR &fileName)
	If the ActionItem specifies an icon, accesses the icon filename.
CoreExport int	GetIconIndex ()
	If the ActionItem specifies an icon, returns the icon index.
CoreExport MSTR	GetTooltipKey ()
	Get the Action's tooltip key.
CoreExport void	SetTooltipKey (const MCHAR *tooltipKey)
	Set the Action's tooltip key.
CoreExport MaxSDK::Util::Path	GetIconPath (IconSize size)
	Get the Action's path to the icon of size specified by param.
CoreExport void	SetIconPath (IconSize size, const MaxSDK::Util::Path &path)
	Sets the Action's path to the icon of size specified by the input param.
CoreExport MSTR	GetMetadata ()
	Gets the Action's metadata.
CoreExport void	SetMetadata (const MCHAR *metadata)
	Sets the Action's metadata.
virtual CoreExport FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual CoreExport FPInterfaceDesc *	GetDesc ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
virtual CoreExport Interface_ID	GetID ()
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Attributes
IPoint2 &	final { return nullptr

Protected Member Functions
	RO_PROP_FN (kGetId, GetId, TYPE_DWORD)
	RO_PROP_FN (kIsVisible, IsItemVisible, TYPE_BOOL)
	RO_PROP_FN (kIsEnabled, IsEnabled, TYPE_BOOL)
	RO_PROP_FN (kIsChecked, IsChecked, TYPE_BOOL)
	VFN_1 (kGetDescription, GetDescriptionText, TYPE_TSTR_BR)
	VFN_1 (kGetCategory, GetCategoryText, TYPE_TSTR_BR)
	VFN_1 (kGetButtonText, GetButtonText, TYPE_TSTR_BR)
	VFN_1 (kGetMenuText, GetMenuText, TYPE_TSTR_BR)
	FN_0 (kHasIcon, TYPE_BOOL, HasIcon)
	FN_1 (kGetIconFileName, TYPE_bool, GetIconFileName, TYPE_TSTR_BR)
	FN_0 (kGetIconIndex, TYPE_INDEX, GetIconIndex)
	RO_PROP_FN (kGetPersistentActionId, GetPersistentActionId, TYPE_TSTR_BV)
virtual CoreExport MaxIcon *	GetIconImp ()
	Returns an icon associated with an ActionItem.
	RO_PROP_FN (kGetId, GetId, TYPE_DWORD)
	RO_PROP_FN (kIsVisible, IsItemVisible, TYPE_BOOL)
	RO_PROP_FN (kIsEnabled, IsEnabled, TYPE_BOOL)
	RO_PROP_FN (kIsChecked, IsChecked, TYPE_BOOL)
	VFN_1 (kGetDescription, GetDescriptionText, TYPE_TSTR_BR)
	VFN_1 (kGetCategory, GetCategoryText, TYPE_TSTR_BR)
	VFN_1 (kGetButtonText, GetButtonText, TYPE_TSTR_BR)
	VFN_1 (kGetMenuText, GetMenuText, TYPE_TSTR_BR)
	FN_0 (kHasIcon, TYPE_BOOL, HasIcon)
	FN_1 (kGetIconFileName, TYPE_bool, GetIconFileName, TYPE_TSTR_BR)
	FN_0 (kGetIconIndex, TYPE_INDEX, GetIconIndex)
	RO_PROP_FN (kGetPersistentActionId, GetPersistentActionId, TYPE_TSTR_BV)
	RO_PROP_FN (kGetDescription_prop, fpGetDescriptionText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetCategory_prop, fpGetCategoryText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetButtonText_prop, fpGetButtonText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetMenuText_prop, fpGetMenuText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetIconFileName_prop, fpGetIconFileName, TYPE_TSTR_BV)
	RO_PROP_FN (kGetIconIndex_prop, GetIconIndex, TYPE_INDEX)
	RO_PROP_FN (kActionTableID, fpActionTableID, TYPE_DWORD)
virtual CoreExport MaxIcon *	GetIconImp ()
	Returns an icon associated with an ActionItem.
MSTR	fpGetDescriptionText ()
MSTR	fpGetCategoryText ()
MSTR	fpGetButtonText ()
MSTR	fpGetMenuText ()
MSTR	fpGetIconFileName ()
CoreExport DWORD	fpActionTableID ()
	RO_PROP_FN (kGetId, GetId, TYPE_DWORD)
	RO_PROP_FN (kIsVisible, IsItemVisible, TYPE_BOOL)
	RO_PROP_FN (kIsEnabled, IsEnabled, TYPE_BOOL)
	RO_PROP_FN (kIsChecked, IsChecked, TYPE_BOOL)
	VFN_1 (kGetDescription, GetDescriptionText, TYPE_TSTR_BR)
	VFN_1 (kGetCategory, GetCategoryText, TYPE_TSTR_BR)
	VFN_1 (kGetButtonText, GetButtonText, TYPE_TSTR_BR)
	VFN_1 (kGetMenuText, GetMenuText, TYPE_TSTR_BR)
	FN_0 (kHasIcon, TYPE_BOOL, HasIcon)
	FN_1 (kGetIconFileName, TYPE_bool, GetIconFileName, TYPE_TSTR_BR)
	FN_0 (kGetIconIndex, TYPE_INDEX, GetIconIndex)
	RO_PROP_FN (kGetPersistentActionId, GetPersistentActionId, TYPE_TSTR_BV)
virtual CoreExport MaxIcon *	GetIconImp ()
	Returns an icon associated with an ActionItem.
	RO_PROP_FN (kGetId, GetId, TYPE_DWORD)
	RO_PROP_FN (kIsVisible, IsItemVisible, TYPE_BOOL)
	RO_PROP_FN (kIsEnabled, IsEnabled, TYPE_BOOL)
	RO_PROP_FN (kIsChecked, IsChecked, TYPE_BOOL)
	VFN_1 (kGetDescription, GetDescriptionText, TYPE_TSTR_BR)
	VFN_1 (kGetCategory, GetCategoryText, TYPE_TSTR_BR)
	VFN_1 (kGetButtonText, GetButtonText, TYPE_TSTR_BR)
	VFN_1 (kGetMenuText, GetMenuText, TYPE_TSTR_BR)
	FN_0 (kHasIcon, TYPE_BOOL, HasIcon)
	FN_1 (kGetIconFileName, TYPE_bool, GetIconFileName, TYPE_TSTR_BR)
	FN_0 (kGetIconIndex, TYPE_INDEX, GetIconIndex)
	RO_PROP_FN (kGetPersistentActionId, GetPersistentActionId, TYPE_TSTR_BV)
	RO_PROP_FN (kGetDescription_prop, fpGetDescriptionText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetCategory_prop, fpGetCategoryText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetButtonText_prop, fpGetButtonText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetMenuText_prop, fpGetMenuText, TYPE_TSTR_BV)
	RO_PROP_FN (kGetIconFileName_prop, fpGetIconFileName, TYPE_TSTR_BV)
	RO_PROP_FN (kGetIconIndex_prop, GetIconIndex, TYPE_INDEX)
	RO_PROP_FN (kActionTableID, fpActionTableID, TYPE_DWORD)
virtual CoreExport MaxIcon *	GetIconImp ()
	Returns an icon associated with an ActionItem.
MSTR	fpGetDescriptionText ()
MSTR	fpGetCategoryText ()
MSTR	fpGetButtonText ()
MSTR	fpGetMenuText ()
MSTR	fpGetIconFileName ()
CoreExport DWORD	fpActionTableID ()
	RO_PROP_FN (kGetId, GetId, TYPE_DWORD)
	RO_PROP_FN (kIsVisible, IsItemVisible, TYPE_BOOL)
	RO_PROP_FN (kIsEnabled, IsEnabled, TYPE_BOOL)
	RO_PROP_FN (kIsChecked, IsChecked, TYPE_BOOL)
	VFN_1 (kGetDescription, GetDescriptionText, TYPE_TSTR_BR)
	VFN_1 (kGetCategory, GetCategoryText, TYPE_TSTR_BR)
	VFN_1 (kGetButtonText, GetButtonText, TYPE_TSTR_BR)
	VFN_1 (kGetMenuText, GetMenuText, TYPE_TSTR_BR)
	FN_0 (kHasIcon, TYPE_BOOL, HasIcon)
	FN_1 (kGetIconFileName, TYPE_bool, GetIconFileName, TYPE_TSTR_BR)
	FN_0 (kGetIconIndex, TYPE_INDEX, GetIconIndex)
	RO_PROP_FN (kGetPersistentActionId, GetPersistentActionId, TYPE_TSTR_BV)
virtual CoreExport MaxIcon *	GetIconImp ()
	Returns an icon associated with an ActionItem.
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Attributes
ActionTable *	mpTable = nullptr
	Points to the table that owns the action.
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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 void *	operator 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 void *	operator 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 void *	operator 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 void *	operator 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 void *	operator 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 void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator 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 void *	operator 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 void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator 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 void *	operator 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 void *	operator 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 void *	operator 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 void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_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.
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Detailed Description

Represents an operation contained in an ActionTable.

Represents an operation contained in an ActionTabls.

ActionItem is an abstract class with operations to support various UI operations. The system provides a default implementation of this class that works when the table is built with the ActionTable::BuildActionTable() method. However, developers may want to specialize this class for more special-purpose applications. For example, MAXScript does this to export macroScripts to an ActionTable. Methods that are marked as internal should not be used.

See also

Class ActionTable, Class ActionCallback, Structure ActionDescription, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class MAXIcon, Class Interface, class FPMixinInterface

ActionItem is an abstract class with operations to support various UI operations. The system provides a default implementation of this class that works when the table is built with the ActionTable::BuildActionTable() method. However, developers may want to specialize this class for more special-purpose applications. For example, MAXScript does this to export macroScripts to an ActionTable. Methods that are marked as internal should not be used.

See also

Class ActionTable, Class ActionCallback, Structure ActionDescription, Class ActionContext, Class IActionManager, Class MAXIcon, Class Interface, class FPMixinInterface

ActionItem is an abstract class with operations to support various UI operations. The system provides a default implementation of this class that works when the table is built with the ActionTable::BuildActionTable() method. However, developers may want to specialize this class for more special-purpose applications. For example, MAXScript does this to export macroScripts to an ActionTable. Methods that are marked as internal should not be used.

Version

4.0

See also

Class ActionTable, Class ActionCallback, Structure ActionDescription, Class ActionContext, Class IActionManager, Class DynamicMenu, Class DynamicMenuCallback, Class MAXIcon, Class Interface, class FPMixinInterface

ActionItem is an abstract class with operations to support various UI operations. The system provides a default implementation of this class that works when the table is built with the ActionTable::BuildActionTable() method. However, developers may want to specialize this class for more special-purpose applications. For example, MAXScript does this to export macroScripts to an ActionTable. Methods that are marked as internal should not be used.

Version

4.0

See also

Class ActionTable, Class ActionCallback, Structure ActionDescription, Class ActionContext, Class IActionManager, Class MAXIcon, Class Interface, class FPMixinInterface

Member Enumeration Documentation

IconSize [1/5]

enum IconSize

Icon size parameter.

Enumerator
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount

                  {
        k16x16, 
        k24x24, 
        k30x30, 
        k32x32, 
        k36x36, 
        k48x48, 
        kIconSizeCount
    };

ActionItemFps [1/5]

enum ActionItemFps

Function IDs for function published (Fps) methods and properties.

Enumerator
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId

    {
        kGetId,
        kIsVisible,
        kIsEnabled,
        kIsChecked,
        kGetDescription,
        kGetCategory,
        kGetButtonText,
        kGetMenuText,
        kHasIcon,
        kGetIconFileName,
        kGetIconIndex,
        kGetPersistentActionId
    };

IconSize [2/5]

enum IconSize

Icon size parameter.

Enumerator
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount

                  {
        k16x16, 
        k24x24, 
        k30x30, 
        k32x32, 
        k36x36, 
        k48x48, 
        kIconSizeCount
    };

ActionItemFps [2/5]

enum ActionItemFps

Function IDs for function published (Fps) methods and properties.

Enumerator
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId

    {
        kGetId,
        kIsVisible,
        kIsEnabled,
        kIsChecked,
        kGetDescription,
        kGetCategory,
        kGetButtonText,
        kGetMenuText,
        kHasIcon,
        kGetIconFileName,
        kGetIconIndex,
        kGetPersistentActionId,
 
        kGetDescription_prop,
        kGetCategory_prop,
        kGetButtonText_prop,
        kGetMenuText_prop,
        kGetIconFileName_prop,
        kGetIconIndex_prop,
        kActionTableID
};

IconSize [3/5]

enum IconSize

Icon size parameter.

Enumerator
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount

                  {
        k16x16, 
        k24x24, 
        k30x30, 
        k32x32, 
        k36x36, 
        k48x48, 
        kIconSizeCount
    };

ActionItemFps [3/5]

enum ActionItemFps

Function IDs for function published (Fps) methods and properties.

Enumerator
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId

    {
        kGetId,
        kIsVisible,
        kIsEnabled,
        kIsChecked,
        kGetDescription,
        kGetCategory,
        kGetButtonText,
        kGetMenuText,
        kHasIcon,
        kGetIconFileName,
        kGetIconIndex,
        kGetPersistentActionId
    };

IconSize [4/5]

enum IconSize

Icon size parameter.

Enumerator
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount

                  {
        k16x16, 
        k24x24, 
        k30x30, 
        k32x32, 
        k36x36, 
        k48x48, 
        kIconSizeCount
    };

ActionItemFps [4/5]

enum ActionItemFps

Function IDs for function published (Fps) methods and properties.

Enumerator
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId

    {
        kGetId,
        kIsVisible,
        kIsEnabled,
        kIsChecked,
        kGetDescription,
        kGetCategory,
        kGetButtonText,
        kGetMenuText,
        kHasIcon,
        kGetIconFileName,
        kGetIconIndex,
        kGetPersistentActionId,
 
        kGetDescription_prop,
        kGetCategory_prop,
        kGetButtonText_prop,
        kGetMenuText_prop,
        kGetIconFileName_prop,
        kGetIconIndex_prop,
        kActionTableID
};

IconSize [5/5]

enum IconSize

Icon size parameter.

Enumerator
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount
k16x16	icon of size 16x16
k24x24	icon of size 24x24
k30x30	icon of size 30x30
k32x32	icon of size 32x32
k36x36	icon of size 36x36
k48x48	icon of size 48x48
kIconSizeCount

                  {
        k16x16, 
        k24x24, 
        k30x30, 
        k32x32, 
        k36x36, 
        k48x48, 
        kIconSizeCount
    };

ActionItemFps [5/5]

enum ActionItemFps

Function IDs for function published (Fps) methods and properties.

Enumerator
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId
kGetDescription_prop
kGetCategory_prop
kGetButtonText_prop
kGetMenuText_prop
kGetIconFileName_prop
kGetIconIndex_prop
kActionTableID
kGetId
kIsVisible
kIsEnabled
kIsChecked
kGetDescription
kGetCategory
kGetButtonText
kGetMenuText
kHasIcon
kGetIconFileName
kGetIconIndex
kGetPersistentActionId

    {
        kGetId,
        kIsVisible,
        kIsEnabled,
        kIsChecked,
        kGetDescription,
        kGetCategory,
        kGetButtonText,
        kGetMenuText,
        kHasIcon,
        kGetIconFileName,
        kGetIconIndex,
        kGetPersistentActionId
    };

Constructor & Destructor Documentation

ActionItem() [1/5]

CoreExport ActionItem

(

)

Constructor.

~ActionItem() [1/5]

virtual CoreExport ~ActionItem ( )

virtual

Destructor.

ActionItem() [2/5]

CoreExport ActionItem

(

)

Constructor.

~ActionItem() [2/5]

virtual CoreExport ~ActionItem ( )

virtual

Destructor.

ActionItem() [3/5]

CoreExport ActionItem

(

)

Constructor.

~ActionItem() [3/5]

virtual CoreExport ~ActionItem ( )

virtual

Destructor.

ActionItem() [4/5]

CoreExport ActionItem

(

)

Constructor.

~ActionItem() [4/5]

virtual CoreExport ~ActionItem ( )

virtual

Destructor.

ActionItem() [5/5]

CoreExport ActionItem

(

)

Constructor.

~ActionItem() [5/5]

virtual CoreExport ~ActionItem ( )

virtual

Destructor.

Member Function Documentation

GetId() [1/5]

virtual int GetId ( )

pure virtual

Retrieves a unique identifier for the action.

This action must be unique in the table, but not does not have to be unique between tables.

Note

This should be a 16 bit value (in the range of 0-65,535) as it is also used as a Windows accelerator command ID for keyboard shortcuts, which is a WORD (16 bit unsigned short).

ExecuteAction() [1/5]

virtual BOOL ExecuteAction ( )

pure virtual

Executes the operation associated with the action item.

This returns a BOOL that indicates if the action was actually executed. If the item is disabled, or if the table that owns it is not activated, then it won't execute, and returns FALSE.

Returns

TRUE if the action is executed; otherwise FALSE.

EmitMacro() [1/5]

virtual CoreExport void EmitMacro ( )

virtual

Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.

Execute() [1/5]

CoreExport BOOL Execute

(

)

Calls ExecuteAction() and handles macro recording etc.

Called by 3ds Max.

GetButtonText() [1/5]

virtual void GetButtonText ( MSTR &  buttonText )

pure virtual

Retrieves the text that will be used when the ActionItem is on a text button.

The text is stored into the buttonText parameter.

Parameters

[out]

buttonText

- The retrieved text.

GetMenuText() [1/5]

virtual void GetMenuText ( MSTR &  menuText )

pure virtual

Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).

This can be different from the button text. This method is called just before the menu is displayed, so it can update the text at that time. For example, the "Undo" menu item in 3ds Max's main menu adds the name of the command that will be undone.

Parameters

[out]

menuText

- The retrieved text.

GetDescriptionText() [1/5]

virtual void GetDescriptionText ( MSTR &  descText )

pure virtual

Retrieves the text that will be used for tool tips and menu help.

This is also the string that is displayed for the operation in all the lists in the customization dialogs.

Parameters

[out]

descText

- The retrieved text.

GetCategoryText() [1/5]

virtual void GetCategoryText ( MSTR &  catText )

pure virtual

Retrieves the text for the category of the operation.

This is used in the customization dialog to fill the "category" drop-down list.

Parameters

[out]

catText

- The retrieved text.

GetPersistentActionId() [1/10]

CoreExport void GetPersistentActionId

(

MSTR &

persistentActionId

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Parameters

[out]

persistentActionId

- The retrieved text.

GetPersistentActionId() [2/10]

CoreExport MSTR GetPersistentActionId

(

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Returns

The persistent action id text.

IsChecked() [1/5]

virtual BOOL IsChecked ( )

pure virtual

Returns whether a menu item is in a checked state, or if a button is in a pressed state.

For menus, this means that this function will return TRUE if a check mark appears next to the item. If the item is on a button, this is used to determine of the button is in the "Pressed" state. Note that button states are automatically updated on selection change and command mode changes. If your plug-in performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE).

Returns

TRUE if menu item is checked, or if a button is 'pressed'. FALSE otherwise

IsIndeterminate() [1/5]

virtual BOOL IsIndeterminate ( )

inlinevirtual

Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.

When implemented return TRUE if the condition of your action is both checked and unchecked. For instance an action that sets/displays the state of a multiple nodes frozen property when you have nodes that are both frozen and unfrozen this would return TRUE and instead of a check the action will display a dash. If this returns TRUE the isChecked state is ignored. NOTE actions with pushbutton icons will not display this state

Returns

TRUE if menu item is in an indeterminate state

{return FALSE;};

IsItemVisible() [1/5]

virtual BOOL IsItemVisible ( )

pure virtual

Determines if an item is visible on a context menu.

If it returns FALSE, then the item is not included in the menu. This can be used to create items that a context sensitive. For example, you may want an item to appear on a menu only when the selected object is of a particular type. To do this, you have this method check the class id of the current selection.

IsEnabled() [1/5]

virtual BOOL IsEnabled ( )

pure virtual

Determines if the operation is available to the user.

If this method returns FALSE, and the ActionItem it is on a menu, or button, the item is grayed out. If it assigned to a keyboard shortcut, then it will not execute the operation if invoked. If your plugin performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE)

Returns

TRUE for enabled; FALSE for disabled.

GetIcon() [1/5]

CoreExport MaxIcon * GetIcon

(

)

Returns an icon associated with an ActionItem.

First checks the result of GetIconImp(), then looks at ActionTable::GetIcon(int). If both functions return NULL, then this action has no Icon associated with it.

Returns

Icon associated with this action.

DeleteThis() [1/5]

virtual void DeleteThis ( )

pure virtual

Called by 3ds Max to delete the ActionItem.

This normally happens when the table that owns it is deleted.

GetTable() [1/5]

virtual CoreExport ActionTable * GetTable ( )

virtual

Returns a pointer to the table that owns the ActionItem.

An item can only be owned by a single table.

Default Implementation

{ return mpTable; }

SetTable() [1/5]

virtual CoreExport void SetTable ( ActionTable *  pTable )

virtual

Sets the table that owns the item.

Used internally. May be used if you implement a custom sub-class of ActionItem.

Parameters

pTable

- Points to the table to set.

Default Implementation:

{ mpTable = pTable; }

GetShortcutString() [1/5]

CoreExport const MCHAR * GetShortcutString

(

)

Returns the string that describes all the keyboard shortcuts associated with the item.

This will look something like "Alt+A" or "C, Shift+Alt+Q".

Returns

NULL if no keyboard shortcut is associated with the item.

GetMacroScript() [1/5]

virtual CoreExport MacroEntry * GetMacroScript ( )

virtual

Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.

Returns

A pointer to a MacroEntry

Default Implementation

{ return NULL; }

IsDynamicMenu() [1/5]

virtual CoreExport BOOL IsDynamicMenu ( )

virtual

Determines if a menu is created or if an action takes place.

Returns

If this method returns TRUE, then the ActionItem creates a menu. If it returns FALSE then an action is performed.

Default Implementation

{ return FALSE; }

SetIsDynamicMenu() [1/5]

virtual CoreExport void SetIsDynamicMenu ( )

virtual

This method may be called after an action item is created to tell the system that it is a dynamic menu action.

Note

Dynamic menus may be added to the quad menus procedurally (via the IMenuManager API) or 'manually'.

GetDynamicMenu() [1/3]

virtual CoreExport IMenu * GetDynamicMenu ( HWND  hwnd, IPoint2 &  m  )

virtual

If the ActionItem does produce a menu, this method is called to return a pointer to the menu.

See class DynamicMenu for an easy way to produce these menus.

Parameters

hwnd	- If the menu is requested by a right-click quad menu, then this hwnd is the handle of the window where the click occurred. If the item is used from a menu bar, this hwnd will be NULL.
m	- If the menu is requested by a right-click quad menu, then this parameter is the point in the window where the user clicked.

Returns

A pointer to the menu.

Default Implementation:

{ return NULL; }

IsDynamicAction() [1/5]

virtual CoreExport BOOL IsDynamicAction ( )

virtual

ActionItems that are deleted after they execute should return TRUE.

HasIcon() [1/5]

CoreExport BOOL HasIcon

(

)

Returns TRUE if the ActionItem specifies an icon.

GetIconFileName() [1/5]

CoreExport bool GetIconFileName

(

MSTR &

fileName

)

If the ActionItem specifies an icon, accesses the icon filename.

Parameters

fileName

- If the ActionItem specifies an icon, then the icon filename is returned through this parameter.

Returns

true if the ActionItem specifies an icon, otherwise false.

GetIconIndex() [1/5]

CoreExport int GetIconIndex

(

)

If the ActionItem specifies an icon, returns the icon index.

Returns

If the ActionItem specifies an icon then the icon index, otherwise -1.

GetTooltipKey() [1/5]

CoreExport MSTR GetTooltipKey

(

)

Get the Action's tooltip key.

The tooltip key may be associated with a product tooltip. By default, the tooltip key is built as "actionTableID-actionID" for native actions and as "Category-MacroName" for macros.

Returns

a string with the tooltip key

SetTooltipKey() [1/5]

CoreExport void SetTooltipKey

(

const MCHAR *

tooltipKey

)

Set the Action's tooltip key.

The function does not verify if the key is unique or not.

tooltipKey - a string with the tooltip key

GetIconPath() [1/5]

CoreExport MaxSDK::Util::Path GetIconPath

(

IconSize

size

)

Get the Action's path to the icon of size specified by param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to get

Returns

The path to the icon of the size specified by the input parameter.

SetIconPath() [1/5]

CoreExport void SetIconPath	(	IconSize	size,
		const MaxSDK::Util::Path &	path
	)

Sets the Action's path to the icon of size specified by the input param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to set
path	The path to the icon of the size specified by the input parameter.

GetMetadata() [1/5]

CoreExport MSTR GetMetadata

(

)

Gets the Action's metadata.

Metadata format is a single string with a comma
separating each individual metadatum. Metadata is used in global search command to list similar command names in other software, etc

SetMetadata() [1/5]

CoreExport void SetMetadata

(

const MCHAR *

metadata

)

Sets the Action's metadata.

Parameters

metadata

The metadata

GetDescByID() [1/5]

virtual CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID  id )

virtual

Remarks

This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.

Parameters:

Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.

Default Implementation:

{ return &nullInterface; }

Reimplemented from FPMixinInterface.

GetDesc() [1/5]

virtual CoreExport FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [1/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

GetID() [1/5]

virtual CoreExport Interface_ID GetID ( )

virtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

RO_PROP_FN() [1/39]

RO_PROP_FN ( kGetId  , GetId  , TYPE_DWORD    )

protected

RO_PROP_FN() [2/39]

RO_PROP_FN ( kIsVisible  , IsItemVisible  , TYPE_BOOL    )

protected

RO_PROP_FN() [3/39]

RO_PROP_FN ( kIsEnabled  , IsEnabled  , TYPE_BOOL    )

protected

RO_PROP_FN() [4/39]

RO_PROP_FN ( kIsChecked  , IsChecked  , TYPE_BOOL    )

protected

VFN_1() [1/20]

VFN_1 ( kGetDescription  , GetDescriptionText  , TYPE_TSTR_BR    )

protected

VFN_1() [2/20]

VFN_1 ( kGetCategory  , GetCategoryText  , TYPE_TSTR_BR    )

protected

VFN_1() [3/20]

VFN_1 ( kGetButtonText  , GetButtonText  , TYPE_TSTR_BR    )

protected

VFN_1() [4/20]

VFN_1 ( kGetMenuText  , GetMenuText  , TYPE_TSTR_BR    )

protected

FN_0() [1/10]

FN_0 ( kHasIcon  , TYPE_BOOL  , HasIcon    )

protected

FN_1() [1/5]

FN_1 ( kGetIconFileName  , TYPE_bool  , GetIconFileName  , TYPE_TSTR_BR    )

protected

FN_0() [2/10]

FN_0 ( kGetIconIndex  , TYPE_INDEX  , GetIconIndex    )

protected

RO_PROP_FN() [5/39]

RO_PROP_FN ( kGetPersistentActionId  , GetPersistentActionId  , TYPE_TSTR_BV    )

protected

GetIconImp() [1/5]

virtual CoreExport MaxIcon * GetIconImp ( )

protectedvirtual

Returns an icon associated with an ActionItem.

To supply a custom icon for an action item, override this method and supply a custom implementation. Default implementation: returns NULL

Returns

Icon for this action, or NULL if not specified by implementing class.

GetId() [2/5]

virtual int GetId ( )

pure virtual

Retrieves a unique identifier for the action.

This action must be unique in the table, but not does not have to be unique <<<<<<< HEAD between tables.

WORD()

which is a WORD ( 16 bit unsigned short  )

pure virtual

ExecuteAction() [2/5]

virtual a406e112cf287e51abdbba7f88b8e4b91e0a64e7 BOOL ExecuteAction ( )

pure virtual

Executes the operation associated with the action item.

This returns a BOOL that indicates if the action was actually executed. If the item is disabled, or if the table that owns it is not activated, then it won't execute, and returns FALSE.

Returns

TRUE if the action is executed; otherwise FALSE.

EmitMacro() [2/5]

virtual CoreExport void EmitMacro ( )

virtual

Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.

Execute() [2/5]

CoreExport BOOL Execute

(

)

Calls ExecuteAction() and handles macro recording etc.

Called by 3ds Max.

SupportsAltExecute() [1/2]

virtual bool SupportsAltExecute ( ) const

inlinevirtual

Returns true if the action supports AltExecute.

If an action supports AltExecute, then a mouse icon (with a dark click button) appears in the quad menu item that corresponds to the action. When the icon is clicked, the AltExecute method is called.

{ return false; }

AltExecute() [1/2]

virtual bool AltExecute ( )

inlinevirtual

Returns true if AltExecute ran successfully.

If an action supports AltExecute, then a mouse icon (with a dark click button) appears in the quad menu item that corresponds to the action. When the icon is clicked, the AltExecute method is called.

{ return false; }

SupportsCloseDialogs() [1/2]

virtual bool SupportsCloseDialogs ( ) const

inlinevirtual

Returns true if the action supports CloseDialogs.

This is called by the internal implementation of IActionItemToggleManager::FlipToggleState to close a dialog if when executing the action the action was registered via IActionItemToggleManager::RegisterToggleAction. If true, the CloseDialogs method is called when toggling the action state off.

{ return false; }

CloseDialogs() [1/2]

virtual bool CloseDialogs ( )

inlinevirtual

Returns true if CloseDialogs ran successfully.

{ return false; }

GetButtonText() [2/5]

virtual void GetButtonText ( MSTR &  buttonText )

pure virtual

Retrieves the text that will be used when the ActionItem is on a text button.

The text is stored into the buttonText parameter.

Parameters

[out]

buttonText

- The retrieved text.

GetMenuText() [2/5]

virtual void GetMenuText ( MSTR &  menuText )

pure virtual

Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).

This can be different from the button text. This method is called just before the menu is displayed, so it can update the text at that time. For example, the "Undo" menu item in 3ds Max's main menu adds the name of the command that will be undone.

Parameters

[out]

menuText

- The retrieved text.

GetDescriptionText() [2/5]

virtual void GetDescriptionText ( MSTR &  descText )

pure virtual

Retrieves the text that will be used for tool tips and menu help.

This is also the string that is displayed for the operation in all the lists in the customization dialogs.

Parameters

[out]

descText

- The retrieved text.

GetCategoryText() [2/5]

virtual void GetCategoryText ( MSTR &  catText )

pure virtual

Retrieves the text for the category of the operation.

This is used in the customization dialog to fill the "category" drop-down list.

Parameters

[out]

catText

- The retrieved text.

GetPersistentActionId() [3/10]

CoreExport void GetPersistentActionId

(

MSTR &

persistentActionId

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Parameters

[out]

persistentActionId

- The retrieved text.

GetPersistentActionId() [4/10]

CoreExport MSTR GetPersistentActionId

(

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Returns

The persistent action id text.

IsChecked() [2/5]

virtual BOOL IsChecked ( )

pure virtual

Returns whether a menu item is in a checked state, or if a button is in a pressed state.

For menus, this means that this function will return TRUE if a check mark appears next to the item. If the item is on a button, this is used to determine of the button is in the "Pressed" state. Note that button states are automatically updated on selection change and command mode changes. If your plug-in performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE).

Returns

TRUE if menu item is checked, or if a button is 'pressed'. FALSE otherwise

IsIndeterminate() [2/5]

virtual BOOL IsIndeterminate ( )

inlinevirtual

Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.

When implemented return TRUE if the condition of your action is both checked and unchecked. For instance an action that sets/displays the state of a multiple nodes frozen property when you have nodes that are both frozen and unfrozen this would return TRUE and instead of a check the action will display a dash. If this returns TRUE the isChecked state is ignored. NOTE actions with pushbutton icons will not display this state

Returns

TRUE if menu item is in an indeterminate state

{return FALSE;};

IsItemVisible() [2/5]

virtual BOOL IsItemVisible ( )

pure virtual

Determines if an item is visible on a context menu.

If it returns FALSE, then the item is not included in the menu. This can be used to create items that a context sensitive. For example, you may want an item to appear on a menu only when the selected object is of a particular type. To do this, you have this method check the class id of the current selection.

IsEnabled() [2/5]

virtual BOOL IsEnabled ( )

pure virtual

Determines if the operation is available to the user.

If this method returns FALSE, and the ActionItem it is on a menu, or button, the item is grayed out. If it assigned to a keyboard shortcut, then it will not execute the operation if invoked. If your plugin performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE)

Returns

TRUE for enabled; FALSE for disabled.

GetIcon() [2/5]

CoreExport MaxIcon * GetIcon

(

)

Returns an icon associated with an ActionItem.

First checks the result of GetIconImp(), then looks at ActionTable::GetIcon(int). If both functions return NULL, then this action has no Icon associated with it.

Returns

Icon associated with this action.

DeleteThis() [2/5]

virtual void DeleteThis ( )

pure virtual

Called by 3ds Max to delete the ActionItem.

This normally happens when the table that owns it is deleted.

GetTable() [2/5]

virtual CoreExport ActionTable * GetTable ( )

virtual

Returns a pointer to the table that owns the ActionItem.

An item can only be owned by a single table.

Default Implementation

{ return mpTable; }

SetTable() [2/5]

virtual CoreExport void SetTable ( ActionTable *  pTable )

virtual

Sets the table that owns the item.

Used internally. May be used if you implement a custom sub-class of ActionItem.

Parameters

pTable

- Points to the table to set.

Default Implementation:

{ mpTable = pTable; }

GetShortcutString() [2/5]

CoreExport const MCHAR * GetShortcutString

(

)

Returns the string that describes all the keyboard shortcuts associated with the item.

This will look something like "Alt+A" or "C, Shift+Alt+Q".

Returns

NULL if no keyboard shortcut is associated with the item.

GetMacroScript() [2/5]

virtual CoreExport MacroEntry * GetMacroScript ( )

virtual

Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.

Returns

A pointer to a MacroEntry

Default Implementation

{ return NULL; }

IsDynamicMenu() [2/5]

virtual CoreExport BOOL IsDynamicMenu ( )

virtual

Determines if a menu is created or if an action takes place.

Returns

If this method returns TRUE, then the ActionItem creates a menu. If it returns FALSE then an action is performed.

Default Implementation

{ return FALSE; }

SetIsDynamicMenu() [2/5]

virtual CoreExport void SetIsDynamicMenu ( )

virtual

This method may be called after an action item is created to tell the system that it is a dynamic menu action.

Note

Dynamic menus may be added to the quad menus procedurally (via the IMenuManager API) or 'manually'.

__declspec() [1/2]

__declspec

(

deprecated

)

Deprecated:

This has been deprecated as of 3ds Max 2024, please use PopulateDynamicMenu instead

PopulateDynamicMenu() [1/2]

virtual CoreExport void PopulateDynamicMenu ( MaxSDK::CUI::ICuiDynamicMenu *  dynMenu, HWND  hWnd, const IPoint2 &  cursorPos  )

virtual

If the ActionItem does produce a dynamic menu (i.e.

IsDyamicAction() returns true), this method is called by the system to populate the new menu currently being created to add items, separators, and submenus. Each item is given an arbitrary id (see ICuiDynamicMenu interface). Default implementation is a no-op.

Parameters

dynMenu	- Pointer to dynamic menu interface. Pointer is owned by the system.
hWnd	- If the menu is requested by a right-click quad menu, then this hWnd is the handle of the window where the click occurred. If the item is used from a menu bar, this hwnd will be nullptr.
cursorPos	- If the menu is requested by a right-click quad menu, then this parameter is the point in the window where the user clicked.

See also

class ICuiDynamicMenu

DynamicMenuItemSelected() [1/2]

virtual CoreExport void DynamicMenuItemSelected ( int  itemId )

virtual

If the ActionItem does produce a menu (i.e.

IsDyamicAction() returns true), this method is called by the system when user clicks a menu item thas was added in PopulateDynamicMenu. Default implementation is a no-op.

Parameters

itemId

- id of menu item that was clicked by user. Use this id to execute appropriate action. This id is passed to ICuiDynamicMenu functions when populating the menu (for example: AddItem(itemCmdId, ...)).

See also

class ICuiDynamicMenu

IsDynamicAction() [2/5]

virtual CoreExport BOOL IsDynamicAction ( )

virtual

ActionItems that are deleted after they execute should return TRUE.

HasIcon() [2/5]

CoreExport BOOL HasIcon

(

)

Returns TRUE if the ActionItem specifies an icon.

GetIconFileName() [2/5]

CoreExport bool GetIconFileName

(

MSTR &

fileName

)

If the ActionItem specifies an icon, accesses the icon filename.

Parameters

fileName

- If the ActionItem specifies an icon, then the icon filename is returned through this parameter.

Returns

true if the ActionItem specifies an icon, otherwise false.

GetIconIndex() [2/5]

CoreExport int GetIconIndex

(

)

If the ActionItem specifies an icon, returns the icon index.

Returns

If the ActionItem specifies an icon then the icon index, otherwise -1.

GetTooltipKey() [2/5]

CoreExport MSTR GetTooltipKey

(

)

Get the Action's tooltip key.

The tooltip key may be associated with a product tooltip. By default, the tooltip key is built as "actionTableID-actionID" for native actions and as "Category-MacroName" for macros.

Returns

a string with the tooltip key

SetTooltipKey() [2/5]

CoreExport void SetTooltipKey

(

const MCHAR *

tooltipKey

)

Set the Action's tooltip key.

The function does not verify if the key is unique or not.

tooltipKey - a string with the tooltip key

GetIconPath() [2/5]

CoreExport MaxSDK::Util::Path GetIconPath

(

IconSize

size

)

Get the Action's path to the icon of size specified by param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to get

Returns

The path to the icon of the size specified by the input parameter.

SetIconPath() [2/5]

CoreExport void SetIconPath	(	IconSize	size,
		const MaxSDK::Util::Path &	path
	)

Sets the Action's path to the icon of size specified by the input param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to set
path	The path to the icon of the size specified by the input parameter.

GetMetadata() [2/5]

CoreExport MSTR GetMetadata

(

)

Gets the Action's metadata.

Metadata format is a single string with a comma
separating each individual metadatum. Metadata is used in global search command to list similar command names in other software, etc

SetMetadata() [2/5]

CoreExport void SetMetadata

(

const MCHAR *

metadata

)

Sets the Action's metadata.

Parameters

metadata

The metadata

GetDescByID() [2/5]

virtual CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID  id )

virtual

Remarks

This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.

Parameters:

Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.

Default Implementation:

{ return &nullInterface; }

Reimplemented from FPMixinInterface.

GetDesc() [2/5]

virtual CoreExport FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [2/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

GetID() [2/5]

virtual CoreExport Interface_ID GetID ( )

virtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

RO_PROP_FN() [6/39]

RO_PROP_FN ( kGetId  , GetId  , TYPE_DWORD    )

protected

RO_PROP_FN() [7/39]

RO_PROP_FN ( kIsVisible  , IsItemVisible  , TYPE_BOOL    )

protected

RO_PROP_FN() [8/39]

RO_PROP_FN ( kIsEnabled  , IsEnabled  , TYPE_BOOL    )

protected

RO_PROP_FN() [9/39]

RO_PROP_FN ( kIsChecked  , IsChecked  , TYPE_BOOL    )

protected

VFN_1() [5/20]

VFN_1 ( kGetDescription  , GetDescriptionText  , TYPE_TSTR_BR    )

protected

VFN_1() [6/20]

VFN_1 ( kGetCategory  , GetCategoryText  , TYPE_TSTR_BR    )

protected

VFN_1() [7/20]

VFN_1 ( kGetButtonText  , GetButtonText  , TYPE_TSTR_BR    )

protected

VFN_1() [8/20]

VFN_1 ( kGetMenuText  , GetMenuText  , TYPE_TSTR_BR    )

protected

FN_0() [3/10]

FN_0 ( kHasIcon  , TYPE_BOOL  , HasIcon    )

protected

FN_1() [2/5]

FN_1 ( kGetIconFileName  , TYPE_bool  , GetIconFileName  , TYPE_TSTR_BR    )

protected

FN_0() [4/10]

FN_0 ( kGetIconIndex  , TYPE_INDEX  , GetIconIndex    )

protected

RO_PROP_FN() [10/39]

RO_PROP_FN ( kGetPersistentActionId  , GetPersistentActionId  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [11/39]

RO_PROP_FN ( kGetDescription_prop  , fpGetDescriptionText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [12/39]

RO_PROP_FN ( kGetCategory_prop  , fpGetCategoryText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [13/39]

RO_PROP_FN ( kGetButtonText_prop  , fpGetButtonText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [14/39]

RO_PROP_FN ( kGetMenuText_prop  , fpGetMenuText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [15/39]

RO_PROP_FN ( kGetIconFileName_prop  , fpGetIconFileName  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [16/39]

RO_PROP_FN ( kGetIconIndex_prop  , GetIconIndex  , TYPE_INDEX    )

protected

RO_PROP_FN() [17/39]

RO_PROP_FN ( kActionTableID  , fpActionTableID  , TYPE_DWORD    )

protected

GetIconImp() [2/5]

virtual CoreExport MaxIcon * GetIconImp ( )

protectedvirtual

Returns an icon associated with an ActionItem.

To supply a custom icon for an action item, override this method and supply a custom implementation. Default implementation: returns NULL

Returns

Icon for this action, or NULL if not specified by implementing class.

fpGetDescriptionText() [1/2]

MSTR fpGetDescriptionText ( )

inlineprotected

    {
        MSTR res;
        GetDescriptionText(res);
        return res;
    }

fpGetCategoryText() [1/2]

MSTR fpGetCategoryText ( )

inlineprotected

    {
        MSTR res;
        GetCategoryText(res);
        return res;
    }

fpGetButtonText() [1/2]

MSTR fpGetButtonText ( )

inlineprotected

    {
        MSTR res;
        GetButtonText(res);
        return res;
    }

fpGetMenuText() [1/2]

MSTR fpGetMenuText ( )

inlineprotected

    {
        MSTR res;
        GetMenuText(res);
        return res;
    }

fpGetIconFileName() [1/2]

MSTR fpGetIconFileName ( )

inlineprotected

    {
        MSTR res;
        GetIconFileName(res);
        return res;
    }

fpActionTableID() [1/2]

CoreExport DWORD fpActionTableID ( )

protected

GetId() [3/5]

virtual int GetId ( )

pure virtual

Retrieves a unique identifier for the action.

This action must be unique in the table, but not does not have to be unique between tables.

ExecuteAction() [3/5]

virtual BOOL ExecuteAction ( )

pure virtual

Executes the operation associated with the action item.

This returns a BOOL that indicates if the action was actually executed. If the item is disabled, or if the table that owns it is not activated, then it won't execute, and returns FALSE.

Returns

TRUE if the action is executed; otherwise FALSE.

EmitMacro() [3/5]

virtual CoreExport void EmitMacro ( )

virtual

Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.

Execute() [3/5]

CoreExport BOOL Execute

(

)

Calls ExecuteAction() and handles macro recording etc.

Called by 3ds Max.

GetButtonText() [3/5]

virtual void GetButtonText ( MSTR &  buttonText )

pure virtual

Retrieves the text that will be used when the ActionItem is on a text button.

The text is stored into the buttonText parameter.

Parameters

[out]

buttonText

- The retrieved text.

GetMenuText() [3/5]

virtual void GetMenuText ( MSTR &  menuText )

pure virtual

Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).

This can be different from the button text. This method is called just before the menu is displayed, so it can update the text at that time. For example, the "Undo" menu item in 3ds Max's main menu adds the name of the command that will be undone.

Parameters

[out]

menuText

- The retrieved text.

GetDescriptionText() [3/5]

virtual void GetDescriptionText ( MSTR &  descText )

pure virtual

Retrieves the text that will be used for tool tips and menu help.

This is also the string that is displayed for the operation in all the lists in the customization dialogs.

Parameters

[out]

descText

- The retrieved text.

GetCategoryText() [3/5]

virtual void GetCategoryText ( MSTR &  catText )

pure virtual

Retrieves the text for the category of the operation.

This is used in the customization dialog to fill the "category" drop-down list.

Parameters

[out]

catText

- The retrieved text.

GetPersistentActionId() [5/10]

CoreExport void GetPersistentActionId

(

MSTR &

persistentActionId

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Parameters

[out]

persistentActionId

- The retrieved text.

GetPersistentActionId() [6/10]

CoreExport MSTR GetPersistentActionId

(

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Returns

The persistent action id text.

IsChecked() [3/5]

virtual BOOL IsChecked ( )

pure virtual

Returns whether a menu item is in a checked state, or if a button is in a pressed state.

For menus, this means that this function will return TRUE if a check mark appears next to the item. If the item is on a button, this is used to determine of the button is in the "Pressed" state. Note that button states are automatically updated on selection change and command mode changes. If your plug-in performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE).

Returns

TRUE if menu item is checked, or if a button is 'pressed'. FALSE otherwise

IsIndeterminate() [3/5]

virtual BOOL IsIndeterminate ( )

inlinevirtual

Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.

When implemented return TRUE if the condition of your action is both checked and unchecked. For instance an action that sets/displays the state of a multiple nodes frozen property when you have nodes that are both frozen and unfrozen this would return TRUE and instead of a check the action will display a dash. If this returns TRUE the isChecked state is ignored. NOTE actions with pushbutton icons will not display this state

Returns

TRUE if menu item is in an indeterminate state

{return FALSE;};

IsItemVisible() [3/5]

virtual BOOL IsItemVisible ( )

pure virtual

Determines if an item is visible on a context menu.

If it returns FALSE, then the item is not included in the menu. This can be used to create items that a context sensitive. For example, you may want an item to appear on a menu only when the selected object is of a particular type. To do this, you have this method check the class id of the current selection.

IsEnabled() [3/5]

virtual BOOL IsEnabled ( )

pure virtual

Determines if the operation is available to the user.

If this method returns FALSE, and the ActionItem it is on a menu, or button, the item is grayed out. If it assigned to a keyboard shortcut, then it will not execute the operation if invoked. If your plugin performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE)

Returns

TRUE for enabled; FALSE for disabled.

GetIcon() [3/5]

CoreExport MaxIcon * GetIcon

(

)

Returns an icon associated with an ActionItem.

First checks the result of GetIconImp(), then looks at ActionTable::GetIcon(int). If both functions return NULL, then this action has no Icon associated with it.

Returns

Icon associated with this action.

DeleteThis() [3/5]

virtual void DeleteThis ( )

pure virtual

Called by 3ds Max to delete the ActionItem.

This normally happens when the table that owns it is deleted.

GetTable() [3/5]

virtual CoreExport ActionTable * GetTable ( )

virtual

Returns a pointer to the table that owns the ActionItem.

An item can only be owned by a single table.

Default Implementation

{ return mpTable; }

SetTable() [3/5]

virtual CoreExport void SetTable ( ActionTable *  pTable )

virtual

Sets the table that owns the item.

Used internally. May be used if you implement a custom sub-class of ActionItem.

Parameters

pTable

- Points to the table to set.

Default Implementation:

{ mpTable = pTable; }

GetShortcutString() [3/5]

CoreExport const MCHAR * GetShortcutString

(

)

Returns the string that describes all the keyboard shortcuts associated with the item.

This will look something like "Alt+A" or "C, Shift+Alt+Q".

Returns

NULL if no keyboard shortcut is associated with the item.

GetMacroScript() [3/5]

virtual CoreExport MacroEntry * GetMacroScript ( )

virtual

Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.

Returns

A pointer to a MacroEntry

Default Implementation

{ return NULL; }

IsDynamicMenu() [3/5]

virtual CoreExport BOOL IsDynamicMenu ( )

virtual

Determines if a menu is created or if an action takes place.

Returns

If this method returns TRUE, then the ActionItem creates a menu. If it returns FALSE then an action is performed.

Default Implementation

{ return FALSE; }

SetIsDynamicMenu() [3/5]

virtual CoreExport void SetIsDynamicMenu ( )

virtual

This method may be called after an action item is created to tell the system that it is a dynamic menu action.

Note

Dynamic menus may be added to the quad menus procedurally (via the IMenuManager API) or 'manually'.

GetDynamicMenu() [2/3]

virtual CoreExport IMenu * GetDynamicMenu ( HWND  hwnd, IPoint2 &  m  )

virtual

If the ActionItem does produce a menu, this method is called to return a pointer to the menu.

See class DynamicMenu for an easy way to produce these menus.

Parameters

hwnd	- If the menu is requested by a right-click quad menu, then this hwnd is the handle of the window where the click occurred. If the item is used from a menu bar, this hwnd will be NULL.
m	- If the menu is requested by a right-click quad menu, then this parameter is the point in the window where the user clicked.

Returns

A pointer to the menu.

Default Implementation:

{ return NULL; }

IsDynamicAction() [3/5]

virtual CoreExport BOOL IsDynamicAction ( )

virtual

ActionItems that are deleted after they execute should return TRUE.

HasIcon() [3/5]

CoreExport BOOL HasIcon

(

)

Returns TRUE if the ActionItem specifies an icon.

GetIconFileName() [3/5]

CoreExport bool GetIconFileName

(

MSTR &

fileName

)

If the ActionItem specifies an icon, accesses the icon filename.

Parameters

fileName

- If the ActionItem specifies an icon, then the icon filename is returned through this parameter.

Returns

true if the ActionItem specifies an icon, otherwise false.

GetIconIndex() [3/5]

CoreExport int GetIconIndex

(

)

If the ActionItem specifies an icon, returns the icon index.

Returns

If the ActionItem specifies an icon then the icon index, otherwise -1.

GetTooltipKey() [3/5]

CoreExport MSTR GetTooltipKey

(

)

Get the Action's tooltip key.

The tooltip key may be associated with a product tooltip. By default, the tooltip key is built as "actionTableID-actionID" for native actions and as "Category-MacroName" for macros.

Returns

a string with the tooltip key

SetTooltipKey() [3/5]

CoreExport void SetTooltipKey

(

const MCHAR *

tooltipKey

)

Set the Action's tooltip key.

The function does not verify if the key is unique or not.

tooltipKey - a string with the tooltip key

GetIconPath() [3/5]

CoreExport MaxSDK::Util::Path GetIconPath

(

IconSize

size

)

Get the Action's path to the icon of size specified by param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to get

Returns

The path to the icon of the size specified by the input parameter.

SetIconPath() [3/5]

CoreExport void SetIconPath	(	IconSize	size,
		const MaxSDK::Util::Path &	path
	)

Sets the Action's path to the icon of size specified by the input param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to set
path	The path to the icon of the size specified by the input parameter.

GetMetadata() [3/5]

CoreExport MSTR GetMetadata

(

)

Gets the Action's metadata.

Metadata format is a single string with a comma
separating each individual metadatum. Metadata is used in global search command to list similar command names in other software, etc

SetMetadata() [3/5]

CoreExport void SetMetadata

(

const MCHAR *

metadata

)

Sets the Action's metadata.

Parameters

metadata

The metadata

GetDescByID() [3/5]

virtual CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID  id )

virtual

Remarks

This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.

Parameters:

Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.

Default Implementation:

{ return &nullInterface; }

Reimplemented from FPMixinInterface.

GetDesc() [3/5]

virtual CoreExport FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [3/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

GetID() [3/5]

virtual CoreExport Interface_ID GetID ( )

virtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

RO_PROP_FN() [18/39]

RO_PROP_FN ( kGetId  , GetId  , TYPE_DWORD    )

protected

RO_PROP_FN() [19/39]

RO_PROP_FN ( kIsVisible  , IsItemVisible  , TYPE_BOOL    )

protected

RO_PROP_FN() [20/39]

RO_PROP_FN ( kIsEnabled  , IsEnabled  , TYPE_BOOL    )

protected

RO_PROP_FN() [21/39]

RO_PROP_FN ( kIsChecked  , IsChecked  , TYPE_BOOL    )

protected

VFN_1() [9/20]

VFN_1 ( kGetDescription  , GetDescriptionText  , TYPE_TSTR_BR    )

protected

VFN_1() [10/20]

VFN_1 ( kGetCategory  , GetCategoryText  , TYPE_TSTR_BR    )

protected

VFN_1() [11/20]

VFN_1 ( kGetButtonText  , GetButtonText  , TYPE_TSTR_BR    )

protected

VFN_1() [12/20]

VFN_1 ( kGetMenuText  , GetMenuText  , TYPE_TSTR_BR    )

protected

FN_0() [5/10]

FN_0 ( kHasIcon  , TYPE_BOOL  , HasIcon    )

protected

FN_1() [3/5]

FN_1 ( kGetIconFileName  , TYPE_bool  , GetIconFileName  , TYPE_TSTR_BR    )

protected

FN_0() [6/10]

FN_0 ( kGetIconIndex  , TYPE_INDEX  , GetIconIndex    )

protected

RO_PROP_FN() [22/39]

RO_PROP_FN ( kGetPersistentActionId  , GetPersistentActionId  , TYPE_TSTR_BV    )

protected

GetIconImp() [3/5]

virtual CoreExport MaxIcon * GetIconImp ( )

protectedvirtual

Returns an icon associated with an ActionItem.

To supply a custom icon for an action item, override this method and supply a custom implementation. Default implementation: returns NULL

Returns

Icon for this action, or NULL if not specified by implementing class.

GetId() [4/5]

virtual int GetId ( )

pure virtual

Retrieves a unique identifier for the action.

This action must be unique in the table, but not does not have to be unique between tables.

ExecuteAction() [4/5]

virtual BOOL ExecuteAction ( )

pure virtual

Executes the operation associated with the action item.

This returns a BOOL that indicates if the action was actually executed. If the item is disabled, or if the table that owns it is not activated, then it won't execute, and returns FALSE.

Returns

TRUE if the action is executed; otherwise FALSE.

EmitMacro() [4/5]

virtual CoreExport void EmitMacro ( )

virtual

Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.

Execute() [4/5]

CoreExport BOOL Execute

(

)

Calls ExecuteAction() and handles macro recording etc.

Called by 3ds Max.

SupportsAltExecute() [2/2]

virtual bool SupportsAltExecute ( ) const

inlinevirtual

Returns true if the action supports AltExecute.

If an action supports AltExecute, then a mouse icon (with a dark click button) appears in the quad menu item that corresponds to the action. When the icon is clicked, the AltExecute method is called.

{ return false; }

AltExecute() [2/2]

virtual bool AltExecute ( )

inlinevirtual

Returns true if AltExecute ran successfully.

If an action supports AltExecute, then a mouse icon (with a dark click button) appears in the quad menu item that corresponds to the action. When the icon is clicked, the AltExecute method is called.

{ return false; }

SupportsCloseDialogs() [2/2]

virtual bool SupportsCloseDialogs ( ) const

inlinevirtual

Returns true if the action supports CloseDialogs.

This is called by the internal implementation of IActionItemToggleManager::FlipToggleState to close a dialog if when executing the action the action was registered via IActionItemToggleManager::RegisterToggleAction. If true, the CloseDialogs method is called when toggling the action state off.

{ return false; }

CloseDialogs() [2/2]

virtual bool CloseDialogs ( )

inlinevirtual

Returns true if CloseDialogs ran successfully.

{ return false; }

GetButtonText() [4/5]

virtual void GetButtonText ( MSTR &  buttonText )

pure virtual

Retrieves the text that will be used when the ActionItem is on a text button.

The text is stored into the buttonText parameter.

Parameters

[out]

buttonText

- The retrieved text.

GetMenuText() [4/5]

virtual void GetMenuText ( MSTR &  menuText )

pure virtual

Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).

This can be different from the button text. This method is called just before the menu is displayed, so it can update the text at that time. For example, the "Undo" menu item in 3ds Max's main menu adds the name of the command that will be undone.

Parameters

[out]

menuText

- The retrieved text.

GetDescriptionText() [4/5]

virtual void GetDescriptionText ( MSTR &  descText )

pure virtual

Retrieves the text that will be used for tool tips and menu help.

This is also the string that is displayed for the operation in all the lists in the customization dialogs.

Parameters

[out]

descText

- The retrieved text.

GetCategoryText() [4/5]

virtual void GetCategoryText ( MSTR &  catText )

pure virtual

Retrieves the text for the category of the operation.

This is used in the customization dialog to fill the "category" drop-down list.

Parameters

[out]

catText

- The retrieved text.

GetPersistentActionId() [7/10]

CoreExport void GetPersistentActionId

(

MSTR &

persistentActionId

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Parameters

[out]

persistentActionId

- The retrieved text.

GetPersistentActionId() [8/10]

CoreExport MSTR GetPersistentActionId

(

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Returns

The persistent action id text.

IsChecked() [4/5]

virtual BOOL IsChecked ( )

pure virtual

Returns whether a menu item is in a checked state, or if a button is in a pressed state.

For menus, this means that this function will return TRUE if a check mark appears next to the item. If the item is on a button, this is used to determine of the button is in the "Pressed" state. Note that button states are automatically updated on selection change and command mode changes. If your plug-in performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE).

Returns

TRUE if menu item is checked, or if a button is 'pressed'. FALSE otherwise

IsIndeterminate() [4/5]

virtual BOOL IsIndeterminate ( )

inlinevirtual

Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.

When implemented return TRUE if the condition of your action is both checked and unchecked. For instance an action that sets/displays the state of a multiple nodes frozen property when you have nodes that are both frozen and unfrozen this would return TRUE and instead of a check the action will display a dash. If this returns TRUE the isChecked state is ignored. NOTE actions with pushbutton icons will not display this state

Returns

TRUE if menu item is in an indeterminate state

{return FALSE;};

IsItemVisible() [4/5]

virtual BOOL IsItemVisible ( )

pure virtual

Determines if an item is visible on a context menu.

If it returns FALSE, then the item is not included in the menu. This can be used to create items that a context sensitive. For example, you may want an item to appear on a menu only when the selected object is of a particular type. To do this, you have this method check the class id of the current selection.

IsEnabled() [4/5]

virtual BOOL IsEnabled ( )

pure virtual

Determines if the operation is available to the user.

If this method returns FALSE, and the ActionItem it is on a menu, or button, the item is grayed out. If it assigned to a keyboard shortcut, then it will not execute the operation if invoked. If your plugin performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE)

Returns

TRUE for enabled; FALSE for disabled.

GetIcon() [4/5]

CoreExport MaxIcon * GetIcon

(

)

Returns an icon associated with an ActionItem.

First checks the result of GetIconImp(), then looks at ActionTable::GetIcon(int). If both functions return NULL, then this action has no Icon associated with it.

Returns

Icon associated with this action.

DeleteThis() [4/5]

virtual void DeleteThis ( )

pure virtual

Called by 3ds Max to delete the ActionItem.

This normally happens when the table that owns it is deleted.

GetTable() [4/5]

virtual CoreExport ActionTable * GetTable ( )

virtual

Returns a pointer to the table that owns the ActionItem.

An item can only be owned by a single table.

Default Implementation

{ return mpTable; }

SetTable() [4/5]

virtual CoreExport void SetTable ( ActionTable *  pTable )

virtual

Sets the table that owns the item.

Used internally. May be used if you implement a custom sub-class of ActionItem.

Parameters

pTable

- Points to the table to set.

Default Implementation:

{ mpTable = pTable; }

GetShortcutString() [4/5]

CoreExport const MCHAR * GetShortcutString

(

)

Returns the string that describes all the keyboard shortcuts associated with the item.

This will look something like "Alt+A" or "C, Shift+Alt+Q".

Returns

NULL if no keyboard shortcut is associated with the item.

GetMacroScript() [4/5]

virtual CoreExport MacroEntry * GetMacroScript ( )

virtual

Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.

Returns

A pointer to a MacroEntry

Default Implementation

{ return NULL; }

IsDynamicMenu() [4/5]

virtual CoreExport BOOL IsDynamicMenu ( )

virtual

Determines if a menu is created or if an action takes place.

Returns

If this method returns TRUE, then the ActionItem creates a menu. If it returns FALSE then an action is performed.

Default Implementation

{ return FALSE; }

SetIsDynamicMenu() [4/5]

virtual CoreExport void SetIsDynamicMenu ( )

virtual

This method may be called after an action item is created to tell the system that it is a dynamic menu action.

Note

Dynamic menus may be added to the quad menus procedurally (via the IMenuManager API) or 'manually'.

__declspec() [2/2]

__declspec

(

deprecated

)

Deprecated:

This has been deprecated as of 3ds Max 2024, please use PopulateDynamicMenu instead

PopulateDynamicMenu() [2/2]

virtual CoreExport void PopulateDynamicMenu ( MaxSDK::CUI::ICuiDynamicMenu *  dynMenu, HWND  hWnd, const IPoint2 &  cursorPos  )

virtual

If the ActionItem does produce a dynamic menu (i.e.

IsDyamicAction() returns true), this method is called by the system to populate the new menu currently being created to add items, separators, and submenus. Each item is given an arbitrary id (see ICuiDynamicMenu interface). Default implementation is a no-op.

Parameters

dynMenu	- Pointer to dynamic menu interface. Pointer is owned by the system.
hWnd	- If the menu is requested by a right-click quad menu, then this hWnd is the handle of the window where the click occurred. If the item is used from a menu bar, this hwnd will be nullptr.
cursorPos	- If the menu is requested by a right-click quad menu, then this parameter is the point in the window where the user clicked.

See also

class ICuiDynamicMenu

DynamicMenuItemSelected() [2/2]

virtual CoreExport void DynamicMenuItemSelected ( int  itemId )

virtual

If the ActionItem does produce a menu (i.e.

IsDyamicAction() returns true), this method is called by the system when user clicks a menu item thas was added in PopulateDynamicMenu. Default implementation is a no-op.

Parameters

itemId

- id of menu item that was clicked by user. Use this id to execute appropriate action. This id is passed to ICuiDynamicMenu functions when populating the menu (for example: AddItem(itemCmdId, ...)).

See also

class ICuiDynamicMenu

IsDynamicAction() [4/5]

virtual CoreExport BOOL IsDynamicAction ( )

virtual

ActionItems that are deleted after they execute should return TRUE.

HasIcon() [4/5]

CoreExport BOOL HasIcon

(

)

Returns TRUE if the ActionItem specifies an icon.

GetIconFileName() [4/5]

CoreExport bool GetIconFileName

(

MSTR &

fileName

)

If the ActionItem specifies an icon, accesses the icon filename.

Parameters

fileName

- If the ActionItem specifies an icon, then the icon filename is returned through this parameter.

Returns

true if the ActionItem specifies an icon, otherwise false.

GetIconIndex() [4/5]

CoreExport int GetIconIndex

(

)

If the ActionItem specifies an icon, returns the icon index.

Returns

If the ActionItem specifies an icon then the icon index, otherwise -1.

GetTooltipKey() [4/5]

CoreExport MSTR GetTooltipKey

(

)

Get the Action's tooltip key.

The tooltip key may be associated with a product tooltip. By default, the tooltip key is built as "actionTableID-actionID" for native actions and as "Category-MacroName" for macros.

Returns

a string with the tooltip key

SetTooltipKey() [4/5]

CoreExport void SetTooltipKey

(

const MCHAR *

tooltipKey

)

Set the Action's tooltip key.

The function does not verify if the key is unique or not.

tooltipKey - a string with the tooltip key

GetIconPath() [4/5]

CoreExport MaxSDK::Util::Path GetIconPath

(

IconSize

size

)

Get the Action's path to the icon of size specified by param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to get

Returns

The path to the icon of the size specified by the input parameter.

SetIconPath() [4/5]

CoreExport void SetIconPath	(	IconSize	size,
		const MaxSDK::Util::Path &	path
	)

Sets the Action's path to the icon of size specified by the input param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to set
path	The path to the icon of the size specified by the input parameter.

GetMetadata() [4/5]

CoreExport MSTR GetMetadata

(

)

Gets the Action's metadata.

Metadata format is a single string with a comma
separating each individual metadatum. Metadata is used in global search command to list similar command names in other software, etc

SetMetadata() [4/5]

CoreExport void SetMetadata

(

const MCHAR *

metadata

)

Sets the Action's metadata.

Parameters

metadata

The metadata

GetDescByID() [4/5]

virtual CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID  id )

virtual

Remarks

This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.

Parameters:

Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.

Default Implementation:

{ return &nullInterface; }

Reimplemented from FPMixinInterface.

GetDesc() [4/5]

virtual CoreExport FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [4/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

GetID() [4/5]

virtual CoreExport Interface_ID GetID ( )

virtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

RO_PROP_FN() [23/39]

RO_PROP_FN ( kGetId  , GetId  , TYPE_DWORD    )

protected

RO_PROP_FN() [24/39]

RO_PROP_FN ( kIsVisible  , IsItemVisible  , TYPE_BOOL    )

protected

RO_PROP_FN() [25/39]

RO_PROP_FN ( kIsEnabled  , IsEnabled  , TYPE_BOOL    )

protected

RO_PROP_FN() [26/39]

RO_PROP_FN ( kIsChecked  , IsChecked  , TYPE_BOOL    )

protected

VFN_1() [13/20]

VFN_1 ( kGetDescription  , GetDescriptionText  , TYPE_TSTR_BR    )

protected

VFN_1() [14/20]

VFN_1 ( kGetCategory  , GetCategoryText  , TYPE_TSTR_BR    )

protected

VFN_1() [15/20]

VFN_1 ( kGetButtonText  , GetButtonText  , TYPE_TSTR_BR    )

protected

VFN_1() [16/20]

VFN_1 ( kGetMenuText  , GetMenuText  , TYPE_TSTR_BR    )

protected

FN_0() [7/10]

FN_0 ( kHasIcon  , TYPE_BOOL  , HasIcon    )

protected

FN_1() [4/5]

FN_1 ( kGetIconFileName  , TYPE_bool  , GetIconFileName  , TYPE_TSTR_BR    )

protected

FN_0() [8/10]

FN_0 ( kGetIconIndex  , TYPE_INDEX  , GetIconIndex    )

protected

RO_PROP_FN() [27/39]

RO_PROP_FN ( kGetPersistentActionId  , GetPersistentActionId  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [28/39]

RO_PROP_FN ( kGetDescription_prop  , fpGetDescriptionText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [29/39]

RO_PROP_FN ( kGetCategory_prop  , fpGetCategoryText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [30/39]

RO_PROP_FN ( kGetButtonText_prop  , fpGetButtonText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [31/39]

RO_PROP_FN ( kGetMenuText_prop  , fpGetMenuText  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [32/39]

RO_PROP_FN ( kGetIconFileName_prop  , fpGetIconFileName  , TYPE_TSTR_BV    )

protected

RO_PROP_FN() [33/39]

RO_PROP_FN ( kGetIconIndex_prop  , GetIconIndex  , TYPE_INDEX    )

protected

RO_PROP_FN() [34/39]

RO_PROP_FN ( kActionTableID  , fpActionTableID  , TYPE_DWORD    )

protected

GetIconImp() [4/5]

virtual CoreExport MaxIcon * GetIconImp ( )

protectedvirtual

Returns an icon associated with an ActionItem.

To supply a custom icon for an action item, override this method and supply a custom implementation. Default implementation: returns NULL

Returns

Icon for this action, or NULL if not specified by implementing class.

fpGetDescriptionText() [2/2]

MSTR fpGetDescriptionText ( )

inlineprotected

    {
        MSTR res;
        GetDescriptionText(res);
        return res;
    }

fpGetCategoryText() [2/2]

MSTR fpGetCategoryText ( )

inlineprotected

    {
        MSTR res;
        GetCategoryText(res);
        return res;
    }

fpGetButtonText() [2/2]

MSTR fpGetButtonText ( )

inlineprotected

    {
        MSTR res;
        GetButtonText(res);
        return res;
    }

fpGetMenuText() [2/2]

MSTR fpGetMenuText ( )

inlineprotected

    {
        MSTR res;
        GetMenuText(res);
        return res;
    }

fpGetIconFileName() [2/2]

MSTR fpGetIconFileName ( )

inlineprotected

    {
        MSTR res;
        GetIconFileName(res);
        return res;
    }

fpActionTableID() [2/2]

CoreExport DWORD fpActionTableID ( )

protected

GetId() [5/5]

virtual int GetId ( )

pure virtual

Retrieves a unique identifier for the action.

This action must be unique in the table, but not does not have to be unique between tables.

Note

This should be a 16 bit value (in the range of 0-65,535) as it is also used as a Windows accelerator command ID for keyboard shortcuts, which is a WORD (16 bit unsigned short).

ExecuteAction() [5/5]

virtual BOOL ExecuteAction ( )

pure virtual

Executes the operation associated with the action item.

This returns a BOOL that indicates if the action was actually executed. If the item is disabled, or if the table that owns it is not activated, then it won't execute, and returns FALSE.

Returns

TRUE if the action is executed; otherwise FALSE.

EmitMacro() [5/5]

virtual CoreExport void EmitMacro ( )

virtual

Called by 3ds Max to allow the ActionItem to customize macroRecorder output for this action.

Execute() [5/5]

CoreExport BOOL Execute

(

)

Calls ExecuteAction() and handles macro recording etc.

Called by 3ds Max.

GetButtonText() [5/5]

virtual void GetButtonText ( MSTR &  buttonText )

pure virtual

Retrieves the text that will be used when the ActionItem is on a text button.

The text is stored into the buttonText parameter.

Parameters

[out]

buttonText

- The retrieved text.

GetMenuText() [5/5]

virtual void GetMenuText ( MSTR &  menuText )

pure virtual

Retrieves the text to use when the item is on a menu (either Quad menu or main menu bar).

This can be different from the button text. This method is called just before the menu is displayed, so it can update the text at that time. For example, the "Undo" menu item in 3ds Max's main menu adds the name of the command that will be undone.

Parameters

[out]

menuText

- The retrieved text.

GetDescriptionText() [5/5]

virtual void GetDescriptionText ( MSTR &  descText )

pure virtual

Retrieves the text that will be used for tool tips and menu help.

This is also the string that is displayed for the operation in all the lists in the customization dialogs.

Parameters

[out]

descText

- The retrieved text.

GetCategoryText() [5/5]

virtual void GetCategoryText ( MSTR &  catText )

pure virtual

Retrieves the text for the category of the operation.

This is used in the customization dialog to fill the "category" drop-down list.

Parameters

[out]

catText

- The retrieved text.

GetPersistentActionId() [9/10]

CoreExport void GetPersistentActionId

(

MSTR &

persistentActionId

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Parameters

[out]

persistentActionId

- The retrieved text.

GetPersistentActionId() [10/10]

CoreExport MSTR GetPersistentActionId

(

)

Retrieves the persistent action id text.

This can be used to store a reference to an action into a file, like it is done by the menu system.

Returns

The persistent action id text.

IsChecked() [5/5]

virtual BOOL IsChecked ( )

pure virtual

Returns whether a menu item is in a checked state, or if a button is in a pressed state.

For menus, this means that this function will return TRUE if a check mark appears next to the item. If the item is on a button, this is used to determine of the button is in the "Pressed" state. Note that button states are automatically updated on selection change and command mode changes. If your plug-in performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE).

Returns

TRUE if menu item is checked, or if a button is 'pressed'. FALSE otherwise

IsIndeterminate() [5/5]

virtual BOOL IsIndeterminate ( )

inlinevirtual

Returns whether an item is in an indeterminate state This is an optional state that can be implemented when the state of the action can be both checked and unchecked.

When implemented return TRUE if the condition of your action is both checked and unchecked. For instance an action that sets/displays the state of a multiple nodes frozen property when you have nodes that are both frozen and unfrozen this would return TRUE and instead of a check the action will display a dash. If this returns TRUE the isChecked state is ignored. NOTE actions with pushbutton icons will not display this state

Returns

TRUE if menu item is in an indeterminate state

{return FALSE;};

IsItemVisible() [5/5]

virtual BOOL IsItemVisible ( )

pure virtual

Determines if an item is visible on a context menu.

If it returns FALSE, then the item is not included in the menu. This can be used to create items that a context sensitive. For example, you may want an item to appear on a menu only when the selected object is of a particular type. To do this, you have this method check the class id of the current selection.

IsEnabled() [5/5]

virtual BOOL IsEnabled ( )

pure virtual

Determines if the operation is available to the user.

If this method returns FALSE, and the ActionItem it is on a menu, or button, the item is grayed out. If it assigned to a keyboard shortcut, then it will not execute the operation if invoked. If your plugin performs an operation that requires the CUI buttons to be redrawn, you need to call the method CUIFrameMgr::SetMacroButtonStates(TRUE)

Returns

TRUE for enabled; FALSE for disabled.

GetIcon() [5/5]

CoreExport MaxIcon * GetIcon

(

)

Returns an icon associated with an ActionItem.

First checks the result of GetIconImp(), then looks at ActionTable::GetIcon(int). If both functions return NULL, then this action has no Icon associated with it.

Returns

Icon associated with this action.

DeleteThis() [5/5]

virtual void DeleteThis ( )

pure virtual

Called by 3ds Max to delete the ActionItem.

This normally happens when the table that owns it is deleted.

GetTable() [5/5]

virtual CoreExport ActionTable * GetTable ( )

virtual

Returns a pointer to the table that owns the ActionItem.

An item can only be owned by a single table.

Default Implementation

{ return mpTable; }

SetTable() [5/5]

virtual CoreExport void SetTable ( ActionTable *  pTable )

virtual

Sets the table that owns the item.

Used internally. May be used if you implement a custom sub-class of ActionItem.

Parameters

pTable

- Points to the table to set.

Default Implementation:

{ mpTable = pTable; }

GetShortcutString() [5/5]

CoreExport const MCHAR * GetShortcutString

(

)

Returns the string that describes all the keyboard shortcuts associated with the item.

This will look something like "Alt+A" or "C, Shift+Alt+Q".

Returns

NULL if no keyboard shortcut is associated with the item.

GetMacroScript() [5/5]

virtual CoreExport MacroEntry * GetMacroScript ( )

virtual

Returns the representation of the macroScript for the item, if it's implemented by a macroScript, it returns NULL otherwise.

Returns

A pointer to a MacroEntry

Default Implementation

{ return NULL; }

IsDynamicMenu() [5/5]

virtual CoreExport BOOL IsDynamicMenu ( )

virtual

Determines if a menu is created or if an action takes place.

Returns

If this method returns TRUE, then the ActionItem creates a menu. If it returns FALSE then an action is performed.

Default Implementation

{ return FALSE; }

SetIsDynamicMenu() [5/5]

virtual CoreExport void SetIsDynamicMenu ( )

virtual

This method may be called after an action item is created to tell the system that it is a dynamic menu action.

Note

Dynamic menus may be added to the quad menus procedurally (via the IMenuManager API) or 'manually'.

GetDynamicMenu() [3/3]

virtual CoreExport IMenu * GetDynamicMenu ( HWND  hwnd, IPoint2 &  m  )

virtual

If the ActionItem does produce a menu, this method is called to return a pointer to the menu.

See class DynamicMenu for an easy way to produce these menus.

Parameters

hwnd	- If the menu is requested by a right-click quad menu, then this hwnd is the handle of the window where the click occurred. If the item is used from a menu bar, this hwnd will be NULL.
m	- If the menu is requested by a right-click quad menu, then this parameter is the point in the window where the user clicked.

Returns

A pointer to the menu.

Default Implementation:

{ return NULL; }

IsDynamicAction() [5/5]

virtual CoreExport BOOL IsDynamicAction ( )

virtual

ActionItems that are deleted after they execute should return TRUE.

HasIcon() [5/5]

CoreExport BOOL HasIcon

(

)

Returns TRUE if the ActionItem specifies an icon.

GetIconFileName() [5/5]

CoreExport bool GetIconFileName

(

MSTR &

fileName

)

If the ActionItem specifies an icon, accesses the icon filename.

Parameters

fileName

- If the ActionItem specifies an icon, then the icon filename is returned through this parameter.

Returns

true if the ActionItem specifies an icon, otherwise false.

GetIconIndex() [5/5]

CoreExport int GetIconIndex

(

)

If the ActionItem specifies an icon, returns the icon index.

Returns

If the ActionItem specifies an icon then the icon index, otherwise -1.

GetTooltipKey() [5/5]

CoreExport MSTR GetTooltipKey

(

)

Get the Action's tooltip key.

The tooltip key may be associated with a product tooltip. By default, the tooltip key is built as "actionTableID-actionID" for native actions and as "Category-MacroName" for macros.

Returns

a string with the tooltip key

SetTooltipKey() [5/5]

CoreExport void SetTooltipKey

(

const MCHAR *

tooltipKey

)

Set the Action's tooltip key.

The function does not verify if the key is unique or not.

tooltipKey - a string with the tooltip key

GetIconPath() [5/5]

CoreExport MaxSDK::Util::Path GetIconPath

(

IconSize

size

)

Get the Action's path to the icon of size specified by param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to get

Returns

The path to the icon of the size specified by the input parameter.

SetIconPath() [5/5]

CoreExport void SetIconPath	(	IconSize	size,
		const MaxSDK::Util::Path &	path
	)

Sets the Action's path to the icon of size specified by the input param.

This path can be relative to the Theme- specific Resources folder under the \UI folder, or it can be an absolute path.

Parameters

size	an enum specifying the icon path to set
path	The path to the icon of the size specified by the input parameter.

GetMetadata() [5/5]

CoreExport MSTR GetMetadata

(

)

Gets the Action's metadata.

Metadata format is a single string with a comma
separating each individual metadatum. Metadata is used in global search command to list similar command names in other software, etc

SetMetadata() [5/5]

CoreExport void SetMetadata

(

const MCHAR *

metadata

)

Sets the Action's metadata.

Parameters

metadata

The metadata

GetDescByID() [5/5]

virtual CoreExport FPInterfaceDesc * GetDescByID ( Interface_ID  id )

virtual

Remarks

This method is used to directly implement FPInterface::GetDesc() in your public virtual base mixin class, like this;

FPInterfaceDesc* GetDesc() { return GetDescByID(THIS_INTERFACE_ID); }

Then implement a GetDescByID() in the implementing class to avoid link export issues.

Parameters:

Interface_ID id

The unique interface ID by which to get the FPInterfaceDesc.

Default Implementation:

{ return &nullInterface; }

Reimplemented from FPMixinInterface.

GetDesc() [5/5]

virtual CoreExport FPInterfaceDesc * GetDesc ( )

virtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

GetInterface() [5/5]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

GetID() [5/5]

virtual CoreExport Interface_ID GetID ( )

virtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

RO_PROP_FN() [35/39]

RO_PROP_FN ( kGetId  , GetId  , TYPE_DWORD    )

protected

RO_PROP_FN() [36/39]

RO_PROP_FN ( kIsVisible  , IsItemVisible  , TYPE_BOOL    )

protected

RO_PROP_FN() [37/39]

RO_PROP_FN ( kIsEnabled  , IsEnabled  , TYPE_BOOL    )

protected

RO_PROP_FN() [38/39]

RO_PROP_FN ( kIsChecked  , IsChecked  , TYPE_BOOL    )

protected

VFN_1() [17/20]

VFN_1 ( kGetDescription  , GetDescriptionText  , TYPE_TSTR_BR    )

protected

VFN_1() [18/20]

VFN_1 ( kGetCategory  , GetCategoryText  , TYPE_TSTR_BR    )

protected

VFN_1() [19/20]

VFN_1 ( kGetButtonText  , GetButtonText  , TYPE_TSTR_BR    )

protected

VFN_1() [20/20]

VFN_1 ( kGetMenuText  , GetMenuText  , TYPE_TSTR_BR    )

protected

FN_0() [9/10]

FN_0 ( kHasIcon  , TYPE_BOOL  , HasIcon    )

protected

FN_1() [5/5]

FN_1 ( kGetIconFileName  , TYPE_bool  , GetIconFileName  , TYPE_TSTR_BR    )

protected

FN_0() [10/10]

FN_0 ( kGetIconIndex  , TYPE_INDEX  , GetIconIndex    )

protected

RO_PROP_FN() [39/39]

RO_PROP_FN ( kGetPersistentActionId  , GetPersistentActionId  , TYPE_TSTR_BV    )

protected

GetIconImp() [5/5]

virtual CoreExport MaxIcon * GetIconImp ( )

protectedvirtual

Returns an icon associated with an ActionItem.

To supply a custom icon for an action item, override this method and supply a custom implementation. Default implementation: returns NULL

Returns

Icon for this action, or NULL if not specified by implementing class.

Member Data Documentation

mpTable

ActionTable * mpTable = nullptr

protected

Points to the table that owns the action.

Note

This does not 'own' the memory for the ActionTable pointer

final

IPoint2 & final { return nullptr