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

   1 #ifndef DALI_INTERNAL_EVENT_ROTATION_GESTURE_RECOGNIZER_H
   2 #define DALI_INTERNAL_EVENT_ROTATION_GESTURE_RECOGNIZER_H
   3
   4 /*
   5  * Copyright (c) 2020 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/rotation-gesture/rotation-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 rotation gesture has taken place.
  41  */
  42 class RotationGestureRecognizer : public GestureRecognizer
  43 {
  44 public:
  45
  46   using Observer = RecognizerObserver< RotationGestureEvent >;
  47
  48   /**
  49    * Constructor
  50    * @param[in] observer   The observer to send gesture too when it's detected
  51    * @param[in] minimumTouchEvents The number of touch events required
  52    * @param[in] minimumTouchEventsAfterStart The number of touch events required after a gesture started
  53    */
  54   RotationGestureRecognizer( Observer& observer, uint32_t minimumTouchEvents, uint32_t minimumTouchEventsAfterStart );
  55
  56   /**
  57    * Virtual destructor.
  58    */
  59   virtual ~RotationGestureRecognizer() = default;
  60
  61 public:
  62
  63   /**
  64    * @copydoc Dali::Internal::GestureDetector::SendEvent(const Integration::TouchEvent&)
  65    */
  66   virtual void SendEvent( const Integration::TouchEvent& event );
  67
  68   /**
  69    * @copydoc Dali::Internal::GestureDetector::Update(const Integration::GestureRequest&)
  70    */
  71   virtual void Update( const GestureRequest& request ) { /* Nothing to do */ }
  72
  73   /**
  74    * Sets the minimum touch events required before a rotation can be started
  75    * @param[in] value The number of touch events
  76    */
  77   void SetMinimumTouchEvents( uint32_t value );
  78
  79   /**
  80    * Sets the minimum touch events required after a rotation started
  81    * @param[in] value The number of touch events
  82    */
  83   void SetMinimumTouchEventsAfterStart( uint32_t value );
  84
  85 private:
  86
  87   /**
  88    * Emits the rotation gesture event to the core.
  89    * @param[in]  state         The state of the rotation (whether it's starting, continuing or finished).
  90    * @param[in]  currentEvent  The latest touch event.
  91    */
  92   void SendRotation( GestureState state, const Integration::TouchEvent& currentEvent );
  93
  94 private:
  95
  96   // Reference to the gesture processor for this recognizer
  97   Observer& mObserver;
  98
  99   /**
 100    * Internal state machine.
 101    */
 102   enum State
 103   {
 104     CLEAR,    ///< No gesture detected.
 105     POSSIBLE, ///< The current touch event data suggests that a gesture is possible.
 106     STARTED,  ///< A gesture has been detected.
 107   };
 108
 109   State mState; ///< The current state of the detector.
 110   std::vector< Integration::TouchEvent > mTouchEvents; ///< The touch events since initial touch down.
 111
 112   float mStartingAngle; ///< The angle between the two touch points when the rotation is first detected.
 113
 114   uint32_t mMinimumTouchEvents; ///< The minimum touch events required before a rotation can be started.
 115
 116   uint32_t mMinimumTouchEventsAfterStart; ///< The minimum touch events required after a rotation started.
 117 };
 118
 119 } // namespace Internal
 120
 121 } // namespace Dali
 122
 123 #endif // DALI_INTERNAL_EVENT_ROTATION_GESTURE_RECOGNIZER_H