SoWinFlyViewer.h

/*=======================================================================
 *** 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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
 
#ifndef  _SO_WIN_FLY_VIEWER_
#define  _SO_WIN_FLY_VIEWER_
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
#include <Inventor/Win/viewers/SoWinConstrainedViewer.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>
 
#include <Inventor/Gui/viewers/SoGuiFlyViewer.h>
class   SoFieldSensor;
 
class  SoWinFlyViewer : public SoWinConstrainedViewer 
{
 public:
    
  SoWinFlyViewer( SoWidget parent = NULL,
                  const char* name = NULL, 
                  SbBool buildInsideParent = TRUE, 
                  SoWinFullViewer::BuildFlag flag = SoWinFullViewer::BUILD_ALL,
                  SoWinViewer::Type type = SoWinViewer::BROWSER );
  ~SoWinFlyViewer();
    
  //
  // redefine these to add fly viewer functionality
  //
  virtual void setViewing( SbBool onOrOff );
  virtual void resetToHomePosition();
  virtual void setCamera( SoCamera* cam );
  virtual void setCursorEnabled( SbBool onOrOff );
  virtual void setSeekMode( SbBool onOrOff );
    
  // This is redefined to prevent the camera type from being changed 
  virtual void setCameraType( SoType type );
 
  // set/get minimum speed in word coodinate / second
  // default value is 0, meaning the minimum speed is computed according to scene graph extent
  void  setMinSpeed( float speed );
  float getMinSpeed();
 
  // set/get speed multiplier. default value is 1.5
  void  setSpeedMultiplier( float speedInc );
  float getSpeedMultiplier();
 
  private:
 
  SoGuiFlyViewer* getGuiFlyViewer() const;
    
 private:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinFlyViewer::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER SoWinFlyViewer( SoWidget parent,
                             const char* name, 
                             SbBool buildInsideParent, 
                             SoWinFullViewer::BuildFlag flag, 
                             SoWinViewer::Type type, 
                             SbBool buildNow,
                             SbBool sync = TRUE );
            
  // redefine these
  virtual SbString getDefaultWidgetName() const;
  virtual SbString getDefaultTitle() const;
  virtual SbString getDefaultIconTitle() const;
    
  // redefine those routines to do viewer specific stuff
  virtual void processEvent( XAnyEvent* anyevent );
  virtual void actualRedraw();
  virtual void rightWheelMotion( float newVal);
  virtual void mouseWheelMotion( float newVal );
    
  // add viewer preference stuff
  virtual void createPrefSheet();
    
  // Define this to bring the viewer help card
  virtual void openViewerHelpCard();
    
 private:
 
  SoGuiFlyViewer* m_guiFlyViewer;
 
  // viewer state variables
  SbRotation camStartOrientation;   
    
  void switchMode( int newMode );
  void changeMaxStraightSpeed( SbBool increase );
 
  // this is called by both constructors
  void constructorCommon( SbBool buildNow );
 
  // Utility function called from processEvent
  void processPopupItem( int item );
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif  /* _SO_WIN_FLY_VIEWER_ */