SoGuiSpaceball.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      : T.MEHAMLI (Jun 2007)
**=======================================================================*/
 
#ifndef  SO_GUI_SPACEBALL
#define  SO_GUI_SPACEBALL
 
#include <Inventor/Gui/SoGui.h>
#include <Inventor/events/SoMotion3Event.h>
#include <Inventor/events/SoSpaceballButtonEvent.h>
 
#include <Inventor/Gui/devices/SoGuiDevice.h>
 
//
//  Class: SoGuiComponent
//
// SoXXSpaceball implementation class
// 
//
 
 
class  SoGuiSpaceball : public SoGuiDevice 
{
private:
 
  enum Mask 
  {
    MOTION  = 0x01, 
    PRESS   = 0x02, 
    RELEASE = 0x04, 
    ALL     = 0x07
  };
  
  enum DeviceType 
  {
    SPACE_BALL           = 0x01, 
    MAGELLAN_SPACE_MOUSE = 0x02
  };
  
  //
  // 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().
  
  SoGuiSpaceball( Mask mask = SoGuiSpaceball::ALL );
 
  ~SoGuiSpaceball();
  
  void setRotationScaleFactor( float f );
  
  float getRotationScaleFactor() const ;
  
  void setTranslationScaleFactor( float f );
  
  float getTranslationScaleFactor() const;
 
  void setFocusToWindow(SbBool flag);
 
  SbBool isFocusToWindow() const;
 
 private:
 
  SbBool m_focusToWindow;
  Mask m_eventMask;      // X event interest for this device
  
  // scale factors
  float m_rotScale;
  float m_transScale;
};
 
#endif // SO_GUI_SPACEBALL