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) 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 #include <dali/public-api/events/gesture.h>
  24 #include <dali/public-api/math/vector2.h>
  25 #include <dali/public-api/object/ref-object.h>
  26 #include <dali/internal/event/events/gesture-event.h>
  27
  28 namespace Dali
  29 {
  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 /**
  53  * Abstract Base class for all adaptor gesture detectors.
  54  *
  55  * @note this may be replaced by gesture events sent directly from X.
  56  */
  57 class GestureRecognizer : public RefObject
  58 {
  59 public:
  60
  61   /**
  62    * Called when it gets a touch event.  The gesture recognizer should
  63    * evaluate this event along with previously received events to determine
  64    * whether the gesture they require has taken place.
  65    * @param[in]  event  The latest touch event.
  66    */
  67   virtual void SendEvent(const Integration::TouchEvent& event) = 0;
  68
  69   /**
  70    * Called when Core updates the gesture's detection requirements.
  71    * @param[in]  request  The updated detection requirements.
  72    */
  73   virtual void Update(const GestureRequest& request) = 0;
  74
  75   /**
  76    * Returns the type of gesture detector.
  77    * @return Type of gesture detector.
  78    */
  79   GestureType::Value GetType() const { return mType; }
  80
  81   /**
  82    * Called when we get a touch event.
  83    * @param[in]  scene  The scene the touch event has occurred on
  84    * @param[in]  event  The latest touch event
  85    */
  86   void SendEvent( Scene& scene, const Integration::TouchEvent& event )
  87   {
  88     mScene = &scene;
  89     SendEvent( event );
  90   }
  91
  92 protected:
  93
  94   /**
  95    * Protected Constructor. Should only be able to create derived class objects.
  96    * @param[in]  screenSize    The size of the screen.
  97    * @param[in]  detectorType  The type of gesture detector.
  98    */
  99   GestureRecognizer( Vector2 screenSize, GestureType::Value detectorType )
 100   : mScreenSize( screenSize ),
 101     mType( detectorType ),
 102     mScene( nullptr )
 103   {
 104   }
 105
 106   /**
 107    * Protected Constructor. Should only be able to create derived class objects.
 108    *
 109    * Use this constructor with the screen size is not used in the dereived class.
 110    * @param[in]  detectorType  The type of gesture detector.
 111    */
 112   GestureRecognizer( GestureType::Value detectorType )
 113   : GestureRecognizer( Vector2::ZERO, detectorType )
 114   {
 115   }
 116
 117   /**
 118    * Virtual destructor.
 119    */
 120   ~GestureRecognizer() override = default;
 121
 122 protected:
 123   Vector2 mScreenSize;
 124   GestureType::Value mType;
 125   Scene* mScene;
 126 };
 127
 128 using GestureRecognizerPtr = IntrusivePtr<GestureRecognizer>;
 129
 130 } // namespace Internal
 131
 132 } // namespace Dali
 133
 134 #endif // DALI_INTERNAL_GESTURE_RECOGNIZER_H