SoGuiGLWidget.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T.MEHAMLI (Jun 2007)
**=======================================================================*/
 
#ifndef SO_GUI_GL_WIDGET_H
#define SO_GUI_GL_WIDGET_H

//
//  Class: SoGuiGLWidget
//
// SoXXGLWidgets implementation class
// 
//
 
#include <Inventor/antialiasing/SiAntialiasingEventListener.h>
#include <Inventor/Gui/SoGuiComponent.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/devices/SoGLFormat.h>
#include <Inventor/nodes/SoFullSceneAntialiasing.h>
#include <Inventor/image/SbRasterImage.h>
 
class SoGLGraphicConfigTemplate;
 
#ifndef HIDDEN_FROM_DOC
typedef SbBool (*soGUIDependentCB)(void* data);
typedef void* (*soGUIWindowDependentCB)(void* data);
#endif
 
 
class  SoGuiGLWidget : public SoGuiComponent 
{
#ifndef HIDDEN_FROM_DOC
  SO_FIELDCONTAINER_HEADER( SoGuiGLWidget );
#endif
 
private:
 
  SoSFFieldContainer gcTemplate;
  SoSFBool focus;
 
  enum FloatColorBufferSize 
  {
    FLOAT_16_COLOR_BUFFER = 0,
    FLOAT_32_COLOR_BUFFER = 1
  };
  
  SoGuiGLWidget();

  void setAntialiasing(const float quality, const SoSceneManager::AntialiasingMode mode = SoSceneManager::AUTO);

  void setAntialiasing(SoAntialiasingParameters* advancedParameters);

  float getAntialiasingQuality() const;

  SoSceneManager::AntialiasingMode getAntialiasingMode() const;

  SoAntialiasingParameters* getAntialiasingParameters() const;

  void setColorMapSize( int size );

  int getColorMapSize();

  SbBool isDoubleBuffer();

  void setBorder( int newValue );

  int getBorderSize();

  SbBool isBorder() const;
 
  void setDrawToFrontBufferEnable( SbBool enableFlag );

  SbBool isDrawToFrontBufferEnable() const;

  void setFloatingColorBuffer( SbBool enable, FloatColorBufferSize size = FLOAT_16_COLOR_BUFFER );

  void getFloatingColorBuffer( SbBool& enable, FloatColorBufferSize& size );

  static SbBool isFloatingColorBufferSupported();

  void setGLModes( int mode );

  int getGLModes() const;

  SbBool setGLFormat( const SoGLFormat& format );

  const SoGLFormat& getGLFormat() const;

  typedef SbBool (*FormatChangeCallback)( SoGLFormat&, void* userData );

  void setOnFormatChangeCalback( FormatChangeCallback callback, void* userData = NULL );

  virtual SbBool setDoubleBuffer( SbBool enable );

  void setRemoteRendering( bool enable );

  bool isRemoteRendering() const;

  SbBool setStereoEnabled( SbBool enable );

  SbBool isStereoEnabled() const;

  // Note: It would make more sense to copydoc *from* this class, but
  //       Doxygen won't do that because this class is not currently documented... :-(
  bool saveSnapshot( const SbString& filename, bool override = true );
 
  // Accessor and mutator for the member m_drawToFrontBuffer
  void setDrawToFrontBuffer( SbBool enable );
  SbBool getDrawToFrontBuffer() const;
 
  // Accessor and mutator for the member m_colorMap
  void setColorMap( unsigned long colorMap );
  unsigned long getColorMap() const;
 
  // ----------------------- Extension usage -----------------------------------
 
  // sets/gets the size of the glx widget(s) - Note this size could be
  // different from the SoXtComponent::getSize() method which return
  // the size of the component, not necessary the same as the glx widget
  // window (because of extra stuff like the decoration in the viewers).
  void setGlxSize( SbVec2s newSize );
  const SbVec2s& getGlxSize() const;
 
  SbBool isStereoBuffer();
 
  // returns TRUE if main window is in rgb mode (FALSE if color index)
  SbBool isRGBMode();
 
  // return the graphic config template from field gcTemplate.
  void setGraphicConfigTemplate( SoGLGraphicConfigTemplate* gc );
  SoGLGraphicConfigTemplate* getGraphicConfigTemplate();
 
  // setup system dependent GLWidget handles.
  void setGLWidgetHandle( const void* glWidgetHandle,
                          soGUIDependentCB swapBufferCB,
                          soGUIDependentCB bindCurrentCB,
                          soGUIDependentCB unbindCurrentCB,
                          soGUIWindowDependentCB getNormalCB,
                          soGUIWindowDependentCB getDisplayCB = NULL);
 
  // These call are internal public to let IvTune to access them.
  // handle on GLWidget handle/function comming from system independent GUI
  // initialized through setGLWidgetHandle;
  static soGUIDependentCB swapNormalBuffersCB;
  static soGUIDependentCB bindNormalCurrentCB;
  static soGUIDependentCB unbindNormalCurrentCB;
  static soGUIWindowDependentCB getNormalWindowCB;
  static soGUIWindowDependentCB getCurrentDisplayCB;
  void * m_glWidgetHandle;
 
  virtual void* getNormalWindow() { return getNormalWindowCB(m_glWidgetHandle); }
  virtual void* getDisplay() { return getCurrentDisplayCB(m_glWidgetHandle); }
 
  virtual SbBool bindNormalContext();
  virtual SbBool unbindNormalContext();
 
  bool onAntialiasingSwitch(const SoSceneManager::AntialiasingMode& mode, const float& quality, const SoAntialiasingParameters* parameters);
 
 
 
private:

  virtual ~SoGuiGLWidget();
 
  SiAntialiasingEventListener* getAntialiasingListener() const;
 
// ----------------------- Private usage -------------------------------------
 
private:
 
  // Used by deprecated Antialiasing API
  SoAntialiasingParameters* m_fsaaParameters;
 
  // local vars
  SbVec2s m_glxSize; // size of glx widgets which is always up to date
  int m_glModes;
  int m_borderSize;
 
  SoGLFormat m_format;
  FormatChangeCallback m_formatChangeCallback;
  void* m_formatChangeCallbackUserData;
  
  unsigned long m_colorMap; // set when color index is used
  int m_colorMapSize;
 
  SbBool m_drawToFrontBuffer; // used by RA to draw new scenes to front buffer
  SbBool m_enableDrawToFrontBuffer;
 
  unsigned long m_transparentPixel;
  
  bool m_isRemoteRendering;
 
  int m_snapshotFBOId;
 
  SoGLGraphicConfigTemplate* m_gcTemplate;
 
  SiAntialiasingEventListener* m_antialiasingListener;
};
 
 
#endif // SO_GUI_GL_WIDGET_H