SoQtFullViewer.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      : Alain Dumesny (MMM yyyy)
**=======================================================================*/
 
 
#ifndef  _SO_QT_FULL_VIEWER_
#define  _SO_QT_FULL_VIEWER_
#include <Inventor/Qt/OivQtCompat.h>
 
#include <QScrollBar>
#include <QPushButton>
#include <QString>
#include <QLabel>
#include <QMenu>
#include <QAction>
#include <QVBoxLayout>
#include <QHBoxLayout>
 
#include <Inventor/Qt/viewers/SoQtViewer.h>
 
#include <Inventor/SbPList.h>
 
#include <Inventor/Gui/viewers/SoGuiFullViewer.h>
 
#include <QPointer>
 
// classes used
class SoFieldSensor;
class SoQtThumbWheel;
class SoStereoDialog;
class QLineEdit;
class SoRecordDialog;
 
//
//  Class: SoQtFullViewer
//
//      The SoQtFullViewer component class is the abstract base class for all
//  viewers which include a decoration around the rendering area. The 
//  decoration is made of thumbwheels, sliders and push/toggle buttons. There
//  is also a popup menu which includes all of the viewing options and methods.
//
 
class  SoQtFullViewer : public SoQtViewer 
{
 
  Q_OBJECT
 
public:
  enum BuildFlag 
  {
    BUILD_NONE          = 0x00, 
    BUILD_DECORATION    = 0x01, 
    BUILD_POPUP         = 0x02, 
    BUILD_ALL           = 0xff 
  };
 
  virtual void setDecoration( SbBool onOrOff );
 
  SbBool isDecoration() { return m_guiFullViewer->isDecoration(); }
 
  void setPopupMenuEnabled( SbBool trueOrFalse );
 
  SbBool isPopupMenuEnabled() { return m_guiFullViewer->isPopupMenuEnabled(); }
 
  void setClientPopupMenu( QMenu* menu );
 
  SbBool isClientPopupMenuInstalled() { return (ClientPopup!= NULL); }
 
  QWidget* getAppPushButtonParent() const { return appButtonForm; }
 
  void addAppPushButton( SoQtButton* newButton );
 
  void insertAppPushButton( SoQtButton* newButton, int index );
 
  void removeAppPushButton( SoQtButton* oldButton );
 
  int findAppPushButton( SoQtButton* oldButton ) { return appButtonList->find(oldButton); }
 
  int lengthAppPushButton() { return appButtonList->getLength(); }
 
  QWidget* getRenderAreaWidget() { return raWidget; }
 
  // redefine these from the base class
  virtual void setViewing( SbBool onOrOff );
 
  virtual void setCamera( SoCamera* cam );
  virtual void hide();
  virtual void setHeadlight( SbBool onOrOff);
  virtual void setDrawStyle( SoQtViewer::DrawType type, SoQtViewer::DrawStyle style );
  virtual void setBufferingType( SoQtViewer::BufferType type );
 
  virtual SoStereoDialog* getStereoDialog() { return stereoDialogBox; }
 
  void setStereoDialog( SoStereoDialog* newDialog );
 
  QPointer<QMenu> mainPopup;
 
  QPointer<QMenu> funcPopup;
 
  QPointer<QMenu> drawPopup;
 
  QPointer<QMenu> prefPopup;
 
  QAction* curPopupDrawItem;
 
  /*
   * Tracks the checkmark for "Moving" draw style.
   */
  QAction* curPopupMoveItem;
 
  /*
   * Tracks the checkmark for the buffering draw style.
   */
  QAction* curPopupBufferItem;
 
  QPointer<QMenu> ClientPopup;
 
  private:
  virtual ~SoQtFullViewer();
 
  SoGuiFullViewer* getGuiFullViewer() const;
 
  virtual void openStereoDialog();
  virtual void openRecordDialog();
 
  virtual void internalSetViewingMode( int ) {};
  virtual int internalGetViewingMode() const { return 0; };
  virtual void defineCursors() { SoQtViewer::defineCursors(); };
 
  // retro compatibilty, don't use them directly. Call their accessors.
  float rightWheelVal, leftWheelVal, bottomWheelVal; 
  SbBool popupEnabled;
 
private:
  // Constructor/Destructor
  SoQtFullViewer( QWidget* parent,
    const char* name, 
    SbBool buildInsideParent, 
    SoQtFullViewer::BuildFlag flag,             
    SoQtViewer::Type type, 
    SbBool buildNow,
    SbBool sync );
 
  SoQtFullViewer( QWidget* parent,
    const char* name, 
    SbBool buildInsideParent, 
    SoQtFullViewer::BuildFlag flag,             
    SoQtViewer::Type type, 
    SbBool buildNow,
    SbBool sync,
    SoGuiFullViewer* guiFullViewer );
 
  // general decoration vars
  QWidget         *mgrWidget; // form which manages all other widgets
  QWidget         *raWidget;  // render area widget
 
  QPointer<QWidget> leftTrimForm, bottomTrimForm, rightTrimForm;
  QWidget*        subMgrWidget;
  QHBoxLayout*    subHbl; // subMgrWidget layout
 
