Detailed Description
- See also:
- Class IKeyControl, Class Interface.
- Description:
- The track bar offers a quick way to manipulate keyframes for
selected objects. Keys are displayed on the track bar just like
they are in Track View. Developers are able to manipulate the track
bar using this class. There is a method of class Interface which returns a
pointer to an instance of this class:
ITrackBar* GetTrackBar().
All methods of this class are Implemented by the System.
#include <maxapi.h>
Inheritance diagram for ITrackBar:
Public Types |
|
| enum | { fIdgetVisible, fIdsetVisible, fIdgetFilter, fIdsetFilter, fIdgetNextKeyTime, fIdgetPreviousKeyTime, fIdredrawTrackBar, fIdgetShowFrames, fIdsetShowFrames, fIdgetShowAudio, fIdsetShowAudio, fIdgetShowSelectionRange, fIdsetShowSelectionRange, fIdgetSnapToFrames, fIdsetSnapToFrames, fIdgetKeyTransparency, fIdsetKeyTransparency, fIdgetSelKeyTransparency, fIdsetSelKeyTransparency, fIdgetCursorTransparency, fIdsetCursorTransparency, fIdregisterFilter, fIdUnRegisterFilter, fIdFilterCount, fIdFilterID, fIdFilterName, fIdIsFilterActive, fIdSetFilterActive } |
| enum | { enumIDfilterType } |
Public Member Functions |
|
| virtual void | SetVisible (BOOL bVisible)=0 |
| virtual BOOL | IsVisible ()=0 |
| virtual void | SetFilter (UINT nFilter)=0 |
| virtual UINT | GetFilter ()=0 |
| virtual TimeValue | GetNextKey (TimeValue tStart, BOOL bForward)=0 |
| virtual void | RedrawTrackBar (bool bForce=false)=0 |
| virtual void | SetShowFrames (bool b)=0 |
| virtual bool | GetShowFrames ()=0 |
| virtual void | SetShowAudio (bool b)=0 |
| virtual bool | GetShowAudio ()=0 |
| virtual void | SetShowSelectionRange (bool b)=0 |
| virtual bool | GetShowSelectionRange ()=0 |
| virtual void | SetSnapToFrames (bool b)=0 |
| virtual bool | GetSnapToFrames ()=0 |
| virtual void | SetKeyTransparency (int xp)=0 |
| virtual int | GetKeyTransparency ()=0 |
| virtual void | SetSelKeyTransparency (int xp)=0 |
| virtual int | GetSelKeyTransparency ()=0 |
| virtual void | SetCursorTransparency (int xp)=0 |
| virtual int | GetCursorTransparency ()=0 |
| BaseInterface * | GetInterface (Interface_ID id) |
| FPInterfaceDesc * | GetDesc () |
| BEGIN_FUNCTION_MAP | VFN_1 (fIdredrawTrackBar, RedrawTrackBar, TYPE_bool) |
| FNT_0 (fIdgetNextKeyTime, TYPE_TIMEVALUE, fpGetNextKey) | |
| FNT_0 (fIdgetPreviousKeyTime, TYPE_TIMEVALUE, fpGetPreviousKey) | |
| FN_6 (fIdregisterFilter, TYPE_INDEX, fpRegisterFilter, TYPE_VALUE, TYPE_VALUE, TYPE_TSTR, TYPE_INT, TYPE_bool, TYPE_bool) | |
| VFN_1 (fIdUnRegisterFilter, fpUnRegisterFilter, TYPE_INDEX) | |
| FN_0 (fIdFilterCount, TYPE_INT, fpFilterCount) | |
| FN_1 (fIdFilterID, TYPE_INT_TAB_BV, fpGetFilterID, TYPE_INDEX) | |
| FN_1 (fIdFilterName, TYPE_TSTR_BV, fpGetFilterName, TYPE_INDEX) | |
| FN_1 (fIdIsFilterActive, TYPE_bool, fpIsFilterActive, TYPE_INDEX) | |
| VFN_2 (fIdSetFilterActive, fpSetFilterActive, TYPE_INDEX, TYPE_bool) | |
| PROP_FNS (fIdgetVisible, IsVisible, fIdsetVisible, SetVisible, TYPE_BOOL) | |
| PROP_FNS (fIdgetFilter, GetFilter, fIdsetFilter, SetFilter, TYPE_ENUM) | |
| PROP_FNS (fIdgetShowFrames, GetShowFrames, fIdsetShowFrames, SetShowFrames, TYPE_bool) | |
| PROP_FNS (fIdgetShowAudio, GetShowAudio, fIdsetShowAudio, SetShowAudio, TYPE_bool) | |
| PROP_FNS (fIdgetShowSelectionRange, GetShowSelectionRange, fIdsetShowSelectionRange, SetShowSelectionRange, TYPE_bool) | |
| PROP_FNS (fIdgetSnapToFrames, GetSnapToFrames, fIdsetSnapToFrames, SetSnapToFrames, TYPE_bool) | |
| PROP_FNS (fIdgetKeyTransparency, GetKeyTransparency, fIdsetKeyTransparency, SetKeyTransparency, TYPE_INT) | |
| PROP_FNS (fIdgetSelKeyTransparency, GetSelKeyTransparency, fIdsetSelKeyTransparency, SetSelKeyTransparency, TYPE_INT) | |
| PROP_FNS (fIdgetCursorTransparency, GetCursorTransparency, fIdsetCursorTransparency, SetCursorTransparency, TYPE_INT) | |
Member Enumeration Documentation
| anonymous enum |
- Enumerator:
{ fIdgetVisible, fIdsetVisible, fIdgetFilter, fIdsetFilter, fIdgetNextKeyTime, fIdgetPreviousKeyTime, fIdredrawTrackBar,
fIdgetShowFrames, fIdsetShowFrames, fIdgetShowAudio, fIdsetShowAudio, fIdgetShowSelectionRange, fIdsetShowSelectionRange,
fIdgetSnapToFrames, fIdsetSnapToFrames, fIdgetKeyTransparency, fIdsetKeyTransparency,
fIdgetSelKeyTransparency, fIdsetSelKeyTransparency, fIdgetCursorTransparency, fIdsetCursorTransparency,
fIdregisterFilter, fIdUnRegisterFilter, fIdFilterCount, fIdFilterID, fIdFilterName, fIdIsFilterActive, fIdSetFilterActive,
};
| anonymous enum |
{enumIDfilterType,
};
Member Function Documentation
| virtual void SetVisible | ( | BOOL | bVisible | ) | [pure virtual] |
- Remarks:
- Sets the visibility of the track bar to on or off.
- Parameters:
- BOOL bVisible
TRUE to make visible; FALSE to hide.
| virtual BOOL IsVisible | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the track bar is visible; otherwise FALSE.
| virtual void SetFilter | ( | UINT | nFilter | ) | [pure virtual] |
- Remarks:
- The track bar shows keys for all parametric animation as well as transforms. This method sets the filter used which determines which keys are shown in the track bar.
- Parameters:
- UINT nFilter
One of the following values:
TRACKBAR_FILTER_ALL
Specifies to show all keys.
TRACKBAR_FILTER_TMONLY
Specifies to show transform keys only.
TRACKBAR_FILTER_CURRENTTM
Specifies to only show keys for the currently active transform (move, rotate or scale).
TRACKBAR_FILTER_OBJECT
Specifies to show keys for the controllers assigned anywhere in the pipeline to be included in the TrackBar key-display. This is essentially the modifiers and the base objects for the selected nodes (no transforms or materials).
TRACKBAR_FILTER_MATERIAL
Specifies to show keys for the controllers assigned anywhere for the selected nodes material - all controllers in the whole material tree will be included in the track bar display.
| virtual UINT GetFilter | ( | ) | [pure virtual] |
- Remarks:
- Returns the filter value which determines which keys are shown in the track bar. See the list specified in the method above for details.
| virtual TimeValue GetNextKey | ( | TimeValue | tStart, |
| BOOL | bForward | ||
| ) | [pure virtual] |
- Remarks:
- This method returns the time of the next key given a start time and a flag which indicates if the search should proceed forward or backwards. This is similar to the behavior of Animatable::GetNextKeyTime().
- Parameters:
- TimeValue tStart
Specifies the time to start looking for the next key.
BOOL bForward
TRUE to return the time of the next key; FALSE for the previous key.
- Returns:
- The time of the next (or previous) key.
| virtual void RedrawTrackBar | ( | bool | bForce = false |
) | [pure virtual] |
- Remarks:
- Redraws the Track Bar if required an optionally forces a redraw (even if not known to be required).
- Parameters:
- bool bForce = false
Pass true to force a redraw; false to only redraw if 3ds Max deems it required.
| virtual void SetShowFrames | ( | bool | b | ) | [pure virtual] |
- Remarks:
- Controls the visibility of frame numbers in the Track Bar.
- Parameters:
- bool b
Pass true to show frame numbers; false to turn them off.
| virtual bool GetShowFrames | ( | ) | [pure virtual] |
- Remarks:
- Returns true if frame numbers are visible in the Track Bar; false if not.
| virtual void SetShowAudio | ( | bool | b | ) | [pure virtual] |
- Remarks:
- Controls the visibility of the audio track.
- Parameters:
- bool b
Pass true to show the audio track; false to turn it off.
| virtual bool GetShowAudio | ( | ) | [pure virtual] |
- Remarks:
- Returns true if the audio track is displayed; false if it is not.
| virtual void SetShowSelectionRange | ( | bool | b | ) | [pure virtual] |
- Remarks:
- Controls if the selection range bar is visible or not.
- Parameters:
- bool b
Pass true to display the selection range bar; false to turn it off.
| virtual bool GetShowSelectionRange | ( | ) | [pure virtual] |
- Remarks:
- Returns true if the selection range bar is visible; false if it is not.
| virtual void SetSnapToFrames | ( | bool | b | ) | [pure virtual] |
- Remarks:
- Controls the snap to frames setting.
- Parameters:
- bool b
Pass true to turn it on; false to turn it off.
| virtual bool GetSnapToFrames | ( | ) | [pure virtual] |
- Remarks:
- Returns true if snap to frames is on; false if it is off.
| virtual void SetKeyTransparency | ( | int | xp | ) | [pure virtual] |
- Remarks:
- This method allows you to set the transparency of keyframes displayed in the trackbar.
- Parameters:
- int xp
The transparency value between 0 and 255.
| virtual int GetKeyTransparency | ( | ) | [pure virtual] |
- Remarks:
- This method returns the transparency of keyframes displayed in the trackbar.
- Returns:
- The transparency value between 0 and 255.
| virtual void SetSelKeyTransparency | ( | int | xp | ) | [pure virtual] |
- Remarks:
- This method allows you to set the transparency of selected keyframes displayed in the trackbar.
- Parameters:
- int xp
The transparency value between 0 and 255.
| virtual int GetSelKeyTransparency | ( | ) | [pure virtual] |
- Remarks:
- This method returns the transparency of selected keyframes displayed in the trackbar.
- Returns:
- The transparency value between 0 and 255.
| virtual void SetCursorTransparency | ( | int | xp | ) | [pure virtual] |
- Remarks:
- This method allows you to set the transparency of the cursor displayed in the trackbar.
- Parameters:
- int xp
The transparency value between 0 and 255.
| virtual int GetCursorTransparency | ( | ) | [pure virtual] |
- Remarks:
- This method returns the transparency of the cursor displayed in the trackbar.
- Returns:
- The transparency value between 0 and 255.
| BaseInterface* GetInterface | ( | Interface_ID | id | ) | [inline, virtual] |
- Remarks:
- Returns a pointer to the interface whose ID is specified.
- Parameters:
- Interface_ID id
The ID of the interface to return.
- Default Implementation:
- { return NULL; }
Reimplemented from FPMixinInterface.
{ return (id == TRACKBAR_INTERFACE) ? this : FPMixinInterface::GetInterface(id); }
| FPInterfaceDesc* GetDesc | ( | ) | [inline, virtual] |
- Remarks:
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
{ return (FPInterfaceDesc*)GetCOREInterface(TRACKBAR_INTERFACE); }
| BEGIN_FUNCTION_MAP VFN_1 | ( | fIdredrawTrackBar | , |
| RedrawTrackBar | , | ||
| TYPE_bool | |||
| ) |
| FNT_0 | ( | fIdgetNextKeyTime | , |
| TYPE_TIMEVALUE | , | ||
| fpGetNextKey | |||
| ) |
| FNT_0 | ( | fIdgetPreviousKeyTime | , |
| TYPE_TIMEVALUE | , | ||
| fpGetPreviousKey | |||
| ) |
| FN_6 | ( | fIdregisterFilter | , |
| TYPE_INDEX | , | ||
| fpRegisterFilter | , | ||
| TYPE_VALUE | , | ||
| TYPE_VALUE | , | ||
| TYPE_TSTR | , | ||
| TYPE_INT | , | ||
| TYPE_bool | , | ||
| TYPE_bool | |||
| ) |
| VFN_1 | ( | fIdUnRegisterFilter | , |
| fpUnRegisterFilter | , | ||
| TYPE_INDEX | |||
| ) |
| FN_0 | ( | fIdFilterCount | , |
| TYPE_INT | , | ||
| fpFilterCount | |||
| ) |
| FN_1 | ( | fIdFilterID | , |
| TYPE_INT_TAB_BV | , | ||
| fpGetFilterID | , | ||
| TYPE_INDEX | |||
| ) |
| FN_1 | ( | fIdFilterName | , |
| TYPE_TSTR_BV | , | ||
| fpGetFilterName | , | ||
| TYPE_INDEX | |||
| ) |
| FN_1 | ( | fIdIsFilterActive | , |
| TYPE_bool | , | ||
| fpIsFilterActive | , | ||
| TYPE_INDEX | |||
| ) |
| VFN_2 | ( | fIdSetFilterActive | , |
| fpSetFilterActive | , | ||
| TYPE_INDEX | , | ||
| TYPE_bool | |||
| ) |
| PROP_FNS | ( | fIdgetVisible | , |
| IsVisible | , | ||
| fIdsetVisible | , | ||
| SetVisible | , | ||
| TYPE_BOOL | |||
| ) |
| PROP_FNS | ( | fIdgetFilter | , |
| GetFilter | , | ||
| fIdsetFilter | , | ||
| SetFilter | , | ||
| TYPE_ENUM | |||
| ) |
| PROP_FNS | ( | fIdgetShowFrames | , |
| GetShowFrames | , | ||
| fIdsetShowFrames | , | ||
| SetShowFrames | , | ||
| TYPE_bool | |||
| ) |
| PROP_FNS | ( | fIdgetShowAudio | , |
| GetShowAudio | , | ||
| fIdsetShowAudio | , | ||
| SetShowAudio | , | ||
| TYPE_bool | |||
| ) |
| PROP_FNS | ( | fIdgetShowSelectionRange | , |
| GetShowSelectionRange | , | ||
| fIdsetShowSelectionRange | , | ||
| SetShowSelectionRange | , | ||
| TYPE_bool | |||
| ) |
| PROP_FNS | ( | fIdgetSnapToFrames | , |
| GetSnapToFrames | , | ||
| fIdsetSnapToFrames | , | ||
| SetSnapToFrames | , | ||
| TYPE_bool | |||
| ) |
| PROP_FNS | ( | fIdgetKeyTransparency | , |
| GetKeyTransparency | , | ||
| fIdsetKeyTransparency | , | ||
| SetKeyTransparency | , | ||
| TYPE_INT | |||
| ) |
| PROP_FNS | ( | fIdgetSelKeyTransparency | , |
| GetSelKeyTransparency | , | ||
| fIdsetSelKeyTransparency | , | ||
| SetSelKeyTransparency | , | ||
| TYPE_INT | |||
| ) |
| PROP_FNS | ( | fIdgetCursorTransparency | , |
| GetCursorTransparency | , | ||
| fIdsetCursorTransparency | , | ||
| SetCursorTransparency | , | ||
| TYPE_INT | |||
| ) |
