2 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali/internal/event/events/pan-gesture/pan-gesture-processor.h>
21 #if defined(DEBUG_ENABLED)
29 #include <dali/integration-api/debug.h>
30 #include <dali/integration-api/trace.h>
31 #include <dali/internal/event/common/scene-impl.h>
32 #include <dali/internal/event/events/gesture-requests.h>
33 #include <dali/internal/event/events/multi-point-event-util.h>
34 #include <dali/internal/event/events/pan-gesture/pan-gesture-event.h>
35 #include <dali/internal/event/events/pan-gesture/pan-gesture-impl.h>
36 #include <dali/internal/event/events/pan-gesture/pan-gesture-recognizer.h>
37 #include <dali/internal/event/render-tasks/render-task-impl.h>
38 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
39 #include <dali/internal/update/manager/update-manager.h>
40 #include <dali/public-api/actors/actor.h>
41 #include <dali/public-api/common/dali-common.h>
42 #include <dali/public-api/events/pan-gesture.h>
43 #include <dali/public-api/math/vector2.h>
49 namespace // unnamed namespace
51 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
52 #if defined(DEBUG_ENABLED)
53 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_PAN_PROCESSOR");
55 const char* GESTURE_STATES[6] =
64 #endif // defined(DEBUG_ENABLED)
66 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY(50u);
69 * Functor which checks whether the specified actor is attached to the gesture detector.
70 * If the actor is attached, it also checks whether the number of touches of the current pan event
71 * are within the range of that expected by the detector.
72 * It returns true if it is no longer attached or the touches are out of range.
73 * This can be used in remove_if functions.
75 struct IsNotAttachedAndOutsideTouchesRangeFunctor
79 * @param[in] actor The actor to check whether it is attached.
80 * @param[in] touches The number of touches in the current pan event.
81 * @param[in] outsideRangeEmitters Reference to container where emitters outside of the touches range should be added.
83 IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, GestureDetectorContainer& outsideRangeEmitters)
84 : actorToCheck(actor),
85 numberOfTouches(touches),
86 outsideTouchesRangeEmitters(outsideRangeEmitters)
91 * Returns true if not attached, false if it is still attached.
92 * Additionally, checks if the number of touches has changed and stops sending the pan to a particular
93 * detector if it exceeds the range of that detector.
94 * @param[in] detector The detector to check.
95 * @return true, if not attached, false otherwise.
97 bool operator()(GestureDetector* detector) const
99 bool remove(!detector->IsAttached(*actorToCheck));
103 PanGestureDetector* panDetector(static_cast<PanGestureDetector*>(detector));
105 // Ensure number of touch points is within the range of our emitter. If it isn't then remove
106 // this emitter and add it to the outsideTouchesRangeEmitters container
107 if((numberOfTouches < panDetector->GetMinimumTouchesRequired()) ||
108 (numberOfTouches > panDetector->GetMaximumTouchesRequired()))
111 outsideTouchesRangeEmitters.push_back(detector);
118 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
119 unsigned int numberOfTouches; ///< The number of touches in the pan event.
120 GestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
123 } // unnamed namespace
125 PanGestureProcessor::PanGestureProcessor(SceneGraph::UpdateManager& updateManager)
126 : GestureProcessor(GestureType::PAN),
127 mPanGestureDetectors(),
128 mCurrentPanEmitters(),
129 mCurrentRenderTask(),
130 mPossiblePanPosition(),
131 mMinTouchesRequired(1),
132 mMaxTouchesRequired(1),
133 mMaxMotionEventAge(std::numeric_limits<uint32_t>::max()),
134 mCurrentPanEvent(nullptr),
135 mSceneObject(SceneGraph::PanGesture::New()) // Create scene object to store pan information.
137 // Pass ownership to scene-graph; scene object lives for the lifecycle of UpdateManager
138 updateManager.SetPanGestureProcessor(mSceneObject);
141 PanGestureProcessor::~PanGestureProcessor()
143 mSceneObject = nullptr; // mSceneObject is owned and destroyed by update manager (there is only one of these for now)
146 void PanGestureProcessor::Process(Scene& scene, const PanGestureEvent& panEvent, Actor* actor)
148 #if defined(DEBUG_ENABLED)
149 DALI_LOG_TRACE_METHOD(gLogFilter);
151 DALI_LOG_INFO(gLogFilter, Debug::General, " Pan Event\n");
152 DALI_LOG_INFO(gLogFilter, Debug::General, " State: %s Touches: %d Time: %d TimeDelta: %d\n", GESTURE_STATES[static_cast<uint8_t>(panEvent.state)], panEvent.numberOfTouches, panEvent.time, panEvent.timeDelta);
153 DALI_LOG_INFO(gLogFilter, Debug::General, " Positions: Current: (%.0f, %.0f), Previous: (%.0f, %.0f)\n", panEvent.currentPosition.x, panEvent.currentPosition.y, panEvent.previousPosition.x, panEvent.previousPosition.y);
156 DALI_TRACE_SCOPE(gTraceFilter, "DALI_PROCESS_PAN_GESTURE");
158 switch(panEvent.state)
160 case GestureState::POSSIBLE:
162 mCurrentPanEmitters.clear();
165 HitTestAlgorithm::Results hitTestResults;
169 mPossiblePanPosition = panEvent.currentPosition;
171 else if(HitTest(scene, panEvent.currentPosition, hitTestResults))
173 SetActor(&GetImplementation(hitTestResults.actor));
174 mPossiblePanPosition = panEvent.currentPosition;
179 case GestureState::STARTED:
181 // Requires a core update
184 // The pan gesture should only be sent to the gesture detector which first received it so that
185 // it can be told when the gesture ends as well.
187 HitTestAlgorithm::Results hitTestResults;
190 hitTestResults.actor = Dali::Actor(actor);
191 hitTestResults.renderTask = panEvent.renderTask;
194 actor->ScreenToLocal(*hitTestResults.renderTask.Get(), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y);
195 hitTestResults.actorCoordinates = actorCoords;
199 HitTest(scene, panEvent.previousPosition, hitTestResults); // Hit Test previous position
202 if(hitTestResults.actor)
204 // If the current hit actor is different from the one we touched down on then set accordingly & update initial pan position
205 if(&GetImplementation(hitTestResults.actor) != GetCurrentGesturedActor())
207 mPossiblePanPosition = panEvent.previousPosition;
208 SetActor(&GetImplementation(hitTestResults.actor));
211 // Record the current render-task for Screen->Actor coordinate conversions
212 mCurrentRenderTask = hitTestResults.renderTask;
214 // Set mCurrentPanEvent to use inside overridden methods called in ProcessAndEmit()
215 mCurrentPanEvent = &panEvent;
218 ProcessAndEmitActor(hitTestResults);
222 ProcessAndEmit(hitTestResults);
224 mCurrentPanEvent = nullptr;
229 mCurrentPanEmitters.clear();
234 case GestureState::CONTINUING:
236 // Requires a core update
242 case GestureState::FINISHED:
243 case GestureState::CANCELLED:
245 // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
246 // Check if actor is still touchable.
248 Actor* currentGesturedActor = GetCurrentGesturedActor();
249 if(currentGesturedActor)
251 if(currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask)
253 GestureDetectorContainer outsideTouchesRangeEmitters;
255 // Removes emitters that no longer have the actor attached
256 // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
257 GestureDetectorContainer::iterator endIter = std::remove_if(mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters));
258 mCurrentPanEmitters.erase(endIter, mCurrentPanEmitters.end());
262 if(!outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty())
264 currentGesturedActor->ScreenToLocal(*mCurrentRenderTask.Get(), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y);
266 // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
267 EmitPanSignal(currentGesturedActor, outsideTouchesRangeEmitters, panEvent, actorCoords, GestureState::FINISHED, mCurrentRenderTask);
268 EmitPanSignal(currentGesturedActor, mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
271 if(mCurrentPanEmitters.empty())
273 // If we have no emitters attached then clear pan actor as well.
277 // Clear current gesture detectors if pan gesture has ended or been cancelled.
278 if((panEvent.state == GestureState::FINISHED) || (panEvent.state == GestureState::CANCELLED))
280 mCurrentPanEmitters.clear();
286 mCurrentPanEmitters.clear();
293 case GestureState::CLEAR:
295 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
301 void PanGestureProcessor::AddGestureDetector(PanGestureDetector* gestureDetector, Scene& scene, int32_t minDistance, int32_t minPanEvents)
303 bool firstRegistration(mPanGestureDetectors.empty());
305 mPanGestureDetectors.push_back(gestureDetector);
307 if(firstRegistration)
309 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
310 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
311 mMaxMotionEventAge = gestureDetector->GetMaximumMotionEventAge();
313 PanGestureRequest request;
314 request.minTouches = mMinTouchesRequired;
315 request.maxTouches = mMaxTouchesRequired;
316 request.maxMotionEventAge = mMaxMotionEventAge;
318 Size size = scene.GetSize();
319 mGestureRecognizer = new PanGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const PanGestureRequest&>(request), minDistance, minPanEvents);
327 void PanGestureProcessor::RemoveGestureDetector(PanGestureDetector* gestureDetector)
329 if(!mCurrentPanEmitters.empty())
331 // Check if the removed detector was one that is currently being panned and remove it from emitters.
332 GestureDetectorContainer::iterator endIter = std::remove(mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector);
333 mCurrentPanEmitters.erase(endIter, mCurrentPanEmitters.end());
335 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
336 if(mCurrentPanEmitters.empty())
342 // Find the detector...
343 PanGestureDetectorContainer::iterator endIter = std::remove(mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector);
344 DALI_ASSERT_DEBUG(endIter != mPanGestureDetectors.end());
347 mPanGestureDetectors.erase(endIter, mPanGestureDetectors.end());
349 if(mPanGestureDetectors.empty())
351 mGestureRecognizer = nullptr;
359 void PanGestureProcessor::GestureDetectorUpdated(PanGestureDetector* gestureDetector)
361 DALI_ASSERT_DEBUG(find(mPanGestureDetectors.begin(), mPanGestureDetectors.end(), gestureDetector) != mPanGestureDetectors.end());
366 bool PanGestureProcessor::SetPanGestureProperties(const Dali::PanGesture& pan)
368 // If we are currently processing a pan gesture then just ignore
369 if(mCurrentPanEmitters.empty() && mSceneObject)
371 const PanGesture& panImpl(GetImplementation(pan));
373 // We update the scene object directly rather than sending a message.
374 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
375 mSceneObject->AddGesture(panImpl);
377 if(GestureState::STARTED == panImpl.GetState() || GestureState::CONTINUING == panImpl.GetState())
386 void PanGestureProcessor::EnableProfiling()
388 mSceneObject->EnableProfiling();
391 void PanGestureProcessor::SetPredictionMode(int mode)
393 if((mode < 0) || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES))
395 mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
397 SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
398 mSceneObject->SetPredictionMode(modeEnum);
401 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
403 mSceneObject->SetPredictionAmount(amount);
406 void PanGestureProcessor::SetMaximumPredictionAmount(unsigned int amount)
408 mSceneObject->SetMaximumPredictionAmount(amount);
411 void PanGestureProcessor::SetMinimumPredictionAmount(unsigned int amount)
413 mSceneObject->SetMinimumPredictionAmount(amount);
416 void PanGestureProcessor::SetPredictionAmountAdjustment(unsigned int amount)
418 mSceneObject->SetPredictionAmountAdjustment(amount);
421 void PanGestureProcessor::SetSmoothingMode(int mode)
423 if((mode < 0) || (mode >= SceneGraph::PanGesture::NUM_SMOOTHING_MODES))
425 mode = SceneGraph::PanGesture::DEFAULT_SMOOTHING_MODE;
427 SceneGraph::PanGesture::SmoothingMode modeEnum = static_cast<SceneGraph::PanGesture::SmoothingMode>(mode);
428 mSceneObject->SetSmoothingMode(modeEnum);
431 void PanGestureProcessor::SetSmoothingAmount(float amount)
433 mSceneObject->SetSmoothingAmount(amount);
436 void PanGestureProcessor::SetUseActualTimes(bool value)
438 mSceneObject->SetUseActualTimes(value);
441 void PanGestureProcessor::SetInterpolationTimeRange(int value)
443 mSceneObject->SetInterpolationTimeRange(value);
446 void PanGestureProcessor::SetScalarOnlyPredictionEnabled(bool value)
448 mSceneObject->SetScalarOnlyPredictionEnabled(value);
451 void PanGestureProcessor::SetTwoPointPredictionEnabled(bool value)
453 mSceneObject->SetTwoPointPredictionEnabled(value);
456 void PanGestureProcessor::SetTwoPointInterpolatePastTime(int value)
458 mSceneObject->SetTwoPointInterpolatePastTime(value);
461 void PanGestureProcessor::SetTwoPointVelocityBias(float value)
463 mSceneObject->SetTwoPointVelocityBias(value);
466 void PanGestureProcessor::SetTwoPointAccelerationBias(float value)
468 mSceneObject->SetTwoPointAccelerationBias(value);
471 void PanGestureProcessor::SetMultitapSmoothingRange(int value)
473 mSceneObject->SetMultitapSmoothingRange(value);
476 const SceneGraph::PanGesture& PanGestureProcessor::GetSceneObject() const
478 return *mSceneObject;
481 void PanGestureProcessor::UpdateDetection()
483 DALI_ASSERT_DEBUG(!mPanGestureDetectors.empty());
485 uint32_t minimumRequired = std::numeric_limits<uint32_t>::max();
486 uint32_t maximumRequired = 0;
487 uint32_t maximumMotionEventAge = std::numeric_limits<uint32_t>::max();
489 for(PanGestureDetectorContainer::iterator iter = mPanGestureDetectors.begin(), endIter = mPanGestureDetectors.end(); iter != endIter; ++iter)
491 PanGestureDetector* detector(*iter);
495 uint32_t minimum = detector->GetMinimumTouchesRequired();
496 if(minimum < minimumRequired)
498 minimumRequired = minimum;
501 uint32_t maximum = detector->GetMaximumTouchesRequired();
502 if(maximum > maximumRequired)
504 maximumRequired = maximum;
507 uint32_t maximumAge = detector->GetMaximumMotionEventAge();
508 if(maximumAge < maximumMotionEventAge)
510 maximumMotionEventAge = maximumAge;
515 if((minimumRequired != mMinTouchesRequired) || (maximumRequired != mMaxTouchesRequired) || (maximumMotionEventAge != mMaxMotionEventAge))
517 mMinTouchesRequired = minimumRequired;
518 mMaxTouchesRequired = maximumRequired;
519 mMaxMotionEventAge = maximumMotionEventAge;
521 PanGestureRequest request;
522 request.minTouches = mMinTouchesRequired;
523 request.maxTouches = mMaxTouchesRequired;
524 request.maxMotionEventAge = mMaxMotionEventAge;
525 mGestureRecognizer->Update(request);
529 void PanGestureProcessor::EmitPanSignal(Actor* actor,
530 const GestureDetectorContainer& gestureDetectors,
531 const PanGestureEvent& panEvent,
532 Vector2 localCurrent,
534 RenderTaskPtr renderTask)
536 if(actor && !gestureDetectors.empty())
538 Internal::PanGesturePtr pan(new Internal::PanGesture(state));
540 pan->SetTime(panEvent.time);
542 pan->SetNumberOfTouches(panEvent.numberOfTouches);
543 pan->SetScreenPosition(panEvent.currentPosition);
544 pan->SetPosition(localCurrent);
545 pan->SetSourceType(panEvent.sourceType);
546 pan->SetSourceData(panEvent.sourceData);
548 RenderTask& renderTaskImpl(*renderTask.Get());
550 Vector2 localPrevious;
551 actor->ScreenToLocal(renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y);
553 pan->SetDisplacement(localCurrent - localPrevious);
554 Vector2 previousPos(panEvent.previousPosition);
555 if(state == GestureState::STARTED)
557 previousPos = mPossiblePanPosition;
560 pan->SetScreenDisplacement(panEvent.currentPosition - previousPos);
562 // Avoid dividing by 0
563 if(panEvent.timeDelta > 0)
566 velocity.x = pan->GetDisplacement().x / static_cast<float>(panEvent.timeDelta);
567 velocity.y = pan->GetDisplacement().y / static_cast<float>(panEvent.timeDelta);
568 pan->SetVelocity(velocity);
570 Vector2 screenVelocity;
571 screenVelocity.x = pan->GetScreenDisplacement().x / static_cast<float>(panEvent.timeDelta);
572 screenVelocity.y = pan->GetScreenDisplacement().y / static_cast<float>(panEvent.timeDelta);
573 pan->SetScreenVelocity(screenVelocity);
576 // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
577 // so we should use the last recorded velocity instead in this scenario.
578 if((state == GestureState::FINISHED) && (pan->GetScreenVelocity() == Vector2::ZERO) &&
579 (panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY))
581 pan->SetVelocity(mLastVelocity);
582 pan->SetScreenVelocity(mLastScreenVelocity);
586 // Store the current velocity for future iterations.
587 mLastVelocity = pan->GetVelocity();
588 mLastScreenVelocity = pan->GetScreenVelocity();
593 // We update the scene object directly rather than sending a message.
594 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
595 mSceneObject->AddGesture(*pan.Get());
598 DALI_TRACE_BEGIN_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_PAN_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
599 oss << "[" << gestureDetectors.size() << "]";
602 Dali::Actor actorHandle(actor);
604 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
605 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
607 static_cast<PanGestureDetector*>(*iter)->EmitPanGestureSignal(actorHandle, Dali::PanGesture(pan.Get()));
610 DALI_TRACE_END_WITH_MESSAGE_GENERATOR(gTraceFilter, "DALI_EMIT_PAN_GESTURE_SIGNAL", [&](std::ostringstream& oss) {
611 oss << "[" << gestureDetectors.size() << "]";
616 void PanGestureProcessor::OnGesturedActorStageDisconnection()
618 mCurrentPanEmitters.clear();
621 bool PanGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
623 DALI_ASSERT_DEBUG(mCurrentPanEvent);
626 PanGestureDetector* panDetector(static_cast<PanGestureDetector*>(detector));
628 if((mCurrentPanEvent->numberOfTouches >= panDetector->GetMinimumTouchesRequired()) &&
629 (mCurrentPanEvent->numberOfTouches <= panDetector->GetMaximumTouchesRequired()))
631 // Check if the detector requires directional panning.
632 if(panDetector->RequiresDirectionalPan() && mCurrentRenderTask)
634 // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
635 // the detector's criteria.
636 RenderTask& renderTaskImpl = *mCurrentRenderTask.Get();
638 Vector2 startPosition, currentPosition;
639 actor->ScreenToLocal(renderTaskImpl, startPosition.x, startPosition.y, mPossiblePanPosition.x, mPossiblePanPosition.y);
640 actor->ScreenToLocal(renderTaskImpl, currentPosition.x, currentPosition.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y);
641 Vector2 displacement(currentPosition - startPosition);
643 Radian angle(atanf(displacement.y / displacement.x));
645 /////////////////////////////
648 // Q3 (-,-) | Q4 (+,-) //
650 // ----------------- +x //
652 // Q2 (-,+) | Q1 (+,+) //
656 /////////////////////////////
658 // Quadrant 2: 180 degrees + angle
659 // Quadrant 3: angle - 180 degrees
661 /////////////////////////////
663 if(displacement.x < 0.0f)
665 if(displacement.y >= 0.0f)
668 angle.radian += Math::PI;
673 angle.radian -= Math::PI;
677 if(panDetector->CheckAngleAllowed(angle))
684 // Directional panning not required so we can use this actor and gesture detector.
691 void PanGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
693 DALI_ASSERT_DEBUG(mCurrentPanEvent);
695 mCurrentPanEmitters.clear();
698 actor->ScreenToLocal(*mCurrentRenderTask.Get(), actorCoordinates.x, actorCoordinates.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y);
700 EmitPanSignal(actor, gestureDetectors, *mCurrentPanEvent, actorCoordinates, mCurrentPanEvent->state, mCurrentRenderTask);
704 mCurrentPanEmitters = gestureDetectors;
709 } // namespace Internal