ITrackViewArray Class Reference

#include <itreevw.h>

Class Description

See also
Class FPStaticInterface, Class ITreeViewOps, Class Animatable

Description:
This class represents the interface to the track views array. An ITrackViewArray pointer can be obtained by calling: GetCOREInterface(ITRACKVIEWS).
+ Inheritance diagram for ITrackViewArray:

Public Types

enum  {
  getTrackView, getAvaliableTrackViews, getNumAvailableTrackViews, openTrackView,
  closeTrackView, getTrackViewName, trackViewZoomSelected, trackViewZoomOn,
  setFilter, clearFilter, pickTrackDlg, isOpen,
  openLastTrackView, currentTrackViewProp, lastUsedTrackViewNameProp, deleteTrackView,
  isTrackViewCurrent, setTrackViewCurrent, doesTrackViewExist, dockTypeEnum,
  getDefaultCurveEditorLayout, setDefaultCurveEditorLayout
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

Public Member Functions

virtual int GetNumAvailableTrackViews ()
 
virtual ITreeViewOpsGetTrackView (int index)
 
virtual ITreeViewOpsGetTrackView (MSTR name)
 
virtual Tab< ITreeViewOps * > GetAvaliableTrackViews ()
 
virtual ITreeViewOpsGetLastActiveTrackView ()
 
virtual BOOL IsTrackViewOpen (MSTR name)
 
virtual BOOL IsTrackViewOpen (int index)
 
virtual BOOL OpenTrackViewWindow (MSTR name, MSTR layoutName=_M(""), Point2 pos=Point2(-1.0f,-1.0f), int width=-1, int height=-1, int dock=TV_FLOAT)
 
virtual BOOL OpenTrackViewWindow (int index)
 
virtual BOOL OpenLastActiveTrackViewWindow ()
 
virtual BOOL CloseTrackView (MSTR name)
 
virtual BOOL CloseTrackView (int index)
 
virtual BOOL DeleteTrackView (MSTR name)
 
virtual BOOL DeleteTrackView (int index)
 
virtual const MCHARGetTrackViewName (int index)
 
virtual const MCHARGetLastUsedTrackViewName ()
 
virtual BOOL IsTrackViewCurrent (int index)
 
virtual BOOL IsTrackViewCurrent (MSTR name)
 
virtual BOOL SetTrackViewCurrent (int index)
 
virtual BOOL SetTrackViewCurrent (MSTR name)
 
virtual BOOL TrackViewZoomSelected (MSTR tvName)
 
virtual BOOL TrackViewZoomOn (MSTR tvName, Animatable *anim, int subNum)
 
virtual void SetDefaultCurveEditorLayout (const MCHAR *layoutName)
 
virtual const MCHARGetDefaultCurveEditorLayout ()
 
 DECLARE_DESCRIPTOR (ITrackViewArray)
 
 FN_1 (getTrackView, TYPE_INTERFACE, fpGetTrackView, TYPE_FPVALUE)
 
 FN_0 (getAvaliableTrackViews, TYPE_INTERFACE_TAB_BV, GetAvaliableTrackViews)
 
 FN_0 (getNumAvailableTrackViews, TYPE_INT, GetNumAvailableTrackViews)
 
 FN_7 (openTrackView, TYPE_BOOL, fpOpenTrackViewWindow, TYPE_FPVALUE, TYPE_TSTR_BV, TYPE_POINT2_BV, TYPE_INT, TYPE_INT, TYPE_ENUM, TYPE_bool)
 
 FN_1 (closeTrackView, TYPE_BOOL, fpCloseTrackView, TYPE_FPVALUE)
 
 VFN_1 (deleteTrackView, fpDeleteTrackView, TYPE_FPVALUE)
 
 FN_1 (getTrackViewName, TYPE_STRING, GetTrackViewName, TYPE_INDEX)
 
 FN_1 (trackViewZoomSelected, TYPE_BOOL, TrackViewZoomSelected, TYPE_TSTR)
 
 FN_3 (trackViewZoomOn, TYPE_BOOL, fpTrackViewZoomOn, TYPE_TSTR, TYPE_REFTARG, TYPE_INDEX)
 
