ITVUtility Class Reference

Search for all occurrences

#include <tvutil.h>

Inheritance diagram for ITVUtility:

---

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.

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

---

Member Function Documentation

virtual int GetNumTracks

(

)

[pure virtual]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

Remarks:

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

Parameters:

int i

Specifies the track.

virtual MSTR GetTrackName

(

int

i

)

[pure virtual]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

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]

Search for all occurrences

Remarks:

Returns the windows handle of the main Track View window.

virtual int GetMajorMode

(

)

[pure virtual]

Search for all occurrences

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]

Search for all occurrences

Remarks:

Returns the current interval of selected time.

virtual BOOL SubTreeMode

(

)

[pure virtual]

Search for all occurrences

Remarks:

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

virtual Animatable* GetTVRoot

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns a pointer to the Track View Root.

virtual void TVUtilClosing

(

TrackViewUtility *

util

)

[pure virtual]

Search for all occurrences

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]

Search for all occurrences