IDxMaterial.h

Go to the documentation of this file.

/**********************************************************************
*<
FILE: IDxMaterial.h

DESCRIPTION:    Interface for accessing the bitmaps used by effects in the DxMaterial

CREATED BY:     Neil Hazzard

HISTORY:        Created:  07/08/03


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

#include "iFnPub.h"
#include "AssetManagement/AssetUser.h"

// forward declarations
class IEffectParser;
class IParameterManager;
class ILightManager;

typedef interface ID3DXEffect * LPD3DXEFFECT;
typedef LPCSTR D3DXHANDLE;
typedef D3DXHANDLE *LPD3DXHANDLE;


#define IDXMATERIAL_INTERFACE Interface_ID(0x55b3201d, 0x29ab7fc3)
#define IDXMATERIAL2_INTERFACE Interface_ID(0x54e4202f, 0x30ab6bc4)
#define IDXMATERIAL3_INTERFACE Interface_ID(0xde24e62f, 0x1a8fd412)


class IDxMaterial : public FPMixinInterface
{

public:
    enum LightSemantics
    {
        LIGHT_COLOR,
        LIGHT_DIRECTION,
        LIGHT_POSITION,
        LIGHT_FALLOFF,
        LIGHT_HOTSPOT,
        LIGHT_ATTENUATION
    };

    virtual void ReloadDXEffect()=0;


    virtual int GetNumberOfEffectBitmaps()=0;


    virtual PBBitmap * GetEffectBitmap(int index)=0;


    virtual void SetEffectBitmap(int index,PBBitmap * bmap)=0;


    virtual const MaxSDK::AssetManagement::AssetUser&  GetEffectFile() = 0;
    

    virtual void SetEffectFile(const MaxSDK::AssetManagement::AssetUser& file) = 0;
    

    virtual PBBitmap * GetSoftwareRenderBitmap() = 0;


    virtual void SetSoftwareRenderBitmap(PBBitmap * bmap) = 0;

    //************************************************************************************
    // The following method are not exposed through function publishing
    //************************************************************************************


    virtual int GetNumberOfLightParams()=0;


    virtual INode * GetLightNode(int index)=0;

    /*
     \param index The index of the light to retrieve
     \return A MCHAR* containing the name
     */
    virtual MCHAR * GetLightParameterName(int index)=0;

    /*
     \param index THe index of the light to retrieve    
     \return The semantic represented as a LightSemantics
     */
    virtual LightSemantics GetLightSemantic(int index)=0;

};

class IDxMaterial2 : public IDxMaterial
{

public:
    enum BitmapTypes
    {
        UNKNOWN_MAP,
        DIFFUSE_MAP,
        BUMP_MAP,
        SPECULAR_MAP,
        OPACITY_MAP,
        DISPLACEMENT_MAP,
        LIGHTMAP_MAP,
        NORMAL_MAP,
        REFLECTION_MAP
    };


    virtual int GetBitmapMappingChannel(int index) = 0;


    virtual BitmapTypes GetBitmapUsage(int index) = 0;


    virtual void SetMappingChannel(int bitmapIndex, int mapChannel)=0;

};

class IDxMaterial3 : public IDxMaterial2
{
public:

    virtual IEffectParser * GetCurrentParser()=0;


    virtual INode * GetLightNode(D3DXHANDLE handle)=0;


    virtual IParameterManager* GetCurrentParameterManager() =0;


    virtual int GetNumberOfTechniques() =0;

    /* Returns the technique name based on the index supplied
    \param index The index of the technique
    \return The name of the technique
    */
    virtual const MCHAR * GetTechniqueName(int index)=0;

    /* Returns the name of the current active technique
    \return The technique name
    */
    virtual const MCHAR * GetCurrentTechniqueName()=0;


    virtual ILightManager * GetCurrentLightManager() =0;

};