This reference page is linked to from the following overview topics: Using FPInterface::Invoke().
Detailed Description
- See also:
- Class FPStaticInterface, Class
ITreeViewOps,
Class Animatable
- Description:
- This class is available in release 4.0 and later only.
This class represents the interface to the track views array. An ITrackViewArray pointer can be obtained by calling: GetCOREInterface(ITRACKVIEWS).
#include <itreevw.h>
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 } |
Public Member Functions |
|
| virtual int | GetNumAvailableTrackViews () |
| virtual ITreeViewOps * | GetTrackView (int index) |
| virtual ITreeViewOps * | GetTrackView (MSTR name) |
| virtual Tab< ITreeViewOps * > | GetAvaliableTrackViews () |
| virtual ITreeViewOps * | GetLastActiveTrackView () |
| 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 MCHAR * | GetTrackViewName (int index) |
| virtual const MCHAR * | GetLastUsedTrackViewName () |
| 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) |
| DECLARE_DESCRIPTOR (ITrackViewArray) | |
| BEGIN_FUNCTION_MAP | FN_1 (getTrackView, TYPE_INTERFACE, fpGetTrackView, TYPE_FPVALUE) |
| FN_0 (getAvaliableTrackViews, TYPE_INTERFACE_TAB_BV, GetAvaliableTrackViews) | |
| FN_0 (getNumAvailableTrackViews, TYPE_INT, GetNumAvailableTrackViews) | |
| FN_6 (openTrackView, TYPE_BOOL, fpOpenTrackViewWindow, TYPE_FPVALUE, TYPE_TSTR_BV, TYPE_POINT2_BV, TYPE_INT, TYPE_INT, TYPE_ENUM) | |
| 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) | |
Protected Member Functions |
|
| BOOL | fpTrackViewZoomOn (MSTR tvName, ReferenceTarget *anim, int subNum) |
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,
};
Member Function Documentation
| BOOL fpTrackViewZoomOn | ( | MSTR | tvName, |
| ReferenceTarget * | anim, | ||
| int | subNum | ||
| ) | [inline, protected] |
{
// upcast
return TrackViewZoomOn(tvName, (Animatable*) anim, subNum);
}
| 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.
| DECLARE_DESCRIPTOR | ( | ITrackViewArray | ) |
| BEGIN_FUNCTION_MAP FN_1 | ( | getTrackView | , |
| TYPE_INTERFACE | , | ||
| fpGetTrackView | , | ||
| TYPE_FPVALUE | |||
| ) |
| FN_0 | ( | getAvaliableTrackViews | , |
| TYPE_INTERFACE_TAB_BV | , | ||
| GetAvaliableTrackViews | |||
| ) |
| FN_0 | ( | getNumAvailableTrackViews | , |
| TYPE_INT | , | ||
| GetNumAvailableTrackViews | |||
| ) |
| FN_6 | ( | openTrackView | , |
| TYPE_BOOL | , | ||
| fpOpenTrackViewWindow | , | ||
| TYPE_FPVALUE | , | ||
| TYPE_TSTR_BV | , | ||
| TYPE_POINT2_BV | , | ||
| TYPE_INT | , | ||
| TYPE_INT | , | ||
| TYPE_ENUM | |||
| ) |
| 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 | |||
| ) |
