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

   1 /*
   2  * Copyright (c) 2014 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/tap-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/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>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace
  43 {
  44
  45 /**
  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.
  51  */
  52 void EmitTapSignal(
  53   Actor* actor,
  54   const GestureDetectorContainer& gestureDetectors,
  55   const Integration::TapGestureEvent& tapEvent,
  56   Vector2 localPoint)
  57 {
  58   TapGesture tap;
  59   tap.time = tapEvent.time;
  60   tap.numberOfTaps = tapEvent.numberOfTaps;
  61   tap.numberOfTouches = tapEvent.numberOfTouches;
  62   tap.screenPoint = tapEvent.point;
  63   tap.localPoint = localPoint;
  64
  65   Dali::Actor actorHandle( actor );
  66   const GestureDetectorContainer::const_iterator endIter = gestureDetectors.end();
  67   for ( GestureDetectorContainer::const_iterator iter = gestureDetectors.begin(); iter != endIter; ++iter )
  68   {
  69     static_cast< TapGestureDetector* >( *iter )->EmitTapGestureSignal( actorHandle, tap );
  70   }
  71 }
  72
  73 } // unnamed namespace
  74
  75 TapGestureProcessor::TapGestureProcessor( Stage& stage, Integration::GestureManager& gestureManager)
  76 : GestureProcessor( Gesture::Tap ),
  77   mStage( stage ),
  78   mGestureManager( gestureManager ),
  79   mGestureDetectors(),
  80   mMinTapsRequired( 1 ),
  81   mMaxTapsRequired( 1 ),
  82   mMinTouchesRequired( 1 ),
  83   mMaxTouchesRequired( 1 ),
  84   mCurrentTapEvent( NULL ),
  85   mPossibleProcessed( false )
  86 {
  87 }
  88
  89 TapGestureProcessor::~TapGestureProcessor()
  90 {
  91 }
  92
  93 void TapGestureProcessor::Process( const Integration::TapGestureEvent& tapEvent )
  94 {
  95   switch ( tapEvent.state )
  96   {
  97     case Gesture::Possible:
  98     {
  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 ) )
 102       {
 103         SetActor( &GetImplementation( hitTestResults.actor ) );
 104         mCurrentTapActor.SetActor( GetCurrentGesturedActor() );
 105
 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;
 108       }
 109       else
 110       {
 111         ResetActor();
 112       }
 113       break;
 114     }
 115
 116     case Gesture::Started:
 117     {
 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 )
 121       {
 122         // Check that this actor is still the one that was used for the last touch down ?
 123         if ( mCurrentTapActor.GetActor() == &GetImplementation( hitTestResults.actor ) )
 124         {
 125           mCurrentTapEvent = &tapEvent;
 126           ProcessAndEmit( hitTestResults );
 127         }
 128         mCurrentTapEvent = NULL;
 129         mPossibleProcessed = false;
 130       }
 131       break;
 132     }
 133
 134     case Gesture::Cancelled:
 135     {
 136       mPossibleProcessed = false;
 137       ResetActor();
 138       break;
 139     }
 140
 141     case Gesture::Continuing:
 142       DALI_ASSERT_ALWAYS( false && "Incorrect state received from Integration layer: Continuing\n" );
 143       break;
 144
 145     case Gesture::Finished:
 146       DALI_ASSERT_ALWAYS( false && "Incorrect state received from Integration layer: Finished\n" );
 147       break;
 148
 149     case Gesture::Clear:
 150       DALI_ASSERT_ALWAYS( false && "Incorrect state received from Integration layer: Clear\n" );
 151       break;
 152   }
 153 }
 154
 155 void TapGestureProcessor::AddGestureDetector( TapGestureDetector* gestureDetector )
 156 {
 157   bool firstRegistration(mGestureDetectors.empty());
 158
 159   mGestureDetectors.push_back(gestureDetector);
 160
 161   const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
 162   const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
 163   const unsigned int touchesRequired = gestureDetector->GetTouchesRequired();
 164
 165   DALI_ASSERT_ALWAYS( minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested" );
 166
 167   if (firstRegistration)
 168   {
 169     // If this is the first tap gesture detector that has been added, then our minimum and maximum
 170     // requirements are the same as each other.
 171
 172     mMinTapsRequired = minTapsRequired;
 173     mMaxTapsRequired = maxTapsRequired;
 174     mMinTouchesRequired = mMaxTouchesRequired = touchesRequired;
 175
 176     Integration::TapGestureRequest request;
 177     request.minTaps = mMinTapsRequired;
 178     request.maxTaps = mMaxTapsRequired;
 179     request.minTouches = mMinTouchesRequired;
 180     request.maxTouches = mMaxTouchesRequired;
 181     mGestureManager.Register(request);
 182   }
 183   else
 184   {
 185     // If we have already registered for tap gesture detection before then we need to check our
 186     // minimum and maximums and see if our gesture detection requirements have changed, if they
 187     // have, then we should ask the adaptor to update its detection policy.
 188
 189     // This is quicker than calling UpdateDetection as there is no need to iterate through the container
 190
 191     unsigned int minTaps = mMinTapsRequired < minTapsRequired ? mMinTapsRequired : minTapsRequired;
 192     unsigned int maxTaps = mMaxTapsRequired > maxTapsRequired ? mMaxTapsRequired : maxTapsRequired;
 193     unsigned int minTouches = mMinTouchesRequired < touchesRequired ? mMinTouchesRequired : touchesRequired;
 194     unsigned int maxTouches = mMaxTouchesRequired > touchesRequired ? mMaxTouchesRequired : touchesRequired;
 195
 196     if ( (minTaps != mMinTapsRequired)||(maxTaps != mMaxTapsRequired) ||
 197          (minTouches != mMinTouchesRequired)||(maxTouches != mMaxTouchesRequired) )
 198     {
 199       Integration::TapGestureRequest request;
 200       request.minTaps = mMinTapsRequired = minTaps;
 201       request.maxTaps = mMaxTapsRequired = maxTaps;
 202       request.minTouches = mMinTouchesRequired = minTouches;
 203       request.maxTouches = mMaxTouchesRequired = maxTouches;
 204       mGestureManager.Update(request);
 205     }
 206   }
 207 }
 208
 209 void TapGestureProcessor::RemoveGestureDetector( TapGestureDetector* gestureDetector )
 210 {
 211   // Find detector ...
 212   TapGestureDetectorContainer::iterator endIter = std::remove( mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector );
 213   DALI_ASSERT_DEBUG( endIter != mGestureDetectors.end() );
 214
 215   // ... and remove it
 216   mGestureDetectors.erase( endIter, mGestureDetectors.end() );
 217
 218   if ( mGestureDetectors.empty() )
 219   {
 220     Integration::GestureRequest request(Gesture::Tap);
 221     mGestureManager.Unregister(request);
 222
 223     ResetActor();
 224   }
 225   else
 226   {
 227     UpdateDetection();
 228   }
 229 }
 230
 231 void TapGestureProcessor::GestureDetectorUpdated( TapGestureDetector* gestureDetector )
 232 {
 233   DALI_ASSERT_DEBUG(find(mGestureDetectors.begin(), mGestureDetectors.end(), gestureDetector) != mGestureDetectors.end());
 234
 235   const unsigned int minTapsRequired = gestureDetector->GetMinimumTapsRequired();
 236   const unsigned int maxTapsRequired = gestureDetector->GetMaximumTapsRequired();
 237
 238   DALI_ASSERT_ALWAYS( minTapsRequired <= maxTapsRequired && "Minimum taps requested is greater than the maximum requested" );
 239
 240   UpdateDetection();
 241 }
 242
 243 void TapGestureProcessor::UpdateDetection()
 244 {
 245   DALI_ASSERT_DEBUG(!mGestureDetectors.empty());
 246
 247   unsigned int minTaps = UINT_MAX;
 248   unsigned int maxTaps = 0;
 249   unsigned int minTouches = UINT_MAX;
 250   unsigned int maxTouches = 0;
 251
 252   for ( TapGestureDetectorContainer::iterator iter = mGestureDetectors.begin(), endIter = mGestureDetectors.end(); iter != endIter; ++iter )
 253   {
 254     TapGestureDetector* detector(*iter);
 255
 256     if( detector )
 257     {
 258       const unsigned int minTapsRequired = detector->GetMinimumTapsRequired();
 259       const unsigned int maxTapsRequired = detector->GetMaximumTapsRequired();
 260       const unsigned int touchesRequired = detector->GetTouchesRequired();
 261
 262       minTaps = minTapsRequired < minTaps ? minTapsRequired : minTaps;
 263       maxTaps = maxTapsRequired > maxTaps ? maxTapsRequired : maxTaps;
 264       minTouches = touchesRequired < minTouches ? touchesRequired : minTouches;
 265       maxTouches = touchesRequired > maxTouches ? touchesRequired : maxTouches;
 266     }
 267   }
 268
 269   if ( (minTaps != mMinTapsRequired)||(maxTaps != mMaxTapsRequired) ||
 270        (minTouches != mMinTouchesRequired)||(maxTouches != mMaxTouchesRequired) )
 271   {
 272     Integration::TapGestureRequest request;
 273     request.minTaps = mMinTapsRequired = minTaps;
 274     request.maxTaps = mMaxTapsRequired = maxTaps;
 275     request.minTouches = mMinTouchesRequired = minTouches;
 276     request.maxTouches = mMaxTouchesRequired = maxTouches;
 277     mGestureManager.Update(request);
 278   }
 279 }
 280
 281 bool TapGestureProcessor::CheckGestureDetector( GestureDetector* detector, Actor* actor )
 282 {
 283   DALI_ASSERT_DEBUG( mCurrentTapEvent );
 284
 285   TapGestureDetector* tapDetector ( static_cast< TapGestureDetector* >( detector ) );
 286
 287   return ( ( tapDetector->GetMinimumTapsRequired() <= mCurrentTapEvent->numberOfTaps ) && ( tapDetector->GetMaximumTapsRequired() >= mCurrentTapEvent->numberOfTaps ) ) &&
 288          ( tapDetector->GetTouchesRequired() == mCurrentTapEvent->numberOfTouches );
 289 }
 290
 291 void TapGestureProcessor::EmitGestureSignal( Actor* actor, const GestureDetectorContainer& gestureDetectors, Vector2 actorCoordinates )
 292 {
 293   DALI_ASSERT_DEBUG( mCurrentTapEvent );
 294
 295   EmitTapSignal( actor, gestureDetectors, *mCurrentTapEvent, actorCoordinates );
 296 }
 297
 298 } // namespace Internal
 299
 300 } // namespace Dali