2 * Copyright (c) 2022 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/internal/event/actors/actor-impl.h>
27 #include <dali/internal/event/common/scene-impl.h>
28 #include <dali/internal/event/events/gesture-requests.h>
29 #include <dali/internal/event/events/tap-gesture/tap-gesture-event.h>
30 #include <dali/internal/event/events/tap-gesture/tap-gesture-impl.h>
31 #include <dali/internal/event/events/tap-gesture/tap-gesture-recognizer.h>
32 #include <dali/internal/event/render-tasks/render-task-impl.h>
33 #include <dali/public-api/actors/actor.h>
34 #include <dali/public-api/common/dali-common.h>
35 #include <dali/public-api/events/tap-gesture.h>
36 #include <dali/public-api/math/vector2.h>
44 constexpr uint32_t DEFAULT_MAXIMUM_ALLOWED_TIME = 500u;
47 * Creates a TapGesture and asks the specified detector to emit its detected signal.
48 * @param[in] actor The actor on which a tap has occurred.
49 * @param[in] gestureDetectors A reference to gesture detectors that should emit the signal.
50 * @param[in] tapEvent The tapEvent received from the adaptor.
51 * @param[in] localPoint Relative to the actor attached to the detector.
55 const GestureDetectorContainer& gestureDetectors,
56 const TapGestureEvent& tapEvent,
59 Internal::TapGesturePtr tap(new Internal::TapGesture(tapEvent.state));
60 tap->SetTime(tapEvent.time);
61 tap->SetNumberOfTaps(tapEvent.numberOfTaps);
62 tap->SetNumberOfTouches(tapEvent.numberOfTouches);
63 tap->SetScreenPoint(tapEvent.point);
64 tap->SetLocalPoint(localPoint);
65 tap->SetSourceType(tapEvent.sourceType);
66 tap->SetSourceData(tapEvent.sourceData);
68 Dali::Actor actorHandle(actor);
69 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
70 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
72 static_cast<TapGestureDetector*>(*iter)->EmitTapGestureSignal(actorHandle, Dali::TapGesture(tap.Get()));
76 } // unnamed namespace
78 TapGestureProcessor::TapGestureProcessor()
79 : GestureProcessor(GestureType::TAP),
80 mTapGestureDetectors(),
83 mMinTouchesRequired(1),
84 mMaxTouchesRequired(1),
85 mCurrentTapEvent(nullptr),
86 mPossibleProcessed(false),
87 mMaximumAllowedTime(DEFAULT_MAXIMUM_ALLOWED_TIME)
91 TapGestureProcessor::~TapGestureProcessor() = default;
93 void TapGestureProcessor::Process(Scene& scene, const TapGestureEvent& tapEvent)
95 switch(tapEvent.state)
97 case GestureState::POSSIBLE:
99 // 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 )
100 HitTestAlgorithm::Results hitTestResults;
101 if(HitTest(scene, tapEvent.point, hitTestResults))
103 SetActor(&GetImplementation(hitTestResults.actor));
104 mCurrentTapActor.SetActor(GetCurrentGesturedActor());
106 // Indicate that we've processed a touch down. Bool should be sufficient as a change in actor will result in a cancellation
107 mPossibleProcessed = true;
116 case GestureState::STARTED:
118 // Ensure that we're processing a hit on the current actor and that we've already processed a touch down
119 HitTestAlgorithm::Results hitTestResults;
120 if(GetCurrentGesturedActor() && HitTest(scene, tapEvent.point, hitTestResults) && mPossibleProcessed)
122 // Check that this actor is still the one that was used for the last touch down ?
123 if(mCurrentTapActor.GetActor() == &GetImplementation(hitTestResults.actor))
125 mCurrentTapEvent = &tapEvent;
126 ProcessAndEmit(hitTestResults);
128 mCurrentTapEvent = nullptr;
129 mPossibleProcessed = false;
134 case GestureState::CANCELLED:
136 mPossibleProcessed = false;
141 case GestureState::CONTINUING:
143 DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
146 case GestureState::FINISHED:
148 DALI_ABORT("Incorrect state received from Integration layer: FINISHED\n");
151 case GestureState::CLEAR:
153 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
159 void TapGestureProcessor::AddGestureDetector(TapGestureDetector* gestureDetector, Scene& scene)
161 bool firstRegistration(mTapGestureDetectors.empty());
163 mTapGestureDetectors.push_back(gestureDetector);
165 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
166 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
167 const unsigned int touchesRequired = gestureDetector->GetTouchesRequired();
169 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
171 if(firstRegistration)
173 // If this is the first tap gesture detector that has been added, then our minimum and maximum
174 // requirements are the same as each other.
176 mMinTapsRequired = minTapsRequired;
177 mMaxTapsRequired = maxTapsRequired;
178 mMinTouchesRequired = mMaxTouchesRequired = touchesRequired;
180 TapGestureRequest request;
181 request.minTaps = mMinTapsRequired;
182 request.maxTaps = mMaxTapsRequired;
183 request.minTouches = mMinTouchesRequired;
184 request.maxTouches = mMaxTouchesRequired;
186 Size size = scene.GetSize();
187 mGestureRecognizer = new TapGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const TapGestureRequest&>(request), mMaximumAllowedTime);
191 // If we have already registered for tap gesture detection before then we need to check our
192 // minimum and maximums and see if our gesture detection requirements have changed, if they
193 // have, then we should ask the adaptor to update its detection policy.
195 // This is quicker than calling UpdateDetection as there is no need to iterate through the container
197 unsigned int minTaps = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
198 unsigned int maxTaps = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
199 unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
200 unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
202 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
203 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
205 TapGestureRequest request;
206 request.minTaps = mMinTapsRequired = minTaps;
207 request.maxTaps = mMaxTapsRequired = maxTaps;
208 request.minTouches = mMinTouchesRequired = minTouches;
209 request.maxTouches = mMaxTouchesRequired = maxTouches;
211 mGestureRecognizer->Update(request);
216 void TapGestureProcessor::RemoveGestureDetector(TapGestureDetector* gestureDetector)
219 TapGestureDetectorContainer::iterator endIter = std::remove(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector);
220 DALI_ASSERT_DEBUG(endIter != mTapGestureDetectors.end());
223 mTapGestureDetectors.erase(endIter, mTapGestureDetectors.end());
225 if(mTapGestureDetectors.empty())
227 mGestureRecognizer = nullptr;
237 void TapGestureProcessor::GestureDetectorUpdated(TapGestureDetector* gestureDetector)
239 DALI_ASSERT_DEBUG(find(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector) != mTapGestureDetectors.end());
241 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
242 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
244 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
249 void TapGestureProcessor::SetMaximumAllowedTime(uint32_t time)
253 DALI_LOG_WARNING("MaximumAllowedTime must be greater than zero.");
256 if(mMaximumAllowedTime != time)
258 mMaximumAllowedTime = time;
260 if(mGestureRecognizer)
262 TapGestureRecognizer* tapRecognizer = dynamic_cast<TapGestureRecognizer*>(mGestureRecognizer.Get());
265 tapRecognizer->SetMaximumAllowedTime(time);
271 void TapGestureProcessor::UpdateDetection()
273 DALI_ASSERT_DEBUG(!mTapGestureDetectors.empty());
275 unsigned int minTaps = UINT_MAX;
276 unsigned int maxTaps = 0;
277 unsigned int minTouches = UINT_MAX;
278 unsigned int maxTouches = 0;
280 for(TapGestureDetectorContainer::iterator iter = mTapGestureDetectors.begin(), endIter = mTapGestureDetectors.end(); iter != endIter; ++iter)
282 TapGestureDetector* detector(*iter);
286 const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
287 const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
288 const unsigned int touchesRequired = detector->GetTouchesRequired();
290 minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
291 maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
292 minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
293 maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
297 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
298 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
300 TapGestureRequest request;
301 request.minTaps = mMinTapsRequired = minTaps;
302 request.maxTaps = mMaxTapsRequired = maxTaps;
303 request.minTouches = mMinTouchesRequired = minTouches;
304 request.maxTouches = mMaxTouchesRequired = maxTouches;
306 mGestureRecognizer->Update(request);
310 bool TapGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
312 DALI_ASSERT_DEBUG(mCurrentTapEvent);
314 TapGestureDetector* tapDetector(static_cast<TapGestureDetector*>(detector));
316 return (tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps) && (tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches);
319 void TapGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
321 DALI_ASSERT_DEBUG(mCurrentTapEvent);
323 EmitTapSignal(actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates);
326 } // namespace Internal