 FN_VA (setFilter, TYPE_BOOL, fpSetTrackViewFilter)
 
 FN_VA (clearFilter, TYPE_BOOL, fpClearTrackViewFilter)
 
 FN_VA (pickTrackDlg, TYPE_FPVALUE_BV, fpDoPickTrackDlg)
 
 FN_1 (isOpen, TYPE_BOOL, fpIsTrackViewOpen, TYPE_FPVALUE)
 
 FN_0 (openLastTrackView, TYPE_BOOL, OpenLastActiveTrackViewWindow)
 
 RO_PROP_FN (currentTrackViewProp, GetLastActiveTrackView, TYPE_INTERFACE)
 
 RO_PROP_FN (lastUsedTrackViewNameProp, GetLastUsedTrackViewName, TYPE_STRING)
 
 FN_1 (isTrackViewCurrent, TYPE_BOOL, fpIsTrackViewCurrent, TYPE_FPVALUE)
 
 FN_1 (setTrackViewCurrent, TYPE_BOOL, fpSetTrackViewCurrent, TYPE_FPVALUE)
 
 FN_1 (doesTrackViewExist, TYPE_BOOL, fpDoesTrackViewExist, TYPE_FPVALUE)
 
 PROP_FNS (getDefaultCurveEditorLayout, GetDefaultCurveEditorLayout, setDefaultCurveEditorLayout, SetDefaultCurveEditorLayout, TYPE_STRING)
 
- Public Member Functions inherited from FPInterfaceDesc
CoreExport FPInterfaceDesc ()
 
CoreExport FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
 
CoreExport ~FPInterfaceDesc ()
 
virtual void Init ()
 
LifetimeType LifetimeControl ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
CoreExport void LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
 
CoreExport void AppendFunction (int id,...)
 Add a new function to this interface descriptor. More...
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor. More...
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor. More...
 
CoreExport void SetClassDesc (ClassDesc *i_cd)
 
CoreExport va_list check_fn (va_list ap, int id)
 
CoreExport va_list scan_fn (va_list ap, int id, int index)
 
CoreExport va_list check_prop (va_list ap, int id)
 
CoreExport va_list scan_prop (va_list ap, int id, int index)
 
CoreExport va_list check_enum (va_list ap, EnumID id)
 
CoreExport va_list scan_enum (va_list ap, EnumID id, int index)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
CoreExport FPFunctionDefGetFnDef (FunctionID fid)
 
ActionTableGetActionTable ()
 
CoreExport void EnableActions (BOOL onOff)
 
virtual CoreExport HINSTANCE HInstance ()
 
virtual CoreExport const MCHARGetRsrcString (StringResID id)
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

Protected Member Functions

BOOL fpTrackViewZoomOn (MSTR tvName, ReferenceTarget *anim, int subNum)
 
- Protected Member Functions inherited from FPInterfaceDesc
CoreExport void load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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...
 
- Public Attributes inherited from FPInterfaceDesc
Interface_ID ID
 
MSTR internal_name
 
StringResID description
 
ClassDesccd
 
USHORT flags
 
Tab< FPFunctionDef * > functions
 
Tab< FPPropDef * > props
 
Tab< FPEnum * > enumerations
 
MSPluginClass * pc
 
Rolloutrollout
 
ActionTableaction_table
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 

Member Enumeration Documentation

anonymous enum
Enumerator
getTrackView 
getAvaliableTrackViews 
getNumAvailableTrackViews 
openTrackView 
closeTrackView 
getTrackViewName 
trackViewZoomSelected 
trackViewZoomOn 
setFilter 
clearFilter 
pickTrackDlg 
isOpen 
openLastTrackView 
currentTrackViewProp 
lastUsedTrackViewNameProp 
deleteTrackView 
isTrackViewCurrent 
setTrackViewCurrent 
doesTrackViewExist 
dockTypeEnum 
getDefaultCurveEditorLayout 
setDefaultCurveEditorLayout 
1039 
1040  dockTypeEnum,
1042  };
Definition: itreevw.h:1035
Definition: itreevw.h:1035
Definition: itreevw.h:1035
Definition: itreevw.h:1035
Definition: itreevw.h:1034
Definition: itreevw.h:1036
Definition: itreevw.h:1036
Definition: itreevw.h:1040
Definition: itreevw.h:1035
Definition: itreevw.h:1038
Definition: itreevw.h:1037
Definition: itreevw.h:1037
Definition: itreevw.h:1036
Definition: itreevw.h:1036
Definition: itreevw.h:1036
Definition: itreevw.h:1037
Definition: itreevw.h:1036
Definition: itreevw.h:1034

