SoXtExaminerViewer.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#elif defined _WIN32
#  include <Inventor/Win/viewers/SoWinExaminerViewer.h>
#else // _WIN32
 
#ifndef  _SO_XT_EXAMINER_VIEWER_
#define  _SO_XT_EXAMINER_VIEWER_
 
#include <Inventor/Xt/viewers/SoXtFullViewer.h>
#include <Inventor/events/SoMouseButtonEvent.h>
#include <Inventor/Gui/viewers/SoGuiExaminerViewer.h>
 
// classes used
class SbSphereSheetProjector;
class SoFieldSensor;
class SoSeparator;
class SoSwitch;
class SoTranslation;
class SoScale;
class SoXtBitmapButton;
 
//
//  Class: SoXtExaminerViewer
//
//      Examiner viewer - allows the user to change the camera position
//  by spinning a sphere in front of the viewpoint.
//
//
//      Keys used by this viewer:
//      -------------------------
//
//      Left Mouse: Tumbles the virtual trackball.
//
//      Middle Mouse:
//      Ctrl + Left Mouse: Translate up, down, left and right.
//
//      Ctrl + Middle Mouse:
//      Left + Middle Mouse: Dolly in and out (gets closer to and further
//                          away from the object).
//
//      <s> + click: Alternative to the Seek button. Press (but do not hold
//                  down) the <s> key, then click on a target object.
//
//      Right Mouse: Open the popup menu.
//
 
class  SoXtExaminerViewer : public SoXtFullViewer
{
 public:
 
  enum ViewingMode 
  {
    VIEWING_MODE_SPIN,
 
    VIEWING_MODE_SPIN_CONSTRAINED,
 
    VIEWING_MODE_PAN,
 
    VIEWING_MODE_ZOOM
  };
 
  enum ConstrainedViewingMode 
  {
    NONE,
    CONSTRAINED_VIEWING_MODE_X,
 
    CONSTRAINED_VIEWING_MODE_Y,
 
    CONSTRAINED_VIEWING_MODE_Z
  };
 
  SoXtExaminerViewer( SoWidget parent = NULL,
                      const char* name = NULL,
                      SbBool buildInsideParent = TRUE,
                      SoXtFullViewer::BuildFlag flag = SoXtFullViewer::BUILD_ALL,
                      SoXtViewer::Type type = SoXtViewer::BROWSER );
  ~SoXtExaminerViewer();
 
  void setViewingMode( ViewingMode viewingMode ) ;
 
  ViewingMode getViewingMode() const
  { return (ViewingMode)m_guiExamViewer->getViewingMode(); }
 
  void setConstrainedViewingMode( ConstrainedViewingMode mode );
 
  ConstrainedViewingMode getConstrainedViewingMode() const
  { return m_constrainedMode; }
 
  void setFeedbackVisibility( SbBool onOrOff );
 
  SbBool isFeedbackVisible() const { return m_guiExamViewer->isFeedbackVisible(); }
 
  void setFeedbackSize( int newSize );
 
  int getFeedbackSize() const { return m_guiExamViewer->getFeedbackSize(); }
 
  void setAnimationEnabled( SbBool onOrOff );
 
  SbBool isAnimationEnabled() { return m_guiExamViewer->isAnimationEnabled(); }
 
  void stopAnimating();
 
  SbBool isAnimating() { return m_guiExamViewer->isAnimating(); }
 
  //
  // redefine these to add Examiner viewer functionality
  //
  virtual void viewAll();
  virtual void resetToHomePosition();
  virtual void setCamera( SoCamera* cam );
  virtual void setViewing( SbBool onOrOff );
  virtual void setCursorEnabled( SbBool onOrOff );
  virtual void setSeekMode( SbBool onOrOff );
 
  virtual void activateSpinning( const SbVec2s& newLocator );
 
  virtual void activatePanning( const SbVec2s& newLocator );
 
  virtual void activateDolly( const SbVec2s& newLocator );
 
  virtual void activateRoll( const SbVec2s& newLocator );
 
  virtual void rollCamera( const SbVec2s& newLocator );
 
 
  virtual void spinCamera( const SbVec2f& newLocator );
 
  virtual void spinConstrainedCamera( const SbVec2f& newLocator, int axisIndex );
 
  virtual void dollyCamera( const SbVec2s& newLocator );
 
  virtual void reverseDollyCamera( const SbVec2s& newLocator );
 
  virtual void panCamera( const SbVec2f& newLocator );
 
  private:
 
  virtual void rotateCamera( const SbRotation& rot );
 
  void constrainCameraRotation( bool x = false, bool y = false, bool z = false );
 
  private:
 
  SoGuiExaminerViewer* getGuiExaminerViewer() const;
 
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtExaminerViewer::buildWidget()
  // when they are ready for it to be built.
   private:
    SoXtExaminerViewer( 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();
 
  // Get X resources for the widget.
  SoWidget buildWidget( SoWidget parent );
 
  // Define those thumb wheels to rotate the object
  virtual void bottomWheelMotion( float newVal );
  virtual void leftWheelMotion( float newVal );
  virtual void rightWheelMotion( float newVal );
 
  // redefine those routines to also stop animation if any
  virtual void bottomWheelStart();
  virtual void leftWheelStart();
 
  // add viewer preference stuff
  virtual void createPrefSheet();
 
  // add some viewer buttons
  virtual void createViewerButtons( SoWidget parent );
 
  // Define this to bring the viewer help card
  virtual void openViewerHelpCard();
 
  virtual void updateCursor();
 
 private:
  // viewer state variables
  Cursor spinCursor, panCursor, dollyCursor, seekCursor;
  SbBool firstBuild; // set FALSE after buildWidget called once
 
  // point of rotation feedback vars
  void createFeedbackNodes();
 
  // variables used for doing spinning animation
  unsigned long lastMotionTime;
  static void visibilityChangeCB( void* pt, SbBool visible );
 
  void setViewerMode();
  void updateViewerMode( unsigned int state );
  void switchMode( int newMode );
  void defineCursors();
 
  // preference sheet stuff
  SoWidget createExamPrefSheetGuts( SoWidget parent );
  static void animPrefSheetToggleCB( SoWidget w, SoXtExaminerViewer* v, void* data );
 
  // point of rotation pref sheet stuff
  int feedbackSizeWheelVal;
  SoWidget feedbackLabel[2], feedbackField, feedbackSizeWheel;
  static void feedbackSizeWheelCB( SoWidget w, SoXtExaminerViewer* v, XtPointer* d );
  static void feedbackSizeFieldCB( SoWidget w, SoXtExaminerViewer* v, void* data );
  static void feedbackPrefSheetToggleCB( SoWidget w, SoXtExaminerViewer* v, void* data );
  void toggleFeedbackWheelSize( SoWidget toggle );
 
  // push button vars and callbacks
  SoXtBitmapButton* buttonList[10];
  static void camPushCB( SoWidget w, SoXtExaminerViewer* v, void* data);
 
  // this is called by both constructors
  void constructorCommon( SbBool buildNow );
 
  SoGuiExaminerViewer* m_guiExamViewer; // Implementation class for SoXxExaminerViewer
 
  // Viewer state variables
  SoGuiExaminerViewer::ViewingSpinType m_viewingSpinType;
  ConstrainedViewingMode m_constrainedMode; // Constrained viewing type
};
 
#endif  /* _SO_XT_EXAMINER_VIEWER_ */
 
#endif // _WIN32