SoWinPlaneViewer.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
 
#ifndef _SO_WIN_PLANE_VIEWER_
#define _SO_WIN_PLANE_VIEWER_
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
#include <Inventor/Win/viewers/SoWinFullViewer.h>
#include <Inventor/SbLinear.h>
 
#include <Inventor/Gui/viewers/SoGuiPlaneViewer.h>
 
class SoWinBitmapButton;
 
//
//  Class: SoWinPlaneViewer
//
//      Plane Viewer - allows the user to move left, right, up, and down a 
//  given plane, as well as roll the viewer and zoom in and out.
//
//
//      Keys used by this viewer:
//      -------------------------
//
//  Left Mouse: Dolly in and out (gets closer to and further away from the
//  object).
//
//  Middle Mouse: 
//  Ctrl + Left Mouse: Translate up, down, left and right.
//
//  Ctrl + Middle Mouse: Used for roll action (rotates around the viewer
//  forward direction).
//
//  Shift + Ctrl + Left Mouse: Roll (same as Ctrl + Middle Mouse 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  SoWinPlaneViewer : public SoWinFullViewer 
{
 
 public:
  SoWinPlaneViewer( SoWidget parent = NULL,
                    const char* name = NULL, 
                    SbBool buildInsideParent = TRUE, 
                    SoWinFullViewer::BuildFlag flag = SoWinFullViewer::BUILD_ALL, 
                    SoWinViewer::Type type = SoWinViewer::BROWSER );
  ~SoWinPlaneViewer();
 
  void setPlane( const SbVec3f& newNormal, const SbVec3f& newRight );
 
  //
  // redefine these to add Plane viewer functionality
  //
  virtual void setViewing( SbBool onOrOff );
  virtual void setCamera( SoCamera* cam );
  virtual void setCursorEnabled( SbBool onOrOff );
  virtual void setSeekMode( SbBool onOrOff );
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinPlaneViewer::buildWidget()
  // when they are ready for it to be built.
  private:
  
  SoGuiPlaneViewer* getGuiPlaneViewer() const;
 
    SoWinPlaneViewer( SoWidget parent,
                      const char* name, 
                      SbBool buildInsideParent, 
                      SoWinFullViewer::BuildFlag flag, 
                      SoWinViewer::Type type, 
                      SbBool buildNow,
                      SbBool sync = TRUE );
 
 private:
  SoWidget buildWidget( SoWidget parent );
 
  // 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();
 
  // Define those thumb wheels to translate in the viewer plane
  virtual void bottomWheelMotion( float newVal );
  virtual void leftWheelMotion( float newVal );
  virtual void rightWheelMotion( float newVal );
  virtual void mouseWheelMotion( float newVal );
 
  // 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();
 
  // Redefine this to keep the same camera rotation when seeking
  virtual void computeSeekFinalOrientation();
 
  // 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 updateCursor();
 
 private:
 
  SoGuiPlaneViewer* m_guiPlaneViewer; // Implementation class for SoXxPlaneViewer
 
  // push button vars and callbacks
  SoWinBitmapButton* buttonList[10];
 
  void updateViewerMode( unsigned int state );
  void switchMode( int newMode );
 
  // 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_PLANE_VIEWER_ */