HitByNameDlgCallback Class Reference

#include <maxapi.h>

Inheritance diagram for HitByNameDlgCallback:

Public Member Functions
virtual	~HitByNameDlgCallback ()
virtual const MCHAR *	dialogTitle ()
virtual const MCHAR *	buttonText ()
virtual BOOL	singleSelect ()
virtual BOOL	useFilter ()
virtual int	filter (INode *node)
virtual BOOL	useProc ()
virtual void	proc (INodeTab &nodeTab)
virtual BOOL	doCustomHilite ()
virtual BOOL	doHilite (INode *node)
virtual BOOL	showHiddenAndFrozen ()

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

See also

Class Interface.

Description:

This is the callback object used with Interface::DoHitByNameDialog().

Constructor & Destructor Documentation

~HitByNameDlgCallback()

virtual ~HitByNameDlgCallback ( )

inlinevirtual

Remarks

Destructor.

{}

Member Function Documentation

dialogTitle()

virtual const MCHAR * dialogTitle ( )

inlinevirtual

Remarks

Returns the title string displayed in the dialog.

Default Implementation:

{ return _M(""); }

{ return _M(""); }

buttonText()

virtual const MCHAR * buttonText ( )

inlinevirtual

Remarks

Returns the text displayed in the 'Select' or 'Pick' button.

Default Implementation:

{ return _M(""); }

{ return _M(""); }

singleSelect()

virtual BOOL singleSelect ( )

inlinevirtual

Remarks

Returns TRUE if the user may only make a single selection in the list at one time; otherwise FALSE.

Default Implementation:

{ return FALSE; }

{ return FALSE; }

useFilter()

virtual BOOL useFilter ( )

inlinevirtual

Remarks

This gives the callback the opportunity to filter out items from the list. This is called before the dialog is presented. It returns TRUE if the filter() method (below) should be called; otherwise FALSE.

Default Implementation:

{ return TRUE; }

{ return TRUE; }

filter()

virtual int filter ( INode *  node )

inlinevirtual

Remarks

This method will be called if useFilter() above returned TRUE. This gives the callback the chance to filter out items from the list before they are presented to the user in the dialog. This is called once for each node that would otherwise be presented. Return nonzero to accept the item and zero to skip it.

Parameters:

INode *node

The node to check for inclusion in the list.

Returns

Nonzero to accept the item and zero to skip it.

Default Implementation:

{ return TRUE; }

{ return TRUE; }

useProc()

virtual BOOL useProc ( )

inlinevirtual

Remarks

Normally, when the user selects OK from the dialog, the system selects all the chosen nodes in the scene. At times a developer may want to do something other than select the chosen nodes. If this method returns TRUE then the nodes in the list will not be selected, but the proc() method is called instead (see below). If this method returns FALSE, then the nodes are selected in the scene and proc() is not called.

Default Implementation:

{ return TRUE; }

{ return TRUE; }

proc()

virtual void proc ( INodeTab &  nodeTab )

inlinevirtual

Remarks

This allows the plug-in to process the nodes chosen from the dialog in any manner. For example if the developer wanted to delete the nodes chosen using this dialog, they would implement useProc() to return TRUE and this method to delete all the nodes in the table passed.

Parameters:

INodeTab &nodeTab

A table of those nodes selected by the user. See Template Class Tab.

Default Implementation:

{}

{}

doCustomHilite()

virtual BOOL doCustomHilite ( )

inlinevirtual

Remarks

Normally, when the dialog is entered, the nodes in the scene that are selected are highlighted in the list. If this method returns TRUE, the developer may control which items are highlighted by implementing doHilite() (see below). If this method returns FALSE the selected nodes will have their names highlighted in the list.

Default Implementation:

{ return FALSE; }

{ return FALSE; }

doHilite()

virtual BOOL doHilite ( INode *  node )

inlinevirtual

Remarks

This method is called for each item in the list if doCustomHilite() returns TRUE. This method returns TRUE or FALSE to control if each item is highlighted.

Parameters:

INode *node

The node to check.

Returns

TRUE to highlight the node in the list; FALSE to not highlight it.

Default Implementation:

{ return FALSE; }

{ return FALSE; }

showHiddenAndFrozen()

virtual BOOL showHiddenAndFrozen ( )

inlinevirtual

Remarks

This defaults to returning FALSE, which means that hidden and frozen objects will not be included in the select by name dialog list. If this method is overridden to return TRUE, then hidden and frozen nodes will be sent through the user-supplied filter as in version 1.x. (Note that, apart from Unhide by Name and Unfreeze by Name, the new default behavior is likely to be correct for all uses of this class.)

Default Implementation:

{ return FALSE; }

{ return FALSE; }