SoTouchEvent.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      : ... (MMM yyyy)
** Modified by : ... (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)
**=======================================================================*/
 
#ifndef  _SO_TOUCH_EVENT_
#define  _SO_TOUCH_EVENT_
 
#include <Inventor/SbBasic.h>
#include <Inventor/events/SoSubEvent.h>
#include <Inventor/SbTime.h>
 
class SoTouchManager;
 
class  SoTouchEvent : public SoEvent 
{
 
  SO_EVENT_HEADER();
    
public:
 
  enum State {
    UNKNOWN,
    UP, 
    DOWN,
    MOVE
  };
 
  SoTouchEvent();
 
  #ifndef HIDDEN_FROM_DOC
  virtual ~SoTouchEvent();
  #endif // HIDDEN_FROM_DOC
 
  State getState() const;
 
  unsigned long getFingerId() const;
    
  SbTime getElapsedTimeSincePreviousEvent() const;
    
  SbTime getFirstContactTime() const;
 
  SbTime getElapsedTimeUntilPreviousEvent() const;
 
  SbTime getPreviousEventTime() const;
 
  SbVec2f getSpeed() const;
    
  SbVec2f getPreviousPosition() const;
    
  SbVec2f getDisplacement() const;
 
  SbVec2f getAcceleration() const;
 
  SbVec2f getPreviousSpeed() const;
 
  SoTouchManager* getTouchManager() const;
 
  void setTouchManager(SoTouchManager* manager);
 
  SbVec2f getFirstPosition() const;
 
  void setState(SoTouchEvent::State b);
 
  void setFingerId(unsigned long idFinger);
 
  virtual void setPosition(const SbVec2f &p);
  virtual void setPosition(const SbVec2s &p);
 
  virtual void setTime(SbTime t);
 
  void setPreviousSpeed();
 
  void setFirstPosition(SbVec2f);
 
private:
  static void initClass();
  static void exitClass();
  
private:
  // Id of the finger launching this event
  unsigned long m_fingerId; 
  // Up, Down, Move or Unknown.
  State m_state; 
  // The difference between the event position and the previous event position.
  SbVec2f m_displacement;
  // The time derivative of instant displacement 
  SbVec2f m_previousSpeed;
  // The time elapsed since the first date contact and the previous event
  SbTime m_elapsedTime;
  // Date of first contact in seconds
  SbTime m_firstContactTime; 
  // First position
  SbVec2f m_firstPosition;
 
  SoTouchManager* m_touchManager;
};
 
#endif /* _SO_TOUCH_EVENT_ */