TrackViewUtility Class Reference

#include <tvutil.h>

Inheritance diagram for TrackViewUtility:

Public Member Functions
virtual void	DeleteThis ()=0
virtual void	BeginEditParams (Interface *ip, ITVUtility *iu)
virtual void	EndEditParams (Interface *ip, ITVUtility *iu)
virtual void	TrackSelectionChanged ()
virtual void	NodeSelectionChanged ()
virtual void	KeySelectionChanged ()
virtual void	TimeSelectionChanged ()
virtual void	MajorModeChanged ()
virtual void	TrackListChanged ()
virtual int	FilterAnim (Animatable *anim, Animatable *client, int subNum)
virtual void	GetClassName (MSTR &s) const
virtual Class_ID	ClassID ()
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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 ITVUtility, Class Interface, Class Control.

Description:

This is the base class for Track View Utility plug-ins. These plug-ins are launched via the 'Track View Utility' icon just to the left of the track view name field in the toolbar. Clicking on this button brings up a dialog of all the track view utilities currently installed in the system. Most utilities will probably be modeless floating dialogs, however modal utilities may be created as well.

The developer will derive their classes from this class. Methods are provided to bracket the beginning and ending of parameter editing, and responding to various changes in Track View (such as key selection, time selection, node selection, etc.). There is also a method to delete this instance of the plug-in class. Sample code is available in /MAXSDK/SAMPLES/UTILITIES/RANDKEYS.CPP, ORTKEYS.CPP and SELKEYS.CPP.

Plug-In Information:

Class Defined In: TVUTIL.H
Super Class ID: TRACKVIEW_UTILITY_CLASS_ID
Standard File Name Extension: DLU
Extra Include File Needed: None

Member Function Documentation

DeleteThis()

virtual void DeleteThis ( )

pure virtual

Remarks

This method is called to delete this instance of the plug-in class. This method should free the memory allocated in ClassDesc::Create(). See the Advanced Topics section on Memory Management for more details.

Implemented in MSPluginTrackViewUtility.

BeginEditParams()

virtual void BeginEditParams ( Interface *  ip, ITVUtility *  iu  )

inlinevirtual

Remarks

This method is called to begin editing of the Track View utility plug-in's parameters.

Parameters:

Interface *ip

An interface for calling functions provided by 3ds Max.

ITVUtility *iu

An interface for allowing track view utilities to access the Track View they are launched from.

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

EndEditParams()

virtual void EndEditParams ( Interface *  ip, ITVUtility *  iu  )

inlinevirtual

Remarks

This method is called when the user has closed the Track View utility or Track View itself.

Parameters:

Interface *ip

An interface for calling functions provided by 3ds Max.

ITVUtility *iu

An interface for allowing track view utilities to access the Track View they are launched from.

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

TrackSelectionChanged()

virtual void TrackSelectionChanged ( )

inlinevirtual

Remarks

This method is called when the selection of tracks has changed.

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

NodeSelectionChanged()

virtual void NodeSelectionChanged ( )

inlinevirtual

Remarks

This method is called when the selection of nodes has changed.

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

KeySelectionChanged()

virtual void KeySelectionChanged ( )

inlinevirtual

Remarks

This method is called when the selection of keys has changed.

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

TimeSelectionChanged()

virtual void TimeSelectionChanged ( )

inlinevirtual

Remarks

This method is called when the amount of time selected changes in Edit Time mode. See ITVUtility::GetTimeSelection().

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

MajorModeChanged()

virtual void MajorModeChanged ( )

inlinevirtual

Remarks

This method is called if the current mode of Track View changes. These are the modes such as Edit Keys, Edit Time, Edit Ranges, Position Ranges, and Edit Function Curves. See ITVUtility::GetMajorMode().

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

TrackListChanged()

virtual void TrackListChanged ( )

inlinevirtual

Remarks

This method is called when the Track View list is rebuild. This is the list of items that are visible (currently open).

Default Implementation:

{}

Reimplemented in MSPluginTrackViewUtility.

{}

FilterAnim()

virtual int FilterAnim ( Animatable *  anim, Animatable *  client, int  subNum  )

inlinevirtual

Reimplemented in MSPluginTrackViewUtility.

{return FILTER_NONE;}

GetClassName()

virtual void GetClassName ( MSTR &  s ) const

inlinevirtual

{ s = MSTR(_M("")); }

ClassID()

virtual Class_ID ClassID ( )

inlinevirtual

Reimplemented in MSPluginTrackViewUtility.

{ return Class_ID(0,0); }