dali/internal/event/events/tap-gesture-processor.h

   1 #ifndef __DALI_INTERNAL_TAP_GESTURE_EVENT_PROCESSOR_H__
   2 #define __DALI_INTERNAL_TAP_GESTURE_EVENT_PROCESSOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // INTERNAL INCLUDES
  22 #include <dali/internal/event/events/tap-gesture-detector-impl.h>
  23 #include <dali/internal/event/events/gesture-processor.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Integration
  29 {
  30 class GestureManager;
  31 struct GestureEvent;
  32 struct TapGestureEvent;
  33 }
  34
  35 namespace Internal
  36 {
  37
  38 class Stage;
  39 class Actor;
  40
  41 /**
  42  * Tap Gesture Event Processing:
  43  *
  44  * When we receive a tap gesture event, we do the following:
  45  * - Determine the hit actor underneath the tap gesture event.
  46  * - Determine whether this actor is attached to any of the detectors or is a child of an actor
  47  *   attached to one of the detectors.
  48  * - Ensure the taps and the touches in the tap event match the requirements of the detector.
  49  * - Emit the gesture when all the above conditions are met.
  50  */
  51 class TapGestureProcessor : public GestureProcessor
  52 {
  53 public:
  54
  55   /**
  56    * Create a tap gesture processor.
  57    * @param[in] stage The stage.
  58    * @param[in] gestureManager The gesture manager.
  59    */
  60   TapGestureProcessor(Stage& stage, Integration::GestureManager& gestureManager);
  61
  62   /**
  63    * Non-virtual destructor; TapGestureProcessor is not a base class
  64    */
  65   ~TapGestureProcessor();
  66
  67 public: // To be called by GestureEventProcessor
  68
  69   /**
  70    * This method is called whenever a tap gesture event occurs.
  71    * @param[in] tapEvent The event that has occurred.
  72    */
  73   void Process(const Integration::TapGestureEvent& tapEvent);
  74
  75   /**
  76    * Adds a gesture detector to this gesture processor.
  77    * If this is the first gesture detector being added, then this method registers the required
  78    * gesture with the adaptor.
  79    * @param[in]  gestureDetector  The gesture detector being added.
  80    */
  81   void AddGestureDetector(TapGestureDetector* gestureDetector);
  82
  83   /**
  84    * Removes the specified gesture detector from this gesture processor.  If, after removing this
  85    * gesture detector, there are no more gesture detectors registered, then this method unregisters
  86    * the gesture from the adaptor.
  87    * @param[in]  gestureDetector  The gesture detector being removed.
  88    */
  89   void RemoveGestureDetector(TapGestureDetector* gestureDetector);
  90
  91   /**
  92    * This method updates the gesture detection parameters.
  93    * @param[in]  gestureDetector  The gesture detector that has been updated.
  94    */
  95   void GestureDetectorUpdated(TapGestureDetector* gestureDetector);
  96
  97 private:
  98
  99   // Undefined
 100   TapGestureProcessor(const TapGestureProcessor&);
 101   TapGestureProcessor& operator=(const TapGestureProcessor& rhs);
 102
 103 private:
 104
 105   /**
 106    * Iterates through our GestureDetectors and determines if we need to ask the adaptor to update
 107    * its detection policy.  If it does, it sends the appropriate gesture update request to adaptor.
 108    */
 109   void UpdateDetection();
 110
 111   // GestureProcessor overrides
 112
 113   /**
 114    * @copydoc GestureProcessor::OnGesturedActorStageDisconnection()
 115    */
 116   void OnGesturedActorStageDisconnection() { /* Nothing to do */ }
 117
 118 private:
 119
 120   Stage& mStage;
 121   Integration::GestureManager& mGestureManager;
 122   TapGestureDetectorContainer mGestureDetectors;
 123
 124   unsigned int mMinTapsRequired;
 125   unsigned int mMaxTapsRequired;
 126   unsigned int mMinTouchesRequired;
 127   unsigned int mMaxTouchesRequired;
 128
 129   struct TapEventFunctor;
 130 };
 131
 132 } // namespace Internal
 133
 134 } // namespace Dali
 135
 136 #endif // __DALI_INTERNAL_PINCH_GESTURE_EVENT_PROCESSOR_H__