Inventor/MP/Win/SoWinMPRenderArea.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      : VSG (MMM YYYY)
**=======================================================================*/



#ifndef _SO_WIN_MP_RENDER_AREA_H_
#define _SO_WIN_MP_RENDER_AREA_H_

#if defined(_WIN32)
#  include <Inventor/Win/SoWinBeginStrict.h>
#  include <windows.h>
#  ifdef _SO_QT_
#    include <wingdi.h>
#  else
#    include <Inventor/Win/SoWinDef.h>
#  endif
#else
#  include <X11/Intrinsic.h>
#  include <X11/Xlib.h>
#endif // _WIN32

#include <Inventor/SbColor.h>
#include <Inventor/sensors/SoNodeSensor.h>
#include <Inventor/SoSceneManager.h>
#include <Inventor/MP/Win/SoWinMPGLWidget.h>
#include <Inventor/actions/SoGLRenderAction.h>
#include <Inventor/threads/SbThreadBarrier.h>
#include <Inventor/threads/SbThread.h>

#include <Inventor/nodes/SoCamera.h> 
#include <Inventor/components/stereo/SoStereoViewer.h>
#include <Inventor/sensors/SoTimerSensor.h>

class   SoHandleEventAction;
class   SoWinDevice;
class   SoNode;
class   SoWinMouse;
class   SoWinKeyboard;
class   SoSelection; 

// callback function prototype
typedef SbBool SoWinMPRenderAreaEventCB(void *userData, XAnyEvent *anyevent);


class SoWinMPRenderArea;
// callback function prototype for thread initialization
typedef void SoWinMPRenderAreaThreadInitCB(void * userData, SoWinMPRenderArea *ra);

// callback function prototype for pre/post thread rendering
typedef void SoWinMPRenderAreaThreadRenderCB(void * userData, SoWinMPRenderArea *ra);

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

class  SoWinMPRenderArea : public SoWinMPGLWidget, public SoStereoViewer {
 public:
  SoWinMPRenderArea(SoWidget parent = NULL,
                    const char *name = NULL, 
                    SbBool buildInsideParent = TRUE, 
                    SbBool getMouseInput = TRUE,
                    SbBool getKeyboardInput = TRUE);

  ~SoWinMPRenderArea();
    
  virtual void            setSceneGraph(SoNode *newScene);
  virtual SoNode *        getSceneGraph();

  void                    registerDevice(SoWinDevice *d);
  void                    unregisterDevice(SoWinDevice *d);
    
  void                    setBackgroundColor(const SbColor &c)
    { sceneMgr->setBackgroundColor(c); }
  const SbColor &         getBackgroundColor() const
    { return sceneMgr->getBackgroundColor(); }
    
  void                    setBackgroundIndex(int index)
    { sceneMgr->setBackgroundIndex(index); }
  int                     getBackgroundIndex() const
    { return sceneMgr->getBackgroundIndex(); }
    
  void        setColorMap(int startIndex, int num, const SbColor *colors);
    
  // methods to reach the subWidgets viewport regions
  void    setViewportRegion(const SbViewportRegion &newRegion, int id) 
    { sceneMgr->getGLRenderAction(id)->setViewportRegion(newRegion); }
  const SbViewportRegion &getViewportRegion(int id) const
    { return sceneMgr->getGLRenderAction(id)->getViewportRegion(); }
  void    setViewportRegion(const SbViewportRegion &newRegion);
  const SbViewportRegion &getViewportRegion() const
    { return sceneMgr->getGLRenderAction(0)->getLogicalViewportRegion(); }
    
  void        setTransparencyType(SoGLRenderAction::TransparencyType type);
  SoGLRenderAction::TransparencyType  getTransparencyType() const
    { return sceneMgr->getGLRenderAction()->getTransparencyType(); }
    
  void                    setClearBeforeRender(SbBool trueOrFalse,
                                               SbBool zbTrueOrFalse = TRUE)
    { clearFirst = trueOrFalse; 
    clearZBufferFirst = zbTrueOrFalse; }
  SbBool                  isClearBeforeRender() const
    { return clearFirst; }
  SbBool                  isClearZBufferBeforeRender() const
    { return clearZBufferFirst; }

