dali/internal/event/events/pinch-gesture/pinch-gesture-recognizer.h

   1 #ifndef DALI_INTERNAL_EVENT_PINCH_GESTURE_RECOGNIZER_H
   2 #define DALI_INTERNAL_EVENT_PINCH_GESTURE_RECOGNIZER_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/vector-wrapper.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/event/events/gesture-recognizer.h>
  26 #include <dali/internal/event/events/pinch-gesture/pinch-gesture-event.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Integration
  32 {
  33 struct TouchEvent;
  34 }
  35
  36 namespace Internal
  37 {
  38
  39 /**
  40  * When given a set of touch events, this detector attempts to determine if a pinch gesture has taken place.
  41  */
  42 class PinchGestureRecognizer : public GestureRecognizer
  43 {
  44 public:
  45
  46   using Observer = RecognizerObserver<PinchGestureEvent>;
  47
  48   /**
  49    * Constructor
  50    * @param[in] screenSize The size of the screen.
  51    * @param[in] screenDpi The dpi value of the screen
  52    * @param[in] minimumPinchDistance in pixels
  53    */
  54   PinchGestureRecognizer(Observer& observer, Vector2 screenSize, Vector2 screenDpi, float minimumPinchDistance);
  55
  56   /**
  57    * Virtual destructor.
  58    */
  59   virtual ~PinchGestureRecognizer();
  60
  61 public:
  62
  63   void SetMinimumPinchDistance(float value);
  64
  65   /**
  66    * @copydoc Dali::Internal::GestureDetector::SendEvent(const Integration::TouchEvent&)
  67    */
  68   virtual void SendEvent(const Integration::TouchEvent& event);
  69
  70   /**
  71    * @copydoc Dali::Internal::GestureDetector::Update(const Integration::GestureRequest&)
  72    */
  73   virtual void Update(const GestureRequest& request);
  74
  75 private:
  76
  77   /**
  78    * Emits the pinch gesture event to the core.
  79    * @param[in]  state         The state of the pinch (whether it's starting, continuing or finished).
  80    * @param[in]  currentEvent  The latest touch event.
  81    */
  82   void SendPinch(Gesture::State state, const Integration::TouchEvent& currentEvent);
  83
  84 private:
  85
  86   // Reference to the gesture processor for this recognizer
  87   Observer& mObserver;
  88
  89   /**
  90    * Internal state machine.
  91    */
  92   enum State
  93   {
  94     Clear,    ///< No gesture detected.
  95     Possible, ///< The current touch event data suggests that a gesture is possible.
  96     Started,  ///< A gesture has been detected.
  97   };
  98
  99   State mState; ///< The current state of the detector.
 100   std::vector<Integration::TouchEvent> mTouchEvents; ///< The touch events since initial touch down.
 101
 102   float mDefaultMinimumDistanceDelta; ///< The default value of the mMinimumDistanceDelta.
 103
 104   float mMinimumDistanceDelta; ///< The minimum distance before a pinch is applicable.
 105
 106   float mStartingDistance; ///< The distance between the two touch points when the pinch is first detected.
 107 };
 108
 109 } // namespace Internal
 110
 111 } // namespace Dali
 112
 113 #endif // DALI_INTERNAL_EVENT_PINCH_GESTURE_RECOGNIZER_H