SoXtGLWidget.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
#ifdef SOQT
#  include <Inventor/Qt/SoQtGLWidget.h>
#elif defined _WIN32
#  include <Inventor/Win/SoWinGLWidget.h>
#else // _WIN32
 
#ifndef _SO_XT_GL_WIDGET_H_
#define _SO_XT_GL_WIDGET_H_
 
#include <X11/Intrinsic.h>
#include <Inventor/helpers/SbGlContextHelper.h>
#include <Inventor/Xt/SoXtComponent.h>
#include <Inventor/components/SoGLGraphicConfigTemplate.h>
#include <Inventor/components/SoGLGraphicDevice.h>
#include <Inventor/components/SoGLGraphicConfig.h>
#include <Inventor/devices/SoGLFormat.h>
#include <Inventor/threads/SbThread.h>
#include <Inventor/nodes/SoFullSceneAntialiasing.h>
 
#include <Inventor/Gui/SoGuiGLWidget.h>
#include <Inventor/devices/SoGLContext.h>
 
class SoXtRemoteRenderInfo;

//
// Class: SoXtGLWidget
//
//

class  SoXtGLWidget : public SoXtComponent
{
 
 public:

   enum FloatColorBufferSize
   {
    FLOAT_16_COLOR_BUFFER = SoGuiGLWidget::FLOAT_16_COLOR_BUFFER,
    FLOAT_32_COLOR_BUFFER = SoGuiGLWidget::FLOAT_32_COLOR_BUFFER
  };

  int getColorMapSize();

  virtual Window getNormalWindow();

  SbGlContextHelper::GLContext  getNormalContext() const;
 
  SoGLContext* getNormalSoContext() const;

  SoWidget getNormalWidget() const;

  virtual void setNormalVisual( XVisualInfo* vis );

  XVisualInfo* getNormalVisual();

  virtual void setDoubleBuffer( SbBool onOrOff );

  SbBool isDoubleBuffer();

  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 setBorder( SbBool onOrOff );

  SbBool isBorder() const { return m_guiGLWidget->isBorder(); }

  void setDrawToFrontBufferEnable( SbBool enableFlag );

  SbBool isDrawToFrontBufferEnable() const { return m_guiGLWidget->isDrawToFrontBufferEnable(); }

  virtual SbBool bindNormalContext();

  virtual SbBool unbindNormalContext();

  virtual SbBool swapNormalBuffers();

  SoGLGraphicConfigTemplate* getGraphicConfigTemplate();

  void setGraphicConfigTemplate( SoGLGraphicConfigTemplate* gTemplate );

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

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

  static SbBool isFloatingColorBufferSupported();

  bool saveSnapshot( const SbString& filename, bool overwrite = true );
 
private:
 
  // Starting with version 3.0, subclasses should no longer make direct
  // calls to glXMakeCurrent, glXSwapBuffers and glFlush.
  // For RemoteRendering we need to know when MakeCurrent is called
  // (marking the beginning of a frame) and when SwapBuffers or glFlush
  // is called (marking the end of a frame).
  // Subclasses should always use these generic methods.
  void   flush();
 
  // Pbuffers are a limited resource.  By default use of Pbuffers for
  // remote rendering is enabled, but it might make sense to disable
  // it for less important windows (like UI components drawn with OpenGL).
  // Must be called after creating the widget but before it is realized.
  void setRemoteRenderPbufferEnable( SbBool enable ) { m_remoteRenderPbufferEnable = enable; }
  SbBool isRemoteRenderPbufferEnable() const { return m_remoteRenderPbufferEnable; }
 
  float getLowResPercent() { return m_lowResPercent; }
 
  // check if the context is direct
  SbBool ctxIsDirect();
 
 private:
 
  // Synchronise current properties from this object with the current configuration.
  void syncFromCurrentConfig();
 
  // Synchronise the current template with current properties from this object.
  void syncToCurrentConfigTemplate( XVisualInfo* newvis );
 
  SbBool currentGraphicConfigTemplateIsUsed;
  SoGLGraphicConfigTemplate currentGraphicConfigTemplate;
 
  // Gets the current graphic device.
  SoGLGraphicDevice* getGraphicDevice();
 
  // Gets the current graphic configuration.
  SoGLGraphicConfig* getGraphicConfig();
 
  SbBool isFsaaSupportHighQuality();
  SbBool isFsaaHighQuality();
 
