Public Member Functions | Friends

ITrackBarFilterManager Class Reference

Search for all occurrences

#include <maxapi.h>

Inheritance diagram for ITrackBarFilterManager:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual int  RegisterFilter (TRACKBAR_FILTER_PROC callbackFilter, TRACKBAR_ADDITION_PROC callbackAddition, MSTR name, Class_ID filterID, bool active=false, bool stopTraversal=true)=0
  Register a new filter with the filter manager.
virtual void  UnRegisterFilter (int index)=0
  Remove a registered filter from the filter manager.
virtual void  UnRegisterFilter (Class_ID filterID)
  Remove a registered filter from the filter manager.
virtual int  FilterCount ()=0
  Returns the number of filters registered with the filter manager.
virtual Class_ID  GetFilterID (int index)=0
  Get a registered filter's ID.
virtual MSTR  GetFilterName (int index)=0
  Get a registered filter's Name.
virtual bool  IsFilterActive (int index)=0
  If the filter is active its Filter() method will be called once for each animatable visited by the TrackBar's traverser.
virtual void  SetFilterActive (int index, bool state)=0
  Activate or deactivate the filter. If active it will be used to filter the key display.

Friends

class  ITrackBar

Member Function Documentation

virtual int RegisterFilter ( TRACKBAR_FILTER_PROC  callbackFilter,
TRACKBAR_ADDITION_PROC  callbackAddition,
MSTR  name,
Class_ID  filterID,
bool  active = false,
bool  stopTraversal = true 
) [pure virtual]

Register a new filter with the filter manager.

This is usually done at startup, but does not have to be. callbackFilter or callbackAddition can be NULL The name is a UI displayable name. The ID is a unique ID so filters are not duplicated. If active is true the filter will be used to filter TrackBar key display. If stopTraversal is false. This filter will not filter out subAnims of the object is supports.

virtual void UnRegisterFilter ( int  index ) [pure virtual]

Remove a registered filter from the filter manager.

virtual void UnRegisterFilter ( Class_ID  filterID ) [inline, virtual]

Remove a registered filter from the filter manager.

    {
        for (int i = FilterCount()-1; i >=0; i--)
        {
            if (GetFilterID(i) == filterID)
            {
                UnRegisterFilter(i);
                break;
            }
        }
    }
virtual int FilterCount ( ) [pure virtual]

Returns the number of filters registered with the filter manager.

virtual Class_ID GetFilterID ( int  index ) [pure virtual]

Get a registered filter's ID.

virtual MSTR GetFilterName ( int  index ) [pure virtual]

Get a registered filter's Name.

virtual bool IsFilterActive ( int  index ) [pure virtual]

If the filter is active its Filter() method will be called once for each animatable visited by the TrackBar's traverser.

virtual void SetFilterActive ( int  index,
bool  state 
) [pure virtual]

Activate or deactivate the filter. If active it will be used to filter the key display.


Friends And Related Function Documentation

friend class ITrackBar [friend]

ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager
ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager ITrackBarFilterManager