SoGuiExaminerViewer.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T.MEHAMLI (Jun 2007)
**=======================================================================*/
 
#ifndef SO_GUI_EXAMINER_VIEWER
#define SO_GUI_EXAMINER_VIEWER
 
//
//  Class: SoGuiViewer
//
// SoXXExaminerViewer implementation class
// 
//
 
#include <Inventor/Gui/viewers/SoGuiAlgoViewers.h>
 
// classes used
class SbSphereSheetProjector;
class SoSeparator;
class SoSwitch;
class SoTranslation;
class SoScale;
 
class SbTime;
 
 
class  SoGuiExaminerViewer : public SoGuiAlgoViewers 
{
#ifndef HIDDEN_FROM_DOC
  SO_FIELDCONTAINER_HEADER( SoGuiExaminerViewer );
#endif
 
private:
 
  //Macros
#define KEY_PRESS_CHECK_VALID_MACRO \
  if ( m_mode != IDLE_MODE && m_mode != SPIN_MODE && \
  m_mode != TRANS_MODE && m_mode != DOLLY_MODE ) \
  break;
 
// size of the rotation buffer, which is used to animate the spinning ball.
#define ROT_BUFF_SIZE 3
 
  enum ViewingMode 
  {
    VIEWING_MODE_SPIN,
 
    VIEWING_MODE_SPIN_CONSTRAINED,
 
    VIEWING_MODE_PAN,
 
    VIEWING_MODE_ZOOM
  };
 
  enum ViewerModes 
  {
    PICK_MODE,          // Alt key can take us out of viewing mode
    VIEW_MODE,          // Equivalent to old IDLE_MODE
    SPIN_MODE = VIEW_MODE,
    SPIN_MODE_ACTIVE,   // Equivalent to old SPIN_MODE
    SPINX_MODE_ACTIVE,          // Rotation on X axis.
    SPINY_MODE_ACTIVE,          // Rotation on Y axis.
    SPINZ_MODE_ACTIVE,          // Rotation on Z axis.
    PAN_MODE,           // Just Ctrl key pressed (similar to old ROLL_MODE)
    PAN_MODE_ACTIVE,    // Equivalent to old TRANS_MODE
    DOLLY_MODE,          // 
    DOLLY_MODE_ACTIVE,  // Equivalent to old DOLLY_MODE
    SEEK_MODE,
    SPINX_VIEWER_MODE_ACTIVE,   // Rotation on X viewer axis.
    SPINY_VIEWER_MODE_ACTIVE,   // Rotation on Y viewer axis.
    SPINZ_VIEWER_MODE_ACTIVE,   // Rotation on Z viewer axis.
    REVERSE_DOLLY_MODE_ACTIVE, // A reversed DOLLY MODE
    ROLL_MODE,
    ROLL_MODE_ACTIVE, // Rotation centered around an anchor.
    EMPTY_MODE = -1
  };
 
  // list of custom push buttons
  enum 
  {
    CAM_PUSH = 0,
    PUSH_NUM
  };
 
  // Defines the spining type
  enum ViewingSpinType 
  {
    VIEWING_SPIN_FREE,
    VIEWING_SPIN_X_OR_Y, // Means that the spin is either on the X or on the Y axis
    VIEWING_SPIN_X,
    VIEWING_SPIN_Y,
    VIEWING_SPIN_Z
  };
 
  SoGuiExaminerViewer();
 
  void setViewingMode( ViewingMode viewingMode );
 
  ViewingMode getViewingMode() const;
 
  void setFeedbackVisibility( SbBool insertFlag );
 
  void setFeedbackFlag( SbBool flag );
 
  SbBool isFeedbackVisible() const;
 
  void setFeedbackSize( int newSize );
 
  int getFeedbackSize() const;
 
  void setAnimationEnabled( SbBool flag );
 
  SbBool isAnimationEnabled();
 
  void setAnimatingFlag( SbBool flag );
 
  SbBool isAnimating();
 
  //Accessor for the member m_feedbackSwitch
  SoSwitch* getFeedbackSwitch() const;
 
  // ----------------------- Extension usage -----------------------------------
 
  // redefine those routines to do viewer specific stuff
  virtual void actualRedraw();
 
  virtual void setCursorEnabled( SbBool onOrOff );
  virtual void setSeekMode( SbBool onOrOff );
 
private:
 
  virtual ~SoGuiExaminerViewer();
 
// ----------------------- Private usage -------------------------------------
private:
 
  void createFeedbackNodes();
 
  // Viewer state variables
  ViewingMode m_viewingMode;
  int m_viewerMode;
 
  // point of rotation feedback vars
  SbBool m_feedbackFlag;
  SoSeparator* m_feedbackRoot;
  SoSwitch* m_feedbackSwitch;
  SoTranslation* m_feedbackTransNode;
  SoScale* m_feedbackScaleNode;
  float m_feedbackSize;
  static char* m_geometryBuffer;
 
  // variables used for spinning animation
  SbBool m_animationEnabled, m_animatingFlag;
};
 
#endif // SO_GUI_EXAMINER_VIEWER