Inventor/MP/Xt/viewers/SoXtMPWalkViewer.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/Win/viewers/SoWinWalkViewer.h>
#else // _WIN32

#ifndef  _SO_XT_WALK_VIEWER_
#define  _SO_XT_WALK_VIEWER_

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

class   SoFieldSensor;

//
//  Class: SoXtWalkViewer
//
//      Walk Viewer - changes the camera position by simulating the constrain
//  on someone walking. The up direction is kept at all times, and the camera
//  is moved keeping the eye level the same, regardless of whether the person
//  is looking down or up (looking direction is constrained to 180 degree).
//
//
//      Keys used by this viewer:
//      -------------------------
//
//     Left Mouse: walk mode. Click down and move up/down for fowards/backwards
//          motion.  Move right and left for turning. Speed increases 
//          exponentially with the distance from the mouse-down origin.
//
//     Middle Mouse: 
//     Ctrl + Left Mouse: Translate up, down, left and right.
//
//     Ctrl + Middle Mouse: tilt the camera up/down and right/left. This 
//          allows you to look around while stopped.
//
//     <s> + click: Alternative to the Seek button. Press (but do not hold down)
//          the <s> key, then click on a target object.
//
//     <U>  + click: 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.
//
//     Right Mouse: Open the popup menu.
//  

class  SoXtMPWalkViewer : public SoXtMPConstrainedViewer {
 public:
    
  SoXtMPWalkViewer(
                   SoWidget parent = NULL,
                   const char *name = NULL, 
                   SbBool buildInsideParent = TRUE, 
                   SoXtMPFullViewer::BuildFlag flag = BUILD_ALL, 
                   SoXtMPViewer::Type type = BROWSER);
  ~SoXtMPWalkViewer();
    
  //
  // redefine these to add Walk viewer functionality
  //
  virtual void    setViewing(SbBool onOrOff);
  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);
        
        
 private:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtWalkViewer::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtMPWalkViewer(
                     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);
    
  // redefine this to add the extra thumbwheel on the left side
  virtual SoWidget      buildLeftTrim(SoWidget parent);
    
  // 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        walkCursor, panCursor, tiltCursor, seekCursor, upCursor;*/
  Cursor          *walkCursor, *panCursor, *tiltCursor, *seekCursor, *upCursor;
  SbVec2s         locator; // mouse position
  SbVec2s         prevPos; // mouse previous location
  SbVec2s         startPos; // mouse starting position
    
  // extra decoration vars
  int             heightWheelVal;
  static void     heightWheelCB(SoWidget, SoXtMPWalkViewer *p, XtPointer *d);
    
  // variables used for doing moving animation
  SoFieldSensor   *animationSensor;
  SbBool          animatingFlag;
  SbTime          prevAnimTime;
  void            startAnimating();
  void            stopAnimating();
  static void     animationSensorCB(void *v, SoSensor *);
    
  void            updateViewerMode(unsigned int state);
  void            switchMode(int newMode);
  void            updateCursor();
  void            defineCursors();
  void            doCameraAnimation();
  void            dollyCamera(float dist);
  void            rotateCamera();
    
  // focal distance update stuff
  void                updateCameraFocalPoint();
  static void         setFocalPointFinishCallback(void *, SoXtMPViewer *);
    
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
        
  void mpXDefineCursor(Cursor * cursorToSetActive);
        
 public:
  void drawViewerFeedback(void);


};

#endif  /* _SO_XT_MP_WALK_VIEWER_ */

#endif // _WIN32

---

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