SoWinRenderArea.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      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef _SO_WIN_RENDER_AREA_H_
#define _SO_WIN_RENDER_AREA_H_
 
#include <Inventor/Win/SoWinBeginStrict.h>
#include <windows.h>
#include <Inventor/Win/SoWinDef.h>
 
#include <climits>
 
#include <Inventor/SbColor.h>
#include <Inventor/sensors/SoNodeSensor.h>
#include <Inventor/SoSceneManager.h>
#include <Inventor/Win/SoWinGLWidget.h>
#include <Inventor/actions/SoGLRenderAction.h>
 
#include <Inventor/nodes/SoCamera.h> // stereo settings
#include <Inventor/elements/SoStereoElement.h>
#include <Inventor/nodes/SoFullSceneAntialiasing.h>
#include <Inventor/SbElapsedTime.h>
 
 
#include <Inventor/Gui/SoGuiRenderArea.h>
 
class SoHandleEventAction;
class SoWinDevice;
class SoNode;
class SoWinMouse;
class SoWinKeyboard;
class SoSelection;
class SoWinRenderArea;
class SoGuiAlgoViewers;
class SoAntialiasingParameters;

typedef SbBool SoWinRenderAreaEventCB( void* userData, XAnyEvent* anyevent );

typedef SbBool SoWinRenderAreaRenderCB( void* userData, SoWinRenderArea* rendArea );

//
//  Class: SoWinRenderArea
//
//  Class to do Inventor rendering in a GLX Motif widget.
//

class  SoWinRenderArea : public SoWinGLWidget
{
 public:

  SoWinRenderArea( SoWidget parent = NULL,
                   const char* name = NULL,
                   SbBool buildInsideParent = TRUE,
                   SbBool getMouseInput = TRUE,
                   SbBool getKeyboardInput = TRUE );
  ~SoWinRenderArea();

  virtual void setSceneGraph( SoNode *newScene );

  virtual SoNode* getSceneGraph();

  void registerDevice( SoWinDevice* d );
  void unregisterDevice( SoWinDevice* 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 setColorMap( int startIndex, int num, const SbColor* colors );

  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( unsigned long priority ) { m_guiRenderArea->setRedrawPriority(priority); }

  unsigned long getRedrawPriority() const { return m_guiRenderArea->getRedrawPriority(); }

  static unsigned long getDefaultRedrawPriority() { return SoSceneManager::getDefaultRedrawPriority(); }

  void render() { redraw(); }

  void scheduleRedraw();

  void redrawOnSelectionChange( SoSelection* s );

  void setEventCallback( SoWinRenderAreaEventCB* 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( SoWinRenderAreaRenderCB* fcn, void* userData = NULL )
    { appPostRenderCB = fcn; appPostRenderData = userData; }

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

  void sendEvent( XAnyEvent* anEvent );

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

  virtual SoMPEGRenderer* getMPEGRecorder() const
  { return m_guiRenderArea->getMPEGRecorder(); }
 
private:
  SoWinRenderArea( SoWidget parent,
                   const char* name, 
                   SbBool buildInsideParent, 
                   SbBool getMouseInput,
                   SbBool getKeyboardInput,
                   SoGuiAlgoViewers* guiAlgos );
 
  //Equivalent to the SoExtender constructor
  SoWinRenderArea( SoWidget parent,
                   const char* name, 
                   SbBool buildInsideParent, 
                   SbBool getMouseInput,
                   SbBool getKeyboardInput, 
                   SbBool buildNow,
                   SbBool sync,
                   SoGuiAlgoViewers* guiAlgos );
 
  //Equivalent to the protected constructor
  SoWinRenderArea( SoWidget 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 void setDoubleBuffer( SbBool db );
 
  virtual SbBool isInteractive() const;
 
  SoWinRenderArea( SoWidget parent,
                   const char* name,
                   SbBool buildInsideParent,
                   SbBool getMouseInput,
                   SbBool getKeyboardInput,
                   SbBool buildNow,
                   SbBool sync );
 
  // Retro compatibility only.
  // 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 SoWinRenderArea::buildWidget()
  // when they are ready for it to be built.
 
  SoWinRenderArea( SoWidget 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
  SoWinRenderArea( SoWidget parent,
                   const char* name,
                   SbBool buildInsideParent,
                   SbBool getMouseInput,
                   SbBool getKeyboardInput,
                   SoGuiRenderArea* guiRenderArea );
 
  //Equivalent to the SoExtender constructor
  SoWinRenderArea( SoWidget parent,
                   const char* name,
                   SbBool buildInsideParent,
                   SbBool getMouseInput,
                   SbBool getKeyboardInput,
                   SbBool buildNow,
                   SbBool sync,
                   SoGuiRenderArea* guiRenderArea );
 
  //Equivalent to the protected constructor
  SoWinRenderArea( SoWidget 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( XAnyEvent* anyevent );
  virtual void initGraphic();
  virtual void sizeChanged( const SbVec2s& );
  virtual void posChanged( const SbVec2i32&, const SbVec2i32& );
  virtual void widgetChanged( SoWidget );
 
  SoWidget buildWidget( SoWidget 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
 
  // application event callbacks variables
  SoWinRenderAreaEventCB *defaultAppEventHandler;
  void                   *defaultAppEventHandlerData;
  SoWinRenderAreaEventCB *appEventHandler;
  void                   *appEventHandlerData;
  // invoke the application event callback - returns what the app cb returns
  SbBool invokeAppCB( XAnyEvent* anyevent );
  SbBool processInventorEvent( XAnyEvent* anyevent );
  const SoEvent* translateAnyEvent( XAnyEvent* anyevent );
 
  // application pre/post render callback variables
  SoWinRenderAreaRenderCB *appPostRenderCB;
  void                    *appPostRenderData;
 
private:
#if defined(__linux__)
  XColor* m_mapColors; // saved colors
  int m_mapColorNum; // number of saved colors
#endif
 
  SoWinMouse* m_mouseDevice;
  SoWinKeyboard* m_keybdDevice;
  void reinstallDevices( SoWidget newWidget );
 
  static void selectionChangeCB( void* userData, SoSelection* s );
  SoWidget m_deviceWidget;
 
  // static callbacks
  SbBool m_firstEvent;
 
private:
  static void windowEventCB( SoWidget w, SoWinRenderArea* wra, XAnyEvent* e, Boolean* b );
private:
  static void renderCB( void* v, SoSceneManager* sm );
 
  static void visibilityChangeCB( void* pt, SbBool visible );
 
  // 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 );
 
  void activate();
  void deactivate();
 
  SbVec2i32 getWindowPosition() { return SbVec2i32( INT_MAX, INT_MAX ); }
 
  int inRedraw;
 
  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*);
 
  SoAntialiasingParameters* m_accumulationParameters;
 
  bool m_firstStdRedraw;
  bool m_firstConnectedRedraw;
  SoTimerSensor* m_viewerUpdaterSensor;
  static void viewerUpdaterCB( void*, SoSensor* );
  void updateFirstFrame();
 
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif /* _SO_WIN_RENDER_AREA_H_ */