TerrainViz/viewer/SoTVizViewer.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      : Frederic FRATANI (MMM yyyy)
**=======================================================================*/


#ifndef SoTVizViewer_H
#define SoTVizViewer_H




#ifdef _WIN32
class SoWinBitmapButton;
#ifdef TVIZ_USE_JOYSTICK
class SiTVizJoystick;
#endif
#endif

#include <Inventor/Xt/viewers/SoXtConstrainedViewer.h>
#include <TerrainViz/viewer/SoTVizCameraManager.h>

#ifdef _WIN32
#  include <Inventor/sys/SoDynamicLibManager.h>
#  include <SoVersion.h>
#  if defined(_DEBUG)
#    define __INVTVIZWDLL "TerrainVizWinD.dll"
#    define __INVTVIZWLIB "TerrainVizWinD.lib"
#  else
#    define __INVTVIZWDLL "TerrainVizWin.dll"
#    define __INVTVIZWLIB "TerrainVizWin.lib"
#  endif
#  ifndef TerrainVizWin_EXPORTS
#    ifndef OIV_DISABLE_AUTOLINK
#      pragma comment(lib,__INVTVIZWLIB)
#    endif
#  endif
#else
#  define __INVTVIZWDLL "libTerrainVizXt"
#endif

#include <Inventor/SoModule.h>
SO_MODULE_HEADER(SoTerrainVizWin, __INVTVIZWDLL)

class SoSwitch;
class SoSeparator;
class SoPerspectiveCamera;
class SoDirectionalLight;
class SoCallback;
class SoNode;
class SoTransform;
class SoFieldSensor;
class SoTVizControls;
class SoTVizNavigationTools;
class SoTVizNavigationToolBase;


// some default values
#define DEFAULT_SPD_MOD_COEF             1.f
#define DEFAULT_MAX_ROLL_ANGLE          30.f
#define DEFAULT_TERRAINSIZE_TO_MAXSPEED   .1f
#define FLY_SPD_FACTOR                    .3f
#define TOPLEFTWHEEL_FACTOR               .1f
class SoDEPRECATED SoTVizViewer : public SoXtConstrainedViewer, public SoTVizCameraManager
{
public:

  SoTVizViewer ( SoWidget parent = NULL,
                 const char *name = NULL,
                 SbBool buildwithDefaultTools = TRUE,
                 SbBool buildInsideParent = TRUE,
                 SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                 SoXtViewer::Type type = BROWSER);

  ~SoTVizViewer ();

  
  virtual void setFlyMode (SbBool onOff);
  
  virtual SbBool isFlyMode () const;
  
  virtual void setInvertedControlsMode (SbBool onOff);
  
  virtual SbBool isInvertedControlsMode () const;
  
  virtual void  setMaxRollAngle (float newAngle);
  
  virtual float getMaxRollAngle () const;
  
  
  virtual void setElevationRelativeSpeedMode (SbBool onOff);
  
  virtual SbBool isElevationRelativeSpeedMode () const;
  
  
  enum speedUnits {
    KILOMETERS_PER_HOUR,
    METERS_PER_SECOND,
    MILES_PER_HOUR
  };
  
  
  virtual void setSpeedUnit (SoTVizViewer::speedUnits newSpeedUnit = SoTVizViewer::KILOMETERS_PER_HOUR);

  virtual SoTVizViewer::speedUnits getSpeedUnit () const;
  
  virtual void  setSpeedModulationCoeff (float newCoeff);
        
  virtual float getSpeedModulationCoeff () const;
  
  virtual void  setMaxSpeed (float newSpeed, SbBool autoMaxSpeed = FALSE);
  
  virtual float getMaxSpeed () const;
  
  virtual void setBorderRespect (SbBool onOff);
  
  
  virtual void setConstantElevationMode (SbBool onOff, SbBool resetElevation = FALSE);
  
  virtual void setTargetRelativeElevation (double newElevation);
  
  virtual void setMinimumElevation (double newMinimalElevation);

  virtual void setTerrain (SoNode* t);

  void setNorth (SbVec3f& newNorth);
        
