IViewportManager.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: IViewportManager.h

    DESCRIPTION:    Viewport Manager for loading up DXEffects and other 
                    viewport properties

    CREATED BY:     Neil Hazzard

    HISTORY:        Created:  02/15/02
                    Updated:  05/05/04  New interface added for 3ds max7
                    Updated:  07/21/05  New interface added for 3ds max10
                    Updated:  07/13/07  exposed some new viewport properties
                    

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

#pragma once

#include "iFnPub.h"
#include "custattrib.h"
#include "IHardwareMaterial.h"
#include "GetCOREInterface.h"
// forward declarations
class MtlBase;

#define VIEWPORT_SHADER_MANAGER_INTERFACE Interface_ID(0x5dbe33d6, 0x2e1b422b)
#define VIEWPORT_SHADER_MANAGER_INTERFACE2 Interface_ID(0x5a4d6672, 0x7d8a2857)
#define VIEWPORT_SHADER_MANAGER_INTERFACE3 Interface_ID(0x59b97216, 0x64d41c0d)

#define VIEWPORT_SHADER_CLIENT_INTERFACE Interface_ID(0x40c926b8, 0x7c3a66b7)
#define VIEWPORT_SHADER9_CLIENT_INTERFACE Interface_ID(0x40c926b7, 0x7c3a6347)

#define IDX_SHADER_MANAGER Interface_ID(0x6dce7429, 0x200169ac)


class IViewportShaderManager : public FPMixinInterface {
    public:

        enum {  get_num_effects, get_active_effect, is_effect_active, is_manager_active,
        get_effect_name,set_effect,activate_effect};

        FPInterfaceDesc* GetDesc();    

        virtual int GetNumEffects()=0;

        virtual ReferenceTarget* GetActiveEffect()=0;

        virtual MCHAR * GetEffectName(int i)=0;

        virtual ReferenceTarget * SetViewportEffect(int i)=0;

        virtual void ActivateEffect(MtlBase * mtl, BOOL State)=0;


    };

class IViewportShaderManager2 : public IViewportShaderManager
{
public:

    virtual bool SaveFXFile(MCHAR * fileName)=0;

    virtual bool IsDxStdMtlEnabled()=0;

    virtual void SetDxStdMtlEnabled(bool state)=0;

    virtual MCHAR * GetActiveEffectName() = 0;
};


class IViewportShaderManager3 : public IViewportShaderManager2
{
public:
    virtual bool IsCurrentEffectEnabled() = 0;

    virtual bool SetCurrentEffectEnabled(bool enabled) = 0;

    virtual bool IsDxStdMtlSupported() = 0;

    virtual bool IsSaveFxSupported() = 0;

    virtual bool IsCurrentEffectSupported() = 0;

    virtual MtlBase* FindOwnerMaterial() = 0;
};


class IDXDataBridge : public BaseInterface
{
public:
    virtual Interface_ID    GetID() { return VIEWPORT_SHADER_CLIENT_INTERFACE; }

    // Interface Lifetime
    virtual LifetimeType    LifetimeControl() { return noRelease; }
    virtual ParamDlg * CreateEffectDlg(HWND hWnd, IMtlParams * imp)= 0;


    virtual void DisableUI()=0;

    virtual MCHAR * GetName()=0;

    virtual void SetDXData(IHardwareMaterial * pHWMtl, Mtl * pMtl)=0;
};


// If you are creating a DX9 based DXEffects then you need to implement this interface 
class IDX9DataBridge : public IDXDataBridge
{
public:
    // Interface Lifetime
    virtual LifetimeType    LifetimeControl() { return noRelease; }
    virtual Interface_ID    GetID() { return VIEWPORT_SHADER9_CLIENT_INTERFACE; }


    virtual float GetDXVersion() = 0;
    
};

class IDXShaderManagerInterface : public FPStaticInterface
{
    public:
        virtual CustAttrib* FindViewportShaderManager (MtlBase* mtl)=0;
        virtual CustAttrib* AddViewportShaderManager(MtlBase * mtl)=0;
        
        virtual void    SetVisible(BOOL show=TRUE)=0;
        virtual BOOL    IsVisible()=0;
    
};

inline IDXShaderManagerInterface* GetDXShaderManager() { return (IDXShaderManagerInterface*)GetCOREInterface(IDX_SHADER_MANAGER); }