Inventor/Qt/viewers/SoQtExaminerViewer.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
**=======================================================================*/


#ifndef _SO_QT_EXAMINER_VIEWER_
#define _SO_QT_EXAMINER_VIEWER_
#include <Inventor/Qt/OivQtCompat.h>
#include <Inventor/Qt/viewers/SoQtFullViewer.h>
#include <Inventor/events/SoMouseButtonEvent.h>

#include <QPointer>
#include <QCursor>

#include <Inventor/Gui/viewers/SoGuiExaminerViewer.h>
// classes used
class SbSphereSheetProjector;
class SoFieldSensor;
class SoSeparator;
class SoSwitch;
class SoTranslation;
class SoScale;

class SbTime;

//
// Class: SoQtExaminerViewer
//
//  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  SoQtExaminerViewer : public SoQtFullViewer 
{

  Q_OBJECT

public:

  enum ViewingMode 
  {
    VIEWING_MODE_SPIN,

    VIEWING_MODE_SPIN_CONSTRAINED,

    VIEWING_MODE_PAN,

    VIEWING_MODE_ROLL,

    VIEWING_MODE_ZOOM
  } ;

  enum ConstrainedViewingMode 
  {
    NONE,
    CONSTRAINED_VIEWING_MODE_X,

    CONSTRAINED_VIEWING_MODE_Y,

    CONSTRAINED_VIEWING_MODE_Z
  } ;

  SoQtExaminerViewer( QWidget* parent = NULL,
                      const char* name = NULL, 
                      SbBool buildInsideParent = TRUE, 
                      SoQtFullViewer::BuildFlag flag = SoQtFullViewer::BUILD_ALL, 
                      SoQtViewer::Type type = SoQtViewer::BROWSER );
  ~SoQtExaminerViewer();

  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:

  SoGuiExaminerViewer* getGuiExaminerViewer() const;

  virtual void internalSetViewingMode( int viewingMode ) { setViewingMode( ViewingMode(viewingMode) ); };
  virtual int internalGetViewingMode() const { return (int)m_guiExamViewer->getViewingMode(); };

  private:

  virtual void rotateCamera( const SbRotation& rot );

  void constrainCameraRotation( bool x = false, bool y = false, bool z = false );

  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoQtExaminerViewer::buildWidget()
  // when they are ready for it to be built.
  SoQtExaminerViewer( QWidget* parent,
                      const char* name, 
                      SbBool buildInsideParent, 
                      SoQtFullViewer::BuildFlag flag, 
                      SoQtViewer::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( QEvent* anyevent );
  virtual void actualRedraw();

  // Get X resources for the widget.
  QWidget* buildWidget( QWidget* 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( QWidget*  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();

  virtual void pushButtonCB( int id );

  virtual void updateCursor();

  virtual void switchMode( int newMode );

  virtual void doSpinAnimation();

  int mode;

  SbVec2s locator; // mouse position

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

  // variables used for doing spinning animation
  SbTime lastMotionTime;

  void setViewerMode();
  void updateViewerMode( unsigned int state );

  // push button vars and callbacks
  QPointer<SoQtButton> buttonList[10];
  static void camPushCB( SoQtExaminerViewer* v);

  // this is called by both constructors
  void constructorCommon( SbBool buildNow );

  //pixmap
  QPixmap IDB_PUSH_PERSP;
  QPixmap IDB_PUSH_ORTHO;

#ifndef HIDDEN_FROM_DOC
  private Q_SLOTS:
    //slot for cam button
    void slotCamPushButton();

  //preference menu
  void slot_popup_spin();
  void slot_popup_axes();
 
#endif // HIDDEN_FROM_DOC

  private Q_SLOTS:
    void visibilityChangeCB( SbBool visible );

};

#endif /* _SO_QT_EXAMINER_VIEWER_ */

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/