effect_directx_shader.h

#ifndef INCLUDED_EFFECT_DIRECTX_SHADER_H
#define INCLUDED_EFFECT_DIRECTX_SHADER_H
 
#include "effect_diff_norm_spec_refl.h"
#include "file_path_class.h"
#include "gls_matrix_affine.h"
#include "gls_render_effect.h"
#include "material.h"
 
#include <map>
 
#ifdef GLES
#    include "gls_state_manager.h"
#endif
 
//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLSGEN_IMPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSADVANCEDMESH ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GlsAdvancedMesh_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GlsAdvancedMesh_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////
 
namespace disti
{
/// Render effect that supports DirectX effect scripts. This will not render anything special in the Editor or in the GLStudio runtime;
/// it only holds the effect configuration for processing by the Lumen converter/generator.
/// \deprecated The Lumen code generator is deprecated.
class Effect_DirectXShader : public GlsRenderEffect
{
public:
    static const std::string EFFECT_TYPE_NAME; ///< Backing storage for the human readable string for this effect type.
 
    FilePathClass* _effectScriptPath; ///< File path to the script for this effect.
 
    typedef std::map<std::string /* parameter name */, float>    FloatParamsT;  ///< Typedef for a map between strings and floats.
    typedef std::map<std::string /* parameter name */, int>      IntParamsT;    ///< Typedef for a map between strings and ints.
    typedef std::map<std::string /* parameter name */, GlsColor> ColorParamsT;  ///< Typedef for a map between strings and Colors.
    typedef std::map<std::string /* parameter name */, Vector>   VectorParamsT; ///< Typedef for a map between strings and Vectors.
    typedef std::map<std::string /* parameter name */, bool>     BoolParamsT;   ///< Typedef for a map between strings and bools.
 
    FloatParamsT  _floatParams;            ///< Float parameter storage.
    IntParamsT    _intParams;              ///< Int parameter storage.
    ColorParamsT  _colorParams;            ///< Color parameter storage.
    VectorParamsT _vectorParams;           ///< Vector parameter storage.
    BoolParamsT   _boolParams;             ///< Bool parameter storage.
    IntParamsT    _texture2DIndexParams;   ///< 2D texture parameter storage.
    IntParamsT    _textureCUBEIndexParams; ///< Cube map parameter storage.
 
protected:
    unsigned int _ref_count; ///< Reference count
 
    unsigned int _materialIndex; ///< The material index to use
 
    /** Used for rendering the object in the editor; we'll just set up a basic grey */
    Effect_DiffNormSpecRefl* _helperEffect;
 
    /// Sets up _helperEffect.
    /// \note Not normally called by users
    void SetupHelperEffect();
 
    DistiAttribDict* _attribDict; ///< The attribute dictionary for this object.
 
    /// Called to add this object's attributes to the dictionary.
    /// \note Not normally called by users.
    void SetupAttribDict();
 
public:
    static const int INVALID_INDEX = -1; ///< Value to represent an invalid texture index.
 
    GLSGEN_GlsAdvancedMesh_EXPORT Effect_DirectXShader();
    GLSGEN_GlsAdvancedMesh_EXPORT ~Effect_DirectXShader();
 
    /// Copy constructor
    GLSGEN_GlsAdvancedMesh_EXPORT Effect_DirectXShader( const Effect_DirectXShader& );
 
    /// Assignment operator
    /// \return The resulting object (this).
    GLSGEN_GlsAdvancedMesh_EXPORT const Effect_DirectXShader& operator=( const Effect_DirectXShader& );
 
    /// Equality operator
    /// \return Whether or not the objects are the same.
    GLSGEN_GlsAdvancedMesh_EXPORT bool operator==( const Effect_DirectXShader& ) const;
 
    /// Inequality operator
    /// \param o The object to compare to.
    /// \return Whether or not the objects are not the same.
    inline bool operator!=( const Effect_DirectXShader& o ) const { return !( *this == o ); }
 
    /// Set the material index for this effect.
    /// \param materialIndex The new material index for this effect.
    inline void SetMaterialIndex( unsigned int materialIndex ) { _materialIndex = materialIndex; }
 
    /// \return The current material index for this effect.
    inline unsigned int GetMaterialIndex() const { return _materialIndex; }
 
    /// Selects the shader to use based on the current effect parameters.
    /// \note Not normally called by users.
    GLSGEN_GlsAdvancedMesh_EXPORT void SelectShader();
 
    /// \return A reference to the effect attribute dictionary.
    inline DistiAttribDict& Attributes() DISTI_METHOD_OVERRIDE
    {
        if( !_attribDict )
        {
            SetupAttribDict();
        }
        return *_attribDict;
    }
 
    /// \return This effect's type as a readable string.
    inline const std::string& EffectTypeName() DISTI_METHOD_OVERRIDE
    {
        return EFFECT_TYPE_NAME;
    }
 
    /////////////////////////////////////////////
    // VertexAttribIndexLookup Interface
    /////////////////////////////////////////////
 
    virtual GLint GetVertexAttribIndexForSemantic( int semanticEnum ) DISTI_METHOD_OVERRIDE;
 
    ///////////////////////////////////////////////////////////////////////////
    // GlsRenderEffect overrides
    ///////////////////////////////////////////////////////////////////////////
    virtual void         AddRef() DISTI_METHOD_OVERRIDE;
    virtual void         Release() DISTI_METHOD_OVERRIDE;
    virtual unsigned int GlsRenderEffect_ClassID() const DISTI_METHOD_OVERRIDE;
    virtual void         SetupEffect(
                DynamicArray<Material>& materialPalette,
                TexturePalette*         texturePalette,
                const TextureSettings&  textureSettings,
                float*                  viewToWorld3x3, // 3x3 matrix (float[9])
                unsigned int            maxLightNum,
                unsigned int            activeLightMask ) DISTI_METHOD_OVERRIDE;
 
    virtual void             CleanupEffect() DISTI_METHOD_OVERRIDE;
    virtual int              Compare( const GlsRenderEffect* ) const DISTI_METHOD_OVERRIDE;
    virtual GlsRenderEffect* Clone() const DISTI_METHOD_OVERRIDE;
};
 
} // namespace disti
 
#endif