Inventor/Gui/SoGuiRenderArea.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 (Jun 2007)
**=======================================================================*/

#ifndef SO_GUI_RENDER_AREA_H
#define SO_GUI_RENDER_AREA_H

//
//  Class: SoGuiRenderArea
//
// SoXXRenderArea implementation class
//
//

#include <Inventor/Gui/SoGuiGLWidget.h>
#include <Inventor/nodes/SoCamera.h> // stereo settings
#include <Inventor/nodes/SoFullSceneAntialiasing.h>
#include <Inventor/SbElapsedTime.h>
#include <Inventor/actions/SoGLRenderAction.h>

class SoNode;
class SoFrameGrabber;
class SbThreadSemaphore;
class ScTracking;
class SoSelection;
class SoMPEGRenderer;

#ifndef HIDDEN_FROM_DOC
typedef void (*soSelectionChangeCB)(void *, SoSelection* data);
#endif


class  SoGuiRenderArea : public SoGuiGLWidget
{
#ifndef HIDDEN_FROM_DOC
 SO_FIELDCONTAINER_HEADER( SoGuiRenderArea );
#endif

private:
 SoSFVec2i32 position;
 SoSFVec2i32 globalPosition;
 SoSFFieldContainer sceneManager;
 SoSFBool stereoAbsoluteAdjustments;
 SoSFFloat stereoOffset;
 SoSFFloat stereoBalance;
 SoSFBool stereoNearFrac;
 SoSFBool stereoReversed;

 SoSFFieldContainer cameraBase;

 SoGuiRenderArea();
 SoGuiRenderArea( bool sync );

 virtual void setSceneGraph( SoNode* newScene );

 virtual SoNode* getSceneGraph();

 void setOverlaySceneGraph( SoNode* newScene );

 SoNode* getOverlaySceneGraph();

 void setBackgroundColor( const SbColor& c );

 const SbColor& getBackgroundColor() const;

 void setBackgroundIndex( int index );

 int getBackgroundIndex() const;

 void setOverlayBackgroundIndex( int index );

 int getOverlayBackgroundIndex() const;

 void setViewportRegion( const SbViewportRegion& newRegion );

 const SbViewportRegion& getViewportRegion() const;

 void setTransparencyType( SoGLRenderAction::TransparencyType type );

 SoGLRenderAction::TransparencyType getTransparencyType() const;

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