Member Function Documentation

BOOL fpTrackViewZoomOn ( MSTR  tvName,
ReferenceTarget anim,
int  subNum 
)
inlineprotected
879  {
880  // upcast
881  return TrackViewZoomOn(tvName, (Animatable*) anim, subNum);
882  }
virtual BOOL TrackViewZoomOn(MSTR tvName, Animatable *anim, int subNum)
Definition: Animatable.h:121
virtual int GetNumAvailableTrackViews ( )
virtual
Remarks
This method returns the number of currently available TrackViews.
virtual ITreeViewOps* GetTrackView ( int  index)
virtual
Remarks
This method returns a pointer to the ITreeViewOps of a specific TrackView.
Parameters:
int index

The index of the TrackView you wish to obtain.
virtual ITreeViewOps* GetTrackView ( MSTR  name)
virtual
Remarks
This method returns a pointer to the ITreeViewOps of a specific TrackView.
Parameters:
MSTR name

The name of the TrackView you wish to obtain.
virtual Tab<ITreeViewOps*> GetAvaliableTrackViews ( )
virtual
Remarks
This method returns a table of ITreeViewOps pointers representing the list of TrackViews that are currently available.
virtual ITreeViewOps* GetLastActiveTrackView ( )
virtual
Remarks
This method returns an interface to the last trackview used by the user.
virtual BOOL IsTrackViewOpen ( MSTR  name)
virtual
Remarks
This method returns TRUE if the specified trackview is open, otherwise FALSE.
Parameters:
MSTR name

The name of the trackview.
virtual BOOL IsTrackViewOpen ( int  index)
virtual
Remarks
This method returns TRUE if the specified trackview is open, otherwise FALSE.
Parameters:
int index

The index of the trackview.
virtual BOOL OpenTrackViewWindow ( MSTR  name,
MSTR  layoutName = _M(""),
Point2  pos = Point2(-1.0f,-1.0f),
int  width = -1,
int  height = -1,
int  dock = TV_FLOAT 
)
virtual
Remarks
This method will open a specific TrackView window.
Parameters:
MSTR name

The name of the TrackView window you wish to open.
Returns
TRUE if the window was opened, otherwise FALSE.
virtual BOOL OpenTrackViewWindow ( int  index)
virtual
Remarks
This method will open a trackview by its specified index.
Parameters:
int index

The index of the trackview.
Returns
TRUE if the trackview could be opened, otherwise FALSE.
virtual BOOL OpenLastActiveTrackViewWindow ( )
virtual
Remarks
This method will open the last edited trackview if it was closed by the user.
Returns
TRUE if the last active trackview could be opened, otherwise FALSE.
virtual BOOL CloseTrackView ( MSTR  name)
virtual
Remarks
This method will close a specific TrackView window.
Parameters:
MSTR name

The name of the TrackView window you wish to close.
Returns
TRUE if the window was closed, otherwise FALSE.
virtual BOOL CloseTrackView ( int  index)
virtual
Remarks
This method will close a specific TrackView window.
Parameters:
int index

The index of the trackview you wish to close.
Returns
TRUE if the window was closed, otherwise FALSE.
virtual BOOL DeleteTrackView ( MSTR  name)
virtual
Remarks
This method deletes the specified trackview from the list of saved trackviews.
Parameters:
MSTR name

The name of the trackview you wish to delete.
Returns
TRUE if the specified track view was deleted, FALSE otherwise. Open or non-existent track views cannot be deleted.
virtual BOOL DeleteTrackView ( int  index)
virtual
Remarks
This method deletes the specified trackview from the list of saved trackviews.
Parameters:
int index

