SoXtWalkViewer.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/viewers/SoQtWalkViewer.h>
#elif defined _WIN32
#  include <Inventor/Win/viewers/SoWinWalkViewer.h>
#else // _WIN32
 
#ifndef  _SO_XT_WALK_VIEWER_
#define  _SO_XT_WALK_VIEWER_
 
#include <Inventor/Xt/viewers/SoXtConstrainedViewer.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbTime.h>
#include <Inventor/Gui/viewers/SoGuiWalkViewer.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  SoXtWalkViewer : public SoXtConstrainedViewer {
 public:
    
  SoXtWalkViewer( SoWidget parent = NULL,
                  const char* name = NULL, 
                  SbBool buildInsideParent = TRUE, 
                  SoXtFullViewer::BuildFlag flag = SoXtFullViewer::BUILD_ALL, 
                  SoXtViewer::Type type = SoXtViewer::BROWSER );
  ~SoXtWalkViewer();
    
  //
  // redefine these to add Walk viewer functionality
  //
  virtual void setViewing( SbBool onOrOff );
  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 );
 
  void setViewerSpeed( float speed ) { m_guiWalkViewer->setViewerSpeed( speed ); }
 
  float getViewerSpeed() const { return m_guiWalkViewer->getViewerSpeed(); }
    
  private:
 
  SoGuiWalkViewer* getGuiWalkViewer() const;
 
  // 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.
   private:
    SoXtWalkViewer( SoWidget parent, 
                    const char* name, 
                    SbBool buildInsideParent, 
                    SoXtFullViewer::BuildFlag flag, 
                    SoXtViewer::Type type, 
                    SbBool buildNow,
                    SbBool sync = TRUE );
            
 private:
  // 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 );
    
  // 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();
 
  virtual void updateCursor();
 
 private:
  SoGuiWalkViewer* m_guiWalkViewer;
 
  // viewer state variables
  Cursor walkCursor, panCursor, tiltCursor, seekCursor, upCursor;
    
  // extra decoration vars
  int heightWheelVal;
  static void heightWheelCB( SoWidget w, SoXtWalkViewer* p, XtPointer* d );
  
  SbTime prevAnimTime;
    
  void updateViewerMode( unsigned int state );
  void switchMode( int newMode );
  void defineCursors();
    
  // this is called by both constructors
  void constructorCommon( SbBool buildNow );
};
 
#endif  /* _SO_XT_WALK_VIEWER_ */
 
#endif // _WIN32