SoQtSpaceball.h

/*=======================================================================
 *** 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_QT_SPACEBALL_
#define  _SO_QT_SPACEBALL_
#include <Inventor/Qt/OivQtCompat.h>
#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/devices/SoQtDevice.h>
#include <Inventor/events/SoMotion3Event.h>
#include <Inventor/events/SoSpaceballButtonEvent.h>
 
#include <Inventor/Gui/devices/SoGuiSpaceball.h>
 
class  SoQtSpaceball : public SoQtDevice {
  
  Q_OBJECT
 
#ifdef __APPLE__
public:
  SoQtSpaceball(SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL) { };
  SoQtSpaceball(Display *d, SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL) { };
  ~SoQtSpaceball() { };
  virtual void  enable(QWidget *w, XtEventHandler f, XtPointer data, void *unused=NULL) { };
  virtual void  disable(QWidget *w, XtEventHandler f, XtPointer data) { };
  virtual const SoEvent * translateEvent(QEvent *xevent) { return NULL;};
  void setRotationScaleFactor(float f) { };
  float getRotationScaleFactor() const { return 0.0; };
  void setTranslationScaleFactor(float f) { };
  float getTranslationScaleFactor() const { return 0.0; };
  static SbBool exists() { return FALSE;};
  static SbBool exists(Display);
  void setFocusToWindow(SbBool);
  SbBool isFocusToWindow() const { return FALSE;};
 
#else
public:
  
  //
  // valid event mask values:
  //        SoXtSpaceball::MOTION   - spaceball translation and rotation
  //        SoXtSpaceball::PRESS    - spaceball button press
  //        SoXtSpaceball::RELEASE  - spaceball button release
  //        SoXtSpaceball::ALL      - all spaceball events
  // Bitwise OR these to specify whichEvents this device should queue.
  //
  // The second constructor allows the spaceball to be attached
  // to a different display than the one used by SoXt::init().
  
  SoQtSpaceball(SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL);
  SoQtSpaceball(SbGlContextHelper::Display d, SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL);
  ~SoQtSpaceball();
  
  virtual void        enable(QWidget *w, XtEventHandler f, XtPointer data, void *unused=NULL);
 
  virtual void        disable(QWidget *w, XtEventHandler f, XtPointer data);
  
  virtual const SoEvent * translateEvent(QEvent *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() { return exists(SoQt::getDisplay());}
  static SbBool exists(SbGlContextHelper::Display d);
 
  void          setFocusToWindow(SbBool 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
  
  QWidget* parentWidget;
 
#ifdef _WIN32
  // The first widget which registered the space ball object
  HWND m_curHwnd;
  // Magellanstruct _MagellanControl_ Space Mouse data structure 
  struct _MagellanControl_ *magellanHandle;
 
#else
 
    // the X display 
    Display *display;
  
    // device type: SPACE_BALL or MAGELLAN_SPACE_MOUSE
    SoGuiSpaceball::DeviceType deviceType;
 
#endif
 
  // event translators for SPACE BALL!
  SoMotion3Event           *translateMotionEvent(QEvent *me);
  SoSpaceballButtonEvent *translateButtonEvent(QEvent *be,
                                               SoButtonEvent::State whichState);
  // event translators for MAGELLAN SPACE MOUSE!
  SoMotion3Event           *translateMotionEventMagellan(XEvent *me);
  
  void constructorCommon(SbGlContextHelper::Display d, SoGuiSpaceball::Mask mask);
#endif
};
 
#endif /* _SO_QT_SPACEBALL_ */