IMtlBrowserFilter_Manager Class Reference
 
 
 
IMtlBrowserFilter_Manager Class Reference

#include <IMtlBrowserFilter.h>

Inheritance diagram for IMtlBrowserFilter_Manager:
FPStaticInterface FPInterfaceDesc FPInterface BaseInterface InterfaceServer MaxHeapOperators

Class Description

See also:
Class IMtlBrowserFilter, Class ISubMtlMap_BrowserFilter
Description
This is the manager for the material and texture map browser filters. It is used to add, remove and access filters for the browser.

Public Member Functions

virtual bool  AddFilter (IMtlBrowserFilter &filter)=0
  Adds a filter to the list.
virtual bool  RemoveFilter (IMtlBrowserFilter &filter)=0
  Remove a filter from the list.
virtual int  GetNumberFilters ()=0
  Query the list of filters currently assigned.
virtual IMtlBrowserFilter GetFilter (unsigned int i)=0
  Query the list of filters currently assigned.
virtual bool  FilterEnabled (unsigned int i)=0
  Returns whether the i-th filter is enabled.
virtual void  EnableFilter (unsigned int i, bool enable)=0
  Enables/disables the i-th filter.
virtual const MCHAR *  GetFilterName (unsigned int i)=0
  Get the name of the i-th filter.
virtual bool  Include (MtlBase &mtlBase, DWORD flags)=0
  Run the given material/map through all the filters in the list.
virtual bool  Include (ClassDesc &classDesc, DWORD flags)=0
  Run the given ClassDesc through all the filters in the list.

Member Function Documentation

virtual bool AddFilter ( IMtlBrowserFilter filter ) [pure virtual]

Adds a filter to the list.

Parameters:
filter - A new filter to add to the browser
Returns:
false if filter could not be added because duplicate.
virtual bool RemoveFilter ( IMtlBrowserFilter filter ) [pure virtual]

Remove a filter from the list.

Parameters:
filter The filter to be removed
Returns:
false if filter could not be removed because not found.
virtual int GetNumberFilters ( ) [pure virtual]

Query the list of filters currently assigned.

Returns:
the number of applied filters
virtual IMtlBrowserFilter* GetFilter ( unsigned int  i ) [pure virtual]

Query the list of filters currently assigned.

Parameters:
i - the index of the filter to return
Returns:
The filter at index i
virtual bool FilterEnabled ( unsigned int  i ) [pure virtual]

Returns whether the i-th filter is enabled.

virtual void EnableFilter ( unsigned int  i,
bool  enable 
) [pure virtual]

Enables/disables the i-th filter.

virtual const MCHAR* GetFilterName ( unsigned int  i ) [pure virtual]

Get the name of the i-th filter.

virtual bool Include ( MtlBase mtlBase,
DWORD  flags 
) [pure virtual]

Run the given material/map through all the filters in the list.

Returns true if and only if all filters accept to include that material/map.

Parameters:
mtlBase - the Material to be filtered
flags - See the List of Material Browser Flags.
Returns:
true if every filter accepts mtlBase
virtual bool Include ( ClassDesc classDesc,
DWORD  flags 
) [pure virtual]

Run the given ClassDesc through all the filters in the list.

Returns true if and only if all filters accept to include that ClassDesc.

Parameters:
classDesc - The material/map class descriptor to be filtered
flags - See the List of Material Browser Flags.
Returns:
true if every filter accepts mtlBase