  SoGuiGLWidget* getGuiGLWidget() const;
 
  // returns the display lists share group for given context:
  int getDisplayListShareGroup( SoGLContext* ctx );
 
  // These variables are  public for retro compatibility purposes only.
  // Do not use them directly but call their accessors instead;
  SbBool drawToFrontBuffer;
 
  // These two function are used by SoGui, to call the system dependent version of
  // these functions. data is a SoWinGLWidget handle.
  static SbBool swapNormalBuffersCB(void *data);
  static SbBool bindNormalCurrentCB(void *data);
  static SbBool unbindNormalCurrentCB(void *data);
  static void* getNormalWindowCB(void *data);
  static void* getCurrentDisplayCB(void *data);
 
 private:
 
  // Update the current device and disable the current configuration.
  // If the given display is the same than the current device, the current
  // device is kept and the current configuration is updated with the
  // current template.
  // If the given display is NULL, the current device and configuration are
  // freed and set to NULL.
  void updateCurrentDeviceAndConfig( Display* display );
 
  SbBool currentGraphicConfigIsUsed;
  SoGLGraphicConfig* currentGraphicConfig;
  SbBool currentGraphicDeviceIsUsed;
  SoGLGraphicDevice* currentGraphicDevice;
 
  // Subclasses can pass in a bitwise OR specifying the GL modes
  // (e.g. SO_GLX_RGB | SO_GLX_DOUBLE | SO_GLX_ZBUFFER)
  // If buildNow is FALSE, this will not build its widget tree until
  // buildWidget() is explicity called; else, buildWidget() is called here.
  SoXtGLWidget( SoWidget parent = NULL,
                const char* name = NULL,
                SbBool buildInsideParent = TRUE,
                int glModes = SO_GLX_RGB | SO_GLX_ZBUFFER | SO_GLX_STENCIL,
                SbBool buildNow = TRUE,
                SbBool sync = TRUE );
  SoXtGLWidget( SoWidget parent,
                const char* name,
                SbBool buildInsideParent,
                int glModes,
                SbBool buildNow,
                SbBool sync,
                SoGuiGLWidget* guiGLWidget );
 
  virtual ~SoXtGLWidget();
 
  // subclasses MUST redefine redraw() to draw in the normal bit planes.
  // processEvent() should be defined if X events are being received (see eventMask).
  virtual void redraw() = 0;
  virtual void processEvent( XAnyEvent* anyevent );
 
  // subclasses can redefine these to do something useful.
  // initGraphic() is called whenever a GLX window gets created
  // sizeChanged() is called whenever the window changes size
  // widgetChanged() is called whenever the widget is changed (i.e. at
  // initialization or after switching from single->double buffer)
  virtual void initGraphic();
  virtual void sizeChanged( const SbVec2s& );
  virtual void posChanged( const SbVec2i32&, const SbVec2i32& );
  virtual void widgetChanged( SoWidget newWidget );
 
  // 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 { return m_guiGLWidget->getGlxSize(); }
 
  // subclasses can use this routine as the event handler for any
  // devices they wish to get input from.
  static void eventHandler( SoWidget w, SoXtGLWidget* p, XAnyEvent* xe, Boolean* b );
 
  // set/get stereo buffering visual. This routine (like setDoubleBuffer)
  // can be called interactively, althought slower since a new window
  // with the needed visual is always created on the fly.
  void setStereoBuffer( SbBool flag );
  SbBool isStereoBuffer() { return (m_guiGLWidget->getGLModes() & SO_GLX_STEREO); }
 
  // returns TRUE if main window is in rgb mode (FALSE if color index)
  SbBool isRGBMode() { return (m_guiGLWidget->getGLModes() & SO_GLX_RGB); }
 
#if defined(__linux__)
  void allocCell( Display *display, Colormap cmap, XColor *colorcells, int ncolors, int colorMapSize );
#endif
 
  // set when color index is used
  Colormap getColorMap() const
  { return m_guiGLWidget->getColorMap(); }
 
  SbBool waitForExpose; // prevent redraws until an expose is received
 
  // make those methods protected to enable the SoXtRenderArea to use them
  // directly when it needs to build the widget and get its resources.
  SoWidget buildWidget( SoWidget parent );
  SoWidget getGlxMgrWidget() { return mgrWidget; }
 
