automated-tests/src/dali-toolkit/utc-Dali-ScrollViewEffect.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 #include <iostream>
  19 #include <stdlib.h>
  20
  21 // Need to override adaptor classes for toolkit test harness, so include
  22 // test harness headers before dali headers.
  23 #include <dali-toolkit-test-suite-utils.h>
  24
  25 #include <dali.h>
  26 #include <dali-toolkit/dali-toolkit.h>
  27 #include <dali/integration-api/events/touch-event-integ.h>
  28 #include <dali/integration-api/events/pan-gesture-event.h>
  29
  30 using namespace Dali;
  31 using namespace Toolkit;
  32
  33 void utc_dali_toolkit_scroll_view_effect_startup(void)
  34 {
  35   test_return_value = TET_UNDEF;
  36 }
  37
  38 void utc_dali_toolkit_scroll_view_effect_cleanup(void)
  39 {
  40   test_return_value = TET_PASS;
  41 }
  42
  43 namespace
  44 {
  45
  46 const int MILLISECONDS_PER_SECOND = 1000;
  47 const int RENDER_FRAME_INTERVAL = 16;                           ///< Duration of each frame in ms. (at approx 60FPS)
  48 const int RENDER_ANIMATION_TEST_DURATION_MS = 1000;             ///< 1000ms to test animation
  49 const int RENDER_DELAY_SCROLL = 1000;                           ///< duration to wait for any scroll to complete.
  50
  51 /*
  52  * Simulate time passed by.
  53  *
  54  * @note this will always process at least 1 frame (1/60 sec)
  55  *
  56  * @param application Test application instance
  57  * @param duration Time to pass in milliseconds.
  58  * @return The actual time passed in milliseconds
  59  */
  60 int Wait(ToolkitTestApplication& application, int duration = 0)
  61 {
  62   int time = 0;
  63
  64   for(int i = 0; i <= ( duration / RENDER_FRAME_INTERVAL); i++)
  65   {
  66     application.SendNotification();
  67     application.Render(RENDER_FRAME_INTERVAL);
  68     time += RENDER_FRAME_INTERVAL;
  69   }
  70
  71   return time;
  72 }
  73
  74 /**
  75  * Creates a Ruler that snaps to a specified grid size.
  76  * If that grid size is 0.0 then this ruler does not
  77  * snap.
  78  *
  79  * @param[in] gridSize (optional) The grid size for the ruler,
  80  * (Default = 0.0 i.e. no snapping)
  81  * @return The ruler is returned.
  82  */
  83 RulerPtr CreateRuler(float gridSize = 0.0f)
  84 {
  85   if(gridSize <= Math::MACHINE_EPSILON_0)
  86   {
  87       return new DefaultRuler();
  88   }
  89   return new FixedRuler(gridSize);
  90 }
  91
  92 // Callback probes.
  93
  94 static bool gOnScrollStartCalled;                       ///< Whether the OnScrollStart signal was invoked.
  95 static bool gOnScrollUpdateCalled;                      ///< Whether the OnScrollUpdate signal was invoked.
  96 static bool gOnScrollCompleteCalled;                    ///< Whether the OnScrollComplete signal was invoked.
  97 static Vector3 gConstraintResult;                       ///< Result from constraint.
  98
  99 static ActorContainer gPages;                                ///< Keeps track of all the pages for applying effects.
 100
 101 static void ResetScrollCallbackResults()
 102 {
 103   gOnScrollStartCalled = false;
 104   gOnScrollUpdateCalled = false;
 105   gOnScrollCompleteCalled = false;
 106 }
 107
 108 /**
 109  * Invoked when scrolling starts.
 110  *
 111  * @param[in] position The current scroll position.
 112  */
 113 static void OnScrollStart( const Vector3& position )
 114 {
 115   gOnScrollStartCalled = true;
 116 }
 117
 118 /**
 119  * Invoked when scrolling updates (via dragging)
 120  *
 121  * @param[in] position The current scroll position.
 122  */
 123 static void OnScrollUpdate( const Vector3& position )
 124 {
 125   gOnScrollUpdateCalled = true;
 126 }
 127
 128 /**
 129  * Invoked when scrolling finishes
 130  *
 131  * @param[in] position The current scroll position.
 132  */
 133 static void OnScrollComplete( const Vector3& position )
 134 {
 135   gOnScrollCompleteCalled = true;
 136 }
 137
 138 ScrollView SetupTestScrollView(int rows, int columns, Vector2 size)
 139 {
 140   ScrollView scrollView = ScrollView::New();
 141   scrollView.SetSize(size);
 142   scrollView.SetAnchorPoint(AnchorPoint::CENTER);
 143   scrollView.SetParentOrigin(ParentOrigin::CENTER);
 144   scrollView.ApplyConstraint( Constraint::New<Dali::Vector3>( Dali::Actor::SIZE, Dali::ParentSource( Dali::Actor::SIZE ), Dali::EqualToConstraint() ) );
 145   scrollView.SetWrapMode(false);
 146   scrollView.ScrollStartedSignal().Connect( &OnScrollStart );
 147   scrollView.ScrollUpdatedSignal().Connect( &OnScrollUpdate );
 148   scrollView.ScrollCompletedSignal().Connect( &OnScrollComplete );
 149   Stage::GetCurrent().Add( scrollView );
 150   RulerPtr rulerX = CreateRuler(size.width);
 151   RulerPtr rulerY = CreateRuler(size.height);
 152   if(columns > 1)
 153   {
 154     rulerX->SetDomain(RulerDomain(0.0f, size.width * columns));
 155   }
 156   else
 157   {
 158     rulerX->Disable();
 159   }
 160   if(rows > 1)
 161   {
 162     rulerY->SetDomain(RulerDomain(0.0f, size.width * rows));
 163   }
 164   else
 165   {
 166     rulerY->Disable();
 167   }
 168
 169   scrollView.SetRulerX( rulerX );
 170   scrollView.SetRulerY( rulerY );
 171   Stage::GetCurrent().Add( scrollView );
 172
 173   Actor container = Actor::New();
 174   container.SetParentOrigin(ParentOrigin::CENTER);
 175   container.SetAnchorPoint(AnchorPoint::CENTER);
 176   container.SetSize( size );
 177   scrollView.Add( container );
 178   container.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
 179
 180   gPages.clear();
 181   for(int row = 0;row<rows;row++)
 182   {
 183     for(int column = 0;column<columns;column++)
 184     {
 185       Actor page = Actor::New();
 186       page.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
 187       page.SetParentOrigin( ParentOrigin::CENTER );
 188       page.SetAnchorPoint( AnchorPoint::CENTER );
 189       page.SetPosition( column * size.x, row * size.y );
 190       container.Add(page);
 191
 192       gPages.push_back(page);
 193     }
 194   }
 195
 196   ResetScrollCallbackResults();
 197   return scrollView;
 198 }
 199
 200 void CleanupTest()
 201 {
 202   gPages.clear();
 203   ResetScrollCallbackResults();
 204 }
 205
 206 Actor AddActorToPage(Actor page, float x, float y, float cols, float rows)
 207 {
 208   Stage stage = Stage::GetCurrent();
 209   Vector2 stageSize = stage.GetSize();
 210
 211   const float margin = 10.0f;
 212   const Vector2 actorSize((stageSize.x / cols) - margin, (stageSize.y / rows) - margin);
 213
 214   Actor actor = Actor::New();
 215   actor.SetParentOrigin( ParentOrigin::CENTER );
 216   actor.SetAnchorPoint( AnchorPoint::CENTER );
 217
 218   Vector3 position( margin * 0.5f + (actorSize.x + margin) * x - stageSize.width * 0.5f,
 219                     margin * 0.5f + (actorSize.y + margin) * y - stageSize.height * 0.5f,
 220                     0.0f);
 221   Vector3 positionEnd( margin * 0.5f + (actorSize.x + margin) * (x + cols) - stageSize.width * 0.5f - margin,
 222                        margin * 0.5f + (actorSize.y + margin) * (y + rows) - stageSize.height * 0.5f - margin,
 223                        0.0f);
 224   Vector3 size(positionEnd - position);
 225   actor.SetPosition( position + size * 0.5f);
 226   actor.SetSize( positionEnd - position );
 227   page.Add(actor);
 228   return actor;
 229 }
 230
 231 } // unnamed namespace
 232
 233
 234 int UtcDaliScrollViewCubeEffectSetup(void)
 235 {
 236   tet_infoline(" UtcDaliScrollViewCubeEffectSetup");
 237
 238   ScrollViewCubeEffect effect;
 239
 240   DALI_TEST_CHECK( !effect );
 241
 242   BaseHandle handle = ScrollViewCubeEffect::New();
 243
 244   DALI_TEST_CHECK( handle );
 245
 246   effect = ScrollViewCubeEffect::DownCast(handle);
 247
 248   DALI_TEST_CHECK( effect );
 249   END_TEST;
 250 }
 251
 252 int UtcDaliScrollViewSpiralEffectSetup(void)
 253 {
 254   tet_infoline(" UtcDaliScrollViewSpiralEffectSetup");
 255
 256   ScrollViewPageSpiralEffect effect;
 257
 258   DALI_TEST_CHECK( !effect );
 259
 260   BaseHandle handle = ScrollViewPageSpiralEffect::New();
 261
 262   DALI_TEST_CHECK( handle );
 263
 264   effect = ScrollViewPageSpiralEffect::DownCast(handle);
 265
 266   DALI_TEST_CHECK( effect );
 267   END_TEST;
 268 }
 269
 270
 271
 272
 273 int UtcDaliScrollViewSlideEffectSetup(void)
 274 {
 275   tet_infoline(" UtcDaliScrollViewSlideEffectSetup");
 276
 277   ScrollViewSlideEffect effect;
 278
 279   DALI_TEST_CHECK( !effect );
 280
 281   BaseHandle handle = ScrollViewSlideEffect::New();
 282
 283   DALI_TEST_CHECK( handle );
 284
 285   effect = ScrollViewSlideEffect::DownCast(handle);
 286
 287   DALI_TEST_CHECK( effect );
 288   END_TEST;
 289 }
 290
 291 int UtcDaliScrollViewCubeEffectTest(void)
 292 {
 293   ToolkitTestApplication application;
 294   tet_infoline(" UtcDaliScrollViewCubeEffectTest");
 295
 296   Vector2 size = Stage::GetCurrent().GetSize();
 297
 298   ScrollView scrollView = SetupTestScrollView(1, 3, size);
 299   Actor page = gPages[1];
 300   Wait(application, 500);
 301
 302   ScrollViewCubeEffect effect = ScrollViewCubeEffect::New();
 303   scrollView.ApplyEffect(effect);
 304
 305   Actor actor = AddActorToPage(page, 0.5f, 0.5f, 3, 3);
 306   Wait(application);
 307   Vector3 actorPrePosition = actor.GetCurrentPosition();
 308
 309   effect.ApplyToActor(actor, page, Vector3(-105.0f, 30.0f, -240.0f), Vector2(Math::PI * 0.5f, Math::PI * 0.5f), Vector2(0.25f, 0.25f) * size);
 310
 311   Actor actor2 = AddActorToPage(page, 0.5f, 0.5f, 3, 3);
 312   effect.ApplyToActor(actor2, Vector3(-105.0f, 30.0f, -240.0f), Vector2(Math::PI * 0.5f, Math::PI * 0.5f), Vector2(0.25f, 0.25f) * size);
 313
 314   scrollView.ScrollTo(1);
 315   while(!gOnScrollCompleteCalled)
 316   {
 317     Wait(application);
 318   }
 319   // test that the first page has reached centre of screen
 320   Vector3 actorPostPosition = actor.GetCurrentPosition();
 321   // just check the actor has moved
 322   DALI_TEST_CHECK((actorPostPosition - actorPrePosition).Length() > Math::MACHINE_EPSILON_1);
 323   CleanupTest();
 324   END_TEST;
 325 }
 326
 327
 328 int UtcDaliScrollViewSpiralEffectTest(void)
 329 {
 330   ToolkitTestApplication application;
 331   tet_infoline(" UtcDaliScrollViewSpiralEffectTest");
 332
 333   Vector2 size = Stage::GetCurrent().GetSize();
 334
 335   ScrollView scrollView = SetupTestScrollView(1, 3, size);
 336   Actor testPage = gPages[1];
 337   Wait(application, 500);
 338
 339   ScrollViewPageSpiralEffect effect = ScrollViewPageSpiralEffect::New();
 340   scrollView.ApplyEffect(effect);
 341
 342   for(ActorIter pageIter = gPages.begin(); pageIter != gPages.end(); ++pageIter)
 343   {
 344     Actor page = *pageIter;
 345     page.RemoveConstraints();
 346     page.ApplyConstraint( Constraint::New<Vector3>( Actor::SIZE, ParentSource( Actor::SIZE ), EqualToConstraint() ) );
 347     effect.ApplyToPage(page, Vector2(Math::PI_2, 0.0f));
 348   }
 349   Wait(application);
 350
 351   scrollView.ScrollTo(1);
 352   while(!gOnScrollCompleteCalled)
 353   {
 354     Wait(application);
 355   }
 356   // test that the first page has reached centre of screen
 357   Vector3 pagePos = testPage.GetCurrentPosition();
 358   DALI_TEST_EQUALS(pagePos, Vector3::ZERO, Math::MACHINE_EPSILON_0, TEST_LOCATION);
 359   CleanupTest();
 360   END_TEST;
 361 }
 362
 363
 364
 365 int UtcDaliScrollViewSlideEffectTest(void)
 366 {
 367   ToolkitTestApplication application;
 368   tet_infoline(" UtcDaliScrollViewSlideEffectTest");
 369
 370   Vector2 size = Stage::GetCurrent().GetSize();
 371   Vector3 pageSize(size.x, size.y, 0.0f);
 372
 373   ScrollView scrollView = SetupTestScrollView(1, 3, size);
 374   Actor testPage = gPages[1];
 375   Wait(application, 500);
 376
 377   ScrollViewSlideEffect effect = ScrollViewSlideEffect::New();
 378   effect.SetDelayReferenceOffset(pageSize * 0.25);
 379   DALI_TEST_EQUALS(effect.GetDelayReferenceOffset(), pageSize * 0.25, Math::MACHINE_EPSILON_0, TEST_LOCATION);
 380   effect.SetMaxDelayDuration(0.5f);
 381   DALI_TEST_EQUALS(effect.GetMaxDelayDuration(), 0.5f, Math::MACHINE_EPSILON_0, TEST_LOCATION);
 382   effect.SetSlideDirection(false);
 383   DALI_TEST_CHECK(!effect.GetSlideDirection());
 384
 385   scrollView.ApplyEffect(effect);
 386
 387   Actor actor = AddActorToPage(testPage, 0.5f, 0.5f, 3, 3);
 388   Wait(application);
 389   Vector3 actorPrePosition = actor.GetCurrentPosition();
 390
 391   effect.ApplyToActor(actor, 0.0f, 0.5f);
 392
 393   scrollView.ScrollTo(1);
 394   while(!gOnScrollCompleteCalled)
 395   {
 396     Wait(application);
 397   }
 398   // test that the first page has reached centre of screen
 399   Vector3 actorPostPosition = actor.GetCurrentPosition();
 400   // just check the actor has moved
 401   DALI_TEST_CHECK((actorPostPosition - actorPrePosition).Length() > Math::MACHINE_EPSILON_1);
 402   CleanupTest();
 403   END_TEST;
 404 }