2 * Copyright (c) 2020 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/public-api/actors/actor.h>
26 #include <dali/public-api/common/dali-common.h>
27 #include <dali/public-api/events/tap-gesture.h>
28 #include <dali/public-api/math/vector2.h>
29 #include <dali/integration-api/debug.h>
30 #include <dali/internal/event/actors/actor-impl.h>
31 #include <dali/internal/event/render-tasks/render-task-impl.h>
32 #include <dali/internal/event/common/scene-impl.h>
33 #include <dali/internal/event/events/tap-gesture/tap-gesture-recognizer.h>
34 #include <dali/internal/event/events/tap-gesture/tap-gesture-impl.h>
35 #include <dali/internal/event/events/gesture-requests.h>
36 #include <dali/internal/event/events/tap-gesture/tap-gesture-event.h>
48 * Creates a TapGesture and asks the specified detector to emit its detected signal.
49 * @param[in] actor The actor on which a tap has occurred.
50 * @param[in] gestureDetectors A reference to gesture detectors that should emit the signal.
51 * @param[in] tapEvent The tapEvent received from the adaptor.
52 * @param[in] localPoint Relative to the actor attached to the detector.
56 const GestureDetectorContainer& gestureDetectors,
57 const TapGestureEvent& tapEvent,
60 Internal::TapGesturePtr tap( new Internal::TapGesture(tapEvent.state) );
61 tap->SetTime( tapEvent.time );
62 tap->SetNumberOfTaps(tapEvent.numberOfTaps);
63 tap->SetNumberOfTouches(tapEvent.numberOfTouches);
64 tap->SetScreenPoint(tapEvent.point);
65 tap->SetLocalPoint(localPoint);
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(),
80 mMinTapsRequired( 1 ),
81 mMaxTapsRequired( 1 ),
82 mMinTouchesRequired( 1 ),
83 mMaxTouchesRequired( 1 ),
84 mCurrentTapEvent( nullptr ),
85 mPossibleProcessed( false )
89 TapGestureProcessor::~TapGestureProcessor()
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));
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::UpdateDetection()
251 DALI_ASSERT_DEBUG(!mTapGestureDetectors.empty());
253 unsigned int minTaps = UINT_MAX;
254 unsigned int maxTaps = 0;
255 unsigned int minTouches = UINT_MAX;
256 unsigned int maxTouches = 0;
258 for ( TapGestureDetectorContainer::iterator iter = mTapGestureDetectors.begin(), endIter = mTapGestureDetectors.end(); iter != endIter; ++iter )
260 TapGestureDetector* detector(*iter);
264 const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
265 const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
266 const unsigned int touchesRequired = detector->GetTouchesRequired();
268 minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
269 maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
270 minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
271 maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
275 if ( (minTaps != mMinTapsRequired)||(maxTaps != mMaxTapsRequired) ||
276 (minTouches != mMinTouchesRequired)||(maxTouches != mMaxTouchesRequired) )
278 TapGestureRequest request;
279 request.minTaps = mMinTapsRequired = minTaps;
280 request.maxTaps = mMaxTapsRequired = maxTaps;
281 request.minTouches = mMinTouchesRequired = minTouches;
282 request.maxTouches = mMaxTouchesRequired = maxTouches;
284 mGestureRecognizer->Update(request);
288 bool TapGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
290 DALI_ASSERT_DEBUG( mCurrentTapEvent );
292 TapGestureDetector* tapDetector ( static_cast< TapGestureDetector* >( detector ) );
294 return ( ( tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps ) && ( tapDetector->GetMaximumTapsRequired() >= mCurrentTapEvent->numberOfTaps ) ) &&
295 ( tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches );
298 void TapGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
300 DALI_ASSERT_DEBUG( mCurrentTapEvent );
302 EmitTapSignal( actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates );
305 } // namespace Internal