  QPointer<QWidget>         zoomForm;
  QLineEdit       *zoomField;
  QScrollBar      *zoomSlider;
  SoFieldSensor   *zoomSensor; // attached to camera zoom field
 
  // thumb wheel vars
  SoQtThumbWheel  *rightWheel, *bottomWheel, *leftWheel , *extraWheel;
 
  QPointer<QWidget>         extraTrimForm;
  float           extraWheelVal;
  QString         extraWheelStr;
  int             extraLabelHeight;
  QWidget         *extraWheelLabel;    //Handle of static control
 
  // static control that contains all the viewer
  // buttons on the right side
  QPointer<QWidget>         vwrButtonForm;
 
  QBrush          backgroundBrush;    //Used to paint control bkgds
 
  QString         rightWheelStr, bottomWheelStr, leftWheelStr;
  QLabel          *rightWheelLabel, *bottomWheelLabel, *leftWheelLabel, *zoomLabel;
 
  // widget list of viewer buttons
  SbPList         *viewerButtonWidgets;
 
  int numFullVwrButtons;
 
  // Subclasses should override this function (in addition to
  // createViewerButtons), handle selection if it's a button they
  // added and if not kick it back up to this function.
  virtual void pushButtonCB( int id );
 
  // The button widget should be used as the parent widget
  // when creating new buttons
  QWidget         *getButtonWidget() const { return appButtonForm; }
 
  // popup menu vars
  QWidget         *popupWidget, *popupToggleWidgets;
  QWidget         *drawStyleWidgets, *bufferStyleWidgets[3];
  QString         popupTitle;
 
  //
  // Build/destroy decoration routines
  //
  QWidget             *buildWidget( QWidget* parent );
 
  virtual void        buildDecoration();
  virtual QWidget     *buildLeftTrim( QWidget* parent );
  virtual QWidget     *buildBottomTrim( QWidget* parent );
  virtual QWidget     *buildRightTrim( QWidget* parent );
  virtual QWidget     *buildZoomSlider( QWidget* parent );
  QWidget             *buildAppButtons( QWidget* parent );
  QWidget             *buildViewerButtons( QWidget* parent );
  virtual void        createViewerButtons( QWidget* parent );
 
  //
  // popup menu build routines
  //
  virtual void buildPopupMenu();
 
  virtual void destroyPopupMenu();
  void setPopupMenuString( const QString& name );
  QWidget* buildFunctionsSubmenu( QWidget* popup );
  QWidget* buildDrawStyleSubmenu( QWidget* popup );
 
  // Display the main or the client popup menu
  virtual void displayPopupMenu( QPoint point );
 
  // Subclasses SHOULD redefine these to do viewer specific tasks
  // since these do nothing in the base class. those routines are
  // called by the thumb wheels whenever they rotate.
  virtual void rightWheelMotion( float f );
  virtual void bottomWheelMotion( float f);
  virtual void leftWheelMotion( float f );
 
  // 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();
 
  // Subclasses SHOULD set those wheel string to whatever functionality
  // name they are redefining the thumb wheels to do. Default names are
  // "Motion X, "Motion Y" and "Motion Z" for bottom, left and right wheels.
  void setBottomWheelString( const QString& name );
  void setLeftWheelString( const QString& name );
  void setRightWheelString( const QString& name );
 
  // Subclasses SHOULD redefine the openViewerHelpCard() routine to bring 
  // their help card (called by push button and popup menu entry).
  // They can simply call SoQtComponent::openHelpCard() to open their
  // specific help card.
  virtual void openViewerHelpCard();
 
  // redefine this to load the popup menu colormap
  virtual void afterRealizeHook();
 
private:
  QPointer<QWidget> appButtonForm;
 
  int SO_WHEEL_DELTA;
 
  virtual void setSeekButton( SbBool onOff );
 
private:
  void constructorCommon( SoQtFullViewer::BuildFlag buildFlag, SbBool buildNow );
 
  SoGuiFullViewer* m_guiFullViewer; // Implementation class for SoXxFullViewer
 
  SbBool firstBuild; // set FALSE after buildWidget called once
  SbBool m_seekState;
 
  // app button vars
  SbPList* appButtonList;
  void doAppButtonLayout( int start, SoQtButton* newButton );
 
  SoStereoDialog *stereoDialogBox;
  SoRecordDialog* m_recordDialogBox;
 
  // zoom slider vars and routines
  SbVec2f zoomSldRange;
  void setCameraZoom( float zoom );
  float getCameraZoom();
  void setZoomSliderPosition( float zoom );
  void setZoomFieldString( float zoom );
 
  static void zoomSensorCB( void* d, SoSensor* s );
 
  // push buttons vars and callbacks
  SoQtButton* buttonList[10];
 
  // pref sheet variables
  QWidget* prefSheetShellWidget;
  char* prefSheetStr;
 
  // seek dist pref sheet vars and callbacks
  int seekDistWheelVal;
  QWidget* seekDistField;
 
