SoXtFullViewer.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : Tristan Mehamli (Nov 2009)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/viewers/SoQtFullViewer.h>
#elif defined _WIN32
#  include <Inventor/Win/viewers/SoWinFullViewer.h>
#else // _WIN32
 
#ifndef _SO_XT_FULL_VIEWER_
#define _SO_XT_FULL_VIEWER_
 
#include <Xm/Xm.h>
#include <Inventor/Xt/viewers/SoXtViewer.h>
#include <Inventor/SbPList.h>
#include <Inventor/components/stereo/SoStereoDialog.h>
#include <Inventor/Gui/viewers/SoGuiFullViewer.h>
 
// classes used
class SoXtResource;
class SoXtBitmapButton;
class SoRecordDialog;
 
//
//  Class: SoXtFullViewer
//
//      The SoXtFullViewer 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  SoXtFullViewer : public SoXtViewer
{
 public:
  enum BuildFlag
  {
    BUILD_NONE = 0x00,
    BUILD_DECORATION = 0x01,
    BUILD_POPUP = 0x02,
    BUILD_ALL = 0xff
  };
 
  void setDecoration( SbBool onOrOff );
 
  SbBool isDecoration() { return m_guiFullViewer->isDecoration(); }
 
  void setPopupMenuEnabled( SbBool trueOrFalse );
 
  SbBool isPopupMenuEnabled() { return m_guiFullViewer->isPopupMenuEnabled(); }
 
  SoWidget getAppPushButtonParent() const { return appButtonForm; }
 
  void addAppPushButton( SoWidget newButton );
 
  void insertAppPushButton( SoWidget newButton, int index );
 
  void removeAppPushButton( SoWidget oldButton );
 
  int findAppPushButton( SoWidget oldButton ) { return appButtonList->find(oldButton); }
 
  int lengthAppPushButton() { return appButtonList->getLength(); }
 
  SoWidget getRenderAreaWidget() { return raWidget; }
 
  // redefine these from the base class
  virtual void setViewing( SbBool onOrOff );
  virtual void setHeadlight( SbBool onOrOff );
  virtual void setDrawStyle( SoXtViewer::DrawType type, SoXtViewer::DrawStyle style );
  virtual void setBufferingType( SoXtViewer::BufferType type );
  virtual void setCamera( SoCamera* cam );
  virtual void hide();
 
  // Allow app, eg. 3SA, to control this if desired.  --mmh Jun-99
  SoStereoDialog* getStereoDialog() { return m_stereoDialogBox; }
  void setStereoDialog( SoStereoDialog *newDialog ) { m_stereoDialogBox = newDialog; }
 
  SoStereoDialog* m_stereoDialogBox;
 
 private:
  virtual ~SoXtFullViewer();
 
  SoGuiFullViewer* getGuiFullViewer() const;
 
  // retro compatibilty, don't use them directly. Call their accessors.
  float rightWheelVal, leftWheelVal, bottomWheelVal; 
  SbBool popupEnabled;
 
  // Constructor/Destructor
  SoXtFullViewer( SoWidget parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SoXtFullViewer::BuildFlag flag,
                  SoXtViewer::Type type,
                  SbBool buildNow,
                  SbBool sync = TRUE );
 private:
 
  SoXtFullViewer( SoWidget parent,
                  const char* name,
                  SbBool buildInsideParent,
                  SoXtFullViewer::BuildFlag flag,
                  SoXtViewer::Type type,
                  SbBool buildNow,
                  SbBool sync,
                  SoGuiFullViewer* guiFullViewer );
 
  // general decoration vars
  SoWidget mgrWidget; // form which manages all other widgets
  SoWidget raWidget; // render area widget
  SoWidget leftTrimForm, bottomTrimForm, rightTrimForm;
 
  // thumb wheel vars
  SoWidget rightWheel, bottomWheel, leftWheel;
  char* rightWheelStr, *bottomWheelStr, *leftWheelStr;
  SoWidget rightWheelLabel, bottomWheelLabel, leftWheelLabel;
 
  // widget list of viewer buttons
  SbPList* viewerButtonWidgets;
 
  // The button widget should be used as the parent widget
  // when creating new buttons
  SoWidget getButtonWidget() const { return appButtonForm; }
 
  // popup menu vars
  SoWidget popupWidget, *popupToggleWidgets;
  SoWidget* drawStyleWidgets, *bufferStyleWidgets;
  char* popupTitle;
 
  //
  // Build/destroy decoration routines
  //
  SoWidget buildWidget( SoWidget parent );
  void buildLeftWheel( SoWidget parent );
 
  virtual void buildDecoration( SoWidget parent );
  virtual SoWidget buildLeftTrim( SoWidget parent );
  virtual SoWidget buildBottomTrim( SoWidget parent );
  virtual SoWidget buildRightTrim( SoWidget parent );
  SoWidget buildAppButtons( SoWidget parent );
  SoWidget buildViewerButtons( SoWidget parent );
  virtual void createViewerButtons( SoWidget parent );
 
  //
  // popup menu build routines
  //
  virtual void  buildPopupMenu();
  virtual void  destroyPopupMenu();
  void setPopupMenuString( const char* name );
  SoWidget buildFunctionsSubmenu( SoWidget popup );
  SoWidget buildDrawStyleSubmenu( SoWidget popup );
 
  //
  // Preference sheet build routines
  //
  void setPrefSheetString( const char* name );
  virtual void createPrefSheet();
  void createPrefSheetShellAndForm( SoWidget& shell, SoWidget& form );
  void createDefaultPrefSheetParts( SoWidget widgetList[], int& num, SoWidget form );
  void layoutPartsAndMapPrefSheet( SoWidget widgetList[], int num, SoWidget form, SoWidget shell );
  SoWidget createSeekPrefSheetGuts( SoWidget parent );
  SoWidget createSeekDistPrefSheetGuts( SoWidget parent );
  SoWidget createZoomPrefSheetGuts( SoWidget parent );
  SoWidget createClippingPrefSheetGuts( SoWidget parent );
  SoWidget createStereoPrefSheetGuts( SoWidget parent );
  SoWidget createFsaaPrefSheetGuts( SoWidget parent );
  SoWidget createRecordPrefSheetGuts( SoWidget parent );
  SoWidget createSpeedPrefSheetGuts( SoWidget parent );
 
  // 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 newVal );
  virtual void bottomWheelMotion( float newVal );
  virtual void leftWheelMotion( float newVal );
 
  // 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 char* name );
  void setLeftWheelString( const char* name );
  void setRightWheelString( const char* name );
 
  // Subclasses SHOULD redefine the openViewerHelpCard() routine to bring
  // their help card (called by push button and popup menu entry).
  // They can simply call SoXtComponent::openHelpCard() to open their
  // specific help card.
  virtual void openViewerHelpCard();
 
  // popup menu callbacks
  static void popMenuCallback( SoWidget w, SoXtFullViewer* v, XEvent* event, Boolean* b );
  static void drawStyleMenuPick( SoWidget w, int id, void* data );
  static void bufferStyleMenuPick( SoWidget w, int id, void* data );
  static void menuPick( SoWidget w, int id, XmAnyCallbackStruct* s );
 
  virtual void setSeekButton( SbBool onOff );
 
private:
 
  void constructorCommon( SoXtFullViewer::BuildFlag buildFlag, SbBool buildNow );
 
  SoGuiFullViewer* m_guiFullViewer; // Implementation class for SoXxFullViewer
 
  SbBool firstBuild; // set FALSE after buildWidget called once
 
  // app button vars
  SoWidget appButtonForm;
  SbPList* appButtonList;
 
  void doAppButtonLayout( int start );
 
  // this is called the first time the widget is built
  void getResources( SoXtResource* xr );
 
  // push buttons vars and callbacks
  SoXtBitmapButton* buttonList[10];
  static void pushButtonCB( SoWidget w, int id, void* data );
 
  // pref sheet variables
  SoWidget prefSheetShellWidget;
  char* prefSheetStr;
  static void prefSheetDestroyCB( SoWidget w, SoXtFullViewer* v, void* data );
  static void stereoSheetDestroyCB( SoWidget w, SoXtFullViewer* v, void* data );
 
  // seek pref sheet callbacks
  static void seekPrefSheetFieldCB( SoWidget field, SoXtFullViewer* v, void* data );
  static void seekPrefSheetToggle1CB( SoWidget tog1, SoWidget tog2, void* data );
  static void seekPrefSheetToggle2CB( SoWidget tog1, SoWidget tog2, void* data );
 
  // zoom pref sheet vars and callbacks
  SoWidget* zoomWidgets;
  SbVec2f zoomSldRange;
  void setCameraZoom( float zoom );
  float getCameraZoom();
  void setZoomSliderPosition( float zoom );
  void setZoomFieldString( float zoom );
  static void zoomSliderCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void zoomFieldCB( SoWidget field, SoXtFullViewer* v, XtPointer* d );
  static void zoomPrefSheetMinFieldCB( SoWidget field, SoXtFullViewer* v, void* data );
  static void zoomPrefSheetMaxFieldCB( SoWidget field, SoXtFullViewer* v, void* data );
 
  // seek dist pref sheet vars and callbacks
  int seekDistWheelVal;
  SoWidget seekDistField;
  static void seekDistWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void seekDistFieldCB( SoWidget field, SoXtFullViewer* v, void* data );
  static void seekDistPercPrefSheetToggleCB( SoWidget tog1, SoWidget tog2, void* data );
  static void seekDistAbsPrefSheetToggleCB( SoWidget tog1, SoWidget tog2, void* data );
 
  // clipping plane pref sheet callbacks and variables
  SoWidget clipWheelForm;
  int clipNearWheelVal, clipFarWheelVal;
  SoWidget clipNearField, clipFarField;
  static void clipPrefSheetToggleCB( SoWidget toggle, SoWidget parent, void* data );
  static void clipNearWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void clipFarWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void clipFieldCB( SoWidget field, SoXtFullViewer* v, void* data );
 
  // stereo viewing pref sheet callbacks and variables
  SoWidget stereoWheelForm, stereoField, stereoLabel;
  int stereoWheelVal;
  static void stereoPrefSheetToggleCB( SoWidget toggle, SoWidget parent, void* data );
  static void stereoWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void stereoFieldCB( SoWidget field, SoXtFullViewer *v, void* data );
 
  // Recording sheet callbacks and variable
  SoWidget recordingLabel;
  static void recordingPrefSheetToggleCB( SoWidget toggle, SoWidget parent, void* data );
 
  // FSAA
  SoWidget fsaaLabel;
  static void fsaaPrefSheetToggleCB( SoWidget toggle, SoWidget parent, void* data );
 
  // dolly speed pref sheet callbacks
  static void speedIncPrefSheetButtonCB( SoWidget w, SoXtFullViewer *p, void* v );
  static void speedDecPrefSheetButtonCB( SoWidget w, SoXtFullViewer *p, void* v );
 
  // callback functions for thumbwheels
  static void rightWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void bottomWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
  static void leftWheelCB( SoWidget w, SoXtFullViewer* v, XtPointer* d );
 
  SbBool seekDistAsPercentage;
};
 
#endif  /* _SO_XT_FULL_VIEWER_ */
 
#endif // _WIN32