src/UIUtil/TrackingGestureManager.hpp

   1 /*
   2  * Copyright (C) 2012 Tobias Bieniek <Tobias.Bieniek@gmx.de>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * - Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *
  11  * - Redistributions in binary form must reproduce the above copyright
  12  * notice, this list of conditions and the following disclaimer in the
  13  * documentation and/or other materials provided with the
  14  * distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  19  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  20  * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  27  * OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef TRACKING_GESTURE_MANAGER_HPP
  31 #define TRACKING_GESTURE_MANAGER_HPP
  32
  33 #include "GestureManager.hpp"
  34
  35 #include "Screen/Point.hpp"
  36
  37 #include <vector>
  38
  39 /**
  40  * A manager class that can detect mouse gesture and saves
  41  * the mouse pointer locations for trail rendering
  42  * @see http://en.wikipedia.org/wiki/Pointing_device_gesture
  43  */
  44 class TrackingGestureManager: public GestureManager
  45 {
  46 public:
  47   typedef std::vector<RasterPoint> PointVector;
  48
  49 private:
  50   PointVector points;
  51
  52 public:
  53   /**
  54    * Stops the GestureManager and returns the recognized gesture
  55    * @return NULL or recognized gesture string
  56    */
  57   const TCHAR* Finish();
  58
  59   /**
  60    * Starts the GestureManager at the given coordinates
  61    */
  62   void Start(PixelScalar x, PixelScalar y, int threshold);
  63
  64   /**
  65    * Adds new coordinates to the GestureManager
  66    * @return True if the threshold was reached, False otherwise
  67    */
  68   bool Update(PixelScalar x, PixelScalar y);
  69
  70   /**
  71    * Returns if there are at least two points for trail rendering
  72    */
  73   bool HasPoints() const {
  74     return points.size() >= 2;
  75   }
  76
  77   /**
  78    * Returns the vector of mouse pointer locations for trail rendering
  79    */
  80   const PointVector &GetPoints() const {
  81     return points;
  82   }
  83 };
  84
  85 #endif