ITrackBar Class Reference

ITrackBar Class Referenceabstract

#include <maxapi.h>

Class 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.
+ 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 Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

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
 
BaseInterfaceGetInterface (Interface_ID id)
 
FPInterfaceDescGetDesc ()
 
 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)
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- 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)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

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...
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

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 
660  };
Definition: maxapi.h:659
Definition: maxapi.h:655
Definition: maxapi.h:656
Definition: maxapi.h:656
Definition: maxapi.h:656
Definition: maxapi.h:655
Definition: maxapi.h:658
Definition: maxapi.h:658
Definition: maxapi.h:659
Definition: maxapi.h:656
Definition: maxapi.h:656
Definition: maxapi.h:658
Definition: maxapi.h:659
Definition: maxapi.h:659
Definition: maxapi.h:657
Definition: maxapi.h:658
Definition: maxapi.h:655
Definition: maxapi.h:657
Definition: maxapi.h:657
Definition: maxapi.h:659
Definition: maxapi.h:655
Definition: maxapi.h:655
Definition: maxapi.h:655
Definition: maxapi.h:659
Definition: maxapi.h:657
Definition: maxapi.h:655
Definition: maxapi.h:659
Definition: maxapi.h:656
anonymous enum
Enumerator
enumIDfilterType 
663  };
Definition: maxapi.h:662

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)
inlinevirtual
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.

665 { return (id == TRACKBAR_INTERFACE) ? this : FPMixinInterface::GetInterface(id); }
#define TRACKBAR_INTERFACE
Definition: maxapi.h:528
virtual BaseInterface * GetInterface(Interface_ID id)
Definition: ifnpub.h:595
FPInterfaceDesc* GetDesc ( )
inlinevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

#define TRACKBAR_INTERFACE
Definition: maxapi.h:528
Definition: ifnpub.h:324
CoreExport Interface * GetCOREInterface()
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   
)