Inventor/MP/Xt/viewers/SoXtMPViewer.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)
**=======================================================================*/


#if defined(_WIN32)
#  include <Inventor/MP/Win/viewers/SoWinMPViewer.h>
#else // _WIN32

#ifndef  _SO_XT_MP_VIEWER_
#define  _SO_XT_MP_VIEWER_

#include <Inventor/SoType.h>
#include <Inventor/MP/Xt/SoXtMPRenderArea.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/SbElapsedTime.h>

// classes
class SoNode;
class SoDirectionalLight;
class SoGroup;
class SoRotation;
class SoCamera;
class SoDrawStyle;
class SoLightModel;
class SoFieldSensor;
class SoXtClipboard;
class SoXtMPViewer;
class SoGetBoundingBoxAction;
class SbPList;
class SoSeparator;
class SoSwitch;
class SoComplexity;
class SoPackedColor;
class SoMaterialBinding;
class SoSFTime;
class SoXtInputFocus;
class SoAlarmSensor;
class SoNodeSensor;
class SoGetPrimitiveCountAction;
class SoStereoViewer;
class SoBaseStereo;
class SoTransform;

// callback function prototypes
typedef void SoXtMPViewerCB(void *userData, SoXtMPViewer *viewer);
typedef void SoXtMPViewerCameraTypeChangeCB(void *userData, SoCamera *camera, SoXtMPViewer *viewer);

// Large Model Viewing notification callbacks for 
// frames per second and decimation percentage:
typedef void SoXtMPViewerFPSCB(float fps, void *userData, SoXtMPViewer *viewer);
typedef void SoXtMPViewerDecimationPercentageCB(float percentage, void *userData, SoXtMPViewer *viewer);

//
//  Class: SoXtMPViewer
//
//      The Viewer component is the abstract base class for all viewers.
//  It is subclassed from renderArea, adding viewing semantics to Inventor
//  rendering.
//

class  SoXtMPViewer : public SoXtMPRenderArea
{
 public:

  enum Type {
    BROWSER,
    EDITOR
  };
  
  enum DrawStyle {
    VIEW_AS_IS,
    VIEW_HIDDEN_LINE,
    VIEW_NO_TEXTURE,
    VIEW_LOW_COMPLEXITY,
    VIEW_LINE,
    VIEW_POINT,
    VIEW_BBOX,
    VIEW_LOW_RES_LINE,
    VIEW_LOW_RES_POINT,
    VIEW_SAME_AS_STILL
  };
   
  enum DrawType {
    STILL,
    INTERACTIVE
  };

  enum BufferType {
    BUFFER_SINGLE,
    BUFFER_DOUBLE, 
    BUFFER_INTERACTIVE
  };
  
  enum DecimationStrategy {
    NORMAL,
    FIXED_NUM_TRIANGLES,
    FRAMES_PER_SECOND,
    FIXED_PERCENTAGE
  };
  
  virtual void setSceneGraph(SoNode *newScene);
  virtual SoNode *getSceneGraph();
  
  virtual void setCamera(SoCamera *cam);
  SoCamera *getCamera() { return camera; }
  
  virtual void setCameraType(SoType type);
  SoType getCameraType() { return cameraType; }

  virtual void          setPreserveCameraHeightAngle(SbBool flag)
    {m_preserveHeightAngle = flag; }

  virtual SbBool     isCameraHeightAnglePreserved() const
    {return m_preserveHeightAngle; }

  virtual void          enableSeekWithOrtho(SbBool flag)
    {m_seekWithOrtho = flag; }

  virtual SbBool     isSeekWithOrthoEnabled() const
    {return m_seekWithOrtho; }
  
  virtual void viewAll();
  virtual void saveHomePosition();
  virtual void resetToHomePosition();
  
  void setCameraTypeChangeCallback(SoXtMPViewerCameraTypeChangeCB *callback,
                                   void *userdata);
  
  virtual void setHeadlight(SbBool onOrOff);
  SbBool isHeadlight() { return headlightFlag; }
  SoDirectionalLight *getHeadlight() { return headlightNode; }
  
