dali/internal/event/events/long-press-gesture/long-press-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/long-press-gesture/long-press-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/long-press-gesture/long-press-gesture-event.h>
  31 #include <dali/internal/event/events/long-press-gesture/long-press-gesture-impl.h>
  32 #include <dali/internal/event/events/long-press-gesture/long-press-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
  37 namespace Dali
  38 {
  39 namespace Internal
  40 {
  41 namespace
  42 {
  43 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
  44 const unsigned long DEFAULT_MINIMUM_HOLDING_TIME = 500u;
  45
  46 /**
  47  * Creates a LongPressGesture and asks the specified detector to emit its detected signal.
  48  * @param[in]  actor             The actor on which the long press gesture has occurred.
  49  * @param[in]  gestureDetectors  A reference to gesture detectors that should emit the signal.
  50  * @param[in]  longPressEvent    The longPressEvent received from the adaptor.
  51  * @param[in]  localPoint        Relative to the actor attached to the detector.
  52  */
  53 void EmitLongPressSignal(
  54   Actor*                          actor,
  55   const GestureDetectorContainer& gestureDetectors,
  56   const LongPressGestureEvent&    longPressEvent,
  57   Vector2                         localPoint)
  58 {
  59   Internal::LongPressGesturePtr longPress(new Internal::LongPressGesture(longPressEvent.state));
  60   longPress->SetTime(longPressEvent.time);
  61   longPress->SetNumberOfTouches(longPressEvent.numberOfTouches);
  62   longPress->SetScreenPoint(longPressEvent.point);
  63   longPress->SetLocalPoint(localPoint);
  64   longPress->SetSourceType(longPressEvent.sourceType);
  65   longPress->SetSourceData(longPressEvent.sourceData);
  66
  67   DALI_TRACE_BEGIN_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_LONG_PRESS_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
  68     oss << "[" << gestureDetectors.size() << "]";
  69   });
  70
  71   Dali::Actor                                    actorHandle(actor);
  72   const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
  73   for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
  74   {
  75     static_cast<LongPressGestureDetector*>(*iter)->EmitLongPressGestureSignal(actorHandle, Dali::LongPressGesture(longPress.Get()));
  76   }
  77
  78   DALI_TRACE_END_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_LONG_PRESS_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
  79     oss << "[" << gestureDetectors.size() << "]";
  80   });
  81 }
  82
  83 /**
  84  * Functor which checks whether the specified actor is attached to the gesture detector.
  85  * It returns true if it is no longer attached.  This can be used in remove_if functions.
  86  */
  87 struct IsNotAttachedFunctor
  88 {
  89   /**
  90    * Constructor
  91    * @param[in]  actor  The actor to check whether it is attached.
  92    */
  93   IsNotAttachedFunctor(Actor* actor)
  94   : actorToCheck(actor)
  95   {
  96   }
  97
  98   /**
  99    * Returns true if not attached, false if it is still attached.
 100    * @param[in]  detector  The detector to check.
 101    * @return true, if not attached, false otherwise.
 102    */
 103   bool operator()(const GestureDetector* detector) const
 104   {
 105     return !detector->IsAttached(*actorToCheck);
 106   }
 107
 108   Actor* actorToCheck; ///< The actor to check whether it is attached or not.
 109 };
 110
 111 } // unnamed namespace
 112
 113 LongPressGestureProcessor::LongPressGestureProcessor()
 114 : GestureProcessor(GestureType::LONG_PRESS),
 115   mLongPressGestureDetectors(),
 116   mCurrentEmitters(),
 117   mCurrentRenderTask(),
 118   mMinTouchesRequired(1),
 119   mMaxTouchesRequired(1),
 120   mCurrentLongPressEvent(nullptr),
 121   mMinimumHoldingTime(DEFAULT_MINIMUM_HOLDING_TIME)
 122 {
 123 }
 124
 125 LongPressGestureProcessor::~LongPressGestureProcessor() = default;
 126
 127 void LongPressGestureProcessor::Process(Scene& scene, const LongPressGestureEvent& longPressEvent)
 128 {
 129   DALI_TRACE_SCOPE(gTraceFilter, "DALI_PROCESS_LONG_PRESS_GESTURE");
 130   switch(longPressEvent.state)
 131   {
 132     case GestureState::POSSIBLE:
 133     {
 134       mCurrentEmitters.clear();
 135       ResetActor();
 136
 137       HitTestAlgorithm::Results hitTestResults;
 138       if(GetFeededActor())
 139       {
 140         SetActor(GetFeededActor());
 141       }
 142       else if(HitTest(scene, longPressEvent.point, hitTestResults))
 143       {
 144         SetActor(&GetImplementation(hitTestResults.actor));
 145       }
 146       break;
 147     }
 148
 149     case GestureState::STARTED:
 150     {
 151       if(GetCurrentGesturedActor())
 152       {
 153         HitTestAlgorithm::Results hitTestResults;
 154         Actor* feededActor = GetFeededActor();
 155         if(feededActor)
 156         {
 157           SetActor(feededActor);
 158           hitTestResults.actor = Dali::Actor(feededActor);
 159           hitTestResults.renderTask = GetFeededRenderTask();
 160
 161           Vector2     actorCoords;
 162           feededActor->ScreenToLocal(*hitTestResults.renderTask.Get(), actorCoords.x, actorCoords.y, longPressEvent.point.x, longPressEvent.point.y);
 163           hitTestResults.actorCoordinates = actorCoords;
 164         }
 165         else
 166         {
 167           HitTest(scene, longPressEvent.point, hitTestResults);
 168         }
 169
 170         if(hitTestResults.actor && (GetCurrentGesturedActor() == &GetImplementation(hitTestResults.actor)))
 171         {
 172           // Record the current render-task for Screen->Actor coordinate conversions
 173           mCurrentRenderTask = hitTestResults.renderTask;
 174
 175           // Set mCurrentLongPressEvent to use inside overridden methods called from ProcessAndEmit()
 176           mCurrentLongPressEvent = &longPressEvent;
 177           if(feededActor)
 178           {
 179             ProcessAndEmitActor(hitTestResults, GetFeededGestureDetector());
 180           }
 181           else
 182           {
 183             ProcessAndEmit(hitTestResults);
 184           }
 185           mCurrentLongPressEvent = nullptr;
 186         }
 187         else
 188         {
 189           mCurrentEmitters.clear();
 190           ResetActor();
 191         }
 192       }
 193       break;
 194     }
 195
 196     case GestureState::FINISHED:
 197     {
 198       // The gesture should only be sent to the gesture detector which first received it so that it
 199       // can be told when the gesture ends as well.
 200
 201       // Only send subsequent long press gesture signals if we processed the gesture when it started.
 202       // Check if actor is still touchable.
 203       Actor* currentGesturedActor = GetCurrentGesturedActor();
 204       if(currentGesturedActor)
 205       {
 206         if(currentGesturedActor->IsHittable() && !mCurrentEmitters.empty() && mCurrentRenderTask)
 207         {
 208           // Ensure actor is still attached to the emitters, if it is not then remove the emitter.
 209           GestureDetectorContainer::iterator endIter = std::remove_if(mCurrentEmitters.begin(), mCurrentEmitters.end(), IsNotAttachedFunctor(currentGesturedActor));
 210           mCurrentEmitters.erase(endIter, mCurrentEmitters.end());
 211
 212           if(!mCurrentEmitters.empty())
 213           {
 214             Vector2     actorCoords;
 215             RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
 216             currentGesturedActor->ScreenToLocal(renderTaskImpl, actorCoords.x, actorCoords.y, longPressEvent.point.x, longPressEvent.point.y);
 217
 218             EmitLongPressSignal(currentGesturedActor, mCurrentEmitters, longPressEvent, actorCoords);
 219           }
 220         }
 221
 222         // Clear current emitters and emitted actor
 223         mCurrentEmitters.clear();
 224         ResetActor();
 225       }
 226       break;
 227     }
 228
 229     case GestureState::CANCELLED:
 230     {
 231       mCurrentEmitters.clear();
 232       ResetActor();
 233       break;
 234     }
 235
 236     case GestureState::CONTINUING:
 237     {
 238       DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
 239       break;
 240     }
 241
 242     case GestureState::CLEAR:
 243     {
 244       DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
 245       break;
 246     }
 247   }
 248 }
 249
 250 void LongPressGestureProcessor::AddGestureDetector(LongPressGestureDetector* gestureDetector, Scene& scene)
 251 {
 252   bool firstRegistration(mLongPressGestureDetectors.empty());
 253
 254   mLongPressGestureDetectors.push_back(gestureDetector);
 255
 256   if(firstRegistration)
 257   {
 258     mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
 259     mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
 260
 261     LongPressGestureRequest request;
 262     request.minTouches = mMinTouchesRequired;
 263     request.maxTouches = mMaxTouchesRequired;
 264
 265     Size size = scene.GetSize();
 266
 267     mGestureRecognizer = new LongPressGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const LongPressGestureRequest&>(request), mMinimumHoldingTime);
 268   }
 269   else
 270   {
 271     UpdateDetection();
 272   }
 273 }
 274
 275 void LongPressGestureProcessor::RemoveGestureDetector(LongPressGestureDetector* gestureDetector)
 276 {
 277   // Find detector ...
 278   LongPressGestureDetectorContainer::iterator endIter = std::remove(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector);
 279   DALI_ASSERT_DEBUG(endIter != mLongPressGestureDetectors.end());
 280
 281   // ... and remove it
 282   mLongPressGestureDetectors.erase(endIter, mLongPressGestureDetectors.end());
 283
 284   if(mLongPressGestureDetectors.empty())
 285   {
 286     mGestureRecognizer = nullptr;
 287   }
 288   else
 289   {
 290     UpdateDetection();
 291   }
 292 }
 293
 294 void LongPressGestureProcessor::GestureDetectorUpdated(LongPressGestureDetector* gestureDetector)
 295 {
 296   DALI_ASSERT_DEBUG(find(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector) != mLongPressGestureDetectors.end());
 297
 298   UpdateDetection();
 299 }
 300
 301 void LongPressGestureProcessor::SetMinimumHoldingTime(uint32_t time)
 302 {
 303   if(time > 0u && mMinimumHoldingTime != time)
 304   {
 305     mMinimumHoldingTime = time;
 306
 307     if(mGestureRecognizer)
 308     {
 309       LongPressGestureRecognizer* longPressRecognizer = dynamic_cast<LongPressGestureRecognizer*>(mGestureRecognizer.Get());
 310       if(longPressRecognizer)
 311       {
 312         longPressRecognizer->SetMinimumHoldingTime(time);
 313       }
 314     }
 315   }
 316 }
 317
 318 uint32_t LongPressGestureProcessor::GetMinimumHoldingTime() const
 319 {
 320   return mMinimumHoldingTime;
 321 }
 322
 323 void LongPressGestureProcessor::UpdateDetection()
 324 {
 325   DALI_ASSERT_DEBUG(!mLongPressGestureDetectors.empty());
 326
 327   unsigned int minimumRequired = UINT_MAX;
 328   unsigned int maximumRequired = 0;
 329
 330   for(LongPressGestureDetectorContainer::iterator iter = mLongPressGestureDetectors.begin(), endIter = mLongPressGestureDetectors.end(); iter != endIter; ++iter)
 331   {
 332     LongPressGestureDetector* current(*iter);
 333
 334     if(current)
 335     {
 336       unsigned int minimum = current->GetMinimumTouchesRequired();
 337       if(minimum < minimumRequired)
 338       {
 339         minimumRequired = minimum;
 340       }
 341
 342       unsigned int maximum = current->GetMaximumTouchesRequired();
 343       if(maximum > maximumRequired)
 344       {
 345         maximumRequired = maximum;
 346       }
 347     }
 348   }
 349
 350   if((minimumRequired != mMinTouchesRequired) || (maximumRequired != mMaxTouchesRequired))
 351   {
 352     mMinTouchesRequired = minimumRequired;
 353     mMaxTouchesRequired = maximumRequired;
 354
 355     LongPressGestureRequest request;
 356     request.minTouches = mMinTouchesRequired;
 357     request.maxTouches = mMaxTouchesRequired;
 358     mGestureRecognizer->Update(request);
 359   }
 360 }
 361
 362 void LongPressGestureProcessor::OnGesturedActorStageDisconnection()
 363 {
 364   mCurrentEmitters.clear();
 365 }
 366
 367 bool LongPressGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
 368 {
 369   DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
 370
 371   LongPressGestureDetector* longPressDetector(static_cast<LongPressGestureDetector*>(detector));
 372
 373   return (longPressDetector->GetMinimumTouchesRequired() <= mCurrentLongPressEvent->numberOfTouches) &&
 374          (longPressDetector->GetMaximumTouchesRequired() >= mCurrentLongPressEvent->numberOfTouches);
 375 }
 376
 377 void LongPressGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
 378 {
 379   DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
 380
 381   mCurrentEmitters.clear();
 382   ResetActor();
 383
 384   EmitLongPressSignal(actor, gestureDetectors, *mCurrentLongPressEvent, actorCoordinates);
 385
 386   if(actor->OnScene())
 387   {
 388     mCurrentEmitters = gestureDetectors;
 389     SetActor(actor);
 390   }
 391 }
 392
 393 } // namespace Internal
 394
 395 } // namespace Dali