glcomponent.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

#ifndef ANA_SURFACE_GLCOMPONENT_H
#define ANA_SURFACE_GLCOMPONENT_H

#include <anatomist/primitive/primitive.h>
#include <anatomist/window/glcaps.h>
#include <anatomist/window/viewstate.h>
#include <anatomist/surface/Shader.h>
#include <aims/rgb/rgb.h>
#include <cartobase/object/object.h>
#include <cartodata/volume/volume.h>
#include <vector>
#include <set>


namespace anatomist
{

  class Material;
  class AObjectPalette;
  class Sliceable;
  class Referential;


  class GLComponent
  {
  public:
    enum glTextureMode
    {
      glGEOMETRIC,
      glLINEAR,
      glREPLACE,
      glDECAL,
      glBLEND,
      glADD,
      glCOMBINE,
      glLINEAR_A_IF_A,
      glLINEAR_ON_DEFINED,
      glLINEAR_A_IF_B = glLINEAR_ON_DEFINED,
      glLINEAR_A_IF_NOT_A,
      glLINEAR_A_IF_NOT_B,
      glLINEAR_B_IF_A,
      glLINEAR_B_IF_B,
      glLINEAR_B_IF_NOT_A,
      glLINEAR_B_IF_NOT_B,
      glLINEAR_A_IF_A_ALPHA,
      glLINEAR_A_IF_NOT_B_ALPHA,
      glLINEAR_B_IF_B_ALPHA,
      glLINEAR_B_IF_NOT_A_ALPHA,
      glMAX_CHANNEL,
      glMIN_CHANNEL,
      glMAX_ALPHA,
      glMIN_ALPHA,
      glGEOMETRIC_SQRT,
      glGEOMETRIC_LIGHTEN,
    };

    enum glTextureFiltering
    {
      glFILT_NEAREST,
      glFILT_LINEAR,
    };

    enum glPart
    {
      glGENERAL,
      glBODY,
      glMATERIAL,
      glGEOMETRY,
      glPALETTE,
      glREFERENTIAL,
      glTEXIMAGE,
      glTEXENV,

      glNOPART,
      glTEXIMAGE_NUM,
      glTEXENV_NUM,
    };

    enum glAutoTexturingMode
    {
      glTEX_MANUAL,
      glTEX_OBJECT_LINEAR,
      glTEX_EYE_LINEAR,
      glTEX_SPHERE_MAP,
      glTEX_REFLECTION_MAP,
      glTEX_NORMAL_MAP,
    };

    typedef ViewState::glSelectRenderMode glSelectRenderMode;

    struct TexExtrema
    {
      TexExtrema();

      // min of data in memory (for OpenGL: between 0 and 1)
      std::vector<float>        min;
      // max of data in memory (for OpenGL: between 0 and 1)
      std::vector<float>        max;
      // min of initial (quantified) data
      std::vector<float>        minquant;
      // max of initial (quantified) data
      std::vector<float>        maxquant;
      bool                      scaled;
    };

    struct TexInfo;

    GLComponent();
    virtual ~GLComponent();

    virtual const GLComponent* glAPI() const { return this; }
    virtual GLComponent* glAPI() { return this; }
    virtual const Sliceable* sliceableAPI() const { return 0; }
    virtual Sliceable* sliceableAPI() { return 0; }

    virtual void glClearHasChangedFlags() const;
    virtual void glSetChanged( glPart, bool = true ) const;
    virtual bool glHasChanged( glPart ) const;

    void setShader(const Shader &shader);
    void removeShader();
    void setupShader();
    const Shader *getShader() const;
    Shader *getShader();
    virtual void setShaderParameters(const Shader &shader,
                                     const ViewState & state) const;

    virtual const Material *glMaterial() const;
    virtual const AObjectPalette* glPalette( unsigned tex = 0 ) const;

    virtual unsigned glNumVertex( const ViewState & ) const;
    virtual const GLfloat* glVertexArray( const ViewState & ) const;
    virtual const GLfloat* glNormalArray( const ViewState & ) const;
    virtual unsigned glPolygonSize( const ViewState & ) const;
    virtual unsigned glNumPolygon( const ViewState & ) const;
    virtual const GLuint* glPolygonArray( const ViewState & ) const;
    virtual unsigned long glMaxNumDisplayedPolygons() const;
    virtual void glSetMaxNumDisplayedPolygons( unsigned long n );
    static unsigned long glGlobalMaxNumDisplayedPolygons();
    static void glSetGlobalMaxNumDisplayedPolygons( unsigned long n );

    // Texturing functions
    virtual void glSetTexImageChanged( bool x = true, 
                                       unsigned tex = 0 ) const ;
    virtual void glSetTexEnvChanged( bool x = true, unsigned tex = 0 ) const;
    virtual unsigned glNumTextures() const;
    virtual unsigned glNumTextures( const ViewState & ) const;
    virtual glTextureMode glTexMode( unsigned tex = 0 ) const;
    virtual void glSetTexMode( glTextureMode mode, unsigned tex = 0 );
    virtual float glTexRate( unsigned tex = 0 ) const;
    virtual void glSetTexRate( float rate, unsigned tex = 0 );
    virtual glTextureFiltering glTexFiltering( unsigned tex = 0 ) const;
    virtual void glSetTexFiltering( glTextureFiltering x, unsigned tex = 0 );
    virtual glAutoTexturingMode glAutoTexMode( unsigned tex = 0 ) const;
    virtual void glSetAutoTexMode( glAutoTexturingMode mode, 
                                   unsigned tex = 0 );
    virtual const float *glAutoTexParams( unsigned coord = 0, 
                                          unsigned tex = 0 ) const;
    virtual void glSetAutoTexParams( const float* params, unsigned coord = 0, 
                                     unsigned tex = 0 );
    virtual bool glTexImageChanged( unsigned tex = 0 ) const;
    virtual bool glTexEnvChanged( unsigned tex = 0 ) const;
    virtual GLint glGLTexMode( unsigned tex = 0) const;
    virtual GLint glGLTexFiltering( unsigned tex = 0 ) const;
    virtual void glSetTexRGBInterpolation( bool x, unsigned tex = 0 );
    virtual bool glTexRGBInterpolation( unsigned tex = 0 ) const;
    virtual unsigned glDimTex( const ViewState &, unsigned tex = 0 ) const;
    virtual unsigned glTexCoordSize( const ViewState &, 
                                     unsigned tex = 0 ) const;
    virtual const GLfloat* glTexCoordArray( const ViewState &, 
                                            unsigned tex = 0 ) const;
    virtual const TexExtrema & glTexExtrema( unsigned tex = 0 ) const;
    virtual TexExtrema & glTexExtrema( unsigned tex = 0 );

