SoTouchManager.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : ... (MMM yyyy)
** Modified by : ... (MMM yyyy)
**=======================================================================*/
 
#ifndef  _SO_TOUCH_MANAGER
#define  _SO_TOUCH_MANAGER
 
#include <Inventor/gestures/recognizers/SoGestureRecognizer.h>
#include <Inventor/touch/events/SoTouchEvent.h>
#include <Inventor/SoSceneManager.h>
 
class SoTouchEvent;
class SoScaleGestureRecognizer;
class SoRotateGestureRecognizer;
class SoDoubleTapGestureRecognizer;
class SoLongTapGestureRecognizer;

class  SoTouchManager 
{
 
public :
 
  SoTouchManager();
 
  virtual ~SoTouchManager();

  const SoTouchEvent* getEventById(unsigned long id) const; 

  const SoTouchEvent* getEventbyIndex(int index) const;

  const std::vector<unsigned long>& getAllFingerIds() const;

  int getFingerNumber() const;

  int getMaxSimultaneousFingers() const;

  void setMaxSimultaneousFingers(int fingers);

   void setThreshold(float t);

  float getThreshold() const; 

  bool isTouchScreenAvailable();

  void setTouchScreenAvailability(bool available);

  void removeRecognizer(SoGestureRecognizer* gesture);

  void addRecognizer(SoGestureRecognizer* recognizer);

  void addDefaultRecognizers();

  void removeDefaultRecognizers();

  const std::vector<SoGestureRecognizer*>& getRecognizerList() const;

  const std::vector<const SoEvent*>& getTouchDownEvent(unsigned long fingerId, const SbVec2f& fingerPos, const SbTime& time);

  const std::vector<const SoEvent*>& getTouchUpEvent(unsigned long fingerId, const SbVec2f& fingerPos, const SbTime& time);

  const std::vector<const SoEvent*>& getTouchMoveEvent(unsigned long fingerId, const SbVec2f& fingerPos, const SbTime& time);
 
#if 1             
  // The scene manager argument is useless. The process event should be now done by using the 
  // class SoRenderAreaCore.SoDEPRECATED
  SoTouchManager(SoSceneManager* sM);
  SoDEPRECATED
  SoTouchEvent* updateAndProcessTouchEvent(unsigned long id, SoTouchEvent::State state, SbVec2f position, SbTime time);
 
#endif 
 
private :
  void init();
 
  //Replace event indexed by i with j
  void replaceEvent(int i, int j);
 
  const std::vector<const SoEvent*>& getTouchEvent(unsigned long fingerId, SoTouchEvent::State state, const SbVec2f& fingerPos, const SbTime& time);
 
  // Events table
  std::vector<SoTouchEvent> m_touchEvent;
 
  // Recognizers list
  std::vector<SoGestureRecognizer*> m_recognizerList;
 
  // default recognizers
  SoScaleGestureRecognizer* m_scaleRecognizer;
  SoRotateGestureRecognizer* m_rotateRecognizer;
  SoDoubleTapGestureRecognizer* m_doubleTapRecognizer;
  SoLongTapGestureRecognizer* m_longTapRecognizer;
 
  bool m_touchScreenAvailable;
 
  unsigned int m_supportedFingersNumber;
  float m_threshold;
  // Number of fingers touching the screen
  int m_fingerNumber;
  // ID of all fingers touching the screen
  std::vector<unsigned long> m_allFingers;
  // Notify if the last event state was UP
  bool m_fingerWasUp;
  // Index of the event
  int m_eventIndex;
  
  int m_maxSimultaneousFingers;
 
  std::vector<const SoEvent*> m_soeventlist;
 
  // Deprecated member: process event should be done by using SoRenderAreaCore
  // Kept only for compat as it is used by the deprecated method updateAndProcessTouchEvent
  SoSceneManager* m_sceneManager; 
};
 
#endif /* _SO_TOUCH_MANAGER */