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

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