The index of the trackview you wish to delete.
Returns
TRUE if the specified track view was deleted, FALSE otherwise. Open or non-existent track views cannot be deleted.
virtual const MCHAR* GetTrackViewName ( int  index)
virtual
Remarks
This method will return the name of a TrackView, specified by it's index.
Parameters:
int index

The index of the TrackView for which you wish to obtain the name.
virtual const MCHAR* GetLastUsedTrackViewName ( )
virtual
Remarks
This method will get the name of the last used trackview.
virtual BOOL IsTrackViewCurrent ( int  index)
virtual
Remarks
This method returns TRUE if the specified trackview is the current trackview, otherwise FALSE.
Parameters:
int index

The index of the trackview.
virtual BOOL IsTrackViewCurrent ( MSTR  name)
virtual
Remarks
This method returns TRUE if the specified trackview is the current trackview, otherwise FALSE.
Parameters:
MSTR name

The name of the trackview.
virtual BOOL SetTrackViewCurrent ( int  index)
virtual
Remarks
This method allows you to set the specified trackview to be the current trackview
Parameters:
int index

The index of the trackview.
virtual BOOL SetTrackViewCurrent ( MSTR  name)
virtual
Remarks
This method allows you to set the specified trackview to be the current trackview
Parameters:
MSTR name

The name of the trackview.
virtual BOOL TrackViewZoomSelected ( MSTR  tvName)
virtual
Remarks
This method will zoom on the selected entries in a specific TrackView
Parameters:
MSTR tvName

The name of the TrackView window you wish to have execute the zoom selected function.
Returns
TRUE if zooming was successful, FALSE if it failed.
virtual BOOL TrackViewZoomOn ( MSTR  tvName,
Animatable anim,
int  subNum 
)
virtual
Remarks
This method will zoom on a specific TrackView entry.
Parameters:
MSTR tvName

The name of the TrackView you wish to execute the zoom function for.

Animatable* anim

A pointer to the Animatable object you wish to zoom on.

int subNum

The sub-anim index.
Returns
TRUE if zooming was successful, FALSE if it failed.
virtual void SetDefaultCurveEditorLayout ( const MCHAR layoutName)
virtual
Remarks
This method sets a track view layout as the default, the one that will be used by the LaunchFCurveEditor command !
Parameters
[in]layoutNamethe name of the layout to be used as default !
virtual const MCHAR* GetDefaultCurveEditorLayout ( )
virtual
Remarks
This method returns the name of the default curve editor layout.
DECLARE_DESCRIPTOR ( ITrackViewArray  )
FN_1 ( getTrackView  ,
TYPE_INTERFACE  ,
fpGetTrackView  ,
TYPE_FPVALUE   
)
FN_7 ( openTrackView  ,
TYPE_BOOL  ,
fpOpenTrackViewWindow  ,
TYPE_FPVALUE  ,
TYPE_TSTR_BV  ,
TYPE_POINT2_BV  ,
TYPE_INT  ,
TYPE_INT  ,
TYPE_ENUM  ,
TYPE_bool   
)
FN_1 ( closeTrackView  ,
TYPE_BOOL  ,
fpCloseTrackView  ,
TYPE_FPVALUE   
)
VFN_1 ( deleteTrackView  ,
fpDeleteTrackView  ,
TYPE_FPVALUE   
)
FN_VA ( setFilter  ,
TYPE_BOOL  ,
fpSetTrackViewFilter   
)
FN_VA ( clearFilter  ,
TYPE_BOOL  ,
fpClearTrackViewFilter   
)
FN_VA ( pickTrackDlg  ,
TYPE_FPVALUE_BV  ,
fpDoPickTrackDlg   
)
FN_1 ( isOpen  ,
TYPE_BOOL  ,
fpIsTrackViewOpen  ,
TYPE_FPVALUE   
)
FN_1 ( isTrackViewCurrent  ,
TYPE_BOOL  ,
fpIsTrackViewCurrent  ,
TYPE_FPVALUE   
)
FN_1 ( setTrackViewCurrent  ,
TYPE_BOOL  ,
fpSetTrackViewCurrent  ,
TYPE_FPVALUE   
)
FN_1 ( doesTrackViewExist  ,
TYPE_BOOL  ,
fpDoesTrackViewExist  ,
TYPE_FPVALUE   
)