ITVUtility Class Reference

#include <tvutil.h>

Class Description

See also

Class Animatable, Class TrackViewUtility, Class Interval, Class Interface, Class Control.

Description:

This class is an interface that is given to track view utilities that allows them to access the track view they were launched from. All methods of this class are implemented by the system.

Inheritance diagram for ITVUtility:

Public Member Functions
virtual int	GetNumTracks ()=0
virtual Animatable *	GetAnim (int i)=0
virtual Animatable *	GetClient (int i)=0
virtual int	GetSubNum (int i)=0
virtual MSTR	GetTrackName (int i)=0
virtual BOOL	IsSelected (int i)=0
virtual void	SetSelect (int i, BOOL sel)=0
virtual HWND	GetTrackViewHWnd ()=0
virtual int	GetMajorMode ()=0
virtual Interval	GetTimeSelection ()=0
virtual BOOL	SubTreeMode ()=0
virtual Animatable *	GetTVRoot ()=0
virtual void	TVUtilClosing (TrackViewUtility *util)=0
virtual ITreeView *	GetTVInterface ()=0
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Member Function Documentation

virtual int GetNumTracks ( )

pure virtual

Remarks

Returns the total number of visible (open) tracks in Track View. This determines valid values to use for 'i' in the methods below.

virtual Animatable* GetAnim ( int  i )

pure virtual

Remarks

Returns a pointer to the Animatalbe for the 'i-th' track.

Parameters:

int i

Specifies the track.

virtual Animatable* GetClient ( int  i )

pure virtual

Remarks

Returns a pointer to the client of the 'i-th' track. This is the 'parent' or 'owner' of the 'i-th' item.

Parameters:

int i

Specifies the track.

virtual int GetSubNum ( int  i )

pure virtual

Remarks

Returns the sub-anim number of the 'i-th' track.

Parameters:

int i

Specifies the track.

virtual MSTR GetTrackName ( int  i )

pure virtual

Remarks

Returns the name of the 'i-th' track.

Parameters:

int i

The index of the track whose name is returned.

virtual BOOL IsSelected ( int  i )

pure virtual

Remarks

Returns TRUE if the 'i-th' track is selected; otherwise FALSE.

Parameters:

int i

The index of the track to test.

virtual void SetSelect ( int  i, BOOL  sel  )

pure virtual

Remarks

Sets the selected state of the 'i-th' track to the state passed.

Parameters:

int i

The index of the track whose selected state is set.

BOOL sel

Specifies the selected state. TRUE for selected; FALSE for not selected.

virtual HWND GetTrackViewHWnd ( )

pure virtual

Remarks

Returns the windows handle of the main Track View window.

virtual int GetMajorMode ( )

pure virtual

Remarks

Returns a value to indicate the current mode Track View is operating in. This is one of five modes.

Returns

One of the following values:

TVMODE_EDITKEYS

TVMODE_EDITTIME

TVMODE_EDITRANGES

TVMODE_POSRANGES

TVMODE_EDITFCURVE

virtual Interval GetTimeSelection ( )

pure virtual

Remarks

Returns the current interval of selected time.

virtual BOOL SubTreeMode ( )

pure virtual

Remarks

Returns TRUE if 'Modify Subtree' mode is active; otherwise FALSE.

virtual Animatable* GetTVRoot ( )

pure virtual

Remarks

Returns a pointer to the Track View Root.

virtual void TVUtilClosing ( TrackViewUtility *  util )

pure virtual

Remarks

This must be called when a track view utility is closing so that it can be unregistered from notifications

Parameters:

TrackViewUtility *util

Points to the utility that is closing. This is usually called by passing the this pointer as in: TVUtilClosing(this);

virtual ITreeView* GetTVInterface ( )

pure virtual