dali/internal/event/events/pan-gesture-processor.cpp

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/event/events/pan-gesture-processor.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23
  24 // INTERNAL INCLUDES
  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>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace // unnamed namespace
  43 {
  44
  45 const unsigned long MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY( 50u );
  46
  47 /**
  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.
  53  */
  54 struct IsNotAttachedAndOutsideTouchesRangeFunctor
  55 {
  56   /**
  57    * Constructor
  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.
  61    */
  62   IsNotAttachedAndOutsideTouchesRangeFunctor(Actor* actor, unsigned int touches, GestureDetectorContainer& outsideRangeEmitters)
  63   : actorToCheck(actor),
  64     numberOfTouches(touches),
  65     outsideTouchesRangeEmitters(outsideRangeEmitters)
  66   {
  67   }
  68
  69   /**
  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.
  75    */
  76   bool operator()(GestureDetector* detector) const
  77   {
  78     bool remove(!detector->IsAttached(*actorToCheck));
  79
  80     if (!remove)
  81     {
  82       PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
  83
  84       // Ensure number of touch points is within the range of our emitter. If it isn't then remove
  85       // this emitter and add it to the outsideTouchesRangeEmitters container
  86       if ( (numberOfTouches < panDetector->GetMinimumTouchesRequired()) ||
  87            (numberOfTouches > panDetector->GetMaximumTouchesRequired()) )
  88       {
  89         remove = true;
  90         outsideTouchesRangeEmitters.push_back(detector);
  91       }
  92     }
  93
  94     return remove;
  95   }
  96
  97   Actor* actorToCheck; ///< The actor to check whether it is attached or not.
  98   unsigned int numberOfTouches; ///< The number of touches in the pan event.
  99   GestureDetectorContainer& outsideTouchesRangeEmitters; ///< Emitters that are outside of the range of current pan.
 100 };
 101
 102 } // unnamed namespace
 103
 104 PanGestureProcessor::PanGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager, SceneGraph::UpdateManager& updateManager )
 105 : GestureProcessor( Gesture::Pan ),
 106   mStage( stage ),
 107   mGestureManager( gestureManager ),
 108   mGestureDetectors(),
 109   mCurrentPanEmitters(),
 110   mCurrentRenderTask(),
 111   mPossiblePanPosition(),
 112   mMinTouchesRequired( 1 ),
 113   mMaxTouchesRequired( 1 ),
 114   mCurrentPanEvent( NULL ),
 115   mSceneObject( SceneGraph::PanGesture::New() ) // Create scene object to store pan information.
 116 {
 117   // Pass ownership to scene-graph; scene object lives for the lifecycle of UpdateManager
 118   updateManager.SetPanGestureProcessor( mSceneObject );
 119 }
 120
 121 PanGestureProcessor::~PanGestureProcessor()
 122 {
 123   mSceneObject = NULL; // mSceneObject is owned and destroyed by update manager (there is only one of these for now)
 124 }
 125
 126 void PanGestureProcessor::Process( const Integration::PanGestureEvent& panEvent )
 127 {
 128   switch( panEvent.state )
 129   {
 130     case Gesture::Possible:
 131     {
 132       mCurrentPanEmitters.clear();
 133       ResetActor();
 134
 135       HitTestAlgorithm::Results hitTestResults;
 136       if( HitTest( mStage, panEvent.currentPosition, hitTestResults ) )
 137       {
 138         SetActor( &GetImplementation( hitTestResults.actor ) );
 139         mPossiblePanPosition = panEvent.currentPosition;
 140       }
 141
 142       break;
 143     }
 144
 145     case Gesture::Started:
 146     {
 147       if ( GetCurrentGesturedActor() )
 148       {
 149         // The pan gesture should only be sent to the gesture detector which first received it so that
 150         // it can be told when the gesture ends as well.
 151
 152         HitTestAlgorithm::Results hitTestResults;
 153         HitTest( mStage, mPossiblePanPosition, hitTestResults ); // Hit test original possible position...
 154
 155         if ( hitTestResults.actor && ( GetCurrentGesturedActor() == &GetImplementation( hitTestResults.actor ) ) )
 156         {
 157           // Record the current render-task for Screen->Actor coordinate conversions
 158           mCurrentRenderTask = hitTestResults.renderTask;
 159
 160           // Set mCurrentPanEvent to use inside overridden methods called in ProcessAndEmit()
 161           mCurrentPanEvent = &panEvent;
 162           ProcessAndEmit( hitTestResults );
 163           mCurrentPanEvent = NULL;
 164         }
 165         else
 166         {
 167           ResetActor();
 168           mCurrentPanEmitters.clear();
 169         }
 170       }
 171       break;
 172     }
 173
 174     case Gesture::Continuing:
 175     case Gesture::Finished:
 176     case Gesture::Cancelled:
 177     {
 178       // Only send subsequent pan gesture signals if we processed the pan gesture when it started.
 179       // Check if actor is still touchable.
 180
 181       Actor* currentGesturedActor = GetCurrentGesturedActor();
 182       if ( currentGesturedActor )
 183       {
 184         if ( currentGesturedActor->IsHittable() && !mCurrentPanEmitters.empty() && mCurrentRenderTask )
 185         {
 186           GestureDetectorContainer outsideTouchesRangeEmitters;
 187
 188           // Removes emitters that no longer have the actor attached
 189           // Also remove emitters whose touches are outside the range of the current pan event and add them to outsideTouchesRangeEmitters
 190           GestureDetectorContainer::iterator endIter = std::remove_if( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(),
 191                                                                        IsNotAttachedAndOutsideTouchesRangeFunctor(currentGesturedActor, panEvent.numberOfTouches, outsideTouchesRangeEmitters) );
 192           mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
 193
 194           Vector2 actorCoords;
 195
 196           if ( !outsideTouchesRangeEmitters.empty() || !mCurrentPanEmitters.empty() )
 197           {
 198             currentGesturedActor->ScreenToLocal( GetImplementation( mCurrentRenderTask ), actorCoords.x, actorCoords.y, panEvent.currentPosition.x, panEvent.currentPosition.y );
 199
 200             // EmitPanSignal checks whether we have a valid actor and whether the container we are passing in has emitters before it emits the pan.
 201             EmitPanSignal( currentGesturedActor, outsideTouchesRangeEmitters, panEvent, actorCoords, Gesture::Finished, mCurrentRenderTask);
 202             EmitPanSignal( currentGesturedActor, mCurrentPanEmitters, panEvent, actorCoords, panEvent.state, mCurrentRenderTask);
 203           }
 204
 205           if ( mCurrentPanEmitters.empty() )
 206           {
 207             // If we have no emitters attached then clear pan actor as well.
 208             ResetActor();
 209           }
 210
 211           // Clear current gesture detectors if pan gesture has ended or been cancelled.
 212           if ( ( panEvent.state == Gesture::Finished ) || ( panEvent.state == Gesture::Cancelled ) )
 213           {
 214             mCurrentPanEmitters.clear();
 215             ResetActor();
 216           }
 217         }
 218         else
 219         {
 220           mCurrentPanEmitters.clear();
 221           ResetActor();
 222         }
 223       }
 224       break;
 225     }
 226
 227     case Gesture::Clear:
 228     {
 229       DALI_ABORT( "Incorrect state received from Integration layer: Clear\n" );
 230       break;
 231     }
 232   }
 233 }
 234
 235 void PanGestureProcessor::AddGestureDetector( PanGestureDetector* gestureDetector )
 236 {
 237   bool firstRegistration(mGestureDetectors.empty());
 238
 239   mGestureDetectors.push_back(gestureDetector);
 240
 241   // Set the pan scene object on the gesture detector
 242   gestureDetector->SetSceneObject( mSceneObject );
 243
 244   if (firstRegistration)
 245   {
 246     mMinTouchesRequired = gestureDetector->GetMinimumTouchesRequired();
 247     mMaxTouchesRequired = gestureDetector->GetMaximumTouchesRequired();
 248
 249     Integration::PanGestureRequest request;
 250     request.minTouches = mMinTouchesRequired;
 251     request.maxTouches = mMaxTouchesRequired;
 252     mGestureManager.Register(request);
 253   }
 254   else
 255   {
 256     UpdateDetection();
 257   }
 258 }
 259
 260 void PanGestureProcessor::RemoveGestureDetector( PanGestureDetector* gestureDetector )
 261 {
 262   if (!mCurrentPanEmitters.empty())
 263   {
 264     // Check if the removed detector was one that is currently being panned and remove it from emitters.
 265     GestureDetectorContainer::iterator endIter = std::remove( mCurrentPanEmitters.begin(), mCurrentPanEmitters.end(), gestureDetector );
 266     mCurrentPanEmitters.erase( endIter, mCurrentPanEmitters.end() );
 267
 268     // If we no longer have any emitters, then we should clear mCurrentGesturedActor as well
 269     if ( mCurrentPanEmitters.empty() )
 270     {
 271       ResetActor();
 272     }
 273   }
 274
 275   // Find the detector...
 276   PanGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
 277   DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
 278
 279   // ...and remove it
 280   mGestureDetectors.erase(endIter, mGestureDetectors.end());
 281
 282   if (mGestureDetectors.empty())
 283   {
 284     Integration::GestureRequest request(Gesture::Pan);
 285     mGestureManager.Unregister(request);
 286   }
 287   else
 288   {
 289     UpdateDetection();
 290   }
 291 }
 292
 293 void PanGestureProcessor::GestureDetectorUpdated( PanGestureDetector* gestureDetector )
 294 {
 295   DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
 296
 297   UpdateDetection();
 298 }
 299
 300 void PanGestureProcessor::SetPanGestureProperties( const PanGesture& pan )
 301 {
 302   // If we are currently processing a pan gesture then just ignore
 303   if ( mCurrentPanEmitters.empty() && mSceneObject )
 304   {
 305     // We update the scene object directly rather than sending a message.
 306     // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
 307     mSceneObject->AddGesture( pan );
 308   }
 309 }
 310
 311 void PanGestureProcessor::EnableProfiling()
 312 {
 313   mSceneObject->EnableProfiling();
 314 }
 315
 316 void PanGestureProcessor::SetPredictionMode(int mode)
 317 {
 318   if( (mode < 0)
 319       || (mode >= SceneGraph::PanGesture::NUM_PREDICTION_MODES) )
 320   {
 321     mode = SceneGraph::PanGesture::DEFAULT_PREDICTION_MODE;
 322   }
 323   SceneGraph::PanGesture::PredictionMode modeEnum = static_cast<SceneGraph::PanGesture::PredictionMode>(mode);
 324   mSceneObject->SetPredictionMode(modeEnum);
 325 }
 326
 327 void PanGestureProcessor::SetPredictionAmount(unsigned int amount)
 328 {
 329   mSceneObject->SetPredictionAmount(amount);
 330 }
 331
 332 void PanGestureProcessor::SetMaximumPredictionAmount(unsigned int amount)
 333 {
 334   mSceneObject->SetMaximumPredictionAmount(amount);
 335 }
 336
 337 void PanGestureProcessor::SetMinimumPredictionAmount(unsigned int amount)
 338 {
 339   mSceneObject->SetMinimumPredictionAmount(amount);
 340 }
 341
 342 void PanGestureProcessor::SetPredictionAmountAdjustment(unsigned int amount)
 343 {
 344   mSceneObject->SetPredictionAmountAdjustment(amount);
 345 }
 346
 347 void PanGestureProcessor::SetSmoothingMode(int mode)
 348 {
 349   if( (mode < 0)
 350       || (mode >= SceneGraph::PanGesture::NUM_SMOOTHING_MODES) )
 351   {
 352     mode = SceneGraph::PanGesture::DEFAULT_SMOOTHING_MODE;
 353   }
 354   SceneGraph::PanGesture::SmoothingMode modeEnum = static_cast<SceneGraph::PanGesture::SmoothingMode>(mode);
 355   mSceneObject->SetSmoothingMode(modeEnum);
 356 }
 357
 358 void PanGestureProcessor::SetSmoothingAmount(float amount)
 359 {
 360   mSceneObject->SetSmoothingAmount(amount);
 361 }
 362
 363 void PanGestureProcessor::UpdateDetection()
 364 {
 365   DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
 366
 367   unsigned int minimumRequired = UINT_MAX;
 368   unsigned int maximumRequired = 0;
 369
 370   for ( PanGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
 371   {
 372     PanGestureDetector* detector(*iter);
 373
 374     if( detector )
 375     {
 376       unsigned int minimum = detector->GetMinimumTouchesRequired();
 377       if (minimum < minimumRequired)
 378       {
 379         minimumRequired = minimum;
 380       }
 381
 382       unsigned int maximum = detector->GetMaximumTouchesRequired();
 383       if (maximum > maximumRequired)
 384       {
 385         maximumRequired = maximum;
 386       }
 387     }
 388   }
 389
 390   if ( (minimumRequired != mMinTouchesRequired)||(maximumRequired != mMaxTouchesRequired) )
 391   {
 392     mMinTouchesRequired = minimumRequired;
 393     mMaxTouchesRequired = maximumRequired;
 394
 395     Integration::PanGestureRequest request;
 396     request.minTouches = mMinTouchesRequired;
 397     request.maxTouches = mMaxTouchesRequired;
 398     mGestureManager.Update(request);
 399   }
 400 }
 401
 402 void PanGestureProcessor::EmitPanSignal( Actor* actor,
 403                                          const GestureDetectorContainer& gestureDetectors,
 404                                          const Integration::PanGestureEvent& panEvent,
 405                                          Vector2 localCurrent,
 406                                          Gesture::State state,
 407                                          Dali::RenderTask renderTask )
 408 {
 409   if ( actor && !gestureDetectors.empty() )
 410   {
 411     PanGesture pan(state);
 412     pan.time = panEvent.time;
 413
 414     pan.numberOfTouches = panEvent.numberOfTouches;
 415     pan.screenPosition = panEvent.currentPosition;
 416     pan.position = localCurrent;
 417
 418     RenderTask& renderTaskImpl( GetImplementation( renderTask ) );
 419
 420     Vector2 localPrevious;
 421     actor->ScreenToLocal( renderTaskImpl, localPrevious.x, localPrevious.y, panEvent.previousPosition.x, panEvent.previousPosition.y );
 422
 423     pan.displacement = localCurrent - localPrevious;
 424     Vector2 previousPos( panEvent.previousPosition );
 425     if ( state == Gesture::Started )
 426     {
 427       previousPos = mPossiblePanPosition;
 428     }
 429
 430     pan.screenDisplacement = panEvent.currentPosition - previousPos;
 431
 432     // Avoid dividing by 0
 433     if ( panEvent.timeDelta > 0 )
 434     {
 435       pan.velocity.x = pan.displacement.x / panEvent.timeDelta;
 436       pan.velocity.y = pan.displacement.y / panEvent.timeDelta;
 437
 438       pan.screenVelocity.x = pan.screenDisplacement.x / panEvent.timeDelta;
 439       pan.screenVelocity.y = pan.screenDisplacement.y / panEvent.timeDelta;
 440     }
 441
 442     // When the gesture ends, we may incorrectly get a ZERO velocity (as we have lifted our finger without any movement)
 443     // so we should use the last recorded velocity instead in this scenario.
 444     if ( ( state == Gesture::Finished ) && ( pan.screenVelocity == Vector2::ZERO ) &&
 445          ( panEvent.timeDelta < MAXIMUM_TIME_WITH_VALID_LAST_VELOCITY ) )
 446     {
 447       pan.velocity = mLastVelocity;
 448       pan.screenVelocity = mLastScreenVelocity;
 449     }
 450     else
 451     {
 452       // Store the current velocity for future iterations.
 453       mLastVelocity = pan.velocity;
 454       mLastScreenVelocity = pan.screenVelocity;
 455     }
 456
 457     if ( mSceneObject )
 458     {
 459       // We update the scene object directly rather than sending a message.
 460       // Sending a message could cause unnecessary delays, the scene object ensure thread safe behaviour.
 461       mSceneObject->AddGesture( pan );
 462     }
 463
 464     Dali::Actor actorHandle( actor );
 465     const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
 466     for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
 467     {
 468       static_cast< PanGestureDetector* >( *iter )->EmitPanGestureSignal( actorHandle, pan );
 469     }
 470   }
 471 }
 472
 473 void PanGestureProcessor::OnGesturedActorStageDisconnection()
 474 {
 475   mCurrentPanEmitters.clear();
 476 }
 477
 478 bool PanGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
 479 {
 480   DALI_ASSERT_DEBUG( mCurrentPanEvent );
 481
 482   bool retVal( false );
 483   PanGestureDetector* panDetector( static_cast< PanGestureDetector* >( detector ) );
 484
 485   if ( ( mCurrentPanEvent->numberOfTouches >= panDetector->GetMinimumTouchesRequired() ) &&
 486        ( mCurrentPanEvent->numberOfTouches <= panDetector->GetMaximumTouchesRequired() ) )
 487   {
 488     // Check if the detector requires directional panning.
 489     if ( panDetector->RequiresDirectionalPan() && mCurrentRenderTask )
 490     {
 491       // It does, calculate the angle of the pan in local actor coordinates and ensures it fits
 492       // the detector's criteria.
 493       RenderTask& renderTaskImpl( GetImplementation( mCurrentRenderTask ) );
 494
 495       Vector2 startPosition, currentPosition;
 496       actor->ScreenToLocal( renderTaskImpl, startPosition.x,   startPosition.y,   mPossiblePanPosition.x,              mPossiblePanPosition.y );
 497       actor->ScreenToLocal( renderTaskImpl, currentPosition.x, currentPosition.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
 498       Vector2 displacement( currentPosition - startPosition );
 499
 500       Radian angle( atan( displacement.y / displacement.x ) );
 501
 502       /////////////////////////////
 503       //            |            //
 504       //            |            //
 505       //   Q3 (-,-) | Q4 (+,-)   //
 506       //            |            //
 507       //    ----------------- +x //
 508       //            |            //
 509       //   Q2 (-,+) | Q1 (+,+)   //
 510       //            |            //
 511       //            |            //
 512       //           +y            //
 513       /////////////////////////////
 514       // Quadrant 1: As is
 515       // Quadrant 2: 180 degrees + angle
 516       // Quadrant 3: angle - 180 degrees
 517       // Quadrant 4: As is
 518       /////////////////////////////
 519
 520       if ( displacement.x < 0.0f )
 521       {
 522         if ( displacement.y >= 0.0f )
 523         {
 524           // Quadrant 2
 525           angle.radian += Math::PI;
 526         }
 527         else
 528         {
 529           // Quadrant 3
 530           angle.radian -= Math::PI;
 531         }
 532       }
 533
 534       if ( panDetector->CheckAngleAllowed( angle ) )
 535       {
 536         retVal = true;
 537       }
 538     }
 539     else
 540     {
 541       // Directional panning not required so we can use this actor and gesture detector.
 542       retVal = true;
 543     }
 544   }
 545   return retVal;
 546 }
 547
 548 void PanGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
 549 {
 550   DALI_ASSERT_DEBUG ( mCurrentPanEvent );
 551
 552   mCurrentPanEmitters.clear();
 553   ResetActor();
 554
 555   actor->ScreenToLocal( GetImplementation(mCurrentRenderTask), actorCoordinates.x, actorCoordinates.y, mCurrentPanEvent->currentPosition.x, mCurrentPanEvent->currentPosition.y );
 556
 557   EmitPanSignal( actor, gestureDetectors, *mCurrentPanEvent, actorCoordinates, mCurrentPanEvent->state, mCurrentRenderTask );
 558
 559   if ( actor->OnStage() )
 560   {
 561     mCurrentPanEmitters = gestureDetectors;
 562     SetActor( actor );
 563   }
 564 }
 565
 566 } // namespace Internal
 567
 568 } // namespace Dali