TAPsOpenGLSupport.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsOpenGLSupport.hpp

Design as a base class for OpenGL Drawing and Properties of inherited class.
It contains texture and material properties.

SUKITTI PUNAK   (09/16/2004)
UPDATE          (11/01/2004)
******************************************************************************/
#ifndef TAPs_OPENGL_SUPPORT_HPP
#define TAPs_OPENGL_SUPPORT_HPP

#include <iostream>
#include "TAPsOpenGLMaterial.hpp"
#include "../ImageHandler/TAPsBitmapImageHandler.hpp"   // bitmap image handler
#include "../ImageHandler/TAPsTargaImageHandler.hpp"    // targa image handler

// Render by GLSL -------------------------------------------------------------
#ifdef  TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
    //#include "../GLSL/TAPsGLSLShaderPool.hpp"
    #include "../GLSL/TAPsGlobalGLSLShaderPool.hpp"
    //TAPs::OpenGL::GLSLShaderPool  GLOBAL_ShaderPool;
#endif//TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
// ----------------------------------------------------------------------------

BEGIN_NAMESPACE_TAPs__OpenGL
//=============================================================================
class OpenGLSupport {
//=============================================================================
    // Friend Fn(s) ============================================================
    //-------------------------------------------------------------------------
    // put it through ostream
    friend std::ostream & operator<< ( std::ostream &output, OpenGLSupport const &o );
//-----------------------------------------------------------------------------
    // Data Members     ========================================================
protected:
    char * m_acImageFileName;   // image file name
    GLuint texName[1];          // texture data
public:
    //-------------------------------------------------------------------------
    BitmapImage *m_pcImg;
    TargaImage *m_pcImg2;

    Material material;

    #ifdef  TAPs_SUPPORT_ASE_FORMAT
    std::vector< Material * > submaterials;
    #endif//TAPs_SUPPORT_ASE_FORMAT

public:
    //-------------------------------------------------------------------------
    // Get/Set Fn(s)
    inline void SetFacetShading( bool b )   { isFacetShading = b; }
    inline bool GetFacetShading()           { return isFacetShading; }
    //-------------------------------------------------------------------------
protected:
    bool isFacetShading;    // should be used with DisplayGL fn below
//-----------------------------------------------------------------------------
public:
    // Helper Functions     ====================================================
    void EnableTexture( GLuint & texName );
    //void GenerateTexture();
    void EnableTexture();
//-----------------------------------------------------------------------------
public:
    // Member Functions     ====================================================
    //OpenGLSupport ();
    OpenGLSupport ( BitmapImage * = NULL, TargaImage * = NULL ); // constructor
    OpenGLSupport ( TargaImage  * );    // constructor
    virtual ~OpenGLSupport ();          // destructor
    //-------------------------------------------------------------------------
    // To make the material affects the drawing, 
    // this fn has to be called before drawing.
    inline void ApplyMaterial ( Enum::Face f = Enum::FRONT )
    { material.ApplyMaterial( f ); }
    // This fn set the material property to the material parameter,
    // but does not apply the material.
    inline void SetMaterial ( Enum::MaterialType mt = Enum::CURRENT_MAT )
    { material.SetMaterial( mt ); }
    //-------------------------------------------------------------------------
    // This fn must be called inside the DisplayGL()
    virtual void DrawTexture ();
    // Draw this 2-D image at a raster position
    void DrawImage1 ( Real x = 0, Real y = 0, Real z = 0 );
    // Draw this 2-D image at a raster position
    void DrawImage2 ( Real x = 0, Real y = 0, Real z = 0 );
    //-------------------------------------------------------------------------
    // Get/Set Fn(s)
    inline Material * const GetMaterial ()  { return &material; }
    char const * const GetImageFileName () const;
    void SetImageFileName ( char * fileName );
    //-------------------------------------------------------------------------
    // Display By OpenGL
    virtual void DisplayGL ( OpenGL::Enum::DrawMode DM = OpenGL::Enum::POLYGON ) = 0;
    virtual void DisplayGLFaceRange ( 
        int startFace, int endFace, 
        OpenGL::Enum::DrawMode DM = OpenGL::Enum::POLYGON )
    {} //{ DisplayGL( DM ); }


#ifdef  TAPs_ENABLE_FACE_VERTEX_COLOR