    virtual GLPrimitives glMainGLL( const ViewState & );
    virtual void glGarbageCollector( int nkept = -1 );
    unsigned glStateMemory() const;
    virtual void glSetStateMemory( unsigned n );

    virtual bool glMakeBodyGLL( const ViewState & state, 
                                const GLList & gllist ) const;
    virtual void glBeforeBodyGLL( const ViewState & state, 
                                  GLPrimitives & pl ) const;
    virtual void glAfterBodyGLL( const ViewState & state, 
                                 GLPrimitives & pl ) const;
    virtual carto::VolumeRef<AimsRGBA> glBuildTexImage(
      const ViewState & state, unsigned tex, int dimx = -1,
      int dimy = -1, bool useTexScale = true ) const;
    virtual bool glMakeTexImage( const ViewState & state, 
                                 const GLTexture & gltex, unsigned tex ) const;
    virtual bool glMakeTexEnvGLL( const ViewState & state, 
                                  const GLList & gllist, unsigned tex ) const;

    virtual GLPrimitives glBodyGLL( const ViewState & state ) const;
    virtual GLPrimitives glMaterialGLL( const ViewState & state ) const;
    virtual GLPrimitives glTexNameGLL( const ViewState &, 
                                       unsigned tex = 0 ) const;
    virtual GLPrimitives glTexEnvGLL( const ViewState &, 
                                      unsigned tex = 0 ) const;
    virtual void glSetMainGLL( const std::string & state, GLPrimitives x );
    virtual void glSetBodyGLL( const std::string & state, RefGLItem x );
    virtual void glSetMaterialGLL( const std::string & state, RefGLItem x );
    virtual void glSetTexNameGLL( const std::string & state, RefGLItem x, 
                                  unsigned tex = 0 );
    virtual std::set<glTextureMode> 
    glAllowedTexModes( unsigned tex = 0 ) const;
    virtual std::set<glTextureFiltering> 
    glAllowedTexFilterings( unsigned tex = 0 ) const;
    virtual std::set<glAutoTexturingMode> 
    glAllowedAutoTexModes( unsigned tex = 0 ) const;
    virtual bool glAllowedTexRGBInterpolation( unsigned tex = 0 ) const;
    virtual bool glAllowedTexRate( unsigned tex = 0 ) const;

    virtual std::string viewStateID( glPart part, const ViewState & ) const;
    virtual carto::Object debugInfo() const;

    static GLPrimitives glHandleTransformation( const ViewState & vs,
                                                const Referential* myref );
    static GLPrimitives glPopTransformation( const ViewState & vs,
                                             const Referential* myref );
    int glObjectID() const;
    virtual TexInfo & glTexInfo( unsigned tex = 0 ) const;

  protected:
    void glAddTextures( unsigned ntex = 1 );

  private:
    struct Private;
    Private     *d;
    Shader      *_shader;
  };


  inline void GLComponent::setShader(const Shader &shader)
  { 
    if (_shader) delete _shader;
    _shader = new Shader(shader);
    glSetChanged( GLComponent::glBODY );
  }
  inline void GLComponent::removeShader(void)
  { 
    if (_shader)
    {
      delete _shader;
      _shader = NULL;
      glSetChanged( GLComponent::glBODY );
    }
  }
  inline const Material *GLComponent::glMaterial() const          { return 0; }
  inline const Shader *GLComponent::getShader() const { return _shader; }
  inline Shader *GLComponent::getShader() { return _shader; }
  inline void GLComponent::setShaderParameters(const Shader &shader, const ViewState & state) const { shader.setShaderParameters(*this, state); }
  inline const AObjectPalette* GLComponent::glPalette( unsigned ) const
  { return 0; }
  inline unsigned GLComponent::glNumVertex( const ViewState & ) const
  { return 0; }
  inline const GLfloat* GLComponent::glVertexArray( const ViewState & ) const
  { return 0; }
  inline const GLfloat* GLComponent::glNormalArray( const ViewState & ) const
  { return 0; }
  inline unsigned GLComponent::glPolygonSize( const ViewState & ) const
  { return 3; }
  inline unsigned GLComponent::glNumPolygon( const ViewState & ) const
  { return 0; }
  inline const GLuint* GLComponent::glPolygonArray( const ViewState & ) const
  { return 0; }

  inline unsigned GLComponent::glDimTex( const ViewState &, unsigned ) const
  { return 1; }
  inline unsigned GLComponent::glTexCoordSize( const ViewState &, 
                                               unsigned ) const
  { return 0; }
  inline const GLfloat* GLComponent::glTexCoordArray( const ViewState &, 
                                                      unsigned ) const 
  { return 0; }

}


#endif