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(HitTest(scene, longPressEvent.point, hitTestResults))
 139       {
 140         SetActor(&GetImplementation(hitTestResults.actor));
 141       }
 142       break;
 143     }
 144
 145     case GestureState::STARTED:
 146     {
 147       Actor* currentGesturedActor = GetCurrentGesturedActor();
 148       if(currentGesturedActor)
 149       {
 150         HitTestAlgorithm::Results hitTestResults;
 151         HitTest(scene, longPressEvent.point, hitTestResults);
 152
 153         if(hitTestResults.actor && (currentGesturedActor == &GetImplementation(hitTestResults.actor)))
 154         {
 155           // Record the current render-task for Screen->Actor coordinate conversions
 156           mCurrentRenderTask = hitTestResults.renderTask;
 157
 158           // Set mCurrentLongPressEvent to use inside overridden methods called from ProcessAndEmit()
 159           mCurrentLongPressEvent = &longPressEvent;
 160           ProcessAndEmit(hitTestResults);
 161           mCurrentLongPressEvent = nullptr;
 162         }
 163         else
 164         {
 165           mCurrentEmitters.clear();
 166           ResetActor();
 167         }
 168       }
 169       break;
 170     }
 171
 172     case GestureState::FINISHED:
 173     {
 174       // The gesture should only be sent to the gesture detector which first received it so that it
 175       // can be told when the gesture ends as well.
 176
 177       // Only send subsequent long press gesture signals if we processed the gesture when it started.
 178       // Check if actor is still touchable.
 179
 180       Actor* currentGesturedActor = GetCurrentGesturedActor();
 181       if(currentGesturedActor)
 182       {
 183         if(currentGesturedActor->IsHittable() && !mCurrentEmitters.empty() && mCurrentRenderTask)
 184         {
 185           // Ensure actor is still attached to the emitters, if it is not then remove the emitter.
 186           GestureDetectorContainer::iterator endIter = std::remove_if(mCurrentEmitters.begin(), mCurrentEmitters.end(), IsNotAttachedFunctor(currentGesturedActor));
 187           mCurrentEmitters.erase(endIter, mCurrentEmitters.end());
 188
 189           if(!mCurrentEmitters.empty())
 190           {
 191             Vector2     actorCoords;
 192             RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
 193             currentGesturedActor->ScreenToLocal(renderTaskImpl, actorCoords.x, actorCoords.y, longPressEvent.point.x, longPressEvent.point.y);
 194
 195             EmitLongPressSignal(currentGesturedActor, mCurrentEmitters, longPressEvent, actorCoords);
 196           }
 197         }
 198
 199         // Clear current emitters and emitted actor
 200         mCurrentEmitters.clear();
 201         ResetActor();
 202       }
 203       break;
 204     }
 205
 206     case GestureState::CANCELLED:
 207     {
 208       mCurrentEmitters.clear();
 209       ResetActor();
 210       break;
 211     }
 212
 213     case GestureState::CONTINUING:
 214     {
 215       DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
 216       break;
 217     }
 218
 219     case GestureState::CLEAR:
 220     {
 221       DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
 222       break;
 223     }
 224   }
 225 }
 226
 227 void LongPressGestureProcessor::AddGestureDetector(LongPressGestureDetector* gestureDetector, Scene& scene)
 228 {
 229   bool firstRegistration(mLongPressGestureDetectors.empty());
 230
 231   mLongPressGestureDetectors.push_back(gestureDetector);
 232
 233   if(firstRegistration)
 234   {
 235     mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
 236     mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
 237
 238     LongPressGestureRequest request;
 239     request.minTouches = mMinTouchesRequired;
 240     request.maxTouches = mMaxTouchesRequired;
 241
 242     Size size = scene.GetSize();
 243
 244     mGestureRecognizer = new LongPressGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const LongPressGestureRequest&>(request), mMinimumHoldingTime);
 245   }
 246   else
 247   {
 248     UpdateDetection();
 249   }
 250 }
 251
 252 void LongPressGestureProcessor::RemoveGestureDetector(LongPressGestureDetector* gestureDetector)
 253 {
 254   // Find detector ...
 255   LongPressGestureDetectorContainer::iterator endIter = std::remove(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector);
 256   DALI_ASSERT_DEBUG(endIter != mLongPressGestureDetectors.end());
 257
 258   // ... and remove it
 259   mLongPressGestureDetectors.erase(endIter, mLongPressGestureDetectors.end());
 260
 261   if(mLongPressGestureDetectors.empty())
 262   {
 263     mGestureRecognizer = nullptr;
 264   }
 265   else
 266   {
 267     UpdateDetection();
 268   }
 269 }
 270
 271 void LongPressGestureProcessor::GestureDetectorUpdated(LongPressGestureDetector* gestureDetector)
 272 {
 273   DALI_ASSERT_DEBUG(find(mLongPressGestureDetectors.begin(), mLongPressGestureDetectors.end(), gestureDetector) != mLongPressGestureDetectors.end());
 274
 275   UpdateDetection();
 276 }
 277
 278 void LongPressGestureProcessor::SetMinimumHoldingTime(uint32_t time)
 279 {
 280   if(time > 0u && mMinimumHoldingTime != time)
 281   {
 282     mMinimumHoldingTime = time;
 283
 284     if(mGestureRecognizer)
 285     {
 286       LongPressGestureRecognizer* longPressRecognizer = dynamic_cast<LongPressGestureRecognizer*>(mGestureRecognizer.Get());
 287       if(longPressRecognizer)
 288       {
 289         longPressRecognizer->SetMinimumHoldingTime(time);
 290       }
 291     }
 292   }
 293 }
 294
 295 uint32_t LongPressGestureProcessor::GetMinimumHoldingTime() const
 296 {
 297   return mMinimumHoldingTime;
 298 }
 299
 300 void LongPressGestureProcessor::UpdateDetection()
 301 {
 302   DALI_ASSERT_DEBUG(!mLongPressGestureDetectors.empty());
 303
 304   unsigned int minimumRequired = UINT_MAX;
 305   unsigned int maximumRequired = 0;
 306
 307   for(LongPressGestureDetectorContainer::iterator iter = mLongPressGestureDetectors.begin(), endIter = mLongPressGestureDetectors.end(); iter != endIter; ++iter)
 308   {
 309     LongPressGestureDetector* current(*iter);
 310
 311     if(current)
 312     {
 313       unsigned int minimum = current->GetMinimumTouchesRequired();
 314       if(minimum < minimumRequired)
 315       {
 316         minimumRequired = minimum;
 317       }
 318
 319       unsigned int maximum = current->GetMaximumTouchesRequired();
 320       if(maximum > maximumRequired)
 321       {
 322         maximumRequired = maximum;
 323       }
 324     }
 325   }
 326
 327   if((minimumRequired != mMinTouchesRequired) || (maximumRequired != mMaxTouchesRequired))
 328   {
 329     mMinTouchesRequired = minimumRequired;
 330     mMaxTouchesRequired = maximumRequired;
 331
 332     LongPressGestureRequest request;
 333     request.minTouches = mMinTouchesRequired;
 334     request.maxTouches = mMaxTouchesRequired;
 335     mGestureRecognizer->Update(request);
 336   }
 337 }
 338
 339 void LongPressGestureProcessor::OnGesturedActorStageDisconnection()
 340 {
 341   mCurrentEmitters.clear();
 342 }
 343
 344 bool LongPressGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
 345 {
 346   DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
 347
 348   LongPressGestureDetector* longPressDetector(static_cast<LongPressGestureDetector*>(detector));
 349
 350   return (longPressDetector->GetMinimumTouchesRequired() <= mCurrentLongPressEvent->numberOfTouches) &&
 351          (longPressDetector->GetMaximumTouchesRequired() >= mCurrentLongPressEvent->numberOfTouches);
 352 }
 353
 354 void LongPressGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
 355 {
 356   DALI_ASSERT_DEBUG(mCurrentLongPressEvent);
 357
 358   mCurrentEmitters.clear();
 359   ResetActor();
 360
 361   EmitLongPressSignal(actor, gestureDetectors, *mCurrentLongPressEvent, actorCoordinates);
 362
 363   if(actor->OnScene())
 364   {
 365     mCurrentEmitters = gestureDetectors;
 366     SetActor(actor);
 367   }
 368 }
 369
 370 } // namespace Internal
 371
 372 } // namespace Dali