IMtlBrowserFilter.h

Go to the documentation of this file.

 /**********************************************************************
 
    FILE:           IMtlBrowserFilter.h

    DESCRIPTION:    Public interface for filtering the contents of the
                    material/map browser.

    CREATED BY:     Daniel Levesque, Discreet

    HISTORY:        Created 23 February 2003

 *> Copyright (c) 2003, All Rights Reserved.
 **********************************************************************/

#pragma once

#include "ifnpub.h"
#include "baseinterface.h"
#include "GetCOREInterface.h"
// forward declarations
class IMtlBrowserFilter;
class MtlBase;
class ClassDesc;

#define IMTLBROWSERFILTER_MANAGER_INTERFACEID Interface_ID(0x371b4b10, 0x6c715bbc)
#define IMTLBROWSERFILTER_INTERFACEID Interface_ID(0x1d1f513b, 0x6f315a24)
#define ISUBMTLMAP_BROWSERFILTER_INTERFACEID Interface_ID(0x17304fc3, 0x1ad25941)

//==============================================================================
// class IMtlBrowserFilter_Manager
//==============================================================================
class IMtlBrowserFilter_Manager : public FPStaticInterface {

public:

    virtual bool AddFilter(IMtlBrowserFilter& filter) = 0;

    virtual bool RemoveFilter(IMtlBrowserFilter& filter) = 0;

    virtual int GetNumberFilters() = 0;
    
    virtual IMtlBrowserFilter* GetFilter(unsigned int i) = 0;
    
    virtual bool FilterEnabled(unsigned int i) = 0;
    
    virtual void EnableFilter(unsigned int i, bool enable) = 0;

    virtual const MCHAR* GetFilterName(unsigned int i) = 0;


    virtual bool Include(MtlBase& mtlBase, DWORD flags) = 0;



    virtual bool Include(ClassDesc& classDesc, DWORD flags) = 0;
};

inline IMtlBrowserFilter_Manager* Get_IMtlBrowserFilter_Manager() {

    return static_cast<IMtlBrowserFilter_Manager*>(GetCOREInterface(IMTLBROWSERFILTER_MANAGER_INTERFACEID));
};

//==============================================================================
// class IMtlBrowserFilter
//==============================================================================
class IMtlBrowserFilter : public BaseInterface {

public:

    virtual const MCHAR* FilterName() = 0;

    virtual bool Enabled() = 0;

    virtual void Enable(bool enable) = 0;

    virtual void Registered() = 0;

    virtual void Unregistered() = 0;

    virtual bool Include(MtlBase& mtlBase, DWORD flags) = 0;

    virtual bool Include(ClassDesc& classDesc, DWORD flags) = 0;

    // -- from BaseInterface
    virtual Interface_ID GetID();
};

//==============================================================================
// class ISubMtlMap_BrowserFilter

//==============================================================================
class ISubMtlMap_BrowserFilter : public BaseInterface {

public:

    virtual IMtlBrowserFilter* GetSubMapFilter(unsigned int i) = 0;


    virtual IMtlBrowserFilter* GetSubMtlFilter(unsigned int i) = 0;
    
    // -- from BaseInterface
    virtual Interface_ID GetID();

};

inline ISubMtlMap_BrowserFilter* Get_ISubMtlMap_BrowserFilter(InterfaceServer* iserver) {

    return static_cast<ISubMtlMap_BrowserFilter*>(iserver->GetInterface(ISUBMTLMAP_BROWSERFILTER_INTERFACEID));
}

//==============================================================================
// class IMtlBrowserFilter inlined methods
//==============================================================================

inline Interface_ID IMtlBrowserFilter::GetID() {

    return IMTLBROWSERFILTER_INTERFACEID;
}

//==============================================================================
// class ISubMapBrowserFilter inlined methods
//==============================================================================

inline Interface_ID ISubMtlMap_BrowserFilter::GetID() {

    return ISUBMTLMAP_BROWSERFILTER_INTERFACEID;
}