  // clipping plane pref sheet callbacks and variables
  QWidget* clipWheelForm;
  int clipNearWheelVal, clipFarWheelVal;
  QWidget* clipNearField, clipFarField;
 
  // stereo viewing pref sheet callbacks and variables
  QWidget* stereoWheelForm, stereoField, stereoLabel;
  int stereoWheelVal;
 
  void UPDATE_CHECKMARK( QAction* curItem, QAction* item );
 
  QVBoxLayout*    mgrVbl; // mgrWidget layout
 
private:
 
  //pixmap
  QPixmap IDB_PUSH_PICK;
  QPixmap IDB_PUSH_VIEW;
  QPixmap IDB_PUSH_HELP;
  QPixmap IDB_PUSH_HOME;
  QPixmap IDB_PUSH_SETHOME;
  QPixmap IDB_PUSH_VIEWALL;
  QPixmap IDB_PUSH_SEEK;
  QPixmap IDB_PUSH_GRAYSEEK;
 
  // Popup menu: need this to have a link to the menu items.
  QAction* IDM_DPOPUP_ASIS;
  QAction* IDM_DPOPUP_HLINE;
  QAction* IDM_DPOPUP_NOTEX;
  QAction* IDM_DPOPUP_LOWRES;
  QAction* IDM_DPOPUP_WIRE;
  QAction* IDM_DPOPUP_POINTS;
  QAction* IDM_DPOPUP_BBOX;
  //move style
  QAction* IDM_DPOPUP_MSAMEAS ;
  QAction* IDM_DPOPUP_MNOTEX;
  QAction* IDM_DPOPUP_MLOWRES;
#ifdef _WIN32
  QAction* IDM_DPOPUP_MHLINE;
#endif
  QAction* IDM_DPOPUP_MWIRE;
  QAction* IDM_DPOPUP_MPOINTS;
  QAction* IDM_DPOPUP_MBBOX;
  //buffer
  QAction* IDM_DPOPUP_SBUFFER;
  QAction* IDM_DPOPUP_DBUFFER;
  QAction* IDM_DPOPUP_IBUFFER;
  //preference menu
  QAction* IDM_PPOPUP_SEEK;
  QAction* IDM_PPOPUP_CLIP;
  QAction* IDM_PPOPUP_SPIN;
  QAction* IDM_PPOPUP_INTERACTIVE;
  QAction* IDM_PPOPUP_AXES;
  QAction* IDM_PPOPUP_STEREO;
  QAction* IDM_PPOPUP_FSAA;
  QAction* IDM_PPOPUP_RECORD;
  //mainPopup 
  QAction* IDM_MPOPUP_VIEWING;
  QAction* IDM_MPOPUP_DECORAT;
  QAction* IDM_MPOPUP_FULLSCREEN;
  QAction* IDM_MPOPUP_HLIGHT;
 
#ifndef HIDDEN_FROM_DOC
  protected Q_SLOTS:
    //slot for thumbwheel
    void leftWheelDrag( int value );
    void leftWheelOther();
    void rightWheelDrag( int value );
    void rightWheelOther();
    void bottomWheelDrag( int value );
    void bottomWheelOther();
 
    void slotPushPickButton();
    void slotPushViewButton();
    void slotPushHelpButton();
    void slotPushHomeButton();
    void slotPushSetHomeButton();
    void slotPushViewAllButton();
    void slotPushSeekButton();
 
    //Q_SLOTS for popup menu
    void slot_popup_home();
    void slot_popup_setHome();
    void slot_popup_viewAll();
    void slot_popup_seek();
 
    //preference menu
    void slot_popup_seekToPoint();
    void slot_popup_clip();
    void slot_popup_interactive();
    void slot_popup_stereo();
    void slot_popup_fsaa();
    void slot_popup_recording();
 
    //mainpopup
    void slot_popup_viewing();
    void slot_popup_decoration();
    void slot_popup_fullscreen();
    void slot_popup_headLight();
 
    //draw style menu
    void slot_popup_asIs();
    void slot_popup_hiddenLine();
    void slot_popup_noTexture();
    void slot_popup_lowResolution();
    void slot_popup_wireFrame();
    void slot_popup_points();
    void slot_popup_boundingBox();
    void slot_popup_moveSameAsStill();
    void slot_popup_moveNoTexture();
    void slot_popup_moveLowRes();
    void slot_popup_moveWireFrame();
    void slot_popup_movePoints();
    void slot_popup_moveBoundingBox();
    void slot_popup_singleBuffer();
    void slot_popup_doubleBuffer();
    void slot_popup_interactiveBuffer();
 
#endif // HIDDEN_FROM_DOC
 
    private Q_SLOTS:
      void visibilityChangeCB( SbBool visible );
      void zoomSliderCB( int value );
      void textChangedSlot();
      void setNum( int value );
      void slot_internalStereoDialogDestroyed();
      void slot_externalStereoDialogDestroyed();
      void slot_internalRecordDialogDestroyed();
};
 
#endif  /* _SO_QT_FULL_VIEWER_ */