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) 2023 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         Device::Class::Type type = point.GetDeviceClass();
  97         if(type == Device::Class::Type::MOUSE)
  98         {
  99           mSourceType = GestureSourceType::MOUSE;
 100         }
 101         else if(type == Device::Class::Type::TOUCH)
 102         {
 103           mSourceType = GestureSourceType::TOUCH;
 104         }
 105         switch(mouseButton)
 106         {
 107           case MouseButton::PRIMARY:
 108           {
 109             mSourceData = GestureSourceData::MOUSE_PRIMARY;
 110             break;
 111           }
 112           case MouseButton::SECONDARY:
 113           {
 114             mSourceData = GestureSourceData::MOUSE_SECONDARY;
 115             break;
 116           }
 117           case MouseButton::TERTIARY:
 118           {
 119             mSourceData = GestureSourceData::MOUSE_TERTIARY;
 120             break;
 121           }
 122           default:
 123           {
 124             mSourceData = GestureSourceData::INVALID;
 125             break;
 126           }
 127         }
 128       }
 129     }
 130     SendEvent(event);
 131   }
 132
 133 protected:
 134   /**
 135    * Protected Constructor. Should only be able to create derived class objects.
 136    * @param[in]  screenSize    The size of the screen.
 137    * @param[in]  detectorType  The type of gesture detector.
 138    */
 139   GestureRecognizer(Vector2 screenSize, GestureType::Value detectorType)
 140   : mScreenSize(screenSize),
 141     mType(detectorType),
 142     mScene(nullptr),
 143     mSourceType(GestureSourceType::INVALID),
 144     mSourceData(GestureSourceData::INVALID)
 145   {
 146   }
 147
 148   /**
 149    * Protected Constructor. Should only be able to create derived class objects.
 150    *
 151    * Use this constructor with the screen size is not used in the dereived class.
 152    * @param[in]  detectorType  The type of gesture detector.
 153    */
 154   GestureRecognizer(GestureType::Value detectorType)
 155   : GestureRecognizer(Vector2::ZERO, detectorType)
 156   {
 157   }
 158
 159   /**
 160    * Virtual destructor.
 161    */
 162   ~GestureRecognizer() override = default;
 163
 164 protected:
 165   Vector2            mScreenSize;
 166   GestureType::Value mType;
 167   Scene*             mScene;
 168   GestureSourceType  mSourceType; /// < Gesture input source type.
 169   GestureSourceData  mSourceData; /// < Gesture input source data.
 170 };
 171
 172 using GestureRecognizerPtr = IntrusivePtr<GestureRecognizer>;
 173
 174 } // namespace Internal
 175
 176 } // namespace Dali
 177
 178 #endif // DALI_INTERNAL_GESTURE_RECOGNIZER_H