  virtual void setDrawStyle(SoXtMPViewer::DrawType type, 
                            SoXtMPViewer::DrawStyle style);
  SoXtMPViewer::DrawStyle getDrawStyle(SoXtMPViewer::DrawType type);
  
  virtual void setBufferingType( SoXtMPViewer::BufferType type);
  SoXtMPViewer::BufferType getBufferingType() { return bufferType; }
  virtual void setViewing(SbBool onOrOff);
  SbBool isViewing() const { return viewingFlag; };
  
  virtual void setCursorEnabled(SbBool onOrOff);
  SbBool isCursorEnabled() const { return cursorEnabledFlag; }
  
  void setAutoClipping(SbBool onOrOff);
  SbBool isAutoClipping() const { return autoClipFlag; }
  
  //  virtual void setStereoViewing(SbBool onOrOff);
  //  virtual SbBool isStereoViewing();

  void setDetailSeek(SbBool onOrOff) { detailSeekFlag = onOrOff; };
  SbBool isDetailSeek() { return detailSeekFlag; }
  
  void setSeekTime(float seconds) { seekAnimTime = seconds; }
  float getSeekTime() { return seekAnimTime; }
  
  void addStartCallback(SoXtMPViewerCB *f, void *userData = NULL)
    { startCBList->addCallback((SoCallbackListCB *)f, userData); }
  void addFinishCallback(SoXtMPViewerCB *f, void *userData = NULL)
    { finishCBList->addCallback((SoCallbackListCB *)f, userData); }
  void removeStartCallback(SoXtMPViewerCB *f, void *userData = NULL)
    { startCBList->removeCallback((SoCallbackListCB *)f, userData); }
  void removeFinishCallback(SoXtMPViewerCB *f, void *userData = NULL)
    { finishCBList->removeCallback((SoCallbackListCB *)f, userData); }
  
  void copyView(Time eventTime);
  void pasteView(Time eventTime);
  
  virtual void recomputeSceneSize();
  
  // --- Large Model Viewing additions:
  
  void setDecimationStrategy(DecimationStrategy strategy);
  DecimationStrategy getDecimationStrategy() {return decStrategy; };
  
  void setGoalNumberOfTriangles(int32_t goal);
  int32_t getGoalNumberOfTriangles() { return goalTris; };
  
  void setGoalFramesPerSecond(float goal);
  float getGoalFramesPerSecond() { return goalFps; };
  
  void setFixedPercentage(float percent);
  float getFixedPercentage() { return decPercentage; };
  
  void enableFullRenderingWhenStill(SbBool onOff);
  SbBool isFullRenderingWhenStill() { return doFullRendering; };
  
  SbBool isStillNow() { return isStill; };
  
  void setFramesPerSecondCallback(SoXtMPViewerFPSCB *callback, 
                                  void *userData = NULL);
  
  void setNumSamples(int numFrames);
  int getNumSamples() { return numSamples; };
  
  void setDecimationPercentageCallback(
                                       SoXtMPViewerDecimationPercentageCB *callback,
                                       void *userData = NULL);
  
  float getCurrentDecimationPercentage(); 
  
  /*  HDC getCurrentDC() {  return NULL; } fkw*/
  
  void insertSceneTransform(void);
  
  SoTransform * getSceneTransform(void);
  
  SoTransform * getWandTransform(void);

  void setWandGeometryFile(SbString wandFile);

  void setHeadTracking(int value);
  
  virtual void navigate(void);
  

 private:
  virtual ~SoXtMPViewer();

  // redefine this to call the viewer setBufferingType() method instead.
  virtual void setDoubleBuffer(SbBool onOrOff);

  // redefine this routine to also correctly set the buffering type
  // on the viewer.
  virtual void setNormalVisual(XVisualInfo *);
  
  
  // tell whether create the wand or not. Default is TRUE 
  void useWand(SbBool flag)
    { addWandGroup = flag;};
  
  
  // Implementing methods from the pure virtual class from SoStereoViewer
 