    bool IsVertexColorsEnabled () const { return m_bEnableVertexColor; };

    int GetDimensionOfVertexColors () const { return static_cast<int>( m_uiVertexColorDimension ); };

    // SHOULD BE PURE VIRTUAL FN!!!
    virtual bool EnableVertexColors ( bool b ) { m_bEnableVertexColor = false; return false; }

    // The codes below should be included in a class extended from this OpenGLSupport class.
        //#ifdef    TAPs_ENABLE_FACE_VERTEX_COLOR
        //public:
        //  virtual bool EnableVertexColors ( bool b );
        //#endif//TAPs_ENABLE_FACE_VERTEX_COLOR

        //#ifdef    TAPs_ENABLE_FACE_VERTEX_COLOR
        //protected:
        //  virtual void DrawGLWithFaceVertexColor_RGB  ( GLenum );
        //  virtual void DrawGLWithFaceVertexColor_RGBA ( GLenum );
        //#endif//TAPs_ENABLE_FACE_VERTEX_COLOR

#endif//TAPs_ENABLE_FACE_VERTEX_COLOR


#ifdef  TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

    bool IsVertexTexturesEnabled () const { return m_bEnableVertexTexture; };

    int GetDimensionOfVertexTextures () const { return static_cast<int>( m_uiVertexTextureDimension ); };

    // SHOULD BE PURE VIRTUAL FN!!!
    virtual bool EnableVertexTextures ( bool b ) { m_bEnableVertexTexture = false; return false; }

    // The codes below should be included in a class extended from this OpenGLSupport class.
        //#ifdef    TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
        //public:
        //  virtual bool EnableVertexTextures ( bool b );
        //#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

        //#ifdef    TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
        //protected:
        //  virtual void DrawGLWithFaceVertexTexture_S   ( GLenum );
        //  virtual void DrawGLWithFaceVertexTexture_ST  ( GLenum );
        //  virtual void DrawGLWithFaceVertexTexture_STR ( GLenum );
        //#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES


// Render by GLSL -------------------------------------------------------------
#ifdef  TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
    GlobalGLSLShaderPool::SHADER    ShaderName;     
    // Set of parameters for shader program
    // ...
#endif//TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
// ----------------------------------------------------------------------------

protected:
    //-------------------------------------------------------------------------
    // Pure Virtual Fns
    // Helper Fn
    // void DrawGL()
    virtual void DrawGL ( GLenum ) = 0;

#ifdef  TAPs_ENABLE_FACE_VERTEX_COLOR
    virtual void DrawGLWithFaceVertexColor_RGB  ( GLenum drawMode ) { DrawGL( drawMode ); }
    virtual void DrawGLWithFaceVertexColor_RGBA ( GLenum drawMode ) { DrawGL( drawMode ); }

    bool            m_bEnableVertexColor;       
    unsigned int    m_uiVertexColorDimension;   
#endif//TAPs_ENABLE_FACE_VERTEX_COLOR

#ifdef  TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
    virtual void DrawGLWithFaceVertexTexture_RGB    ( GLenum drawMode ) { DrawGL( drawMode ); }
    virtual void DrawGLWithFaceVertexTexture_RGBA   ( GLenum drawMode ) { DrawGL( drawMode ); }

    bool            m_bEnableVertexTexture;     
    unsigned int    m_uiVertexTextureDimension; 
#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

// Render by GLSL -------------------------------------------------------------
#ifdef  TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
    virtual void DrawGLSLWithDSFaceVertex_RGB   ( GLenum drawMode ) { DrawGL( drawMode ); }
    virtual void DrawGLSLWithDSFaceVertex_RGBA  ( GLenum drawMode ) { DrawGL( drawMode ); }
#endif//TAPs_RENDER_BY_GLSL_DS_FACE_VERTEX
// ----------------------------------------------------------------------------

    //-------------------------------------------------------------------------
    void SetTexture ( BitmapImage *img );
    //-------------------------------------------------------------------------
}; // END CLASS OpenGLSupport
//=============================================================================
END_NAMESPACE_TAPs__OpenGL
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
#if !defined( TAPs_USE_EXPORT )
    #include "TAPsOpenGLSupport.cpp"
#endif
//-----------------------------------------------------------------------------
#endif
//345678901234567890123456789012345678901234567890123456789012345678901234567890
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8