SoWinSpaceball.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
 
#ifndef  _SO_WIN_SPACEBALL_
#define  _SO_WIN_SPACEBALL_
 
#include <Inventor/Win/SoWinBeginStrict.h>
 
#include <windows.h>
#include <Inventor/Win/SoWin.h>
#include <Inventor/Win/devices/SoWinDevice.h>
 
#include <Inventor/events/SoMotion3Event.h>
#include <Inventor/events/SoSpaceballButtonEvent.h>
#include <Inventor/Win/SoWinRenderArea.h>
 
#include <Inventor/Gui/devices/SoGuiSpaceball.h>
class  SoWinSpaceball : public SoWinDevice {
 
 public:
 
  //
  // valid event mask values:
  //        SoWinSpaceball::MOTION   - spaceball translation and rotation
  //        SoWinSpaceball::PRESS    - spaceball button press
  //        SoWinSpaceball::RELEASE  - spaceball button release
  //        SoWinSpaceball::ALL     - all spaceball events
  // Bitwise OR these to specify whichEvents this device should queue.
  //
  
  static SbBool isSpaceMousePresent();
  
  SoWinSpaceball(SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL);
 
  ~SoWinSpaceball();
  
  virtual void enable(SoWidget w, XtEventHandler f,
                      XtPointer data, Window win = NULL);
 
  virtual void disable(SoWidget w, XtEventHandler f, XtPointer data);
  
  virtual const SoEvent *translateEvent(XAnyEvent *xevent);
  
  void setRotationScaleFactor(float f) { m_guiSpaceball->setRotationScaleFactor( f ); }
 
  float getRotationScaleFactor() const { return m_guiSpaceball->getRotationScaleFactor(); }
 
  void setTranslationScaleFactor(float f) { m_guiSpaceball->setTranslationScaleFactor( f ); }
 
  float getTranslationScaleFactor() const { return m_guiSpaceball->getTranslationScaleFactor(); }
  
  static SbBool exists();
  
  void setFocusToWindow(SbBool flag) { m_guiSpaceball->setFocusToWindow( flag ); }
 
  SbBool isFocusToWindow() const { return m_guiSpaceball->isFocusToWindow(); }
 
 private:
 
   SoGuiSpaceball* m_guiSpaceball; // Implementation class for SoXxSpaceball
 
  SoMotion3Event *motionEvent; // spaceball rotation/translation
  SoSpaceballButtonEvent *buttonEvent; // spball button press/release
  
  // The first widget which registered the space ball object
  SoWidget parentWidget;
 
  HWND m_curHwnd;
 
  // event translators!
  SoMotion3Event *translateMotionEvent(MSG *me);
  SoSpaceballButtonEvent *translateButtonEvent(MSG *be,
                                               SoButtonEvent::State whichState);
  SoMotion3Event *translateMotionEventMagellan(MSG *me);
  
  // Magellanstruct _MagellanControl_ Space Mouse data structure 
  struct _MagellanControl_ *magellanHandle;
};
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif /* _SO_WIN_SPACEBALL_ */