Inventor/Wx/viewers/SoWxPlaneViewer.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      : T.MEHAMLI (Jul 2007)
**=======================================================================*/

#ifndef SO_WX_PLANE_VIEWER
#define SO_WX_PLANE_VIEWER

//
//  Class: SoWxPlaneViewer
//

#include <Inventor/Wx/viewers/SoWxFullViewer.h>

#include <Inventor/Gui/viewers/SoGuiPlaneViewer.h>
#include <Inventor/SbLinear.h>

class SoGuiPlaneViewer;

//
//  Class: SoWxPlaneViewer
//
//      Plane Viewer - allows the user to move left, right, up, and down a 
//  given plane, as well as roll the viewer and zoom in and out.
//
//
//      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).
//
//  Shift + Ctrl + Left Mouse: Roll (same as Ctrl + Middle Mouse 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  SoWxPlaneViewer : public SoWxFullViewer 
{

    public:
  SoWxPlaneViewer( wxWindow* parent = NULL,
                   const char* name = NULL, 
                   SbBool buildInsideParent = TRUE, 
                   SoWxFullViewer::BuildFlag flag = SoWxFullViewer::BUILD_ALL, 
                   SoWxViewer::Type type = SoWxViewer::BROWSER );
  ~SoWxPlaneViewer();

  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 );
  virtual void setSeekMode( SbBool onOrOff );
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWxPlaneViewer::buildWidget()
  // when they are ready for it to be built.
  private:

    SoGuiPlaneViewer* getGuiPlaneViewer() const;

    SoWxPlaneViewer( wxWindow* parent,
                     const char* name, 
                     SbBool buildInsideParent, 
                     SoWxFullViewer::BuildFlag flag, 
                     SoWxViewer::Type type, 
                     SbBool buildNow,
                     SbBool sync = true );

  private:
  
    void visibilityChangeCB( wxShowEvent& se );

private:

  wxPanel* buildWidget(wxWindow* 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( wxEvent& anyEvent );
  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 );
  virtual void mouseWheelMotion( float newVal );

  // add viewer preference stuff
  virtual void createPrefSheet();

  // add some viewer buttons
  virtual void createViewerButtons( wxPanel* 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();

  // It's a long story, but since we can't attach callbacks to a window
  // quite like we can to an Xt widget, it makes more sense for the
  // subclass viewer to handle the buttons it knows about then pass
  // the rest back up to SoWxFullViewer.
  //
  // So WINxx this function must be virtual and protected, not private.
  virtual void pushButtonCB( int id );

  virtual void updateCursor();

 private:

   enum BUTTONS_ID
   {
     X_PUSH_ID = wxID_HIGHEST + 3001,
     Y_PUSH_ID,
     Z_PUSH_ID,
     CAM_PUSH_ID,
   };

  wxBitmap X_PUSH;
  wxBitmap Y_PUSH;
  wxBitmap Z_PUSH;
  wxBitmap CAM_PUSH_PERSP;
  wxBitmap CAM_PUSH_ORTHO;

  SoGuiPlaneViewer* m_guiPlaneViewer; // Implementation class for SoXxPlaneViewer

  // push button vars and callbacks
  wxBitmapButton* buttonList[10];

  // Added for WINxx port, makes it easier to merge WINxx and X code.
  // For _WIN32 saving this value saves us having to reload the normal
  // cursor all the time.  For X it's always NULL. --mmh 2/12/95

  void updateViewerMode( wxMouseEvent& me );
  void switchMode( int newMode );
  
  // this is called by both constructors
  void constructorCommon( SbBool buildNow );

  // Utility function called from processEvent
  void processPopupItem( int item );

  void slot_xButton( wxCommandEvent& ce );
  void slot_yButton( wxCommandEvent& ce );   
  void slot_zButton( wxCommandEvent& ce );   
  void slotCamPushButton( wxCommandEvent& ce );  
};


#endif  // SO_WX_PLANE_VIEWER

---

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