SoWinExaminerViewer.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_EXAMINER_VIEWER_
#define _SO_WIN_EXAMINER_VIEWER_
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
#include <Inventor/Win/viewers/SoWinFullViewer.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 SoWinBitmapButton;
 
//
// Class: SoWinExaminerViewer
//
//  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).
//
//  Shift + Ctrl + Left Mouse: Dolly in and out (same as Left + Middle
//  behavior but added by VSG to support the
//  standard Microsoft 2-button mouse).
//
//  <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  SoWinExaminerViewer : public SoWinFullViewer 
{
 
 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,
  };
 
  SoWinExaminerViewer( SoWidget parent = NULL,
                       const char* name = NULL, 
                       SbBool buildInsideParent = TRUE, 
                       SoWinFullViewer::BuildFlag flag = SoWinFullViewer::BUILD_ALL, 
                       SoWinViewer::Type type = SoWinViewer::BROWSER );
  ~SoWinExaminerViewer();
 
  void setViewingMode( ViewingMode viewingMode ) ;
 
  ViewingMode getViewingMode() const
  { return (ViewingMode)m_guiExamViewer->getViewingMode(); }
 
  void setConstrainedViewingMode( ConstrainedViewingMode mode );
 
  ConstrainedViewingMode getConstrainedViewingMode() const
  { return m_constrainedMode; }
 
  // Constrained viewer.
  class  SoViewingFunction 
  {
  public:
    void setViewer(SoWinViewer* viewer) { m_viewer = viewer; }
 
    virtual void apply() const = 0;
 
    private:
    SoWinViewer* m_viewer;
  };
 
  class  SoViewingSphericalRotation : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
  
  class  SoViewingTranslation : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingRotationX : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
  
  class  SoViewingRotationY : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingRotationZ : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingRotationXViewer : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingRotationYViewer : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingRotationZViewer : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingSeek : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingDolly : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingReverseDolly : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  class  SoViewingEmpty : public SoViewingFunction 
  {
  private:
    void apply() const;
  };
 
  virtual void addFunctionKeyBinding( SoKeyboardEvent::Key key, const SoViewingFunction* viewingFunc );
 
  virtual void removeFunctionKeyBinding( SoKeyboardEvent::Key functionKey );
 
  virtual void addViewingMouseBinding( SoKeyboardEvent::Key* keys = NULL, 
                                       int numKey = 0,
                                       SoMouseButtonEvent::Button *mouseBtn = NULL, 
                                       int numMouseBtn = 0,
                                       const SoViewingFunction *viewingFunc = NULL );
  virtual void removeViewingMouseBinding( SoKeyboardEvent::Key* keys = NULL,
                                          int numKeys = 0,
                                          SoMouseButtonEvent::Button* mouseBtn = NULL,
                                          int numMouseBtn = 0 );
 
  // End Constrained viewer.
 
  // Defines the list of functions that supports this viewer.
 
  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:
 
  SoGuiExaminerViewer* getGuiExaminerViewer() const;
 
  private:
 
      virtual void rotateCamera( const SbRotation& rot );
 
  void constrainCameraRotation( bool x = false, bool y = false, bool z = false );
 
 private:
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinExaminerViewer::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinExaminerViewer( 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();
 
  // 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 );
  virtual void mouseWheelMotion( 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 );
 
  // build examiner viewer specific popup menu
  // Note: Examiner viewer uses a slightly different popup menu
  // resource that has two more items in the preferences submenu.
  virtual void buildPopupMenu();
 
  // Define this to bring the viewer help card
  virtual void openViewerHelpCard();
 
  // It's a long story, but since we can't attach callbacks to a window
  // quite like we can to an Xt widget, it makes more sense for the
  // subclass viewer to handle the buttons it knows about then pass
  // the rest back up to SoWinFullViewer.
  //
  // So WINxx this function must be virtual and protected, not private.
  virtual void pushButtonCB( SoWidget w, int id, void* data );
 
  virtual void doSpinAnimation();
 
  virtual void updateCursor();
 
 private:
  SoGuiExaminerViewer* m_guiExamViewer; // Implementation class for SoXxExaminerViewer
 
  // Viewer state variables
  SoGuiExaminerViewer::ViewingSpinType m_viewingSpinType;
  ConstrainedViewingMode m_constrainedMode; // Constrained viewing type
 
  SbBool firstBuild; // set FALSE after buildWidget called once
 
  // point of rotation feedback vars
  static char* geometryBuffer;
 
  // variables used for doing spinning animation
  long lastMotionTime;
  static void visibilityChangeCB( void* pt, SbBool visible );
 
 private:
 
  // viewer state variables
  int m_mouseReady; 
  SbBool m_viewingOnOffFlag;
 
  int m_prevFlag;
  
  // Members used to return in the previous mode after using binding function:
  // Set to true when a binding function start.
  SbBool m_needToBeReset;
  // Viewer mode before launching binding function.
  int m_prevCursorMode;
 
  void updateViewerMode( unsigned int state );
  void switchMode( int newMode );
  void setViewerMode();
 
  // push button vars and callbacks
  SoWinBitmapButton* buttonList[10];
  static void camPushCB( SoWidget w, SoWinExaminerViewer* v, void* data );
 
  // 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_EXAMINER_VIEWER_ */