CommandMode Class Reference

This base class allows the developer to create a command mode that handles processing user interaction using the mouse in the viewports. More...

#include <cmdmode.h>

Inheritance diagram for CommandMode:

Public Member Functions
virtual	~CommandMode ()
	Destructor.
virtual int	Class ()=0
	Returns the Class of the command mode.
virtual int	SuperClass ()
	This method can be ignored.
virtual int	ID ()=0
	Returns the ID of the command mode.
virtual MouseCallBack *	MouseProc (int *numPoints)=0
	This method establishes the number of points required by the command mode and returns a pointer to the mouse callback object that is used to process the user input.
virtual ChangeForegroundCallback *	ChangeFGProc ()=0
	Returns a pointer to a callback procedure that flags nodes that belong in the foreground plane.
virtual BOOL	ChangeFG (CommandMode *oldMode)=0
	This method returns TRUE if the command mode needs to change the foreground proc (using ChangeFGProc()) and FALSE if it does not.
virtual void	EnterMode ()=0
	This method is called when a command mode becomes active.
virtual void	ExitMode ()=0
	This method is called when the active command mode is replaced by a different mode.

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.

Detailed Description

This base class allows the developer to create a command mode that handles processing user interaction using the mouse in the viewports.

See the page on "Command Modes and Mouse Procs" and "Foreground / Background Planes". There are methods in 3ds Max's Interface class to set and get the current command mode.

See also

Class MouseCallBack, Class ChangeForegroundCallback, page "

Constructor & Destructor Documentation

~CommandMode()

virtual ~CommandMode ( )

inlinevirtual

Destructor.

{} 

Member Function Documentation

Class()

virtual int Class ( )

pure virtual

Returns the Class of the command mode.

The class describes the type of command mode this is. If the developer is defining a command mode to be used as part of the sub-object manipulation (Move, Rotate, and Scale) then one of the following pre-defined values in Command Classes should be used.

Returns

The Class of the command mode.

Implemented in PickCommandMode, EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

SuperClass()

virtual int SuperClass ( )

inlinevirtual

This method can be ignored.

The default implementation should be used.

{ return 0; }

ID()

virtual int ID ( )

pure virtual

Returns the ID of the command mode.

This value should be the constant CID_USER plus some random value chosen by the developer. As an example, this method could be implemented as: { CID_USER+0x1423; } In the special case of the developer implementing a custom command mode to be used as part of sub-object manipulation (Move, Rotate or Scale) the value for ID() should be one of the following values:

• CID_SUBOBJMOVE
• CID_SUBOBJROTATE
• CID_SUBOBJSCALE
• CID_SUBOBJUSCALE
• CID_SUBOBJSQUASH Note: It is not a problem if two command modes conflict in this ID value, so the uniqueness is not strictly required. However, this ID() method is often used to check which mode is active. Therefore,
  unless the value for your command mode is identifiable via this ID, you may not be able to recognize if your mode is indeed the active one.

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

MouseProc()

virtual MouseCallBack * MouseProc ( int *  numPoints )

pure virtual

This method establishes the number of points required by the command mode and returns a pointer to the mouse callback object that is used to process the user input.

Parameters

numPoints

This is where to store the number of points used by the CommandMode. If the plug-in needs to use an undetermined number of points it can specify a large number for this value. When the mouse proc has finished processing points it returns FALSE to stop the point processing before the number of points specified here have been entered.

Returns

A pointer to the mouse callback object that is used to process the user input.

See also

Class MouseCallBack.

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

ChangeFGProc()

virtual ChangeForegroundCallback * ChangeFGProc ( )

pure virtual

Returns a pointer to a callback procedure that flags nodes that belong in the foreground plane.

Plug-ins typically use a standard callback object provided by the system that flags all nodes dependent on the plug-in object. This ensures that when the plug-in object changes, any nodes that change as a result will be in the foreground plane, making redraw time faster. These constants may be specified to use one of the standard callback objects instead of an actual FG proc. For example {return CHANGE_FG_SELECTED;} CHANGE_FG_SELECTED Selected nodes are flagged. CHANGE_FG_ANIMATED Nodes that are animated are flagged.

Returns

A pointer to a callback procedure that flags nodes that belong in the foreground plane.

See also

For additional information see the Advanced Topics section "Foreground / Background Planes".

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

ChangeFG()

virtual BOOL ChangeFG ( CommandMode *  oldMode )

pure virtual

This method returns TRUE if the command mode needs to change the foreground proc (using ChangeFGProc()) and FALSE if it does not.

A command mode that does not involve any redrawing of the viewports can just return FALSE.

Parameters

oldMode

This is the command mode that is currently in place. This may be used for comparison with a potential new mode. See the sample code below.

Sample Code:

The sample code below checks to see if the command mode is already CHANGE_FG_SELECTED. If it is there is no reason to change to foreground proc to this mode so the method returns FALSE. If a different mode is in place TRUE is returned.

BOL ChangeFG( CommandMode *oldMode ) { return (oldMode->ChangeFGProc() != CHANGE_FG_SELECTED); }
ChangeForegroundCallback *ChangeFGProc() { return CHANGE_FG_SELECTED; }

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

EnterMode()

virtual void EnterMode ( )

pure virtual

This method is called when a command mode becomes active.

Usually a developer responds by changing the state of a control to indicate to the user that they have entered the mode. Typically this means pushing in a tool button. When the mode is finished the button should be returned to normal (see ExitMode() below).

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.

ExitMode()

virtual void ExitMode ( )

pure virtual

This method is called when the active command mode is replaced by a different mode.

Typically a developer implements this method to set the state of the control that invoked the command mode to the 'out' state. See Class ICustButton (specifically the method SetCheck().

Sample Code:

iPick->SetCheck(FALSE);

Implemented in EditSSMode, MoveModBoxCMode, RotateModBoxCMode, UScaleModBoxCMode, NUScaleModBoxCMode, SquashModBoxCMode, SelectModBoxCMode, MoveCtrlApparatusCMode, RotateCtrlApparatusCMode, UScaleCtrlApparatusCMode, NUScaleCtrlApparatusCMode, SquashCtrlApparatusCMode, SelectCtrlApparatusCMode, EP_BindCMode, EP_ExtrudeCMode, EP_NormalFlipCMode, EP_BevelCMode, EP_CreateVertCMode, EP_CreatePatchCMode, EP_VertWeldCMode, EP_CopyTangentCMode, EP_PasteTangentCMode, SSOutlineCMode, SSFilletCMode, SSChamferCMode, SSSegBreakCMode, SSSegRefineCMode, SSCrossInsertCMode, SSVertConnectCMode, SSVertInsertCMode, SSCreateLineCMode, SSCrossSectionCMode, SSBooleanCMode, SSTrimCMode, SSExtendCMode, SSBindCMode, SSRefineConnectCMode, SSCopyTangentCMode, SSPasteTangentCMode, and MouseToolCommandMode.