  void                    setAutoRedraw(SbBool trueOrFalse);
  SbBool                  isAutoRedraw() const { return autoRedraw; }
    
  void                setRedrawPriority(unsigned long priority)
    { sceneMgr->setRedrawPriority(priority);
    overlaySceneMgr->setRedrawPriority(priority); }
  unsigned long       getRedrawPriority() const
    { return sceneMgr->getRedrawPriority(); }
  static unsigned long getDefaultRedrawPriority()
    { return SoSceneManager::getDefaultRedrawPriority(); }

  void                    render()            { redraw(); }

  void                    scheduleRedraw();

  void                    redrawOnSelectionChange(SoSelection *s);
    
  void            setEventCallback(
                                   SoWinMPRenderAreaEventCB *fcn, 
                                   void *userData = NULL)
    { appEventHandler = fcn; appEventHandlerData = userData; }
    
  void                setSceneManager(SoSceneManager *sm);
  SoSceneManager *    getSceneManager() const { return sceneMgr; }

  void                setGLRenderAction(SoGLRenderAction *ra) 
    { 
      sizeChanged(SbVec2s(166,363));
      sceneMgr->setGLRenderAction(ra); 
    }
  SoGLRenderAction    *getGLRenderAction() const
    { return sceneMgr->getGLRenderAction(); }
  void            setGLRenderAction(SoGLRenderAction *ra, int i)
    {       sceneMgr->setGLRenderAction(ra, i); }
  SoGLRenderAction    *getGLRenderAction(int i) const
    { return sceneMgr->getGLRenderAction(i); }

#if 1             SoDEPRECATED
  void setOverlaySceneGraph( SoNode *newScene );
SoDEPRECATED
  SoNode* getOverlaySceneGraph() { return overlaySceneMgr->getSceneGraph(); }
SoDEPRECATED
  void setOverlayBackgroundIndex( int index ) { overlaySceneMgr->setBackgroundIndex( index ); }
SoDEPRECATED
  int getOverlayBackgroundIndex() const { return overlaySceneMgr->getBackgroundIndex(); }
SoDEPRECATED
  void setOverlayColorMap( int startIndex, int num, const SbColor *colors );
SoDEPRECATED
  void setClearBeforeOverlayRender( SbBool trueOrFalse ) { clearOverlayFirst = trueOrFalse; }
SoDEPRECATED
  SbBool isClearBeforeOverlayRender() const { return clearOverlayFirst; }
SoDEPRECATED
  void renderOverlay();
SoDEPRECATED
  void scheduleOverlayRedraw();
SoDEPRECATED
  void redrawOverlayOnSelectionChange( SoSelection *s );
SoDEPRECATED
  void setOverlaySceneManager( SoSceneManager *sm ) { overlaySceneMgr = sm; }
SoDEPRECATED
  SoSceneManager* getOverlaySceneManager() const { return overlaySceneMgr; }
SoDEPRECATED
  void setOverlayGLRenderAction(SoGLRenderAction *ra) { overlaySceneMgr->setGLRenderAction(ra); }
SoDEPRECATED
  SoGLRenderAction* getOverlayGLRenderAction() const { return overlaySceneMgr->getGLRenderAction(); }
#endif 
  SoTimerSensor * getTrackerSensor()
    { return trackerSensor; }
          
  void setInterEyeDistance(float value)
    { interEyeDistance = value;}

  float getInterEyeDistance(void)
    { return interEyeDistance;}

  // Flag to switch on/off the z-buffer
  int changeZbuffer;

  void            setStereoOffset(float dist) { stereoOffset = dist; scheduleRedraw() ;}
  float           getStereoOffset()   { return stereoOffset; }

  virtual SoGLContext* getViewerContext() { return getNormalContext(); }
  
  virtual SoSceneManager* getViewerSceneManager() { return getSceneManager(); }

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

#endif 
private:
  
  //
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinMPRenderArea::buildWidget()
  // when they are ready for it to be built.