  /*fkw*/ 
  /*   virtual SoCamera * getViewerCamera();
       virtual SbBool isViewerDoubleBuffer();
       virtual void actualRendering();
       virtual void adjustClippingPlanes();
       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 setStereoBalance(float balance);
       virtual float getStereoBalance();
       virtual void setStereoActive(SbBool activate) ;
       virtual SbBool isStereoActive() ;
       // virtual void setStereoOffset(float offset);
       // virtual float getStereoOffset();
       //  void setViewport(short left, short bottom, short width, short height) ;
       //  void getViewport(short &left, short &bottom, short &width, short &height) ;
  */
 public:
  void setAutoClipTolerance ( float tolerance ) {
    minimumNearPlane = tolerance; };

  float getAutoClipTolerance () const
    { return minimumNearPlane; };
    
  SoNode * getViewAllScene() { return viewAllScene;}
  void setViewAllScene(SoNode* node)
  {
    viewAllScene = node;
  }

  virtual void toggleCameraType();
  
 private:

  SbBool              m_preserveHeightAngle;
  float               m_previousHeightAngle; 
  SbBool              m_seekWithOrtho;

  // Constructor/Destructor
  SoXtMPViewer(SoWidget parent,
               const char *name, 
               SbBool buildInsideParent, 
               Type type, 
               SbBool buildNow);
  
  // global vars
  SoXtMPViewer::Type type;
  SoCamera *camera; // camera being edited
  SbBool viewingFlag; // FALSE when the viewer is off
  SbBool altSwitchBack; // flag to return to PICK after an Alt release
  SbBool cursorEnabledFlag;
  static SoSFTime *viewerRealTime; // pointer to "realTime" global field
  float sceneSize; // the larger of the X,Y,Z scene BBox
  float viewerSpeed; // default to 1.0 - SoXtMPFullViewer add UI to inc/dec
  
  // local tree variables
  SoSeparator *sceneRoot; // root node given to the RA
  SoNode *sceneGraph; // user supplied scene graph
  
  // Subclasses can call this routine to handle a common set of events. A Boolean
  // is returned to specify whether the event was handled by the base class.
  // Currently handled events and functions are :
  // 'Esc' key - toggles viewing on/off
  // When viewing OFF - send all events down the scene graph
  // When camera == NULL - Discard all viewing events
  // 'home' Key - calls resetToHomePosition()
  // 's' Key - toggles seek on/off
  // Arrow Keys - moves the camera up/down/right/left in the viewing plane
  SbBool processCommonEvents(XAnyEvent *xe);
  
  // Invokes the start and finish viewing callbacks. Subclasses NEED to call
  // those routines when they start and finish doing interactive viewing 
  // operations so that correct interactive drawing style and buffering 
  // types, as well as application callbacks, gets set and called properly.
  //
  // Those routines simply increment and decrement a counter. When the counter
  // changes from 0->1 the start viewing callbacks are called. When the counter 
  // changes back from 1->0 the finish viewing callbacks are called.
  // The counter approach enables different parts of a viewer to call those 
  // routines withough having to know about each others (which is not 
  //
  void interactiveCountInc();
  void interactiveCountDec();
  int getInteractiveCount() { return interactiveCount; }
  
  //
  // This routine is used by subclasses to initiate the seek animation. Given a
  // screen mouse location, this routine will return the picked point
  // and the normal at that point. It will also schedule the sensor to animate
  // if necessary. The routine retuns TRUE if something got picked...
  //
  // Note: if detailSeek is on, the point and normal correspond to the exact 
  // 3D location under the cursor.
  // if detailSeek if off, the object bbox center and the camera 
  // orientation are instead returned.
  SbBool seekToPoint(const SbVec2s &mouseLocation);
  
  //
  // Subclasses CAN redefine this to interpolate camera position/orientation
  // while the seek animation is going on (called by animation sensor).
  // The parameter t is a [0,1] value corresponding to the animation percentage
  // completion. (i.e. a value of 0.25 means that animation is only 1/4 of the way
  // through).
  //
  virtual void interpolateSeekAnimation(float t);
  virtual void computeSeekFinalOrientation();
  
