Inventor/MP/Xt/viewers/SoXtMPPlaneViewer.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/


#if defined(_WIN32)
#  include <Inventor/Win/viewers/SoWinPlaneViewer.h>
#else // _WIN32

#ifndef  _SO_XT_PLANE_VIEWER_
#define  _SO_XT_PLANE_VIEWER_

#include <Inventor/MP/Xt/viewers/SoXtMPFullViewer.h>
#include <Inventor/SbLinear.h>

class SoXtBitmapButton;


//
//  Class: SoXtMPPlaneViewer
//
//  Plane Viewer - allows the user to move the camera in a plane, zoom in
//      and out, as well as rotate the viewing plane.
//
//      Keys used by this viewer:
//      -------------------------
//
//     Left Mouse: Dolly in and out (gets closer to and further away from the
//     object).
//
//     Middle Mouse: 
//     Ctrl + Left Mouse: Translate up, down, left and right.
//
//     Ctrl + Middle Mouse: Used for roll action (rotates around the viewer
//     forward direction).
//
//     <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  SoXtMPPlaneViewer : public SoXtMPFullViewer {
 public:
  SoXtMPPlaneViewer(
                    SoWidget parent = NULL,
                    const char *name = NULL, 
                    SbBool buildInsideParent = TRUE, 
                    SoXtMPFullViewer::BuildFlag flag = BUILD_ALL, 
                    SoXtMPViewer::Type type = BROWSER);
  ~SoXtMPPlaneViewer();
    
  void setPlane(const SbVec3f &newNormal, const SbVec3f &newRight);

  //
  // redefine these to add Plane viewer functionality
  //
  virtual void        setViewing(SbBool onOrOff);
  virtual void        setCamera(SoCamera *cam);
  virtual void        setCursorEnabled(SbBool onOrOff);
    
 private:
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtMPPlaneViewer::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtMPPlaneViewer(
                      SoWidget parent,
                      const char *name, 
                      SbBool buildInsideParent, 
                      SoXtMPFullViewer::BuildFlag flag, 
                      SoXtMPViewer::Type type, 
                      SbBool buildNow);

  SoWidget              buildWidget(SoWidget parent);
        
  // 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(XAnyEvent *anyevent);
  virtual void        setSeekMode(SbBool onOrOff);
  virtual void        actualRedraw();
    
  // Define those thumb wheels to translate in the viewer plane
  virtual void        bottomWheelMotion(float newVal);
  virtual void        leftWheelMotion(float newVal);
  virtual void        rightWheelMotion(float newVal);
    
  // add viewer preference stuff
  virtual void        createPrefSheet();
    
  // add some viewer buttons
  virtual void        createViewerButtons(SoWidget parent);
    
  // Define this to bring the viewer help card
  virtual void        openViewerHelpCard();
    
  // Redefine this to keep the same camera rotation when seeking
  virtual void        computeSeekFinalOrientation();

 private:
  // viewer state variables
  int             mode;
  SbBool          createdCursors;
  Cursor          transCursor, dollyCursor, seekCursor;
  SbVec2s         locator; // mouse position
    
  // camera translation vars
  SbVec3f         locator3D;
  SbPlane         focalplane;
  float           transXspeed, transYspeed;
    
  // push button vars and callbacks
  SoXtBitmapButton  *buttonList[10];
  static void     pushButtonCB(SoWidget, int id, void *);
    
  void            updateViewerMode(unsigned int state);
  void            switchMode(int newMode);
  void            updateCursor();
  void            defineCursors();
  void            rollCamera(const SbVec2s &newLocator);
  void            translateCamera(const SbVec2f &newLocator);
  void            dollyCamera(const SbVec2s &newLocator);
    
  // redefine these to also call computeTranslateValues()
  virtual void    bottomWheelStart();
  virtual void    leftWheelStart();
  void            computeTranslateValues();
    
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);

};

#endif  /* _SO_XT_PLANE_VIEWER_ */

#endif // _WIN32

---

Open Inventor Toolkit reference manual, generated on 22 Jul 2025
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/