  SoWinMPRenderArea(SoWidget parent,
                    const char *name, 
                    SbBool buildInsideParent, 
                    SbBool getMouseInput,
                    SbBool getKeyboardInput, 
                    SbBool buildNow);
        
  //
  // 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.
  //
  void partialRedraw(int id);
#if 1             SoDEPRECATED
  void partialRedrawOverlay( int id );
#endif 
  void swapBuffers(int); 

  // drawing functions for the normal layer
  virtual void    redraw();
  virtual void        prepareRedraw();
  virtual void        actualRedraw();
  virtual void        endRedraw();

#if 1             
  // drawing functions for the overlay layer
SoDEPRECATED
  virtual void        redrawOverlay();SoDEPRECATED
  virtual void        prepareOverlayRedraw();SoDEPRECATED
  virtual void        actualOverlayRedraw();SoDEPRECATED
  virtual void        endOverlayRedraw();
#endif 
  //
  // Redefine these to do Inventor-specific things
  //
  virtual void        processEvent(XAnyEvent *anyevent);
  virtual void        initGraphic();
#if 1             SoDEPRECATED
  virtual void        initOverlayGraphic();
#endif 
  virtual void        sizeChanged(const SbVec2s &newSize);
  virtual void        widgetChanged(SoWidget);
        
  virtual void    initViewportRegion(int);


  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             *deviceList;    // list of devices
    
  // application event callback variables
  SoWinMPRenderAreaEventCB *appEventHandler;
  void                   *appEventHandlerData;
  // invoke the application event callback - returns what the app cb returns
  SbBool              invokeAppCB(XAnyEvent *anyevent);
  
  // hidden lines draw style 
  void setDepthRange(float,float);
  float zNear;
  float zFar;
  void changeDepthRange(void);
  SbBool drawHiddenLineMode;
  void setHiddenLineSwap(SbBool);
  SbBool hiddenLineSwap;

  // stereo adjustment (previously in SoXtMPViewer)
  SbBool  stereoAbsoluteAdjustments;
  float   stereoOffset;
  float   stereoBalance;
  SbBool   stereoNearFrac;
  SoCamera::StereoMode stereoMode;
  float interEyeDistance; // MP immersive only

 private:
  void setDoSwapBuffers(SbBool);
  SbBool doSwapBuffers(void);
  void setLeftView(SbBool);
  void setRightView(SbBool);
  SbBool isLeftViewRendering(void);
  SbBool isRightViewRendering(void);
    
  void setStereoMode(SoCamera::StereoMode stMode);

 private:

  void setModifyViewVolumeElementWall(int id,SoSceneManager * sceneManager);
  void setStereoElement(int);

  // stereo MP
  SbBool doSwap;
  SbBool doLeftViewRendering;
  SbBool doRightViewRendering;

  SbThreadBarrier *swapBarrier;
        
  SbThreadBarrier *synchroStartBarrier;
  SbThreadBarrier *synchroEndBarrier;

  SbThreadBarrier *synchroOverlayStartBarrier;
  SbThreadBarrier *synchroOverlayEndBarrier;

  {
    SoWinMPRenderArea *p;
    int id ;
  } ThreadFuncStruct ;
  ThreadFuncStruct *threadStruct;

  // Normal
  static unsigned int WINAPI threadRoutRedraw(LPVOID _userData);
  SbThread        **threadHandle;
  // Overlay
  static unsigned int WINAPI threadRoutRedrawOverlay(LPVOID _userData);
  SbThread        **threadHandleOverlay;

  // flag indicating whether a render traversal is in
  // progress.
  SbBool          isRedrawing;
    
  // these make rendering/redrawing happen
  SoSceneManager      *sceneMgr;      // this manages rendering and events
  SoSceneManager      *overlaySceneMgr; // manages the overlay scene graph

  SbBool      clearFirst, clearOverlayFirst;  // call clear() before rendering
  SbBool      clearZBufferFirst;  // clear ZBuffer before rendering
  SbBool      autoRedraw;     // if TRUE, then we automatically redraw
  XColor      *mapColors, *overlayMapColors; // saved colors
  int         mapColorNum, overlayMapColorNum; // number of saved colors