  // variables used for interpolating seek animations
  float seekDistance;
  SbBool seekDistAsPercentage; // percentage/absolute flag
  SbBool computeSeekVariables;
  SbVec3f seekPoint, seekNormal;
  SbRotation oldCamOrientation, newCamOrientation;
  SbVec3f oldCamPosition, newCamPosition;
  
  // Externally set the viewer into/out off seek mode (default OFF). Actual
  // seeking will not happen until the viewer decides to (ex: mouse click).
  //
  // Note: setting the viewer out of seek mode while the camera is being
  // animated will stop the animation to the current location.
  virtual void setSeekMode(SbBool onOrOff);
  SbBool isSeekMode() { return seekModeFlag; }
  
  // redefine this routine to adjust the camera clipping planes just
  // before doing a redraw. The sensor will be unschedule after the camera
  // is changed in the base class to prevent a second redraw from occuring.
  virtual void prepareRedraw();
  virtual void actualRedraw();
  virtual void endRedraw(); 
  
  // This is called during a paste.
  // Subclasses may wish to redefine this in a way that
  // keeps their viewing paradigm intact.
  virtual void changeCameraValues(SoCamera *newCamera);
  
  //
  // Convenience routines which subclasses can use when drawing viewer 
  // feedback which may be common across multiple viewers. There is for 
  // example a convenience routine which sets an orthographics projection
  // and a method to draw common feedback like the roll anchor (used by
  // a couple of viewers).
  //
  // All drawing routines assume that the window and projection is 
  // already set by the caller.
  //
  // set an ortho projection of the glx window size - this also turns
  // zbuffering off and lighting off (if necessary).
  static void setFeedbackOrthoProjection(const SbVec2s &glxSize);
  // restores the zbuffer and lighting state that was changed when
  // setFeedbackOrthoProjection() was last called.
  static void restoreGLStateAfterFeedback();
  // draws a simple 2 colored cross at given position
  static void drawViewerCrossFeedback(SbVec2s loc);
  // draws the anchor feedback given center of rotation and mouse location
  static void drawViewerRollFeedback(SbVec2s center, SbVec2s loc);
  
  // redefine this for a better default draw style (need to wait for context)
  virtual void afterRealizeHook();
  
  // auto clipping vars and routines
  SbBool autoClipFlag;
  float minimumNearPlane; // minimum near plane as percentage of far
  SoGetBoundingBoxAction *autoClipBboxAction;
  virtual void adjustCameraClippingPlanes();
  
  // Override redraw() in order to calculate render time including
  // frame buffer switch
  virtual void redraw();
  
  // Subclasses may override this function to change way that 
  // viewer tries to calculate decimation percentage for 
  // DecimationStrategy FRAMES_PER_SECOND.
  // Given goal frames per second, timeTaken in last render, 
  // and last decimation value used, this function should return
  // decimation percentage value to use in next render.
  virtual float decimationForFramesPerSecond(float fps, 
                                             double timeTaken, 
                                             float decimation);
  // Subclasses may override this function to change way that 
  // viewer tries to calculate decimation percentage for 
  // DecimationStrategy FIXED_NUM_TRIANGLES.
  // Given goal number of triangles to reach, this function 
  // should return decimation percentage value to use.
  virtual float decimationForNumTriangles(uint32_t numTris);
  
 private:
  // current state vars
  SoType cameraType;
  BufferType bufferType;
  SbBool interactiveFlag; // TRUE while doing interactive work
  SoXtInputFocus *inputFocus;
  
  
  
  // node to apply the viewAll method to
  // in some cases, we need to apply the viewAll method on 
  // a part of the sceneGraph
  SoNode * viewAllScene;
  
  // draw style vars
  DrawStyle stillDrawStyle, interactiveDrawStyle;
  SbBool checkForDrawStyle;
  SoSwitch *drawStyleSwitch; // on/off draw styles
  SoDrawStyle *drawStyleNode; // LINE vs POINT
  SoLightModel *lightModelNode; // BASE_COLOR vs PHONG
  SoPackedColor *colorNode; // hidden line first pass
  SoMaterialBinding *matBindingNode; // hidden line first pass
  SoComplexity *complexityNode; // low complexity & texture off
  void setCurrentDrawStyle(SoXtMPViewer::DrawStyle style);
  void doRendering();
   
