SoGuiFullViewer.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      : T.MEHAMLI (Jun 2007)
**=======================================================================*/
 
#ifndef  SO_GUI_FULL_VIEWER
#define  SO_GUI_FULL_VIEWER
 
//
//  Class: SoGuiFullViewer
//
// SoXXFullViewer implementation class
// 
//
 
#include <Inventor/Gui/viewers/SoGuiViewer.h>
 
// classes used
class SoFieldSensor;
class SoStereoDialog;
class SoAntialiasingParameters;
 
 
class  SoGuiFullViewer : public SoGuiViewer 
{
#ifndef HIDDEN_FROM_DOC
  SO_FIELDCONTAINER_HEADER( SoGuiFullViewer );
#endif
 
private:
  // This specifies what should be build by default in the constructor
  enum BuildFlag 
  {
    BUILD_NONE          = 0x00, 
    BUILD_DECORATION    = 0x01, 
    BUILD_POPUP         = 0x02, 
    BUILD_ALL           = 0xff 
  };
 
  /*
   * Defines
   */
  // list of the different popup choices
  enum popupChoices 
  {
    VIEW_ALL = 20,  // enables the same menu routine to be used
    SET_HOME,    // as the draw style entrie (can't overlap
    HOME,         // with SoWinViewerDrawStyle values)
    HEADLIGHT, 
    SEEK, 
    PREF, 
    VIEWING, 
    DECORATION, 
    FULLSCREEN,
    COPY_VIEW, 
    PASTE_VIEW,
    HELP
  };
 
  enum drawChoices 
  {
    AS_IS,
    HIDDEN_LINE, 
    NO_TXT, 
    LOW_RES, 
    LINE, 
    POINT,
    BBOX, 
    
    MOVE_SAME_AS, 
    MOVE_NO_TXT, 
    MOVE_LOW_RES, 
    MOVE_LINE, 
    MOVE_LOW_LINE, 
    MOVE_POINT, 
    MOVE_LOW_POINT, 
    MOVE_BBOX, 
    
    DRAW_STYLE_NUM // specify the length
  };
 
  // list of the toggle buttons in the popumenu
  enum popupToggles 
  {
    HEADLIGHT_WIDGET = 0,    // very convenient to start at 0
    VIEWING_WIDGET,
    DECORATION_WIDGET,
    FULLSCREEN_WIDGET,
    POPUP_TOGGLE_NUM   // specify the length
  };
 
  // list of custom push buttons
  enum ViewerPushButtons 
  {
    PICK_PUSH, 
    VIEW_PUSH, 
    HELP_PUSH, 
    HOME_PUSH,
    SET_HOME_PUSH,
    VIEW_ALL_PUSH,
    SEEK_PUSH,
    PUSH_NUM
  };
 
  SoGuiFullViewer();
 
  void setDecoration( SbBool onOrOff );
 
  SbBool isDecoration();
    
  void setPopupMenuEnabled( SbBool trueOrFalse );
 
  SbBool isPopupMenuEnabled();
 
  bool toggleAntiAliasing();
 
  // Accessors and mutators for xxWheelVals
  void setRightWheelVal( float newVal );
  float getRightWheelVal() const;
 
  void setBottomWheelVal( float newVal );
  float getBottomWheelVal() const;
 
  void setLeftWheelVal( float newVal );
  float getLeftWheelVal() const;
 
  void initVars( BuildFlag buildFlag ); // Initialize m_popupEnabled & m_decorationFlag
 
  // ----------------------- Extension usage -----------------------------------
    
  // Subclasses can redefine these to add viewer functionality. They
  // by default call start and finish interactive viewing methods.
  // (defined in the base class).
  virtual void rightWheelStart();
  virtual void bottomWheelStart();
  virtual void leftWheelStart();
  virtual void rightWheelFinish();
  virtual void bottomWheelFinish();
  virtual void leftWheelFinish();
 
  int SO_WHEEL_DELTA;
 
  private:
   virtual ~SoGuiFullViewer();
 
  // ----------------------- Private usage -------------------------------------
  private:
 
  SbBool m_decorationFlag;
  SbBool m_popupEnabled;
  float  m_rightWheelVal, m_bottomWheelVal, m_leftWheelVal;
 
  // Antialiasing parameters to restore after toggling AA OFF with the GUI button
  float m_savedAAQuality;
  SoAntialiasingParameters* m_savedAAParams;
};
 
#endif  // SO_GUI_FULL_VIEWER