Inventor/Wx/SoWxRenderArea.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T.MEHAMLI (Jul 2007)
**=======================================================================*/

#ifndef SO_WX_RENDERAREA
#define SO_WX_RENDERAREA

//
//  Class: SoWxRenderArea
//

#include <Inventor/Wx/SoWxGLWidget.h>

#include <climits>

#include <Inventor/SbColor.h>
#include <Inventor/SoSceneManager.h>
#include <Inventor/sensors/SoNodeSensor.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 SoWxDevice;
class SoNode;
class SoWxMouse;
class SoWxKeyboard;
class SoWxRenderArea;
class SoGuiAlgoViewers;
class SoAntialiasingParameters;

// callback function prototypes
typedef SbBool SoWxRenderAreaEventCB( void* userData, wxEvent& anyEvent );
typedef SbBool SoWxRenderAreaRenderCB( void* userData, SoWxRenderArea* renderArea );

class  SoWxRenderArea : public SoWxGLWidget
{
public:
  SoWxRenderArea( wxWindow* parent = NULL,
                  const char *name = NULL,
                  SbBool buildInsideParent = TRUE,
                  SbBool getMouseInput = TRUE,
                  SbBool getKeyboardInput = TRUE );
  ~SoWxRenderArea();

  virtual void setSceneGraph( SoNode* newScene );

  virtual SoNode* getSceneGraph();

  void registerDevice( SoWxDevice* d );

  void unregisterDevice( SoWxDevice* d );

  void setBackgroundColor( const SbColor& c );

  const 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 setSortedTrianglesSortFrequency( int angle );

  int getSortedTrianglesSortFrequency();

  void setSortedTrianglesNumCaches( int numCaches );

  int getSortedTrianglesNumCaches();

  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( SoWxRenderAreaEventCB* fcn, void* userData = NULL );
  void setSceneManager( SoSceneManager* sm );

  SoSceneManager* getSceneManager() const { return m_guiRenderArea->getSceneManager(); }

#if 1             SoDEPRECATED
  void setOverlaySceneGraph( SoNode* newScene );
SoDEPRECATED
  SoNode* getOverlaySceneGraph() { return m_guiRenderArea->getOverlaySceneGraph(); }
SoDEPRECATED
  void scheduleOverlayRedraw();
SoDEPRECATED
  void redrawOverlayOnSelectionChange( SoSelection* s );
SoDEPRECATED
  SoSceneManager* getOverlaySceneManager() const { return m_guiRenderArea->getOverlaySceneManager(); }
#endif 
  void setGLRenderAction( SoGLRenderAction* ra );

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

  const SbGLShareContext getShareContext();

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

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

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

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

  static SbBool isFloatingColorBufferSupported();

  void sendEvent( wxEvent& anEvent );

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

  virtual SoMPEGRenderer* getMPEGRecorder() const
  { return m_guiRenderArea->getMPEGRecorder(); }

#if 1             SoDEPRECATED
  void setAntialiasing( SbBool smoothing, int numPasses );
  using SoWxGLWidget::setAntialiasing;
SoDEPRECATED
  void getAntialiasing(SbBool &smoothing, int &numPasses) const;

#endif 
private:
  SoWxRenderArea( wxWindow* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SoGuiAlgoViewers* guiAlgos );

  SoWxRenderArea( wxWindow* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput, 
                  SbBool buildNow,
                  SbBool sync,
                  SoGuiAlgoViewers* guiAlgos );

  SoWxRenderArea( wxWindow* parent,
                  const char* name, 
                  SbBool buildInsideParent, 
                  SbBool getMouseInput,
                  SbBool getKeyboardInput, 
                  SbBool buildNow,
                  SoGuiAlgoViewers* guiAlgos );
  SoGuiAlgoViewers* getGuiAlgoViewers() const { return (SoGuiAlgoViewers*)m_guiRenderArea; }

private:

  void setDoubleBuffer( SbBool db );

  SoGuiRenderArea* getGuiRenderArea() const;

  void setStereoMode( SoCamera::StereoMode stMode );
  void setStereoElement();
  virtual SbBool isInteractive() const;
  void redrawCleanUp(); //replace some goto in the previous function

  SoWxRenderArea( wxWindow* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow,
                  SbBool sync );

  void visibilityChangeCB( wxShowEvent& se );
  void onFocusEvent(SbBool hasFocus);

  // 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 SoWxRenderArea::buildWidget()
  // when they are ready for it to be built.

  SoWxRenderArea( wxWindow* 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
  SoWxRenderArea( wxWindow* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SoGuiRenderArea* guiRenderArea );

  SoWxRenderArea( wxWindow* parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SbBool getMouseInput,
                  SbBool getKeyboardInput,
                  SbBool buildNow,
                  SbBool sync,
                  SoGuiRenderArea* guiRenderArea );

  SoWxRenderArea( wxWindow* 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();
#if 1             SoDEPRECATED
  virtual void redrawOverlay();SoDEPRECATED
  virtual void actualOverlayRedraw();
#endif 
  //
  // Redefine these to do Inventor-specific things
  //
  virtual void processEvent( wxEvent& anyEvent );
  virtual void initGraphic();
  virtual void sizeChanged( const SbVec2s& );
  virtual void posChanged( const SbVec2i32&, const SbVec2i32& );
  virtual void widgetChanged( wxWindow* w );

  wxPanel* buildWidget( wxWindow* 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* data, SoSceneManager* sm );
#if 1             SoDEPRECATED
  static void renderOverlayCB( void* v, SoSceneManager* sm );
#endif 
  // application event callbacks variables
  SoWxRenderAreaEventCB* defaultAppEventHandler;
  void* defaultAppEventHandlerData;
  SoWxRenderAreaEventCB* appEventHandler;
  void* appEventHandlerData;
  // invoke the application event callback - returns what the app cb returns
  SbBool invokeAppCB( wxEvent& anyEvent );
  SbBool processInventorEvent( wxEvent& anyEvent );
  const SoEvent* translateAnyEvent( wxEvent& anyevent );

  // application pre/post render callback variables
  SoWxRenderAreaRenderCB* appPostRenderCB;
  void* appPostRenderData;

private:
  // Floating point rendering
  SbBool m_isFloatingPointRendering;
  FloatColorBufferSize m_floatingPointRenderingPrecision;

  // these make rendering/redrawing happen
  XColor* m_mapColors, *m_overlayMapColors; // saved colors
  int m_mapColorNum, m_overlayMapColorNum; // number of saved colors

  SoWxMouse* m_mouseDevice;
  SoWxKeyboard* m_keybdDevice;

  void reinstallDevices( wxWindow* newWidget );

  static void selectionChangeCB( void* userData, SoSelection* s );
  static void overlaySelectionChangeCB( void* userData, SoSelection* s );

  wxWindow* 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() { return SbVec2i32( INT_MAX, INT_MAX ); }

  wxPoint m_oldPos;
  wxSize m_oldSize;
  wxSize m_minimumSize;
  wxSize 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*);

  SbBool m_runOnce;

  bool m_firstStdRedraw;
  bool m_firstConnectedRedraw;
  SoTimerSensor* m_viewerUpdaterSensor;
  static void viewerUpdaterCB( void*, SoSensor* );
  void updateFirstFrame();

  SoAntialiasingParameters* m_accumulationParameters;
};


#endif // SO_WX_RENDERAREA

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/