base/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.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-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  26 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-impl.h>
  27
  28 using namespace Dali;
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 ///////////////////////////////////////////////////////////////////////////////////////////////////
  37 // RulerDomain
  38 ///////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 RulerDomain::RulerDomain(float min, float max, bool enabled)
  41 : min(min),
  42   max(max),
  43   enabled(enabled)
  44 {
  45 }
  46
  47 float RulerDomain::Clamp(float x, float length, float scale) const
  48 {
  49   ClampState clamped;
  50
  51   return Clamp(x, length, scale, clamped);
  52 }
  53
  54 float RulerDomain::Clamp(float x, float length, float scale, ClampState &clamped) const
  55 {
  56   if(!enabled)
  57   {
  58     clamped = NotClamped;
  59     return x;
  60   }
  61
  62   const float minExtent = min * scale;
  63   const float maxExtent = max * scale - length;
  64   if(x < minExtent)
  65   {
  66     clamped = ClampedToMin;
  67     return minExtent;
  68   }
  69   else if(x > maxExtent)
  70   {
  71     clamped = ClampedToMax;
  72     return maxExtent;
  73   }
  74
  75   clamped = NotClamped;
  76   return x;
  77 }
  78
  79 float RulerDomain::GetSize() const
  80 {
  81   return max-min;
  82 }
  83
  84 ///////////////////////////////////////////////////////////////////////////////////////////////////
  85 // Ruler
  86 ///////////////////////////////////////////////////////////////////////////////////////////////////
  87
  88 Ruler::Ruler()
  89 : mType(Free),
  90   mEnabled(true),
  91   mDomain(RulerDomain(0.0f,1.0f,false))
  92 {
  93 }
  94
  95 Ruler::~Ruler()
  96 {
  97 }
  98
  99 Ruler::RulerType Ruler::GetType() const
 100 {
 101   return mType;
 102 }
 103
 104 bool Ruler::IsEnabled() const
 105 {
 106   return mEnabled;
 107 }
 108
 109 void Ruler::Enable()
 110 {
 111   mEnabled = true;
 112 }
 113
 114 void Ruler::Disable()
 115 {
 116   mEnabled = false;
 117 }
 118
 119 void Ruler::SetDomain(RulerDomain domain)
 120 {
 121   mDomain = domain;
 122 }
 123
 124 const RulerDomain &Ruler::GetDomain() const
 125 {
 126   return mDomain;
 127 }
 128
 129 void Ruler::DisableDomain()
 130 {
 131   mDomain = RulerDomain(0.0f,1.0f,false);
 132 }
 133
 134 float Ruler::Clamp(float x, float length, float scale) const
 135 {
 136   return mDomain.Clamp(x, length, scale);
 137 }
 138
 139 float Ruler::Clamp(float x, float length, float scale, ClampState &clamped) const
 140 {
 141   return mDomain.Clamp(x, length, scale, clamped);
 142 }
 143
 144 float Ruler::SnapAndClamp(float x, float bias, float length, float scale) const
 145 {
 146   return Clamp(Snap(x, bias), length, scale);
 147 }
 148
 149 float Ruler::SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const
 150 {
 151   return Clamp(Snap(x, bias), length, scale, clamped);
 152 }
 153
 154 ///////////////////////////////////////////////////////////////////////////////////////////////////
 155 // DefaultRuler
 156 ///////////////////////////////////////////////////////////////////////////////////////////////////
 157
 158 DefaultRuler::DefaultRuler()
 159 {
 160   mType = Free;
 161 }
 162
 163 float DefaultRuler::Snap(float x, float bias) const
 164 {
 165   return x;
 166 }
 167
 168 float DefaultRuler::GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const
 169 {
 170   volume = 0;
 171   return 0.0f;
 172 }
 173
 174 unsigned int DefaultRuler::GetPageFromPosition(float position, bool wrap) const
 175 {
 176   return 0;
 177 }
 178
 179 unsigned int DefaultRuler::GetTotalPages() const
 180 {
 181   return 1;
 182 }
 183
 184 ///////////////////////////////////////////////////////////////////////////////////////////////////
 185 // FixedRuler
 186 ///////////////////////////////////////////////////////////////////////////////////////////////////
 187
 188 FixedRuler::FixedRuler(float spacing)
 189 : mSpacing(spacing)
 190 {
 191   mType = Fixed;
 192 }
 193
 194 float FixedRuler::Snap(float x, float bias) const
 195 {
 196   return floor(x / mSpacing + bias) * mSpacing;
 197 }
 198
 199 float FixedRuler::GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const
 200 {
 201   float position = mDomain.min;
 202
 203   volume = 0;
 204
 205   // spacing must be present.
 206   if(mEnabled && fabsf(mSpacing) > Math::MACHINE_EPSILON_1)
 207   {
 208     unsigned int column = page;
 209
 210     // In carry mode, a volume (carry) is produced when page exceeds limit within domain
 211     if(wrap)
 212     {
 213       unsigned int pagesPerVolume = mDomain.GetSize() / mSpacing;
 214       if(pagesPerVolume>0)
 215       {
 216         column += pagesPerVolume;
 217         column %= pagesPerVolume;
 218         volume = page/pagesPerVolume;
 219       }
 220     }
 221
 222     position = mDomain.min + column * mSpacing;
 223   }
 224   else  // Domain (or Spacing) is not present, carry page to volume.
 225   {
 226     if(wrap)
 227     {
 228       volume = page;
 229     }
 230   }
 231
 232   return position;
 233 }
 234
 235 unsigned int FixedRuler::GetPageFromPosition(float position, bool wrap) const
 236 {
 237   unsigned int page = 0;
 238
 239   // spacing must be present.
 240   if(mEnabled && fabsf(mSpacing) > Math::MACHINE_EPSILON_1)
 241   {
 242     if( wrap )
 243     {
 244       position = WrapInDomain(position, mDomain.min, mDomain.max);
 245     }
 246     page = floor((position - mDomain.min) / mSpacing + 0.5f);
 247
 248     if(wrap)
 249     {
 250       unsigned int pagesPerVolume = mDomain.GetSize() / mSpacing;
 251       page %= pagesPerVolume;
 252     }
 253   }
 254
 255   return page;
 256 }
 257
 258 unsigned int FixedRuler::GetTotalPages() const
 259 {
 260   unsigned int pagesPerVolume = 1;
 261
 262   // spacing must be present.
 263   if(mEnabled && fabsf(mSpacing) > Math::MACHINE_EPSILON_1)
 264   {
 265     pagesPerVolume = mDomain.GetSize() / mSpacing;
 266   }
 267
 268   return pagesPerVolume;
 269 }
 270
 271 ///////////////////////////////////////////////////////////////////////////////////////////////////
 272 // ScrollView
 273 ///////////////////////////////////////////////////////////////////////////////////////////////////
 274
 275 const std::string ScrollView::SCROLL_PAGE_CURRENT( "scroll-page-current" );
 276 const std::string ScrollView::SCROLL_TIME_PROPERTY_NAME( "scroll-time" );
 277 const std::string ScrollView::SCROLL_POSITION_PROPERTY_NAME( "scroll-position" );
 278 const std::string ScrollView::SCROLL_PRE_POSITION_PROPERTY_NAME( "scroll-pre-position" );
 279 const std::string ScrollView::SCROLL_OVERSHOOT_X_PROPERTY_NAME( "scroll-overshoot-x" );
 280 const std::string ScrollView::SCROLL_OVERSHOOT_Y_PROPERTY_NAME( "scroll-overshoot-y" );
 281 const std::string ScrollView::SCROLL_FINAL_PROPERTY_NAME( "scroll-final" );
 282 const std::string ScrollView::SCROLL_SCALE_PROPERTY_NAME( "scroll-scale" );
 283 const std::string ScrollView::SCROLL_WRAP_PROPERTY_NAME( "scroll-wrap" );
 284 const std::string ScrollView::SCROLL_PANNING_PROPERTY_NAME( "scroll-panning" );
 285 const std::string ScrollView::SCROLL_SCROLLING_PROPERTY_NAME( "scroll-scrolling" );
 286 const std::string ScrollView::SCROLL_POSITION_DELTA_PROPERTY_NAME( "scroll-position-delta" );
 287 const std::string ScrollView::SCROLL_START_PAGE_POSITION_PROPERTY_NAME( "scroll-start-page-position" );
 288
 289 const float ScrollView::DEFAULT_SLOW_SNAP_ANIMATION_DURATION(0.5f);
 290 const float ScrollView::DEFAULT_FAST_SNAP_ANIMATION_DURATION(0.25f);
 291 const float ScrollView::DEFAULT_SNAP_OVERSHOOT_DURATION(0.5f);
 292 const float ScrollView::DEFAULT_MAX_OVERSHOOT(100.0f);  // 100 pixels
 293
 294 const float ScrollView::DEFAULT_AXIS_AUTO_LOCK_GRADIENT(0.36f);
 295 const float ScrollView::DEFAULT_FRICTION_COEFFICIENT(1.0f);
 296 const float ScrollView::DEFAULT_FLICK_SPEED_COEFFICIENT(1.0f);
 297 const float ScrollView::DEFAULT_MAX_FLICK_SPEED(3.0f);
 298
 299 const char* const ScrollView::SIGNAL_SNAP_STARTED = "snap-started";
 300
 301 ScrollView::ScrollView()
 302 {
 303 }
 304
 305 ScrollView::ScrollView(Internal::ScrollView& implementation)
 306 : Scrollable(implementation)
 307 {
 308 }
 309
 310 ScrollView::ScrollView( Dali::Internal::CustomActor* internal )
 311 : Scrollable( internal )
 312 {
 313   VerifyCustomActorPointer<Internal::ScrollView>(internal);
 314 }
 315
 316 ScrollView::ScrollView( const ScrollView& handle )
 317 : Scrollable( handle )
 318 {
 319 }
 320
 321 ScrollView& ScrollView::operator=( const ScrollView& handle )
 322 {
 323   if( &handle != this )
 324   {
 325     Control::operator=( handle );
 326   }
 327   return *this;
 328 }
 329
 330 ScrollView ScrollView::New()
 331 {
 332   return Internal::ScrollView::New();
 333 }
 334
 335 ScrollView::~ScrollView()
 336 {
 337 }
 338
 339 ScrollView ScrollView::DownCast( BaseHandle handle )
 340 {
 341   return Control::DownCast<ScrollView, Internal::ScrollView>(handle);
 342 }
 343
 344 AlphaFunction ScrollView::GetScrollSnapAlphaFunction() const
 345 {
 346   return GetImpl(*this).GetScrollSnapAlphaFunction();
 347 }
 348
 349 void ScrollView::SetScrollSnapAlphaFunction(AlphaFunction alpha)
 350 {
 351   GetImpl(*this).SetScrollSnapAlphaFunction(alpha);
 352 }
 353
 354 AlphaFunction ScrollView::GetScrollFlickAlphaFunction() const
 355 {
 356   return GetImpl(*this).GetScrollFlickAlphaFunction();
 357 }
 358
 359 void ScrollView::SetScrollFlickAlphaFunction(AlphaFunction alpha)
 360 {
 361   GetImpl(*this).SetScrollFlickAlphaFunction(alpha);
 362 }
 363
 364 float ScrollView::GetScrollSnapDuration() const
 365 {
 366   return GetImpl(*this).GetScrollSnapDuration();
 367 }
 368
 369 void ScrollView::SetScrollSnapDuration(float time)
 370 {
 371   GetImpl(*this).SetScrollSnapDuration(time);
 372 }
 373
 374 float ScrollView::GetScrollFlickDuration() const
 375 {
 376   return GetImpl(*this).GetScrollFlickDuration();
 377 }
 378
 379 void ScrollView::SetScrollFlickDuration(float time)
 380 {
 381   GetImpl(*this).SetScrollFlickDuration(time);
 382 }
 383
 384 void ScrollView::SetRulerX(RulerPtr ruler)
 385 {
 386   GetImpl(*this).SetRulerX(ruler);
 387 }
 388
 389 void ScrollView::SetRulerY(RulerPtr ruler)
 390 {
 391   GetImpl(*this).SetRulerY(ruler);
 392 }
 393
 394 void ScrollView::SetScrollSensitive(bool sensitive)
 395 {
 396   GetImpl(*this).SetScrollSensitive(sensitive);
 397 }
 398
 399 void ScrollView::SetMaxOvershoot(float overshootX, float overshootY)
 400 {
 401   GetImpl(*this).SetMaxOvershoot(overshootX, overshootY);
 402 }
 403
 404 void ScrollView::SetSnapOvershootAlphaFunction(AlphaFunction alpha)
 405 {
 406   GetImpl(*this).SetSnapOvershootAlphaFunction(alpha);
 407 }
 408
 409 void ScrollView::SetSnapOvershootDuration(float duration)
 410 {
 411   GetImpl(*this).SetSnapOvershootDuration(duration);
 412 }
 413
 414 void ScrollView::SetTouchesRequiredForPanning(unsigned int minTouches, unsigned int maxTouches, bool endOutside)
 415 {
 416   GetImpl(*this).SetTouchesRequiredForPanning(minTouches, maxTouches, endOutside);
 417 }
 418
 419 void ScrollView::SetActorAutoSnap(bool enable)
 420 {
 421   GetImpl(*this).SetActorAutoSnap(enable);
 422 }
 423
 424 void ScrollView::SetWrapMode(bool enable)
 425 {
 426   GetImpl(*this).SetWrapMode(enable);
 427 }
 428
 429 int ScrollView::GetScrollUpdateDistance() const
 430 {
 431   return GetImpl(*this).GetScrollUpdateDistance();
 432 }
 433
 434 void ScrollView::SetScrollUpdateDistance(int distance)
 435 {
 436   GetImpl(*this).SetScrollUpdateDistance(distance);
 437 }
 438
 439 bool ScrollView::GetAxisAutoLock() const
 440 {
 441   return GetImpl(*this).GetAxisAutoLock();
 442 }
 443
 444 void ScrollView::SetAxisAutoLock(bool enable)
 445 {
 446   GetImpl(*this).SetAxisAutoLock(enable);
 447 }
 448
 449 float ScrollView::GetAxisAutoLockGradient() const
 450 {
 451   return GetImpl(*this).GetAxisAutoLockGradient();
 452 }
 453
 454 void ScrollView::SetAxisAutoLockGradient(float gradient)
 455 {
 456   GetImpl(*this).SetAxisAutoLockGradient(gradient);
 457 }
 458
 459 float ScrollView::GetFrictionCoefficient() const
 460 {
 461   return GetImpl(*this).GetFrictionCoefficient();
 462 }
 463
 464 void ScrollView::SetFrictionCoefficient(float friction)
 465 {
 466   GetImpl(*this).SetFrictionCoefficient(friction);
 467 }
 468
 469 float ScrollView::GetFlickSpeedCoefficient() const
 470 {
 471   return GetImpl(*this).GetFlickSpeedCoefficient();
 472 }
 473
 474 void ScrollView::SetFlickSpeedCoefficient(float speed)
 475 {
 476   GetImpl(*this).SetFlickSpeedCoefficient(speed);
 477 }
 478
 479 Vector2 ScrollView::GetMinimumDistanceForFlick() const
 480 {
 481   return GetImpl(*this).GetMinimumDistanceForFlick();
 482 }
 483
 484 void ScrollView::SetMinimumDistanceForFlick( const Vector2& distance )
 485 {
 486   GetImpl(*this).SetMinimumDistanceForFlick(distance);
 487 }
 488
 489 float ScrollView::GetMinimumSpeedForFlick() const
 490 {
 491   return GetImpl(*this).GetMinimumSpeedForFlick();
 492 }
 493
 494 void ScrollView::SetMinimumSpeedForFlick( float speed )
 495 {
 496   GetImpl(*this).SetMinimumSpeedForFlick(speed);
 497 }
 498
 499 float ScrollView::GetMaxFlickSpeed() const
 500 {
 501   return GetImpl(*this).GetMaxFlickSpeed();
 502 }
 503
 504 void ScrollView::SetMaxFlickSpeed(float speed)
 505 {
 506   GetImpl(*this).SetMaxFlickSpeed(speed);
 507 }
 508
 509 Vector2 ScrollView::GetMouseWheelScrollDistanceStep() const
 510 {
 511   return GetImpl(*this).GetMouseWheelScrollDistanceStep();
 512 }
 513
 514 void ScrollView::SetMouseWheelScrollDistanceStep(Vector2 step)
 515 {
 516   GetImpl(*this).SetMouseWheelScrollDistanceStep(step);
 517 }
 518
 519 Vector3 ScrollView::GetCurrentScrollPosition() const
 520 {
 521   return GetImpl(*this).GetCurrentScrollPosition();
 522 }
 523
 524 void ScrollView::SetScrollPosition(const Vector3& position)
 525 {
 526   GetImpl(*this).SetScrollPosition(position);
 527 }
 528
 529 unsigned int ScrollView::GetCurrentPage() const
 530 {
 531   return GetImpl(*this).GetCurrentPage();
 532 }
 533
 534 void ScrollView::ScrollTo(const Vector3 &position)
 535 {
 536   GetImpl(*this).ScrollTo(position);
 537 }
 538
 539 void ScrollView::ScrollTo(const Vector3 &position, float duration)
 540 {
 541   GetImpl(*this).ScrollTo(position, duration);
 542 }
 543
 544 void ScrollView::ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha)
 545 {
 546   GetImpl(*this).ScrollTo(position, duration, alpha);
 547 }
 548
 549 void ScrollView::ScrollTo(const Vector3 &position, float duration,
 550                           DirectionBias horizontalBias, DirectionBias verticalBias)
 551 {
 552   GetImpl(*this).ScrollTo(position, duration, horizontalBias, verticalBias);
 553 }
 554
 555 void ScrollView::ScrollTo(const Vector3 &position, float duration, AlphaFunction alpha,
 556                           DirectionBias horizontalBias, DirectionBias verticalBias)
 557 {
 558   GetImpl(*this).ScrollTo(position, duration, alpha, horizontalBias, verticalBias);
 559 }
 560
 561 void ScrollView::ScrollTo(unsigned int page)
 562 {
 563   GetImpl(*this).ScrollTo(page);
 564 }
 565
 566 void ScrollView::ScrollTo(unsigned int page, float duration)
 567 {
 568   GetImpl(*this).ScrollTo(page, duration);
 569 }
 570
 571 void ScrollView::ScrollTo(unsigned int page, float duration, DirectionBias bias)
 572 {
 573   GetImpl(*this).ScrollTo(page, duration, bias);
 574 }
 575
 576 void ScrollView::ScrollTo(Actor &actor)
 577 {
 578   GetImpl(*this).ScrollTo(actor);
 579 }
 580
 581 void ScrollView::ScrollTo(Actor &actor, float duration)
 582 {
 583   GetImpl(*this).ScrollTo(actor, duration);
 584 }
 585
 586 bool ScrollView::ScrollToSnapPoint()
 587 {
 588   return GetImpl(*this).ScrollToSnapPoint();
 589 }
 590
 591 void ScrollView::ApplyConstraintToChildren(Constraint constraint)
 592 {
 593   GetImpl(*this).ApplyConstraintToChildren(constraint);
 594 }
 595
 596 void ScrollView::RemoveConstraintsFromChildren()
 597 {
 598   GetImpl(*this).RemoveConstraintsFromChildren();
 599 }
 600
 601 void ScrollView::ApplyEffect(ScrollViewEffect effect)
 602 {
 603   GetImpl(*this).ApplyEffect(effect);
 604 }
 605
 606 ScrollViewEffect ScrollView::ApplyEffect(ScrollView::PageEffect effect)
 607 {
 608   return GetImpl(*this).ApplyEffect(effect);
 609 }
 610
 611 void ScrollView::RemoveEffect(ScrollViewEffect effect)
 612 {
 613   GetImpl(*this).RemoveEffect(effect);
 614 }
 615
 616 void ScrollView::RemoveAllEffects()
 617 {
 618   GetImpl(*this).RemoveAllEffects();
 619 }
 620
 621 void ScrollView::BindActor(Actor child)
 622 {
 623   GetImpl(*this).BindActor(child);
 624 }
 625
 626 void ScrollView::UnbindActor(Actor child)
 627 {
 628   GetImpl(*this).UnbindActor(child);
 629 }
 630
 631 ScrollView::SnapStartedSignalV2& ScrollView::SnapStartedSignal()
 632 {
 633   return GetImpl(*this).SnapStartedSignal();
 634 }
 635
 636 void ScrollView::SetScrollingDirection( Radian direction, Radian threshold )
 637 {
 638   GetImpl(*this).SetScrollingDirection( direction, threshold );
 639 }
 640
 641 void ScrollView::RemoveScrollingDirection( Radian direction )
 642 {
 643   GetImpl(*this).RemoveScrollingDirection( direction );
 644 }
 645
 646 } // namespace Toolkit
 647
 648 } // namespace Dali