00001 /*=======================================================================
00002  *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
00003  ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
00004  ***                                                                                ***
00005  ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
00006  ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
00007  ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
00008  ***                                                                                ***
00009  ***                        RESTRICTED RIGHTS LEGEND                                ***
00010  ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
00011  ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
00012  ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
00013  ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
00014  ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
00015  ***                                                                                ***
00016  ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
00017  ***                        BORDEAUX, FRANCE                                        ***
00018  ***                      ALL RIGHTS RESERVED                                       ***
00019 **=======================================================================*/
00020 /*=======================================================================
00021 ** Author      : VSG (MMM YYYY)
00022 **=======================================================================*/
00023 
00024 
00025 
00026 
00027 #ifndef _SO_WIN_MP_EXAMINER_VIEWER_
00028 #define _SO_WIN_MP_EXAMINER_VIEWER_
00029 
00030 #if defined(_WIN32)
00031 #  include <Inventor/Win/SoWinBeginStrict.h>
00032 #endif // _WIN32
00033 #include <Inventor/MP/Win/viewers/SoWinMPFullViewer.h>
00034 #include <Inventor/SbLinear.h>
00035 
00036 // classes used
00037 class SbSphereSheetProjector;
00038 class SoFieldSensor;
00039 class SoSeparator;
00040 class SoSwitch;
00041 class SoTranslation;
00042 class SoScale;
00043 
00044 class SoWinBitmapButton;
00045 
00046 
00048 //
00049 // Class: SoWinMPExaminerViewer
00050 //
00051 //  Examiner viewer - allows the user to change the camera position
00052 //  by spinning a sphere in front of the viewpoint.
00053 //
00054 //
00055 //      Keys used by this viewer:
00056 //      -------------------------
00057 //
00058 //      Left Mouse: Tumbles the virtual trackball.
00059 //
00060 //      Middle Mouse: 
00061 //      Ctrl + Left Mouse: Translate up, down, left and right.
00062 //
00063 //      Ctrl + Middle Mouse: 
00064 //      Left + Middle Mouse: Dolly in and out (gets closer to and further
00065 //  away from the object).
00066 //
00067 //  Shift + Ctrl + Left Mouse: Dolly in and out (same as Left + Middle
00068 //  behavior but added by VSG to support the
00069 //  standard Microsoft 2-button mouse).
00070 //
00071 //      <s> + click: Alternative to the Seek button. Press (but do not hold 
00072 //                         down) the <s> key, then click on a target object.
00073 //
00074 //      Right Mouse: Open the popup menu.
00075 //
00077 
00092 class  SoWinMPExaminerViewer : public SoWinMPFullViewer {
00093 
00094  public:
00095   SoWinMPExaminerViewer(SoWidget parent = NULL,
00096                         const char *name = NULL, 
00097                         SbBool buildInsideParent = TRUE, 
00098                         SoWinMPFullViewer::BuildFlag flag = BUILD_ALL, 
00099                         SoWinMPViewer::Type type = BROWSER);
00100   ~SoWinMPExaminerViewer();
00101 
00102   //
00103   // Show/hide the point of rotation feedback, which only appears while
00104   // in Viewing mode. (default OFF)
00105   //
00106   void setFeedbackVisibility(SbBool onOrOff);
00107   SbBool isFeedbackVisible() const { return feedbackFlag; }
00108 
00109   //
00110   // Set/get the point of rotation feeedback size in pixels (default 20). 
00111   //
00112   void setFeedbackSize(int newSize);
00113   int getFeedbackSize() const { return (int)feedbackSize; }
00114 
00115   //
00116   // Enable/disable the animation feature of the viewer. 
00117   // (enabled by default)
00118   //
00119   void setAnimationEnabled(SbBool onOrOff);
00120   SbBool isAnimationEnabled() { return animationEnabled; }
00121 
00122   //
00123   // Stop animation, if it is occurring, and queuery if the viewer is 
00124   // currently animating.
00125   //
00126   void stopAnimating();
00127   SbBool isAnimating() { return animatingFlag; }
00128 
00129   //
00130   // redefine these to add Examiner viewer functionality
00131   //
00132   virtual void viewAll();
00133   virtual void resetToHomePosition();
00134   virtual void setCamera(SoCamera *cam);
00135   virtual void setViewing(SbBool onOrOff);
00136   virtual void setCursorEnabled(SbBool onOrOff);
00137 
00138  private:
00139 
00140   // This constructor takes a boolean whether to build the widget now.
00141   // Subclasses can pass FALSE, then call SoWinMPExaminerViewer::buildWidget()
00142   // when they are ready for it to be built.
00143   SoEXTENDER
00144     SoWinMPExaminerViewer(SoWidget parent,
00145                           const char *name, 
00146                           SbBool buildInsideParent, 
00147                           SoWinMPFullViewer::BuildFlag flag, 
00148                           SoWinMPViewer::Type type, 
00149                           SbBool buildNow);
00150 
00151   // redefine these
00152   virtual SbString getDefaultWidgetName() const;
00153   virtual SbString getDefaultTitle() const;
00154   virtual SbString getDefaultIconTitle() const;
00155 
00156   // redefine those routines to do viewer specific stuff
00157   virtual void processEvent(XAnyEvent *anyevent);
00158   virtual void setSeekMode(SbBool onOrOff);
00159   virtual void prepareRedraw();
00160   virtual void actualRedraw();
00161   virtual void endRedraw();
00162 
00163   // Get X resources for the widget.
00164   SoWidget buildWidget(SoWidget parent);
00165 
00166   // Define those thumb wheels to rotate the object
00167   virtual void bottomWheelMotion(float newVal);
00168   virtual void leftWheelMotion(float newVal);
00169   virtual void rightWheelMotion(float newVal);
00170 
00171   // redefine those routines to also stop animation if any
00172   virtual void bottomWheelStart();
00173   virtual void leftWheelStart();
00174 
00175   // add viewer preference stuff
00176   virtual void createPrefSheet();
00177 
00178   // add some viewer buttons
00179   virtual void createViewerButtons(SoWidget parent);
00180 
00181   // Define this to bring the viewer help card
00182   virtual void openViewerHelpCard();
00183 
00184   // It's a long story, but since we can't attach callbacks to a window
00185   // quite like we can to an Xt widget, it makes more sense for the
00186   // subclass viewer to handle the buttons it knows about then pass
00187   // the rest back up to SoWinFullViewer.
00188   //
00189   // So WINxx this function must be virtual and protected, not private.
00190   virtual void pushButtonCB(SoWidget, int id, void *);
00191 
00192   virtual void updateCursor();
00193 
00194  private:
00195   // viewer state variables
00196   int mode;
00197 
00198   SbSphereSheetProjector *sphereSheet;
00199   SbVec2s locator; // mouse position
00200   SbBool firstBuild; // set FALSE after buildWidget called once
00201 
00202   // point of rotation feedback vars
00203   SbBool feedbackFlag;
00204   float feedbackSize;
00205   SoSeparator *feedbackRoot;
00206   SoSwitch *feedbackSwitch;
00207   SoTranslation *feedbackTransNode;
00208   SoScale *feedbackScaleNode;
00209   static char *geometryBuffer;
00210   void createFeedbackNodes();
00211 
00212   // variables used for doing spinning animation
00213   SbBool animationEnabled, animatingFlag;
00214   SoFieldSensor *animationSensor;
00215   SbRotation *rotBuffer;
00216   int firstIndex, lastIndex;
00217   long lastMotionTime;
00218   SbRotation averageRotation;
00219   SbBool computeAverage;
00220   static void animationSensorCB(void *v, SoSensor *s);
00221   static void visibilityChangeCB(void *pt, SbBool visible);
00222   void doSpinAnimation();
00223 
00224   // camera translation vars
00225   SbVec3f locator3D;
00226   SbPlane focalplane;
00227 
00228   void updateViewerMode(unsigned int state);
00229   void switchMode(int newMode);
00230 
00231   void rotateCamera(const SbRotation &rot);
00232   void rollCamera(const SbVec2s &newLocator);
00233   void spinCamera(const SbVec2f &newLocator);
00234   void dollyCamera(const SbVec2s &newLocator);
00235   void panCamera(const SbVec2f &newLocator);
00236 
00237   // preference sheet stuff
00238   SoWidget createExamPrefSheetGuts(SoWidget parent);
00239   static void animPrefSheetToggleCB(SoWidget, SoWinMPExaminerViewer *, void *);
00240 
00241   // point of rotation pref sheet stuff
00242   int feedbackSizeWheelVal;
00243   SoWidget feedbackLabel[2], feedbackField, feedbackSizeWheel;
00244   static void feedbackSizeWheelCB(SoWidget, SoWinMPExaminerViewer *p, XtPointer *d);
00245   static void feedbackSizeFieldCB(SoWidget, SoWinMPExaminerViewer *, void *);
00246   static void feedbackPrefSheetToggleCB(SoWidget, SoWinMPExaminerViewer *, void *);
00247   void toggleFeedbackWheelSize(SoWidget toggle);
00248 
00249   // push button vars and callbacks
00250   SoWinBitmapButton *buttonList[10];
00251   static void camPushCB(SoWidget, SoWinMPExaminerViewer *, void *);
00252 
00253   // this is called by both constructors
00254   void constructorCommon(SbBool buildNow);
00255 
00256   // Utility function called from processEvent
00257   void processPopupItem(int item);
00258 
00259 };
00260 
00261 #if defined(_WIN32)
00262 #  include <Inventor/Win/SoWinEndStrict.h>
00263 #endif
00264 
00265 #endif /* _SO_WIN_EXAMINER_VIEWER_ */
00266 
00267
Inventor/MP/Win/viewers/SoWinMPExaminerViewer.h
