SoXtSpaceball.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      : David Mott (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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/devices/SoQtSpaceball.h>
#elif defined _WIN32
#  include <Inventor/Win/devices/SoWinSpaceball.h>
#else
 
#ifndef  _SO_XT_SPACEBALL_
#define  _SO_XT_SPACEBALL_
 
#include <X11/X.h>
#include <X11/extensions/XInput.h>
 
#include <Inventor/Xt/SoXt.h>
#include <Inventor/Xt/devices/SoXtDevice.h>
#include <Inventor/events/SoMotion3Event.h>
#include <Inventor/events/SoSpaceballButtonEvent.h>
 
#include <Inventor/Gui/devices/SoGuiSpaceball.h>

class  SoXtSpaceball : public SoXtDevice 
{
 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().
  
  SoXtSpaceball(SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL);
  SoXtSpaceball(Display *d, SoGuiSpaceball::Mask mask = SoGuiSpaceball::ALL);
  ~SoXtSpaceball();
  
  virtual void        enable(SoWidget w, XtEventHandler f,
                             XtPointer data, Window win = 0);
  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() { return exists(SoXt::getDisplay()); }
  static SbBool exists(Display *d);

  void          setFocusToWindow(SbBool flag);
  SbBool        isFocusToWindow() const { return m_guiSpaceball->isFocusToWindow(); }
 
 private:
  SoMotion3Event          *motionEvent;   // spaceball rotation/translation
  SoSpaceballButtonEvent  *buttonEvent;   // spball button press/release
  
  SoWidget parentWidget;
 
  SoGuiSpaceball* m_guiSpaceball; // Implementation class for SoXxSpaceball
  
  // the X display 
  Display *display;
 
  // flag indicating when to receive events.
  SbBool focusToWindow;
 
  // the window receiving events
  Window window;
 
  // event translators for SPACE BALL!
  SoMotion3Event           *translateMotionEvent(XDeviceMotionEvent *me);
  SoSpaceballButtonEvent *translateButtonEvent(XEvent *be,
                                               SoButtonEvent::State whichState);
  // event translators for MAGELLAN SPACE MOUSE!
  SoMotion3Event           *translateMotionEventMagellan(XEvent *me);
  
  void constructorCommon(Display *d, SoGuiSpaceball::Mask mask);         
 
};
 
#endif /* _SO_XT_SPACEBALL_ */
 
#endif // _WIN32