  SbVec3f getNorth() const;

  virtual void openControls();

  virtual SoTVizNavigationTools* getTerrainNavigationTools () const;
   
  virtual void setTerrainNavigationToolsVisibility (SbBool onOff);
   
  virtual SbBool getTerrainNavigationToolsVisibility () const;
   
   
  virtual void setTerrainNavigationToolsInteractivity (SbBool onOff);
   
  virtual SbBool getTerrainNavigationToolsInteractivity () const;
   
   
   
  virtual void setSceneGraph (SoNode *);
   
  virtual void setCamera (SoCamera *);
   
  virtual SoCamera* getCamera () const;
   
  virtual void setHeadlight(SbBool);
   
  virtual void setUpDirection (SbVec3f& newUpDirection);
   
  virtual SbVec3f getUpDirection() const { return getGuiConstrainedViewer()->getUpDirection(); }
   
  virtual void viewAll();
   
  virtual void resetToHomePosition();
   
   
  virtual void setViewing (SbBool onOff);
   
  virtual void setCursorEnabled(SbBool onOff);
   


private:

  // protected constructor for delayed building
  SoTVizViewer(SoWidget parent,
               const char *name,
               SbBool buildwithDefaultTools,
               SbBool buildInsideParent,
               SoXtFullViewer::BuildFlag flag,
               SoXtViewer::Type type,
               SbBool buildNow);

  void
  SoTVizViewerCommon(SoWidget parent,
                     const char *name,
                     SbBool buildwithDefaultTools,
                     SbBool buildInsideParent,
                     SoXtFullViewer::BuildFlag flag,
                     SoXtViewer::Type type,
                     SbBool buildNow);


  // Viewer modes
  enum {
    PICK_MODE, 
    WALK_MODE,
    WALK_MODE_ACTIVE, 
    TILT_MODE, 
    TILT_MODE_ACTIVE, 
    PAN_MODE, 
    PAN_MODE_ACTIVE, 
    FLY_MODE,
    FLY_MODE_ACTIVE,
    SEEK_MODE
  };
  int m_mode;
  
  // Viewer new buttons
  enum {
    // ConstrainedViewer has allready 7 PushButtons
    FLY_PUSH = 8, 
    CT_ELEVATION_PUSH = 9
  };
  
  // Mouse location
  SbVec2s m_locator;

  void commonDelete() ;


#ifdef _WIN32
  // redefined methods for cursors management
  HCURSOR sizeCursor, moveCursor;
  // redefined methods for new popup menu
  virtual void buildPopupMenu();
  // callback for viewer buttons
  virtual void pushButtonCB (SoWidget w, int id, void *);
  // popup management
  virtual void processPopupItem(int item);
  // Methods dealing with the new top left wheel of viewer decoration
  static void topLeftWheelCB (SoTVizViewer *v, XtPointer *d);
#elif defined(__APPLE__)

#else
  SbBool createdCursors;
  Cursor walkCursor, spinCursor, panCursor, flyCursor, seekCursor;
  // redefined methods for new popup menu
  // pb : parent method is not virtual
  virtual SoWidget buildFunctionsSubmenu(SoWidget popup);
  virtual void rightWheelMotion(float newVal);
  // Methods dealing with the new top left wheel of viewer decoration
  static void topLeftWheelCB(SoWidget, SoTVizViewer *v, XtPointer *d);
#endif

  void setFlyModeCommon (SbBool onOff);
  void setConstantElevationModeCommon (SbBool onOff, SbBool resetElevation);

  virtual void defineCursors();
  virtual void updateCursor();

  // Redefined to redraw navigation tools on window size changes
  virtual void sizeChanged(const SbVec2s & newSize);

  // redefined decoration building methods
  virtual SoWidget buildLeftTrim(SoWidget parent);

  // Create custom buttons
  virtual void createViewerButtons(SoWidget parent);

  // redefined method to react to events
  virtual void processEvent (XAnyEvent *);

  // Redefined viewer methods
  virtual void setSeekMode (SbBool flag);

