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

   1 #ifndef DALI_INTERNAL_GESTURE_RECOGNIZER_H
   2 #define DALI_INTERNAL_GESTURE_RECOGNIZER_H
   3
   4 /*
   5  * Copyright (c) 2022 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/integration-api/events/touch-event-integ.h>
  23 #include <dali/internal/event/events/gesture-event.h>
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/events/gesture.h>
  26 #include <dali/public-api/math/vector2.h>
  27 #include <dali/public-api/object/ref-object.h>
  28
  29 namespace Dali
  30 {
  31 namespace Integration
  32 {
  33 struct TouchEvent;
  34 }
  35
  36 namespace Internal
  37 {
  38 struct GestureRequest;
  39 class Scene;
  40
  41 template<typename T>
  42 class RecognizerObserver
  43 {
  44 public:
  45   virtual void Process(Scene& scene, const T& event) = 0;
  46
  47   virtual ~RecognizerObserver() = default;
  48   ;
  49 };
  50
  51 /**
  52  * Abstract Base class for all adaptor gesture detectors.
  53  *
  54  * @note this may be replaced by gesture events sent directly from X.
  55  */
  56 class GestureRecognizer : public RefObject
  57 {
  58 public:
  59   /**
  60    * Called when it gets a touch event.  The gesture recognizer should
  61    * evaluate this event along with previously received events to determine
  62    * whether the gesture they require has taken place.
  63    * @param[in]  event  The latest touch event.
  64    */
  65   virtual void SendEvent(const Integration::TouchEvent& event) = 0;
  66
  67   /**
  68    * Called when Core updates the gesture's detection requirements.
  69    * @param[in]  request  The updated detection requirements.
  70    */
  71   virtual void Update(const GestureRequest& request) = 0;
  72
  73   /**
  74    * Returns the type of gesture detector.
  75    * @return Type of gesture detector.
  76    */
  77   GestureType::Value GetType() const
  78   {
  79     return mType;
  80   }
  81
  82   /**
  83    * Called when we get a touch event.
  84    * @param[in]  scene  The scene the touch event has occurred on
  85    * @param[in]  event  The latest touch event
  86    */
  87   void SendEvent(Scene& scene, const Integration::TouchEvent& event)
  88   {
  89     mScene = &scene;
  90     if(event.GetPointCount() > 0)
  91     {
  92       const Integration::Point& point       = event.points[0];
  93       MouseButton::Type         mouseButton = point.GetMouseButton();
  94       if(mouseButton != MouseButton::INVALID)
  95       {
  96         mSourceType = GestureSourceType::MOUSE;
  97         switch(mouseButton)
  98         {
  99           case MouseButton::PRIMARY:
 100           {
 101             mSourceData = GestureSourceData::MOUSE_PRIMARY;
 102             break;
 103           }
 104           case MouseButton::SECONDARY:
 105           {
 106             mSourceData = GestureSourceData::MOUSE_SECONDARY;
 107             break;
 108           }
 109           case MouseButton::TERTIARY:
 110           {
 111             mSourceData = GestureSourceData::MOUSE_TERTIARY;
 112             break;
 113           }
 114           default:
 115           {
 116             mSourceData = GestureSourceData::INVALID;
 117             break;
 118           }
 119         }
 120       }
 121     }
 122     SendEvent(event);
 123   }
 124
 125 protected:
 126   /**
 127    * Protected Constructor. Should only be able to create derived class objects.
 128    * @param[in]  screenSize    The size of the screen.
 129    * @param[in]  detectorType  The type of gesture detector.
 130    */
 131   GestureRecognizer(Vector2 screenSize, GestureType::Value detectorType)
 132   : mScreenSize(screenSize),
 133     mType(detectorType),
 134     mScene(nullptr),
 135     mSourceType(GestureSourceType::INVALID),
 136     mSourceData(GestureSourceData::INVALID)
 137   {
 138   }
 139
 140   /**
 141    * Protected Constructor. Should only be able to create derived class objects.
 142    *
 143    * Use this constructor with the screen size is not used in the dereived class.
 144    * @param[in]  detectorType  The type of gesture detector.
 145    */
 146   GestureRecognizer(GestureType::Value detectorType)
 147   : GestureRecognizer(Vector2::ZERO, detectorType)
 148   {
 149   }
 150
 151   /**
 152    * Virtual destructor.
 153    */
 154   ~GestureRecognizer() override = default;
 155
 156 protected:
 157   Vector2            mScreenSize;
 158   GestureType::Value mType;
 159   Scene*             mScene;
 160   GestureSourceType  mSourceType; /// < Gesture input source type.
 161   GestureSourceData  mSourceData; /// < Gesture input source data.
 162 };
 163
 164 using GestureRecognizerPtr = IntrusivePtr<GestureRecognizer>;
 165
 166 } // namespace Internal
 167
 168 } // namespace Dali
 169
 170 #endif // DALI_INTERNAL_GESTURE_RECOGNIZER_H