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->SetGestureSourceType(tapEvent.gestureSourceType);
67 Dali::Actor actorHandle(actor);
68 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
69 for(GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter)
71 static_cast<TapGestureDetector*>(*iter)->EmitTapGestureSignal(actorHandle, Dali::TapGesture(tap.Get()));
75 } // unnamed namespace
77 TapGestureProcessor::TapGestureProcessor()
78 : GestureProcessor(GestureType::TAP),
79 mTapGestureDetectors(),
82 mMinTouchesRequired(1),
83 mMaxTouchesRequired(1),
84 mCurrentTapEvent(nullptr),
85 mPossibleProcessed(false),
86 mMaximumAllowedTime(DEFAULT_MAXIMUM_ALLOWED_TIME)
90 TapGestureProcessor::~TapGestureProcessor() = default;
92 void TapGestureProcessor::Process(Scene& scene, const TapGestureEvent& tapEvent)
94 switch(tapEvent.state)
96 case GestureState::POSSIBLE:
98 // 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 )
99 HitTestAlgorithm::Results hitTestResults;
100 if(HitTest(scene, tapEvent.point, hitTestResults))
102 SetActor(&GetImplementation(hitTestResults.actor));
103 mCurrentTapActor.SetActor(GetCurrentGesturedActor());
105 // Indicate that we've processed a touch down. Bool should be sufficient as a change in actor will result in a cancellation
106 mPossibleProcessed = true;
115 case GestureState::STARTED:
117 // Ensure that we're processing a hit on the current actor and that we've already processed a touch down
118 HitTestAlgorithm::Results hitTestResults;
119 if(GetCurrentGesturedActor() && HitTest(scene, tapEvent.point, hitTestResults) && mPossibleProcessed)
121 // Check that this actor is still the one that was used for the last touch down ?
122 if(mCurrentTapActor.GetActor() == &GetImplementation(hitTestResults.actor))
124 mCurrentTapEvent = &tapEvent;
125 ProcessAndEmit(hitTestResults);
127 mCurrentTapEvent = nullptr;
128 mPossibleProcessed = false;
133 case GestureState::CANCELLED:
135 mPossibleProcessed = false;
140 case GestureState::CONTINUING:
142 DALI_ABORT("Incorrect state received from Integration layer: CONTINUING\n");
145 case GestureState::FINISHED:
147 DALI_ABORT("Incorrect state received from Integration layer: FINISHED\n");
150 case GestureState::CLEAR:
152 DALI_ABORT("Incorrect state received from Integration layer: CLEAR\n");
158 void TapGestureProcessor::AddGestureDetector(TapGestureDetector* gestureDetector, Scene& scene)
160 bool firstRegistration(mTapGestureDetectors.empty());
162 mTapGestureDetectors.push_back(gestureDetector);
164 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
165 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
166 const unsigned int touchesRequired = gestureDetector->GetTouchesRequired();
168 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
170 if(firstRegistration)
172 // If this is the first tap gesture detector that has been added, then our minimum and maximum
173 // requirements are the same as each other.
175 mMinTapsRequired = minTapsRequired;
176 mMaxTapsRequired = maxTapsRequired;
177 mMinTouchesRequired = mMaxTouchesRequired = touchesRequired;
179 TapGestureRequest request;
180 request.minTaps = mMinTapsRequired;
181 request.maxTaps = mMaxTapsRequired;
182 request.minTouches = mMinTouchesRequired;
183 request.maxTouches = mMaxTouchesRequired;
185 Size size = scene.GetSize();
186 mGestureRecognizer = new TapGestureRecognizer(*this, Vector2(size.width, size.height), static_cast<const TapGestureRequest&>(request), mMaximumAllowedTime);
190 // If we have already registered for tap gesture detection before then we need to check our
191 // minimum and maximums and see if our gesture detection requirements have changed, if they
192 // have, then we should ask the adaptor to update its detection policy.
194 // This is quicker than calling UpdateDetection as there is no need to iterate through the container
196 unsigned int minTaps = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
197 unsigned int maxTaps = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
198 unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
199 unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
201 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
202 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
204 TapGestureRequest request;
205 request.minTaps = mMinTapsRequired = minTaps;
206 request.maxTaps = mMaxTapsRequired = maxTaps;
207 request.minTouches = mMinTouchesRequired = minTouches;
208 request.maxTouches = mMaxTouchesRequired = maxTouches;
210 mGestureRecognizer->Update(request);
215 void TapGestureProcessor::RemoveGestureDetector(TapGestureDetector* gestureDetector)
218 TapGestureDetectorContainer::iterator endIter = std::remove(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector);
219 DALI_ASSERT_DEBUG(endIter != mTapGestureDetectors.end());
222 mTapGestureDetectors.erase(endIter, mTapGestureDetectors.end());
224 if(mTapGestureDetectors.empty())
226 mGestureRecognizer = nullptr;
236 void TapGestureProcessor::GestureDetectorUpdated(TapGestureDetector* gestureDetector)
238 DALI_ASSERT_DEBUG(find(mTapGestureDetectors.begin(), mTapGestureDetectors.end(), gestureDetector) != mTapGestureDetectors.end());
240 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
241 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
243 DALI_ASSERT_ALWAYS(minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested");
248 void TapGestureProcessor::SetMaximumAllowedTime(uint32_t time)
252 DALI_LOG_WARNING("MaximumAllowedTime must be greater than zero.");
255 if(mMaximumAllowedTime != time)
257 mMaximumAllowedTime = time;
259 if(mGestureRecognizer)
261 TapGestureRecognizer* tapRecognizer = dynamic_cast<TapGestureRecognizer*>(mGestureRecognizer.Get());
264 tapRecognizer->SetMaximumAllowedTime(time);
270 void TapGestureProcessor::UpdateDetection()
272 DALI_ASSERT_DEBUG(!mTapGestureDetectors.empty());
274 unsigned int minTaps = UINT_MAX;
275 unsigned int maxTaps = 0;
276 unsigned int minTouches = UINT_MAX;
277 unsigned int maxTouches = 0;
279 for(TapGestureDetectorContainer::iterator iter = mTapGestureDetectors.begin(), endIter = mTapGestureDetectors.end(); iter != endIter; ++iter)
281 TapGestureDetector* detector(*iter);
285 const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
286 const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
287 const unsigned int touchesRequired = detector->GetTouchesRequired();
289 minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
290 maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
291 minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
292 maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
296 if((minTaps != mMinTapsRequired) || (maxTaps != mMaxTapsRequired) ||
297 (minTouches != mMinTouchesRequired) || (maxTouches != mMaxTouchesRequired))
299 TapGestureRequest request;
300 request.minTaps = mMinTapsRequired = minTaps;
301 request.maxTaps = mMaxTapsRequired = maxTaps;
302 request.minTouches = mMinTouchesRequired = minTouches;
303 request.maxTouches = mMaxTouchesRequired = maxTouches;
305 mGestureRecognizer->Update(request);
309 bool TapGestureProcessor::CheckGestureDetector(GestureDetector* detector, Actor* actor)
311 DALI_ASSERT_DEBUG(mCurrentTapEvent);
313 TapGestureDetector* tapDetector(static_cast<TapGestureDetector*>(detector));
315 return (tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps) && (tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches);
318 void TapGestureProcessor::EmitGestureSignal(Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates)
320 DALI_ASSERT_DEBUG(mCurrentTapEvent);
322 EmitTapSignal(actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates);
325 } // namespace Internal