Inventor/MP/Xt/viewers/SoXtMPFlyViewer.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/


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

#ifndef  _SO_XT_MP_FLY_VIEWER_
#define  _SO_XT_MP_FLY_VIEWER_

#include <Inventor/MP/Xt/viewers/SoXtMPConstrainedViewer.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>

class   SoFieldSensor;

//
//  Class: SoXtFlyViewer
//
//
//      Keys used by this viewer:
//      -------------------------
//
//  Left Mouse: Click to increase speed.
//  
//  <s> + Left Mouse: Alternative to the Seek button. Press (but do not
//      hold down) the <s> key, then click on a target object.
//  
//  <U>  + Left Mouse: Press (but do not hold down) the <U>  key, then
//      click on a target object to set the "up" direction to the surface normal.
//      By default +y is the "up" direction.
//  
//  Middle Mouse: Click to decrease speed.
//  
//  Left and Middle Mouse: Click boths simultaneously to stop.
//  
//  Ctrl: Hold the key down to temporary stop and rotate the viewpoint.
//  
//  Right Mouse: Open the popup menu.
//  

class  SoXtMPFlyViewer : public SoXtMPConstrainedViewer {
 public:
    
  SoXtMPFlyViewer(
                  SoWidget parent = NULL,
                  const char *name = NULL, 
                  SbBool buildInsideParent = TRUE, 
                  SoXtMPFullViewer::BuildFlag flag = BUILD_ALL,
                  SoXtMPViewer::Type type = BROWSER);
  ~SoXtMPFlyViewer();
    
  //
  // 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);
    
  // 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:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtFlyViewer::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtMPFlyViewer(
                    SoWidget parent,
                    const char *name, 
                    SbBool buildInsideParent, 
                    SoXtMPFullViewer::BuildFlag flag, 
                    SoXtMPViewer::Type type, 
                    SbBool buildNow);
            
  // 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        setSeekMode(SbBool onOrOff);
  virtual void        actualRedraw();
  virtual void        rightWheelMotion(float);
    
  // add viewer preference stuff
  virtual void        createPrefSheet();
    
  // Define this to bring the viewer help card
  virtual void        openViewerHelpCard();
    
 private:
  // viewer state variables
  int             mode;
  SbBool          createdCursors;
  //    Cursor        viewerCursor, seekCursor, upCursor;
  Cursor          *viewerCursor, *seekCursor, *upCursor;

  SbVec2s         locator; // mouse position
  SbVec2s         startPos; // mouse starting position
  SbRotation      camStartOrientation;
    
  // variables used for doing moving animation
  SoFieldSensor   *animationSensor;
  SbTime          prevAnimTime;
  float           speed, maxSpeed, maxStraightSpeed;
  float           speedLimit, speedLimitFactor;
  float           minSpeed, maxInc;
    
  // preference sheet stuff
  SoWidget          createFlyPrefSheetGuts(SoWidget parent);
  static void     incPrefSheetButtonCB(SoWidget, SoXtMPFlyViewer *, void *);
  static void     decPrefSheetButtonCB(SoWidget, SoXtMPFlyViewer *, void *);
    
  void            defineCursors();
  void            drawViewerFeedback();
  void            switchMode(int newMode);
  void            changeMaxStraightSpeed(SbBool increase);
  void            calculateMaxSpeed();
  static void     animationSensorCB(void *, SoSensor *);
  void            doCameraAnimation();

  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
        
  // define and undefined cursor in each window created by MP
  void mpXDefineCursor(Cursor *);
  void mpXUndefineCursor(void);

};

#endif  /* _SO_XT_MP_FLY_VIEWER_ */

#endif // _WIN32

---

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