SoQtRenderArea.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      : Author(s) (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
** Modified by : Alain Dumesny (MMM yyyy)
**=======================================================================*/
 
 
#ifndef _SO_QT_RENDERAREA_
#define _SO_QT_RENDERAREA_
 
#include <Inventor/Qt/OivQtCompat.h>
#include <Inventor/Qt/SoQtGLWidget.h>
 
#include <Inventor/SbColor.h>
#include <Inventor/SoSceneManager.h>
#include <Inventor/actions/SoGLRenderAction.h>
#include <Inventor/nodes/SoCamera.h> // stereo settings
#include <Inventor/SbElapsedTime.h>
 
#include <Inventor/Gui/SoGuiRenderArea.h>
 
class SoSelection;
class SoQtDevice;
class SoNode;
class SoQtMouse;
class SoQtKeyboard;
class SoQtRenderArea;
class SoGuiAlgoViewers;
class SoTimerSensor;
class SoAntialiasingParameters;

typedef SbBool SoQtRenderAreaEventCB( void* userData, QEvent* anyevent );

typedef SbBool SoQtRenderAreaRenderCB( void* userData, SoQtRenderArea* rendArea );

class  SoQtRenderArea : public SoQtGLWidget
{
  Q_OBJECT
 
public: 
  SoQtRenderArea( QWidget* parent = NULL,
                  const char* name = NULL,
                  SbBool buildInsideParent = TRUE,
                  SbBool getMouseInput = TRUE,
                  SbBool getKeyboardInput = TRUE );
  ~SoQtRenderArea();

  virtual void setSceneGraph( SoNode* newScene );

  virtual SoNode* getSceneGraph();

  void registerDevice( SoQtDevice* d );

  void unregisterDevice( SoQtDevice* d );

  void setBackgroundColor( const SbColor& c );

  SbColor getBackgroundColor() const { return m_guiRenderArea->getBackgroundColor(); }

  void setBackgroundIndex( int index ) { m_guiRenderArea->setBackgroundIndex( index ); }

  int getBackgroundIndex() const { return m_guiRenderArea->getBackgroundIndex(); }

  void setViewportRegion( const SbViewportRegion& newRegion )
  { m_guiRenderArea->setViewportRegion( newRegion ); }

  const SbViewportRegion &getViewportRegion() const
    { return m_guiRenderArea->getViewportRegion(); }
    
  void setTransparencyType( SoGLRenderAction::TransparencyType type );

  SoGLRenderAction::TransparencyType  getTransparencyType() const
    { return m_guiRenderArea->getTransparencyType(); }

  void setFastEditSavePolicy( SoGLRenderAction::FastEditSavePolicy policy,
                              SbBool fastEditDelayedObjects = FALSE);

  SoGLRenderAction::FastEditSavePolicy  getFastEditSavePolicy() const
    { return m_guiRenderArea->getFastEditSavePolicy(); }

  void setInvalidateCacheMode( SoGLRenderAction::InvalidateCacheMode icm );
   
  SoGLRenderAction::InvalidateCacheMode getInvalidateCacheMode();

  void setClearBeforeRender( SbBool trueOrFalse, SbBool zbTrueOrFalse = TRUE )
  { m_guiRenderArea->setClearBeforeRender( trueOrFalse, zbTrueOrFalse ); }

  SbBool isClearBeforeRender() const { return m_guiRenderArea->isClearBeforeRender(); }

  SbBool isClearZBufferBeforeRender() const { return m_guiRenderArea->isClearZBufferBeforeRender(); }
    
  void setAutoRedraw( SbBool trueOrFalse );

  SbBool isAutoRedraw() const { return m_guiRenderArea->isAutoRedraw(); }
    
  void setRedrawPriority( uint32_t priority ) { m_guiRenderArea->setRedrawPriority( priority ); }

  uint32_t getRedrawPriority() const { return m_guiRenderArea->getRedrawPriority(); }

  static uint32_t getDefaultRedrawPriority() { return SoSceneManager::getDefaultRedrawPriority(); }

  void render() { redraw(); }

  void scheduleRedraw();
    
  void redrawOnSelectionChange( SoSelection* s );
    
  void setEventCallback( SoQtRenderAreaEventCB *fcn, void* userData = NULL );

  void setSceneManager( SoSceneManager* sm );

  SoSceneManager* getSceneManager() const { return m_guiRenderArea->getSceneManager(); }
    
  void setGLRenderAction( SoGLRenderAction* ra );

  SoGLRenderAction* getGLRenderAction() const { return m_guiRenderArea->getGLRenderAction(); }

  const SbGLShareContext getShareContext();

  void setPostRenderCallback( SoQtRenderAreaRenderCB *fcn, void* userData = NULL )
    { appPostRenderCB = fcn; appPostRenderData = userData; }

  SoQtRenderAreaRenderCB *getPostRenderCallback( const void* &userData ) const
    { userData = appPostRenderData; return appPostRenderCB; }

  void sendEvent( QEvent* anEvent );

  virtual void setMPEGRecorder( SoMPEGRenderer* recorder )
  { m_guiRenderArea->setMPEGRecorder( recorder ); }

  virtual SoMPEGRenderer* getMPEGRecorder() const
  { return m_guiRenderArea->getMPEGRecorder(); }
 
private:
  SoQtRenderArea( QWidget* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SoGuiAlgoViewers* guiAlgos );
 
  SoQtRenderArea( QWidget* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput, 
                  SbBool buildNow,
                  SbBool sync,
                  SoGuiAlgoViewers* guiAlgos );
 
  SoQtRenderArea( QWidget* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput, 
                  SbBool buildNow,
                  SoGuiAlgoViewers* guiAlgos );

  SoGuiAlgoViewers* getGuiAlgoViewers() const { return (SoGuiAlgoViewers*)m_guiRenderArea; }
 
private:
  SoGuiRenderArea* getGuiRenderArea() const;
 
  void setStereoMode( SoCamera::StereoMode stMode );
  void setStereoElement();
  virtual SbBool isInteractive() const;
  void redrawCleanUp(); //replace some goto in the previous function
 
  SoQtRenderArea( QWidget* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow,
                  SbBool sync );
 
  //These members shouldn't be used directly, instead call their accessors
  float stereoBalance, stereoOffset;
  SbBool stereoAbsoluteAdjustments;
  SoCamera::StereoMode stereoMode;
  SbBool stereoReversed;
 
 private:
  
  //
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoQtRenderArea::buildWidget()
  // when they are ready for it to be built.
 
  SoQtRenderArea( QWidget* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow );
 
  //Constructors provided to avoid multiple instance of implementation objects
  //Equivalent to the public constructor
  SoQtRenderArea( QWidget* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SoGuiRenderArea* guiRenderArea );
 
  SoQtRenderArea( QWidget* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow,
                  SbBool sync,
                  SoGuiRenderArea* guiRenderArea );
 
  SoQtRenderArea( QWidget* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow,
                  SoGuiRenderArea* guiRenderArea );
 
  // redraw() calls actualRedraw(), followed by swapbuffers if necessary.
  // actualRedraw will have the scene manager render the scene. Rendering
  // is broken up into two routines like this so that subclasses can
  // redefine or simply add to rendering (in actualRedraw) without having
  // to worry about being visible, seting up the window or
  // single/double buffer swapping.
  //
  virtual void        redraw();
  virtual void        actualRedraw();
 
  //
  // Redefine these to do Inventor-specific things
  //
  virtual void processEvent( QEvent* anyevent );
  virtual void initGraphic();
  virtual void sizeChanged( const SbVec2s& );
  virtual void posChanged( const SbVec2i32&, const SbVec2i32& );
  virtual void widgetChanged( QWidget* w );
 
  QWidget* buildWidget(QWidget* parent);
    
  // redefine these
  virtual SbString getDefaultWidgetName() const;
  virtual SbString getDefaultTitle() const;
  virtual SbString getDefaultIconTitle() const;
    
  // subclasses have access to the device list for event processing
  SbPList* m_deviceList;    // list of devices
    
  // static callbacks
  static void renderCB( void* v, SoSceneManager* sm );
 
  // application event callbacks variables
  SoQtRenderAreaEventCB    *defaultAppEventHandler;
  void                   *defaultAppEventHandlerData;
  SoQtRenderAreaEventCB    *appEventHandler;
  void                   *appEventHandlerData;
 
  // invoke the application event callback - returns what the app cb returns
  SbBool invokeAppCB( QEvent* anyevent );
  SbBool processInventorEvent( QEvent* anyevent );
  const SoEvent* translateAnyEvent( QEvent* anyevent );
 
  // application pre/post render callback variables
  SoQtRenderAreaRenderCB *appPostRenderCB;
  void                    *appPostRenderData;
 
  // This function is overloaded to set the window element
  void onFocusEvent(SbBool hasFocus);
 
private:
 
  // these make rendering/redrawing happen
#if defined(__linux__)
  XColorPointer m_mapColors; // saved colors
  int m_mapColorNum; // number of saved colors
#endif
 
  SoQtMouse* m_mouseDevice;
  SoQtKeyboard* m_keybdDevice;
  void reinstallDevices( QWidget* newWidget );
    
  static void selectionChangeCB( void* userData, SoSelection* s );
  QWidget* m_deviceWidget;
 
  SbBool m_firstEvent;
 
  void activate();             // connects the sensor
  void deactivate();           // disconnects the sensor
 
  // this is called by constructors
  void constructorCommon( SbBool getMouseInput,
                          SbBool getKeyboardInput,
                          SbBool buildNow );
  // this is called by constructorCommon
  void constructorCommon2( SbBool getMouseInput,
                           SbBool getKeyboardInput,
                           SbBool buildNow );
 
  SbVec2i32 getWindowPosition();
 
  QPoint m_oldPos;
  QSize m_oldSize;
  QSize m_minimumSize;
  QSize m_maximumSize;
 
  SoGuiRenderArea* m_guiRenderArea; // Implementation class for SoXxRendeArea
 
  // this is the default implementation of the hasRenderAbortCallback passed to the scenemanager
  // at construction. Implementation is common to all created renderArea.
  // If an event is received to one renderArea, all renderArea of the process will consider it as
  // a candidate for abortion (only implemented on Windows)
  static SbBool s_abortRenderCallback(SoAction*,void*);
 
  bool m_firstStdRedraw;
  bool m_firstConnectedRedraw;
  SoTimerSensor* m_viewerUpdaterSensor;
  static void viewerUpdaterCB( void*, SoSensor* );
  void updateFirstFrame();
 
  SoAntialiasingParameters* m_accumulationParameters;
 
  private Q_SLOTS:
    void visibilityChangeCB( SbBool visible );
 
};
 
 
#endif // _SO_QT_RENDERAREA_