  // Viewer mode switch method
  void switchMode (int newMode);

  float        topLeftWheelVal;
  virtual void topLeftWheelStart();
  virtual void topLeftWheelFinish();
  virtual void topLeftWheelMotion(float newVal);

  // Redefined from TerrainCameraManager to take speed unit in account
  // and support controls interface update
  virtual void updateIOUnits();

  // Navigation tools in the render area
  SoTVizNavigationTools * m_navTools;
  SbBool m_terrainNavigationToolsVisibility;
  SbBool m_terrainNavigationToolsInteractivity;
  
  // processEvent method variables
  SbBool m_controlKey;
  SbBool m_shiftKey;
  SbBool m_leftButton;

private:

  // the real constructor method
  void constructorCommon (SbBool buildNow);

  // Controls interface
  SoTVizControls * m_controlsBox;
  SoSwitch * m_navToolsSwitch;
  
  // m_internalNorthDirection is the normalized projection of m_northVector
  // on upDirection normal plan
  SbVec3f       m_northVector;
  SbVec3f m_internalNorthDirection;
  // Called when north or up direction changes
  void    updateNorthDirection();
  
  SbBool  m_flyMode;
  SbBool  m_invertedControlsMode;
  SbBool  m_buildwithDefaultTools;
  float   m_maxRollingAngle;
  
  SoNode* m_sceneGraph;
  SoNode* m_terrain;
  
  SoTVizViewer::speedUnits m_speedUnit;
  float m_toIOSpeed;
  SbBool  m_elevationRelativeSpeedMode;
  float m_speedModulationCoeff;
  float m_maxSpeed;
  float m_previousAngleX;

  // Update the viewer camera speed
  void computeViewerSpeed ();
  
  // camera sensors and theirs callbacks
  SoFieldSensor * m_cameraPositionSensor;
  SoFieldSensor * m_cameraOrientationSensor;
  static void     cameraPositionCB (void *, SoSensor *);
  static void     cameraOrientationCB (void *, SoSensor *);
  
  // methods and variables used during animation phases
  static void   animationSensorCB (void *, SoSensor *);
  void      startAnimating ();
  void      stopAnimating ();
  void        doCameraAnimation ();
  SbRotation  m_noRolling;
  SbTime            m_prevAnimTime;
  SoFieldSensor * m_animationSensor;

  SbVec3f m_previousCameraPosition;
  SbBool  m_resetCamera;

  float  m_maxHeight;

  double m_previousTargetHeight;

  SbVec2s m_locatorOnLeftClick;

  SbBool m_autoMaxSpeed;

#ifdef _WIN32
private:
  // two viewer buttons more
  SoWinBitmapButton* fly_Button;
  SoWinBitmapButton* ct_Elevation_Button;

  // Because this is private in our parent class, we will need our own
  SoWinBitmapButton* buttonList[12];
  // Pointer to the InvTViz DLL
  SoDynamicLibManager::SafeLibraryHandle TVizWinDLL;
  // Pointer to the inventor resource DLL
  SoDynamicLibManager::SafeLibraryHandle resDLL;

#ifdef TVIZ_USE_JOYSTICK
private:
  SiTVizJoystick* m_joystick;
  SbBool m_joystickUsed;
  int m_previousMode;

 private:
  static void setJoystickCallback(void *data, SoSensor *);
  void joystickControl ();
  SbBool isJoystickActivated();
  // If joystickUsed==0 (keyboard) -> joystickUsed=1 (joystick) and vice versa
  void   switchControlInput();
  SbBool isJoystickUsed();
  SbBool isButtonPressed(unsigned char which_one);
#endif

#elif defined(__APPLE__)

#else
private:
  // two viewer buttons more
  SoXtBitmapButton* flyPushButton;
  SoXtBitmapButton* cstElevPushButton; 
  // redefined to react to popup menu events
  static void menuPick(SoWidget, int id, XmAnyCallbackStruct *);
  // callback for viewer buttons
  static void pushButtonCB (SoWidget w, int id, void *);
#endif

};

#endif // SoTVizViewer_H

---

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