  // ----- RemoteRender additions (v3.0) -----
  enum RemoteRenderEnabled     // Possible values for remote rendering
  {
    OFF,                      // Never use remote rendering
    ON,                       // Always try to use remote rendering
    AUTO                      // Use if remote does not support GLX (default)
  };
  RemoteRenderEnabled   m_remoteRenderMode;  // See possible values above
  SbBool                m_remoteRender;      // Is remote rendering being used?
  SoXtRemoteRenderInfo* m_remoteRenderInfo;  // Opaque type for internal state
  SbBool                m_remoteRenderPbufferEnable; // Can we use a Pbuffer?
  SbBool                m_lowResRender;      //Is Low Resolution Render Mode in use?
  float                 m_lowResLowPercent;  //lowest value of m_lowResPercent
  float                 m_lowResHighPercent; //highest value of m_lowResPercent
  float                 m_lowResPercent;    //percent of the window sent thru the network
 
  void remoteRenderInit();                // Init member vars
  void remoteRenderCleanup();             // Free allocated resources
  void remoteRenderGinitCB( SoWidget w );     // Create pixmap and other stuff
  SbGlContextHelper::GLContext remoteRenderLowResRenderGinitCB( SoWidget w ); //Same for LowResRender configuration : return Remote Context
  void remoteRenderResizeCB();            // Resize pixmap
  void remoteRenderSendImage();           // Send rendered image to remote display
  void remoteRenderSendLowResRender();    // send low Resolution image to remote display
  XVisualInfo* remoteRenderChooseVisual();        // Find visual for remote window
  void remoteRenderFatalError( const char* methodName, const char* message );
 
  void setLowResLowPercent( float percent ) { m_lowResLowPercent = percent;}
  void setLowResHighPercent( float percent ) { m_lowResHighPercent = percent;}
  float getLowResLowPercent() const { return m_lowResLowPercent;}
  float getLowResHighPercent() const { return m_lowResHighPercent;}
 
  virtual void setLowResPercent( float newLowres ) {m_lowResPercent = newLowres;}
 
  // Set/get thread this context belongs to
  SbThreadId_t dwThreadId; // thread to which this context belongs
  SbThreadId_t getThreadId() { return dwThreadId; };
  void setThreadId( SbThreadId_t id ) { dwThreadId=id; };
 
  virtual void onExpose();
 
 private:
  // local vars
  SoWidget mgrWidget;
  SoWidget m_widgetNormal;
 
  SoRef<SoGLContext> m_contextNormal;
 
  int* attribList;
 
  // specify if sizeChanged() should be called when an expose event
  // is received (as opposed to when a resize event is received, where
  // the window hasn't yet been maped to the new size).
  // ??? a GlxDraw bug ?
  SbBool windowResized;
 
  SbBool directConnection;
 
  // creates a GLX widget of the correct current type and get the current
  // set of windows, color maps, etc...
  void buildNormalGLXWidget( XVisualInfo* vis = NULL );
  void destroyNormalWindows(SbBool normalCall=TRUE);
  void destroyGLXWidget( SoWidget& w, SoRef<SoGLContext>& ctx, SbBool normalWindow );
 
  SoWidget createWindow( SoGLFormat* format );
  void destroyWindow( SoWidget widget );
 
   static SbBool onGLFormatChangeCallback( SoGLFormat& format, void* userData );
 
  // callbacks from glx widget
  static void ginitCB( SoWidget w, SoXtGLWidget* v, XtPointer p );
  static void exposeCB( SoWidget w, SoXtGLWidget* v, XtPointer p );
  static void resizeCB( SoWidget glx, SoXtGLWidget* p, XtPointer pt );
 
  int m_nPixelFormat;
 
  // Flags used when the stereo is set from environment variables.
  bool m_stereoActiveDelayed; 
  bool m_stereoBufferFlag;
 
  SbBool m_singleBufferExpected;
 
  SoGuiGLWidget* m_guiGLWidget; //Implementation class for SoXxGLWidget
 
  void constructorCommon( int glModes, SbBool buildNow );
 
  SbBool remoteRenderGinitCB_pbuffer( SoWidget w );
};
 
inline void
SoXtGLWidget::posChanged( const SbVec2i32&, const SbVec2i32& )
{}
 
#endif // _SO_XT_GL_WIDGET_H_
 
#endif // _WIN32