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/tap-gesture/tap-gesture-processor.h>
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>
45 DALI_INIT_TRACE_FILTER(gTraceFilter, DALI_TRACE_PERFORMANCE_MARKER, false);
46 constexpr uint32_t DEFAULT_MAXIMUM_ALLOWED_TIME = 500u;
47 constexpr uint32_t DEFAULT_RECOGNIZER_TIME = 500u;
50 * Creates a TapGesture and asks the specified detector to emit its detected signal.
51 * @param[in] actor The actor on which a tap has occurred.
52 * @param[in] gestureDetectors A reference to gesture detectors that should emit the signal.
53 * @param[in] tapEvent The tapEvent received from the adaptor.
54 * @param[in] localPoint Relative to the actor attached to the detector.
58 const GestureDetectorContainer& gestureDetectors,
59 const TapGestureEvent& tapEvent,
62 Internal::TapGesturePtr tap(new Internal::TapGesture(tapEvent.state));
63 tap->SetTime(tapEvent.time);
64 tap->SetNumberOfTaps(tapEvent.numberOfTaps);
65 tap->SetNumberOfTouches(tapEvent.numberOfTouches);
66 tap->SetScreenPoint(tapEvent.point);
67 tap->SetLocalPoint(localPoint);
68 tap->SetSourceType(tapEvent.sourceType);
69 tap->SetSourceData(tapEvent.sourceData);
71 DALI_TRACE_SCOPE(gTraceFilter, "DALI_EMIT_TAP_GESTURE_SIGNAL");
73 Dali::Actor actorHandle(actor);
74 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
75 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
77 static_cast<TapGestureDetector*>(*iter)->EmitTapGestureSignal(actorHandle, Dali::TapGesture(tap.Get()));
81 } // unnamed namespace
83 TapGestureProcessor::TapGestureProcessor()
84 : GestureProcessor(GestureType::TAP),
85 mTapGestureDetectors(),
88 mMinTouchesRequired(1),
89 mMaxTouchesRequired(1),
90 mCurrentTapEvent(nullptr),
91 mPossibleProcessed(false),
92 mMaximumAllowedTime(DEFAULT_MAXIMUM_ALLOWED_TIME),
93 mRecognizerTime(DEFAULT_RECOGNIZER_TIME)
97 TapGestureProcessor::~TapGestureProcessor() = default;
99 void TapGestureProcessor::Process(Scene& scene, const TapGestureEvent& tapEvent)
101 DALI_TRACE_SCOPE(gTraceFilter, "DALI_PROCESS_TAP_GESTURE");
102 switch(tapEvent.state)
104 case GestureState::POSSIBLE:
106 // 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 )
107 HitTestAlgorithm::Results hitTestResults;
108 if(HitTest(scene, tapEvent.point, hitTestResults))
110 SetActor(&GetImplementation(hitTestResults.actor));
111 mCurrentTapActor.SetActor(GetCurrentGesturedActor());
113 // Indicate that we've processed a touch down. Bool should be sufficient as a change in actor will result in a cancellation
114 mPossibleProcessed = true;
123 case GestureState::STARTED:
125 // Ensure that we're processing a hit on the current actor and that we've already processed a touch down
126 HitTestAlgorithm::Results hitTestResults;
127 if(GetCurrentGesturedActor() && HitTest(scene, tapEvent.point, hitTestResults) && mPossibleProcessed)
129 // Check that this actor is still the one that was used for the last touch down ?
130 if(mCurrentTapActor.GetActor() == &GetImplementation(hitTestResults.actor))
132 mCurrentTapEvent = &tapEvent;
133 ProcessAndEmit(hitTestResults);
135 mCurrentTapEvent = nullptr;
136 mPossibleProcessed = false;
141 case GestureState::CANCELLED:
143 mPossibleProcessed = false;
148 case GestureState::CONTINUING:
150 DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
153 case GestureState::FINISHED:
155 DALI_ABORT("Incorrect state received from Integration layer: FINISHED\n");
158 case GestureState::CLEAR:
160 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
166 void TapGestureProcessor::AddGestureDetector(TapGestureDetector* gestureDetector, Scene& scene)
168 bool firstRegistration(mTapGestureDetectors.empty());
170 mTapGestureDetectors.push_back(gestureDetector);
172 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
173 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
174 const unsigned int touchesRequired = gestureDetector->GetTouchesRequired();
176 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
178 if(firstRegistration)
180 // If this is the first tap gesture detector that has been added, then our minimum and maximum
181 // requirements are the same as each other.
183 mMinTapsRequired = minTapsRequired;
184 mMaxTapsRequired = maxTapsRequired;
185 mMinTouchesRequired = mMaxTouchesRequired = touchesRequired;
187 TapGestureRequest request;
188 request.minTaps = mMinTapsRequired;
189 request.maxTaps = mMaxTapsRequired;
190 request.minTouches = mMinTouchesRequired;
191 request.maxTouches = mMaxTouchesRequired;
193 Size size = scene.GetSize();
194 mGestureRecognizer = new TapGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const TapGestureRequest&>(request), mMaximumAllowedTime, mRecognizerTime);
198 // If we have already registered for tap gesture detection before then we need to check our
199 // minimum and maximums and see if our gesture detection requirements have changed, if they
200 // have, then we should ask the adaptor to update its detection policy.
202 // This is quicker than calling UpdateDetection as there is no need to iterate through the container
204 unsigned int minTaps = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
205 unsigned int maxTaps = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
206 unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
207 unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
209 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
210 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
212 TapGestureRequest request;
213 request.minTaps = mMinTapsRequired = minTaps;
214 request.maxTaps = mMaxTapsRequired = maxTaps;
215 request.minTouches = mMinTouchesRequired = minTouches;
216 request.maxTouches = mMaxTouchesRequired = maxTouches;
218 mGestureRecognizer->Update(request);
223 void TapGestureProcessor::RemoveGestureDetector(TapGestureDetector* gestureDetector)
226 TapGestureDetectorContainer::iterator endIter = std::remove(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector);
227 DALI_ASSERT_DEBUG(endIter != mTapGestureDetectors.end());
230 mTapGestureDetectors.erase(endIter, mTapGestureDetectors.end());
232 if(mTapGestureDetectors.empty())
234 mGestureRecognizer = nullptr;
244 void TapGestureProcessor::GestureDetectorUpdated(TapGestureDetector* gestureDetector)
246 DALI_ASSERT_DEBUG(find(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector) != mTapGestureDetectors.end());
248 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
249 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
251 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
256 void TapGestureProcessor::SetMaximumAllowedTime(uint32_t time)
260 DALI_LOG_WARNING("MaximumAllowedTime must be greater than zero.");
263 if(mMaximumAllowedTime != time)
265 mMaximumAllowedTime = time;
267 if(mGestureRecognizer)
269 TapGestureRecognizer* tapRecognizer = dynamic_cast<TapGestureRecognizer*>(mGestureRecognizer.Get());
272 tapRecognizer->SetMaximumAllowedTime(time);
278 void TapGestureProcessor::SetRecognizerTime(uint32_t time)
282 DALI_LOG_WARNING("RecognizerTime must be greater than zero.");
285 if(mRecognizerTime != time)
287 mRecognizerTime = time;
289 if(mGestureRecognizer)
291 TapGestureRecognizer* tapRecognizer = dynamic_cast<TapGestureRecognizer*>(mGestureRecognizer.Get());
294 tapRecognizer->SetRecognizerTime(time);
300 void TapGestureProcessor::UpdateDetection()
302 DALI_ASSERT_DEBUG(!mTapGestureDetectors.empty());
304 unsigned int minTaps = UINT_MAX;
305 unsigned int maxTaps = 0;
306 unsigned int minTouches = UINT_MAX;
307 unsigned int maxTouches = 0;
309 for(TapGestureDetectorContainer::iterator iter = mTapGestureDetectors.begin(), endIter = mTapGestureDetectors.end(); iter != endIter; ++iter)
311 TapGestureDetector* detector(*iter);
315 const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
316 const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
317 const unsigned int touchesRequired = detector->GetTouchesRequired();
319 minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
320 maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
321 minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
322 maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
326 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
327 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
329 TapGestureRequest request;
330 request.minTaps = mMinTapsRequired = minTaps;
331 request.maxTaps = mMaxTapsRequired = maxTaps;
332 request.minTouches = mMinTouchesRequired = minTouches;
333 request.maxTouches = mMaxTouchesRequired = maxTouches;
335 mGestureRecognizer->Update(request);
339 bool TapGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
341 DALI_ASSERT_DEBUG(mCurrentTapEvent);
343 TapGestureDetector* tapDetector(static_cast<TapGestureDetector*>(detector));
345 return (tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps) && (tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches);
348 void TapGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
350 DALI_ASSERT_DEBUG(mCurrentTapEvent);
352 EmitTapSignal(actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates);
355 } // namespace Internal