  SoWinMouse          *mouseDevice;
  SoWinKeyboard       *keybdDevice;
  void                reinstallDevices(SoWidget newWidget);
    
  static void         selectionChangeCB(void *userData, SoSelection *s);
  static void         overlaySelectionChangeCB(void *userData, SoSelection *s);
  SoSelection         *selection, *overlaySelection;
  SoWidget              deviceWidget;


  // static callbacks
  SbBool              firstEvent; // used to init the action SoWindowElement
 private:
  static void         windowEventCB(SoWidget, SoWinMPRenderArea *, XAnyEvent *, Boolean *);
 private:
  static void         renderCB(void *, SoSceneManager *);
  static void         renderOverlayCB(void *, SoSceneManager *);
    
  static void visibilityChangeCB(void *pt, SbBool visible);
  void        activate();             // connects the sensor
  void        deactivate();           // disconnects the sensor
    
  // this is called by both constructors
  void constructorCommon(
                         SbBool getMouseInput,
                         SbBool getKeyboardInput, 
                         SbBool buildNow);
  int inRedraw;
  int inOverlayRedraw;

  void setModifyViewVolume(int, SoSceneManager *);

  static SoCallbackList * threadInitCBList;
  static SoCallbackList * threadPreRenderCBList;
  static SoCallbackList * threadPostRenderCBList;

  SbBool stereoActive;
  SoTimerSensor * trackerSensor;

 public:
    
  static void addThreadInitCB(SoWinMPRenderAreaThreadInitCB * fcn, void *userData);
  static void removeThreadInitCB(SoWinMPRenderAreaThreadInitCB * fcn, void *userData);
        
  static void addThreadPreRenderCB(SoWinMPRenderAreaThreadRenderCB * fcn, void *userData);
  static void removeThreadPreRenderCB(SoWinMPRenderAreaThreadRenderCB * fcn, void *userData);
        
  static void addThreadPostRenderCB(SoWinMPRenderAreaThreadRenderCB * fcn, void *userData);
  static void removeThreadPostRenderCB(SoWinMPRenderAreaThreadRenderCB * fcn, void *userData);

  /*fkw stereo for MT/MP*/
  // Implementing methods from the pure virtual class from SoStereoViewer
  virtual SbBool isViewerDoubleBuffer();
  virtual void setStereoViewing(SbBool onOrOff);
  virtual SbBool isStereoViewing();
  virtual SoCamera * getViewerCamera();
  virtual const SbVec2s& getSize();
  virtual const SbVec2s& getTopLeft() ;
  virtual const SbVec2s& getBottomRight() ;
  void setStereoViewType(SoBaseStereo * stereo);
  SoBaseStereo * getStereoViewType();
  void reverseStereoView(SbBool reverse);
  SbBool isStereoViewReversed();
  virtual void setStereoAbsoluteAdjustments(SbBool absolute);
  virtual SbBool isStereoAbsoluteAdjustments() const {return stereoAbsoluteAdjustments;}
  virtual void setStereoBalance(float balance, SbBool nearFrac = false);
  virtual float getStereoBalance();
  virtual SbBool isStereoBalanceNearFrac();
  virtual void setStereoActive(SbBool activate) ;
  virtual SbBool isStereoActive() ;
  void setViewport(short left, short bottom, short width, short height) ;
  void getViewport(short &left, short &bottom, short &width, short &height) ;
  void * getViewer(void);
  virtual void actualRendering() {} // temporary, do nothing.

#if 1             SoDEPRECATED
  virtual void adjustClippingPlanes();
SoDEPRECATED
  HDC getCurrentDC() {return NULL;} // temporary, do nothing.

#endif 
 private:
  SoBaseStereo * stereoViewType;

};

#if defined(_WIN32)
#include <Inventor/Win/SoWinEndStrict.h>
#endif // _WIN32

#endif /* _SO_WIN_RENDER_AREA_H_ */

---

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