  // copy and paste support
  SoXtClipboard *clipboard;
  static void pasteDoneCB(void *userData, SoPathList *pathList);
   
  // camera original values, used to restore the camera
  SbBool createdCamera;
  SbVec3f origPosition;
  SbRotation origOrientation;
  float origNearDistance;
  float origFarDistance;
  float origFocalDistance;
  float origHeight;
   
  // seek animation vars
  SbBool seekModeFlag; // TRUE when seek turned on externally
  SoFieldSensor *seekAnimationSensor;
  SbBool detailSeekFlag;
  float seekAnimTime;
  SbTime seekStartTime;
  static void seekAnimationSensorCB(void *p, SoSensor *);
   
  // headlight variables
  SoDirectionalLight *headlightNode;
  SoGroup *headlightGroup;
  SoRotation *headlightRot;
  SbBool headlightFlag; // true when headlight in turned on
   
  // interactive viewing callbacks
  int interactiveCount;
  SoCallbackList *startCBList;
  SoCallbackList *finishCBList;
  static void drawStyleStartCallback(void *, SoXtMPViewer *v);
  static void drawStyleFinishCallback(void *, SoXtMPViewer *v);
  static void bufferStartCallback(void *, SoXtMPViewer *v);
  static void bufferFinishCallback(void *, SoXtMPViewer *v);
   
  // set the zbuffer on current window to correct state
  void setZbufferState();
  SbBool isZbufferOff();
  void arrowKeyPressed(KeySym key);
   
  // Decimation strategy additions:
  DecimationStrategy decStrategy;
  int32_t goalTris; // Goal Number of Triangles
  float goalFps; // Goal Frames Per Second
  float decPercentage; // Fixed percentage
  float lastDecimationValue; // Last decimation value and render time 
  int lastDirection;
  double lastRenderTime; // used when (strategy==FRAMES_PER_SECOND)
  SoGetPrimitiveCountAction *primCountAction;
  static SoGLRenderAction::AbortCode renderAbortCB(void *data); 
  SbBool isStill, doFullRendering;
  SoAlarmSensor *stillSensor;
  static void alarmCB(void* thisp, SoSensor*) { ((SoXtMPViewer*)thisp)->stillSensorCalled(); };
  void stillSensorCalled(); 
  SoNodeSensor *motionSensor;
  static void changeCB(void* thisp, SoSensor*) { ((SoXtMPViewer*)thisp)->changeSensorCalled(); };
  void changeSensorCalled();

  // Camera type change callback
  SoXtMPViewerCameraTypeChangeCB *viewerCameraTypeChangeCallback;
  void *viewerCameraTypeChangeCallbackUserData;
  
  // Frames per second calculating:
  int numSamples, curNumSamples;
  double curTotalTime;
  SoXtMPViewerFPSCB *fpsUserCallback;
  void *fpsUserData;
  SbElapsedTime fpsTimer;
   
  // Decimation Percentage callback
  SoXtMPViewerDecimationPercentageCB *decimationUserCallback;
  void *decimationUserData;

  // SoTransform Node that will modify the scene
  // this node is inserted just after the camera 
  // that the viewer is using.
  SoTransform * sceneTransform;
  // TRUE if we are in MP immersive mode
  SbBool addSceneTransform;

  // Wand 
  SoSeparator * wandGroup;
  SoTransform * wandTransform;
  SoSeparator * wandGeometry;
  static const char * defaultWandGeometry;
  SbString wandFileStr;
  SbBool addWandGroup;
  void createWandGroup(void);
  void insertWandGroup(void);
  
  void scaleScene(SoNode * scene);

 private:
  void * getViewer() {return (void*) this;}


};

#endif /* _SO_XT_MP_VIEWER_ */

#endif // _WIN32

---

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