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

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/event/events/tap-gesture/tap-gesture-processor.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/internal/event/actors/actor-impl.h>
  27 #include <dali/internal/event/common/scene-impl.h>
  28 #include <dali/internal/event/events/gesture-requests.h>
  29 #include <dali/internal/event/events/tap-gesture/tap-gesture-event.h>
  30 #include <dali/internal/event/events/tap-gesture/tap-gesture-impl.h>
  31 #include <dali/internal/event/events/tap-gesture/tap-gesture-recognizer.h>
  32 #include <dali/internal/event/render-tasks/render-task-impl.h>
  33 #include <dali/public-api/actors/actor.h>
  34 #include <dali/public-api/common/dali-common.h>
  35 #include <dali/public-api/events/tap-gesture.h>
  36 #include <dali/public-api/math/vector2.h>
  37
  38 namespace Dali
  39 {
  40 namespace Internal
  41 {
  42 namespace
  43 {
  44 constexpr uint32_t DEFAULT_MAXIMUM_ALLOWED_TIME = 500u;
  45
  46 /**
  47  * Creates a TapGesture and asks the specified detector to emit its detected signal.
  48  * @param[in]  actor             The actor on which a tap has occurred.
  49  * @param[in]  gestureDetectors  A reference to gesture detectors that should emit the signal.
  50  * @param[in]  tapEvent          The tapEvent received from the adaptor.
  51  * @param[in]  localPoint        Relative to the actor attached to the detector.
  52  */
  53 void EmitTapSignal(
  54   Actor*                          actor,
  55   const GestureDetectorContainer& gestureDetectors,
  56   const TapGestureEvent&          tapEvent,
  57   Vector2                         localPoint)
  58 {
  59   Internal::TapGesturePtr tap(new Internal::TapGesture(tapEvent.state));
  60   tap->SetTime(tapEvent.time);
  61   tap->SetNumberOfTaps(tapEvent.numberOfTaps);
  62   tap->SetNumberOfTouches(tapEvent.numberOfTouches);
  63   tap->SetScreenPoint(tapEvent.point);
  64   tap->SetLocalPoint(localPoint);
  65   tap->SetSourceType(tapEvent.sourceType);
  66   tap->SetSourceData(tapEvent.sourceData);
  67
  68   Dali::Actor                                    actorHandle(actor);
  69   const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
  70   for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
  71   {
  72     static_cast<TapGestureDetector*>(*iter)->EmitTapGestureSignal(actorHandle, Dali::TapGesture(tap.Get()));
  73   }
  74 }
  75
  76 } // unnamed namespace
  77
  78 TapGestureProcessor::TapGestureProcessor()
  79 : GestureProcessor(GestureType::TAP),
  80   mTapGestureDetectors(),
  81   mMinTapsRequired(1),
  82   mMaxTapsRequired(1),
  83   mMinTouchesRequired(1),
  84   mMaxTouchesRequired(1),
  85   mCurrentTapEvent(nullptr),
  86   mPossibleProcessed(false),
  87   mMaximumAllowedTime(DEFAULT_MAXIMUM_ALLOWED_TIME)
  88 {
  89 }
  90
  91 TapGestureProcessor::~TapGestureProcessor() = default;
  92
  93 void TapGestureProcessor::Process(Scene& scene, const TapGestureEvent& tapEvent)
  94 {
  95   switch(tapEvent.state)
  96   {
  97     case GestureState::POSSIBLE:
  98     {
  99       // Do a hit test and if an actor has been hit then save to see if tap event is still valid on a tap( same actor being hit )
 100       HitTestAlgorithm::Results hitTestResults;
 101       if(HitTest(scene, tapEvent.point, hitTestResults))
 102       {
 103         SetActor(&GetImplementation(hitTestResults.actor));
 104         mCurrentTapActor.SetActor(GetCurrentGesturedActor());
 105
 106         // Indicate that we've processed a touch down. Bool should be sufficient as a change in actor will result in a cancellation
 107         mPossibleProcessed = true;
 108       }
 109       else
 110       {
 111         ResetActor();
 112       }
 113       break;
 114     }
 115
 116     case GestureState::STARTED:
 117     {
 118       // Ensure that we're processing a hit on the current actor and that we've already processed a touch down
 119       HitTestAlgorithm::Results hitTestResults;
 120       if(GetCurrentGesturedActor() && HitTest(scene, tapEvent.point, hitTestResults) && mPossibleProcessed)
 121       {
 122         // Check that this actor is still the one that was used for the last touch down ?
 123         if(mCurrentTapActor.GetActor() == &GetImplementation(hitTestResults.actor))
 124         {
 125           mCurrentTapEvent = &tapEvent;
 126           ProcessAndEmit(hitTestResults);
 127         }
 128         mCurrentTapEvent   = nullptr;
 129         mPossibleProcessed = false;
 130       }
 131       break;
 132     }
 133
 134     case GestureState::CANCELLED:
 135     {
 136       mPossibleProcessed = false;
 137       ResetActor();
 138       break;
 139     }
 140
 141     case GestureState::CONTINUING:
 142     {
 143       DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
 144       break;
 145     }
 146     case GestureState::FINISHED:
 147     {
 148       DALI_ABORT("Incorrect state received from Integration layer: FINISHED\n");
 149       break;
 150     }
 151     case GestureState::CLEAR:
 152     {
 153       DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
 154       break;
 155     }
 156   }
 157 }
 158
 159 void TapGestureProcessor::AddGestureDetector(TapGestureDetector* gestureDetector, Scene& scene)
 160 {
 161   bool firstRegistration(mTapGestureDetectors.empty());
 162
 163   mTapGestureDetectors.push_back(gestureDetector);
 164
 165   const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
 166   const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
 167   const unsigned int touchesRequired = gestureDetector->GetTouchesRequired();
 168
 169   DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
 170
 171   if(firstRegistration)
 172   {
 173     // If this is the first tap gesture detector that has been added, then our minimum and maximum
 174     // requirements are the same as each other.
 175
 176     mMinTapsRequired    = minTapsRequired;
 177     mMaxTapsRequired    = maxTapsRequired;
 178     mMinTouchesRequired = mMaxTouchesRequired = touchesRequired;
 179
 180     TapGestureRequest request;
 181     request.minTaps    = mMinTapsRequired;
 182     request.maxTaps    = mMaxTapsRequired;
 183     request.minTouches = mMinTouchesRequired;
 184     request.maxTouches = mMaxTouchesRequired;
 185
 186     Size size          = scene.GetSize();
 187     mGestureRecognizer = new TapGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const TapGestureRequest&>(request), mMaximumAllowedTime);
 188   }
 189   else
 190   {
 191     // If we have already registered for tap gesture detection before then we need to check our
 192     // minimum and maximums and see if our gesture detection requirements have changed, if they
 193     // have, then we should ask the adaptor to update its detection policy.
 194
 195     // This is quicker than calling UpdateDetection as there is no need to iterate through the container
 196
 197     unsigned int minTaps    = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
 198     unsigned int maxTaps    = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
 199     unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
 200     unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
 201
 202     if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
 203        (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
 204     {
 205       TapGestureRequest request;
 206       request.minTaps = mMinTapsRequired = minTaps;
 207       request.maxTaps = mMaxTapsRequired = maxTaps;
 208       request.minTouches = mMinTouchesRequired = minTouches;
 209       request.maxTouches = mMaxTouchesRequired = maxTouches;
 210
 211       mGestureRecognizer->Update(request);
 212     }
 213   }
 214 }
 215
 216 void TapGestureProcessor::RemoveGestureDetector(TapGestureDetector* gestureDetector)
 217 {
 218   // Find detector ...
 219   TapGestureDetectorContainer::iterator endIter = std::remove(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector);
 220   DALI_ASSERT_DEBUG(endIter != mTapGestureDetectors.end());
 221
 222   // ... and remove it
 223   mTapGestureDetectors.erase(endIter, mTapGestureDetectors.end());
 224
 225   if(mTapGestureDetectors.empty())
 226   {
 227     mGestureRecognizer = nullptr;
 228
 229     ResetActor();
 230   }
 231   else
 232   {
 233     UpdateDetection();
 234   }
 235 }
 236
 237 void TapGestureProcessor::GestureDetectorUpdated(TapGestureDetector* gestureDetector)
 238 {
 239   DALI_ASSERT_DEBUG(find(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector) != mTapGestureDetectors.end());
 240
 241   const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
 242   const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
 243
 244   DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
 245
 246   UpdateDetection();
 247 }
 248
 249 void TapGestureProcessor::SetMaximumAllowedTime(uint32_t time)
 250 {
 251   if(time == 0u)
 252   {
 253     DALI_LOG_WARNING("MaximumAllowedTime must be greater than zero.");
 254     return;
 255   }
 256   if(mMaximumAllowedTime != time)
 257   {
 258     mMaximumAllowedTime = time;
 259
 260     if(mGestureRecognizer)
 261     {
 262       TapGestureRecognizer* tapRecognizer = dynamic_cast<TapGestureRecognizer*>(mGestureRecognizer.Get());
 263       if(tapRecognizer)
 264       {
 265         tapRecognizer->SetMaximumAllowedTime(time);
 266       }
 267     }
 268   }
 269 }
 270
 271 void TapGestureProcessor::UpdateDetection()
 272 {
 273   DALI_ASSERT_DEBUG(!mTapGestureDetectors.empty());
 274
 275   unsigned int minTaps    = UINT_MAX;
 276   unsigned int maxTaps    = 0;
 277   unsigned int minTouches = UINT_MAX;
 278   unsigned int maxTouches = 0;
 279
 280   for(TapGestureDetectorContainer::iterator iter = mTapGestureDetectors.begin(), endIter = mTapGestureDetectors.end(); iter != endIter; ++iter)
 281   {
 282     TapGestureDetector* detector(*iter);
 283
 284     if(detector)
 285     {
 286       const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
 287       const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
 288       const unsigned int touchesRequired = detector->GetTouchesRequired();
 289
 290       minTaps    = minTapsRequired < minTaps ? minTapsRequired : minTaps;
 291       maxTaps    = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
 292       minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
 293       maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
 294     }
 295   }
 296
 297   if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
 298      (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
 299   {
 300     TapGestureRequest request;
 301     request.minTaps = mMinTapsRequired = minTaps;
 302     request.maxTaps = mMaxTapsRequired = maxTaps;
 303     request.minTouches = mMinTouchesRequired = minTouches;
 304     request.maxTouches = mMaxTouchesRequired = maxTouches;
 305
 306     mGestureRecognizer->Update(request);
 307   }
 308 }
 309
 310 bool TapGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
 311 {
 312   DALI_ASSERT_DEBUG(mCurrentTapEvent);
 313
 314   TapGestureDetector* tapDetector(static_cast<TapGestureDetector*>(detector));
 315
 316   return (tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps) && (tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches);
 317 }
 318
 319 void TapGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
 320 {
 321   DALI_ASSERT_DEBUG(mCurrentTapEvent);
 322
 323   EmitTapSignal(actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates);
 324 }
 325
 326 } // namespace Internal
 327
 328 } // namespace Dali