IMtlRender_Compatibility.h

Go to the documentation of this file.

 /**********************************************************************
 
    FILE:           IMtlRender_Compatibility.h

    DESCRIPTION:    Public interface for determining compatibility
                    between a material/texmap and a renderer.

                    The interface also allows 3rd party material/map plugins to
                    use custom icons in the material/map browser.

    CREATED BY:     Daniel Levesque, Discreet

    HISTORY:        Created 14 April 2003

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

#include "ifnpub.h"
#include "baseinterface.h"
#include <CommCtrl.h> // for HIMAGELIST
#include "plugapi.h"

// forward declarations
class Renderer;
class MtlBase;

#define IMTLRENDER_COMPATIBILITY_MTLBASE_INTERFACEID Interface_ID(0x5537445b, 0x70a97e02)
#define IMTLRENDER_COMPATIBILITY_RENDERER_INTERFACEID Interface_ID(0x25d24114, 0xdbe505f)

//==============================================================================
// class IMtlRender_Compability_MtlBase
//==============================================================================
class IMtlRender_Compatibility_MtlBase : public FPStaticInterface {

public:

    void Init(ClassDesc& classDesc);

    virtual bool IsCompatibleWithRenderer(ClassDesc& rendererClassDesc) = 0;

    #pragma warning(push)
    #pragma warning(disable:4100)
    virtual bool GetCustomMtlBrowserIcon(
        HIMAGELIST& hImageList,
        int& inactiveIndex,
        int& activeIndex,
        int& disabledIndex
    ) 
    { 
        return false; 
    }
    #pragma warning(pop)
};

// Given the class descriptor of a Mtl/Texmap plugin, this returns its compatibility interface (if it exists).
inline IMtlRender_Compatibility_MtlBase* Get_IMtlRender_Compability_MtlBase(ClassDesc& mtlBaseClassDesc) {

    return static_cast<IMtlRender_Compatibility_MtlBase*>(mtlBaseClassDesc.GetInterface(IMTLRENDER_COMPATIBILITY_MTLBASE_INTERFACEID));
}

//==============================================================================
// class IMtlRender_Compatibility_Renderer
//==============================================================================
class IMtlRender_Compatibility_Renderer : public FPStaticInterface  {

public:

    void Init(ClassDesc& classDesc);

    virtual bool IsCompatibleWithMtlBase(ClassDesc& mtlBaseClassDesc) = 0;
};

// Given the class descriptor of a Renderer plugin, this returns its compatibility interface (if it exists).
inline IMtlRender_Compatibility_Renderer* Get_IMtlRender_Compatibility_Renderer(ClassDesc& rendererClassDesc) {

    return static_cast<IMtlRender_Compatibility_Renderer*>(rendererClassDesc.GetInterface(IMTLRENDER_COMPATIBILITY_RENDERER_INTERFACEID));
}

// bool AreMtlAndRendererCompatible(ClassDesc&, ClassDesc&)
inline bool AreMtlAndRendererCompatible(ClassDesc& mtlBaseClassDesc, ClassDesc& rendererClassDesc) {

    IMtlRender_Compatibility_MtlBase* mtlBaseCompatibility = Get_IMtlRender_Compability_MtlBase(mtlBaseClassDesc);
    IMtlRender_Compatibility_Renderer* rendererCompatibility = Get_IMtlRender_Compatibility_Renderer(rendererClassDesc);

    if((mtlBaseCompatibility == NULL) && (rendererCompatibility == NULL)) {
        // No compatibility info: compatible by default
        return true;
    }
    else if((mtlBaseCompatibility != NULL) && mtlBaseCompatibility->IsCompatibleWithRenderer(rendererClassDesc)) {
        // Material says it's compatible with the renderer: compatible
        return true;
    }
    else if((rendererCompatibility != NULL) && rendererCompatibility->IsCompatibleWithMtlBase(mtlBaseClassDesc)) {
        // Renderer says it's compatible with the material: compatible
        return true;
    }
    else {
        // Neither material nor renderer says it's compatible: incompatible
        return false;
    }
}

//==============================================================================
// class IMtlRender_Compability_MtlBase inlined methods
//==============================================================================

inline void IMtlRender_Compatibility_MtlBase::Init(ClassDesc& classDesc) {

    LoadDescriptor(IMTLRENDER_COMPATIBILITY_MTLBASE_INTERFACEID, _M("IMtlRender_Compability_MtlBase"), 0, &classDesc, 0, end);
}

//==============================================================================
// class IMtlRender_Compatibility_Renderer inlined methods
//==============================================================================

inline void IMtlRender_Compatibility_Renderer::Init(ClassDesc& classDesc) {

    LoadDescriptor(IMTLRENDER_COMPATIBILITY_RENDERER_INTERFACEID, _M("IMtlRender_Compability_Renderer"), 0, &classDesc, 0, end);
}