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/pan-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/pan-gesture.h>
28 #include <dali/public-api/math/vector2.h>
29 #include <dali/integration-api/events/pan-gesture-event.h>
30 #include <dali/integration-api/gesture-manager.h>
31 #include <dali/integration-api/debug.h>
32 #include <dali/internal/event/common/stage-impl.h>
33 #include <dali/internal/event/render-tasks/render-task-impl.h>
34 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
42 namespace // unnamed namespace
45 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
48 * Functor which checks whether the specified actor is attached to the gesture detector.
49 * If the actor is attached, it also checks whether the number of touches of the current pan event
50 * are within the range of that expected by the detector.
51 * It returns true if it is no longer attached or the touches are out of range.
52 * This can be used in remove_if functions.
54 struct IsNotAttachedAndOutsideTouchesRangeFunctor
58 * @param[in] actor The actor to check whether it is attached.
59 * @param[in] touches The number of touches in the current pan event.
60 * @param[in] outsideRangeEmitters Reference to container where emitters outside of the touches range should be added.
62 IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, PanGestureDetectorContainer& outsideRangeEmitters)
63 : actorToCheck(actor),
64 numberOfTouches(touches),
65 outsideTouchesRangeEmitters(outsideRangeEmitters)
70 * Returns true if not attached, false if it is still attached.
71 * Additionally, checks if the number of touches has changed and stops sending the pan to a particular
72 * detector if it exceeds the range of that detector.
73 * @param[in] detector The detector to check.
74 * @return true, if not attached, false otherwise.
76 bool operator()(PanGestureDetector* detector) const
78 bool remove(!detector->IsAttached(*actorToCheck));
82 // Ensure number of touch points is within the range of our emitter. If it isn't then remove
83 // this emitter and add it to the outsideTouchesRangeEmitters container
84 if ( (numberOfTouches < detector->GetMinimumTouchesRequired()) ||
85 (numberOfTouches > detector->GetMaximumTouchesRequired()) )
88 outsideTouchesRangeEmitters.push_back(detector);
95 Actor* actorToCheck; ///< The actor to check whether it is attached or not.
96 unsigned int numberOfTouches; ///< The number of touches in the pan event.
97 PanGestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
100 } // unnamed namespace
102 struct PanGestureProcessor::PanEventFunctor : public GestureProcessor::Functor
106 * @param[in] panEvent The current gesture event.
107 * @param[in] processor Reference to the processor.
109 PanEventFunctor( const Integration::PanGestureEvent& panEvent, PanGestureProcessor& processor )
110 : panEvent( panEvent ),
111 processor( processor )
116 * Check if the detector meets the current gesture event parameters.
118 virtual bool operator() ( GestureDetector* detector, Actor* actor )
120 bool retVal( false );
122 PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
124 if ( ( panEvent.numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
125 ( panEvent.numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
127 // Check if the detector requires directional panning.
128 if ( panDetector->RequiresDirectionalPan() && processor.mCurrentRenderTask )
130 // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
131 // the detector's criteria.
132 RenderTask& renderTaskImpl( GetImplementation( processor.mCurrentRenderTask ) );
134 Vector2 startPosition, currentPosition;
135 actor->ScreenToLocal( renderTaskImpl, startPosition.x, startPosition.y, processor.mPossiblePanPosition.x, processor.mPossiblePanPosition.y );
136 actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
137 Vector2 displacement( currentPosition - startPosition );
139 Radian angle( atan( displacement.y / displacement.x ) );
141 /////////////////////////////
144 // Q3 (-,-) | Q4 (+,-) //
146 // ----------------- +x //
148 // Q2 (-,+) | Q1 (+,+) //
152 /////////////////////////////
154 // Quadrant 2: 180 degrees + angle
155 // Quadrant 3: angle - 180 degrees
157 /////////////////////////////
159 if ( displacement.x < 0.0f )
161 if ( displacement.y >= 0.0f )
173 if ( panDetector->CheckAngleAllowed( angle ) )
180 // Directional panning not required so we can use this actor and gesture detector.
189 * Gestured actor and gesture detectors that meet the gesture's parameters found, emit and save required information.
191 virtual void operator() ( Dali::Actor actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
193 PanGestureDetectorContainer derivedContainer;
194 DownCastContainer<PanGestureDetector>( gestureDetectors, derivedContainer );
196 processor.mCurrentPanEmitters.clear();
197 processor.ResetActor();
199 Actor* actorImpl( &GetImplementation( actor ) );
200 actorImpl->ScreenToLocal( GetImplementation(processor.mCurrentRenderTask), actorCoordinates.x, actorCoordinates.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
202 processor.EmitPanSignal( actor, derivedContainer, panEvent, actorCoordinates, panEvent.state, processor.mCurrentRenderTask );
204 if ( actorImpl->OnStage() )
206 processor.mCurrentPanEmitters = derivedContainer;
207 processor.SetActor( actor );
211 const Integration::PanGestureEvent& panEvent;
212 PanGestureProcessor& processor;
215 PanGestureProcessor::PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager )
217 mGestureManager( gestureManager ),
219 mCurrentPanEmitters(),
220 mCurrentRenderTask(),
221 mPossiblePanPosition(),
222 mMinTouchesRequired( 1 ),
223 mMaxTouchesRequired( 1 ),
224 mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
226 // Pass ownership to scene-graph
227 AddGestureMessage( mStage.GetUpdateManager(), mSceneObject );
230 PanGestureProcessor::~PanGestureProcessor()
232 if( Stage::IsInstalled() && ( mSceneObject != NULL ) )
234 RemoveGestureMessage( mStage.GetUpdateManager(), mSceneObject );
235 mSceneObject = NULL; // mSceneObject is about to be destroyed
239 void PanGestureProcessor::Process( const Integration::PanGestureEvent& panEvent )
241 switch( panEvent.state )
243 case Gesture::Possible:
245 mCurrentPanEmitters.clear();
248 HitTestAlgorithm::Results hitTestResults;
249 if( HitTest( mStage, panEvent.currentPosition, hitTestResults ) )
251 SetActor( hitTestResults.actor );
252 mPossiblePanPosition = panEvent.currentPosition;
258 case Gesture::Started:
260 if ( GetCurrentGesturedActor() )
262 // The pan gesture should only be sent to the gesture detector which first received it so that
263 // it can be told when the gesture ends as well.
265 HitTestAlgorithm::Results hitTestResults;
266 HitTestAlgorithm::HitTest( mStage, mPossiblePanPosition, hitTestResults ); // Hit test original possible position...
268 if ( hitTestResults.actor && ( GetCurrentGesturedActor() == &GetImplementation( hitTestResults.actor ) ) )
270 // Record the current render-task for Screen->Actor coordinate conversions
271 mCurrentRenderTask = hitTestResults.renderTask;
273 PanEventFunctor functor( panEvent, *this );
274 GestureDetectorContainer gestureDetectors;
275 UpCastContainer<PanGestureDetector>( mGestureDetectors, gestureDetectors );
276 ProcessAndEmit( hitTestResults, gestureDetectors, functor );
281 mCurrentPanEmitters.clear();
287 case Gesture::Continuing:
288 case Gesture::Finished:
289 case Gesture::Cancelled:
291 // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
292 // Check if actor is still touchable.
294 Actor* currentGesturedActor = GetCurrentGesturedActor();
295 if ( currentGesturedActor )
297 if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
299 PanGestureDetectorContainer outsideTouchesRangeEmitters;
301 // Removes emitters that no longer have the actor attached
302 // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
303 PanGestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
304 IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
305 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
309 if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
311 currentGesturedActor->ScreenToLocal( GetImplementation( mCurrentRenderTask ), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
313 // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
314 EmitPanSignal(Dali::Actor(currentGesturedActor), outsideTouchesRangeEmitters, panEvent, actorCoords, Gesture::Finished, mCurrentRenderTask);
315 EmitPanSignal(Dali::Actor(currentGesturedActor), mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
318 if ( mCurrentPanEmitters.empty() )
320 // If we have no emitters attached then clear pan actor as well.
324 // Clear current gesture detectors if pan gesture has ended or been cancelled.
325 if ( ( panEvent.state == Gesture::Finished ) || ( panEvent.state == Gesture::Cancelled ) )
327 mCurrentPanEmitters.clear();
333 mCurrentPanEmitters.clear();
341 DALI_ASSERT_ALWAYS( false && "Incorrect state received from Integration layer: Clear\n" );
346 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector )
348 bool firstRegistration(mGestureDetectors.empty());
350 mGestureDetectors.push_back(gestureDetector);
352 // Set the pan scene object on the gesture detector
353 gestureDetector->SetSceneObject( mSceneObject );
355 if (firstRegistration)
357 mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
358 mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
360 Integration::PanGestureRequest request;
361 request.minTouches = mMinTouchesRequired;
362 request.maxTouches = mMaxTouchesRequired;
363 mGestureManager.Register(request);
371 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
373 if (!mCurrentPanEmitters.empty())
375 // Check if the removed detector was one that is currently being panned and remove it from emitters.
376 PanGestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
377 mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
379 // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
380 if ( mCurrentPanEmitters.empty() )
386 // Find the detector...
387 PanGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
388 DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
391 mGestureDetectors.erase(endIter, mGestureDetectors.end());
393 if (mGestureDetectors.empty())
395 Integration::GestureRequest request(Gesture::Pan);
396 mGestureManager.Unregister(request);
404 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
406 DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
411 void PanGestureProcessor::SetPanGestureProperties( const PanGesture& pan )
413 // If we are currently processing a pan gesture then just ignore
414 if ( mCurrentPanEmitters.empty() && mSceneObject )
416 // We update the scene object directly rather than sending a message.
417 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
418 mSceneObject->AddGesture( pan );
422 void PanGestureProcessor::EnableProfiling()
424 mSceneObject->EnableProfiling();
427 void PanGestureProcessor::SetPredictionMode(int mode)
430 || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
432 mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
434 SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
435 mSceneObject->SetPredictionMode(modeEnum);
438 void PanGestureProcessor::UpdateDetection()
440 DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
442 unsigned int minimumRequired = UINT_MAX;
443 unsigned int maximumRequired = 0;
445 for ( PanGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
447 PanGestureDetector* detector(*iter);
449 unsigned int minimum = detector->GetMinimumTouchesRequired();
450 if (minimum < minimumRequired)
452 minimumRequired = minimum;
455 unsigned int maximum = detector->GetMaximumTouchesRequired();
456 if (maximum > maximumRequired)
458 maximumRequired = maximum;
462 if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
464 mMinTouchesRequired = minimumRequired;
465 mMaxTouchesRequired = maximumRequired;
467 Integration::PanGestureRequest request;
468 request.minTouches = mMinTouchesRequired;
469 request.maxTouches = mMaxTouchesRequired;
470 mGestureManager.Update(request);
474 void PanGestureProcessor::EmitPanSignal( Dali::Actor actorHandle,
475 PanGestureDetectorContainer& gestureDetectors,
476 const Integration::PanGestureEvent& panEvent,
477 Vector2 localCurrent,
478 Gesture::State state,
479 Dali::RenderTask renderTask )
481 if ( actorHandle && !gestureDetectors.empty() )
483 Actor& actor = GetImplementation(actorHandle);
485 PanGesture pan(state);
486 pan.time = panEvent.time;
488 pan.numberOfTouches = panEvent.numberOfTouches;
489 pan.screenPosition = panEvent.currentPosition;
490 pan.position = localCurrent;
492 RenderTask& renderTaskImpl( GetImplementation( renderTask ) );
494 Vector2 localPrevious;
495 actor.ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
497 pan.displacement = localCurrent - localPrevious;
498 Vector2 previousPos( panEvent.previousPosition );
499 if ( state == Gesture::Started )
501 previousPos = mPossiblePanPosition;
504 pan.screenDisplacement = panEvent.currentPosition - previousPos;
506 pan.velocity.x = pan.displacement.x / panEvent.timeDelta;
507 pan.velocity.y = pan.displacement.y / panEvent.timeDelta;
509 pan.screenVelocity.x = pan.screenDisplacement.x / panEvent.timeDelta;
510 pan.screenVelocity.y = pan.screenDisplacement.y / panEvent.timeDelta;
512 // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
513 // so we should use the last recorded velocity instead in this scenario.
514 if ( ( state == Gesture::Finished ) && ( pan.screenVelocity == Vector2::ZERO ) &&
515 ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
517 pan.velocity = mLastVelocity;
518 pan.screenVelocity = mLastScreenVelocity;
522 // Store the current velocity for future iterations.
523 mLastVelocity = pan.velocity;
524 mLastScreenVelocity = pan.screenVelocity;
529 // We update the scene object directly rather than sending a message.
530 // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
531 mSceneObject->AddGesture( pan );
534 for ( PanGestureDetectorContainer::iterator iter = gestureDetectors.begin(), endIter = gestureDetectors.end(); iter != endIter; ++iter )
536 (*iter)->EmitPanGestureSignal(actorHandle, pan);
541 void PanGestureProcessor::OnGesturedActorStageDisconnection()
543 mCurrentPanEmitters.clear();
546 } // namespace Internal