2 * Copyright (c) 2014 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-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/events/tap-gesture-event.h>
30 #include <dali/integration-api/gesture-manager.h>
31 #include <dali/integration-api/debug.h>
32 #include <dali/internal/event/actors/actor-impl.h>
33 #include <dali/internal/event/render-tasks/render-task-impl.h>
34 #include <dali/internal/event/common/stage-impl.h>
46 * Creates a TapGesture and asks the specified detector to emit its detected signal.
47 * @param[in] actor The actor on which a tap has occurred.
48 * @param[in] gestureDetectors A reference to gesture detectors that should emit the signal.
49 * @param[in] tapEvent The tapEvent received from the adaptor.
50 * @param[in] localPoint Relative to the actor attached to the detector.
54 const GestureDetectorContainer& gestureDetectors,
55 const Integration::TapGestureEvent& tapEvent,
59 tap.time = tapEvent.time;
60 tap.numberOfTaps = tapEvent.numberOfTaps;
61 tap.numberOfTouches = tapEvent.numberOfTouches;
62 tap.screenPoint = tapEvent.point;
63 tap.localPoint = localPoint;
65 Dali::Actor actorHandle( actor );
66 const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
67 for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
69 static_cast< TapGestureDetector* >( *iter )->EmitTapGestureSignal( actorHandle, tap );
73 } // unnamed namespace
75 TapGestureProcessor::TapGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager)
76 : GestureProcessor( Gesture::Tap ),
78 mGestureManager( gestureManager ),
80 mMinTapsRequired( 1 ),
81 mMaxTapsRequired( 1 ),
82 mMinTouchesRequired( 1 ),
83 mMaxTouchesRequired( 1 ),
84 mCurrentTapEvent( NULL ),
85 mPossibleProcessed( false )
89 TapGestureProcessor::~TapGestureProcessor()
93 void TapGestureProcessor::Process( const Integration::TapGestureEvent& tapEvent )
95 switch ( tapEvent.state )
97 case Gesture::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( mStage, 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 Gesture::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( mStage, 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 = NULL;
129 mPossibleProcessed = false;
134 case Gesture::Cancelled:
136 mPossibleProcessed = false;
141 case Gesture::Continuing:
143 DALI_ABORT( "Incorrect state received from Integration layer: Continuing\n" );
146 case Gesture::Finished:
148 DALI_ABORT( "Incorrect state received from Integration layer: Finished\n" );
153 DALI_ABORT( "Incorrect state received from Integration layer: Clear\n" );
159 void TapGestureProcessor::AddGestureDetector( TapGestureDetector* gestureDetector )
161 bool firstRegistration(mGestureDetectors.empty());
163 mGestureDetectors.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 Integration::TapGestureRequest request;
181 request.minTaps = mMinTapsRequired;
182 request.maxTaps = mMaxTapsRequired;
183 request.minTouches = mMinTouchesRequired;
184 request.maxTouches = mMaxTouchesRequired;
185 mGestureManager.Register(request);
189 // If we have already registered for tap gesture detection before then we need to check our
190 // minimum and maximums and see if our gesture detection requirements have changed, if they
191 // have, then we should ask the adaptor to update its detection policy.
193 // This is quicker than calling UpdateDetection as there is no need to iterate through the container
195 unsigned int minTaps = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
196 unsigned int maxTaps = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
197 unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
198 unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
200 if ( (minTaps != mMinTapsRequired)||(maxTaps != mMaxTapsRequired) ||
201 (minTouches != mMinTouchesRequired)||(maxTouches != mMaxTouchesRequired) )
203 Integration::TapGestureRequest request;
204 request.minTaps = mMinTapsRequired = minTaps;
205 request.maxTaps = mMaxTapsRequired = maxTaps;
206 request.minTouches = mMinTouchesRequired = minTouches;
207 request.maxTouches = mMaxTouchesRequired = maxTouches;
208 mGestureManager.Update(request);
213 void TapGestureProcessor::RemoveGestureDetector( TapGestureDetector* gestureDetector )
216 TapGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
217 DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
220 mGestureDetectors.erase( endIter, mGestureDetectors.end() );
222 if ( mGestureDetectors.empty() )
224 Integration::GestureRequest request(Gesture::Tap);
225 mGestureManager.Unregister(request);
235 void TapGestureProcessor::GestureDetectorUpdated( TapGestureDetector* gestureDetector )
237 DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
239 const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
240 const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
242 DALI_ASSERT_ALWAYS( minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested" );
247 void TapGestureProcessor::UpdateDetection()
249 DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
251 unsigned int minTaps = UINT_MAX;
252 unsigned int maxTaps = 0;
253 unsigned int minTouches = UINT_MAX;
254 unsigned int maxTouches = 0;
256 for ( TapGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
258 TapGestureDetector* detector(*iter);
262 const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
263 const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
264 const unsigned int touchesRequired = detector->GetTouchesRequired();
266 minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
267 maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
268 minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
269 maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
273 if ( (minTaps != mMinTapsRequired)||(maxTaps != mMaxTapsRequired) ||
274 (minTouches != mMinTouchesRequired)||(maxTouches != mMaxTouchesRequired) )
276 Integration::TapGestureRequest request;
277 request.minTaps = mMinTapsRequired = minTaps;
278 request.maxTaps = mMaxTapsRequired = maxTaps;
279 request.minTouches = mMinTouchesRequired = minTouches;
280 request.maxTouches = mMaxTouchesRequired = maxTouches;
281 mGestureManager.Update(request);
285 bool TapGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
287 DALI_ASSERT_DEBUG( mCurrentTapEvent );
289 TapGestureDetector* tapDetector ( static_cast< TapGestureDetector* >( detector ) );
291 return ( ( tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps ) && ( tapDetector->GetMaximumTapsRequired() >= mCurrentTapEvent->numberOfTaps ) ) &&
292 ( tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches );
295 void TapGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
297 DALI_ASSERT_DEBUG( mCurrentTapEvent );
299 EmitTapSignal( actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates );
302 } // namespace Internal