 SoGLRenderAction::FastEditSavePolicy getFastEditSavePolicy() const;

 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 );

 SbBool isClearBeforeRender() const;

 SbBool isClearZBufferBeforeRender() const;

 void setClearBeforeOverlayRender( SbBool trueOrFalse );

 SbBool isClearBeforeOverlayRender() const;

 void setAutoRedraw( SbBool trueOrFalse );

 SbBool isAutoRedraw() const;

 void setRedrawPriority( uint32_t priority );

 uint32_t getRedrawPriority() const;

 static uint32_t getDefaultRedrawPriority();


  void setSceneManager( SoSceneManager* sm );

 SoSceneManager* getSceneManager() const;

 void setOverlaySceneManager( SoSceneManager* sm );

 SoSceneManager* getOverlaySceneManager() const;

 void setGLRenderAction( SoGLRenderAction* ra );

 SoGLRenderAction* getGLRenderAction() const;

 void setOverlayGLRenderAction( SoGLRenderAction* ra );

 SoGLRenderAction* getOverlayGLRenderAction() const;

 static SbVec2s getDefaultSize();

  SbBool invokeAppCB( const SoEvent* anyevent );

  virtual void notifyRedraw();
  virtual void signalRedraw();
  virtual void cleanRedraw();

  virtual void notify( SoNotList* );

  virtual void showDirectVizDialog( SbBool show );

  virtual void setMPEGRecorder( SoMPEGRenderer* recorder );

  virtual SoMPEGRenderer* getMPEGRecorder() const;

  // ----------------------- Extension usage -----------------------------------

 void setStereoMode( SoCamera::StereoMode stMode );
 void setStereoElement();

 void setRedrawing( SbBool redrawing );
 SbBool isRedrawing() const;

 SbBool isInteractive() const;

 void setStereoOffset( float offset );
 float getStereoOffset() const;

 void setStereoReversed( SbBool reverse );
 SbBool getStereoReversed() const;

 void setStereoAbsoluteAdjustments( SbBool absolute );
 SbBool getStereoAbsoluteAdjustments() const;

 void setStereoBalance( float balance, SbBool nearFrac = false );
 float getStereoBalance() const;
 SbBool isStereoBalanceNearFrac() const;

 virtual void setDoubleBufferRA(SbBool db);

 virtual void actualRedraw();
 virtual void actualOverlayRedraw();

 virtual void initGraphic();
 void redrawCleanUp();

 void activate();             // connects the sensor
 void deactivate();           // disconnects the sensor

 void posChanged( const SbVec2i32& newPos, const SbVec2i32& newGPos );

 void setFrameGrabber( SoFrameGrabber* grabber );
 SoFrameGrabber* getFrameGrabber() const;

  //static void asyncPaintSensorCB( void *data, SoSensor * );

  //SoOneShotSensor *m_asyncPaintSensor;

  // called at the begining of redraw call
  void preRedraw();

  // called at the end of redraw call
  virtual void postRedraw();

  // call when selection changed
  void redrawOnSelectionChange( SoSelection* s );

  // call when overlay selection changed
  void redrawOverlayOnSelectionChange( SoSelection* s );


  // setup system dependent renderArea handles.
  void setRenderAreaHandle(const void *renderAreaHandle, soSelectionChangeCB _selectionChangedCB, soSelectionChangeCB _overlaySelectionChangedCB);
  void *m_renderAreaHandle;
  soSelectionChangeCB selectionChangeCB;
  soSelectionChangeCB overlaySelectionChangeCB;

  inline SoFrameGrabber* getGrabber() const;

  unsigned int getFPSCount();


  // Method related to dynamic loaded libraries (RemoteViz and DirectViz)
  SoFieldContainer* remoteNewInstance();
  void remoteCreateViewer( bool );
  void remoteDeleteViewer();
  void remoteIncRequest();
  void remoteSetViewport( const SbVec2i32& );
  void remoteSetInteraction( bool );
  int remoteGetLossyMode();
  void remoteChangeColorMask();
  void remoteResizeViewer();
  void remoteMoveViewer();
  void remoteSetComposing( bool );
  void remoteExecute( const SbVec4s&, const SbVec4i32&, const SbVec4i32& );
  bool remoteIsComposing();
  static void remoteApplyVncColorMask( const SbColor& color );
  static bool remoteMustDraw();
  static bool remoteIsClientConnected();

  static int directvizGetShortcutValue();
  static bool directvizIsLoadedGui( bool );
  static void* directvizGetViewer();
  static void directvizSetViewer( void* );
  static void directvizShowDialog( bool, SoNode*, SoGuiBase* );
  static void directvizHideDialog( bool );
  static void directvizDeleteDialog();
  static bool directvizCheck();
  static SoNode* directvizGetInstance(SoSceneManager*);
  static void directvizInternalEnable( SbBool, SoSceneManager*, SoCamera*, SoNode*, SoGuiBase* );
  static void directvizSetCamera( SoSceneManager*, SoCamera*, SoNode* );

private:

  virtual ~SoGuiRenderArea();

  int m_interactiveCount;
  unsigned int m_fpsCount;
  SbElapsedTime m_fpsTimer;
  double m_previousfpsTime;
  bool m_usefpsCallback;

  // MPEG recording
  SoMPEGRenderer* m_mpegRenderer;

// ----------------------- Private usage -------------------------------------
private:
  void commonConstructor();

  // these make rendering/redrawing happen
  SoSceneManager* m_sceneMgr;      // this manages rendering and events
  SoSceneManager* m_overlaySceneMgr; // manages the overlay scene graph
  SbBool m_autoRedraw;     // if TRUE, then we automatically redraw
  SbBool m_clearFirst, m_clearOverlayFirst;  // call clear() before rendering
  SbBool m_clearZBufferFirst;      // clear ZBuffer before rendering
  SbBool m_isRedrawing;
  SoFrameGrabber* m_grabber;
  ScTracking* m_tracking;
  SoCamera* m_cameraBase;

  SoSelection* selection, *overlaySelection;

  // Floating point rendering
  SbBool m_isFloatingPointRendering;
  FloatColorBufferSize m_floatingPointRenderingPrecision;

  // stereo adjustment
  SoCamera::StereoMode m_stereoMode;

  SbThreadSemaphore* m_redrawSem;
};

SoFrameGrabber* SoGuiRenderArea::getGrabber() const
{
  return m_grabber;
}

inline unsigned int
SoGuiRenderArea::getFPSCount()
{
  return m_fpsCount;
}

#endif // SO_GUI_RENDER_AREA_H

---

Open Inventor Toolkit reference manual, generated on 22 Jul 2025
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/