dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.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/internal/controls/scroll-bar/scroll-bar-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/constraints.h>
  23 #include <dali/public-api/object/type-registry.h>
  24 #include <dali/public-api/images/resource-image.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
  28
  29 using namespace Dali;
  30
  31 namespace
  32 {
  33
  34 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
  35 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
  36 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
  37 const float DEFAULT_SLIDER_DEPTH(1.0f);
  38 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
  39 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
  40 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
  41 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
  42
  43 /**
  44  * Indicator size depends on both indicator's parent size and the scroll content size
  45  */
  46 Vector3 IndicatorSize( const Vector3& parentSize, float contentSize)
  47 {
  48   float height = contentSize > parentSize.height ?
  49                  parentSize.height * ( parentSize.height / contentSize ) :
  50                  parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height);
  51   return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
  52 }
  53
  54 /**
  55  * Indicator position constraint
  56  * Positions the indicator to reflect the current scroll position within the scroll domain.
  57  */
  58 struct IndicatorPositionConstraint
  59 {
  60   /**
  61    * @param[in] minPosition The minimum limit of scroll position
  62    * @param[in] maxPosition the maximum limit of scroll position
  63    */
  64   IndicatorPositionConstraint(float minPosition, float maxPosition)
  65   : mMinPosition(minPosition),
  66     mMaxPosition(maxPosition)
  67   {
  68   }
  69
  70   /**
  71    * Constraint operator
  72    * @param[in] current The current indicator position
  73    * @param[in] indicatorSizeProperty The size of indicator.
  74    * @param[in] parentSizeProperty The parent size of indicator.
  75    * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
  76    * @return The new indicator position is returned.
  77    */
  78   Vector3 operator()(const Vector3& current,
  79                      const PropertyInput& indicatorSizeProperty,
  80                      const PropertyInput& parentSizeProperty,
  81                      const PropertyInput& scrollPositionProperty)
  82   {
  83     Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
  84     Vector3 parentSize = parentSizeProperty.GetVector3();
  85     float scrollPosition = scrollPositionProperty.GetFloat();
  86
  87     const float domainSize = fabs(mMaxPosition - mMinPosition);
  88     float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
  89     return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
  90   }
  91
  92   float mMinPosition;  ///< The minimum scroll position
  93   float mMaxPosition;  ///< The maximum scroll position
  94 };
  95
  96 } // unnamed namespace
  97
  98 namespace Dali
  99 {
 100
 101 namespace Toolkit
 102 {
 103
 104 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
 105 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
 106 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
 107 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
 108
 109 namespace Internal
 110 {
 111
 112 namespace
 113 {
 114
 115 using namespace Dali;
 116
 117 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
 118
 119 BaseHandle Create()
 120 {
 121   return Toolkit::ScrollBar::New();
 122 }
 123
 124 TypeRegistration typeRegistration( typeid(Toolkit::ScrollBar), typeid(Toolkit::ScrollComponent), Create );
 125
 126 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 127 PropertyRegistration property2( typeRegistration, "indicator-fixed-height",  Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 128 PropertyRegistration property3( typeRegistration, "indicator-show-duration",  Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 129 PropertyRegistration property4( typeRegistration, "indicator-hide-duration",  Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION,  Property::FLOAT,  &ScrollBar::SetProperty, &ScrollBar::GetProperty );
 130 }
 131
 132 ScrollBar::ScrollBar()
 133 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
 134   mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
 135   mScrollStart(0.0f),
 136   mIsPanning(false),
 137   mCurrentScrollPosition(0.0f),
 138   mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
 139   mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
 140   mPropertyIndicatorPosition(Property::INVALID_INDEX)
 141 {
 142 }
 143
 144 ScrollBar::~ScrollBar()
 145 {
 146 }
 147
 148 void ScrollBar::OnInitialize()
 149 {
 150   Actor self = Self();
 151
 152   Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH );
 153   mIndicator = ImageActor::New( indicatorImage );
 154   mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
 155   mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
 156   mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
 157   mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
 158   self.Add(mIndicator);
 159
 160   self.SetDrawMode(DrawMode::OVERLAY);
 161
 162   // Enable the pan gesture which is attached to the control
 163   EnableGestureDetection(Gesture::Type(Gesture::Pan));
 164 }
 165
 166 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
 167 {
 168   if( oldConnector )
 169   {
 170     oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
 171
 172     mScrollPositionObject.Reset();
 173   }
 174
 175   if( mScrollConnector )
 176   {
 177     mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
 178
 179     ApplyConstraints();
 180     mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
 181   }
 182 }
 183
 184 void ScrollBar::SetIndicatorImage( Image image )
 185 {
 186   mIndicator.SetImage(image);
 187 }
 188
 189 Actor ScrollBar::GetScrollIndicator()
 190 {
 191   return mIndicator;
 192 }
 193
 194 void ScrollBar::ApplyConstraints()
 195 {
 196   if( mScrollConnector )
 197   {
 198     Constraint constraint;
 199
 200     if(mIndicatorSizeConstraint)
 201     {
 202       mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
 203     }
 204
 205     // Set indicator height according to the indicator's height policy
 206     if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
 207     {
 208       mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
 209     }
 210     else
 211     {
 212       mIndicator.SetSize( IndicatorSize( Self().GetCurrentSize(), mScrollConnector.GetContentLength() ) );
 213     }
 214
 215     if(mIndicatorPositionConstraint)
 216     {
 217       mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
 218     }
 219
 220     constraint = Constraint::New<Vector3>( Actor::POSITION,
 221                                            LocalSource( Actor::SIZE ),
 222                                            ParentSource( Actor::SIZE ),
 223                                            Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
 224                                            IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
 225     mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
 226   }
 227 }
 228
 229 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
 230 {
 231   if(mScrollPositionObject)
 232   {
 233     if(mPositionNotification)
 234     {
 235       mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
 236     }
 237     mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
 238     mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
 239   }
 240 }
 241
 242 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
 243 {
 244   // Emit the signal to notify the scroll position crossing
 245   mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
 246 }
 247
 248 void ScrollBar::Show()
 249 {
 250   // Cancel any animation
 251   if(mAnimation)
 252   {
 253     mAnimation.Clear();
 254     mAnimation.Reset();
 255   }
 256
 257   if(mIndicatorShowDuration > 0.0f)
 258   {
 259     mAnimation = Animation::New( mIndicatorShowDuration );
 260     mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
 261     mAnimation.Play();
 262   }
 263   else
 264   {
 265     Self().SetOpacity(1.0f);
 266   }
 267 }
 268
 269 void ScrollBar::Hide()
 270 {
 271   // Cancel any animation
 272   if(mAnimation)
 273   {
 274     mAnimation.Clear();
 275     mAnimation.Reset();
 276   }
 277
 278   if(mIndicatorHideDuration > 0.0f)
 279   {
 280     mAnimation = Animation::New( mIndicatorHideDuration );
 281     mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
 282     mAnimation.Play();
 283   }
 284   else
 285   {
 286     Self().SetOpacity(0.0f);
 287   }
 288 }
 289
 290 bool ScrollBar::OnPanGestureProcessTick()
 291 {
 292   // Update the scroll position property.
 293   if( mScrollConnector )
 294   {
 295     mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
 296   }
 297
 298   return true;
 299 }
 300
 301 void ScrollBar::OnPan( PanGesture gesture )
 302 {
 303   if(mScrollConnector)
 304   {
 305     Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
 306
 307     switch(gesture.state)
 308     {
 309       case Gesture::Started:
 310       {
 311         if( !mTimer )
 312         {
 313           // Make sure the pan gesture is only being processed once per frame.
 314           mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
 315           mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
 316           mTimer.Start();
 317         }
 318
 319         Show();
 320         mScrollStart = mScrollConnector.GetScrollPosition();
 321         mGestureDisplacement = Vector3::ZERO;
 322         mIsPanning = true;
 323
 324         break;
 325       }
 326       case Gesture::Continuing:
 327       {
 328         Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
 329         mGestureDisplacement+=delta;
 330
 331         Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
 332         const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
 333         mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
 334         mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
 335
 336         break;
 337       }
 338       default:
 339       {
 340         mIsPanning = false;
 341
 342         if( mTimer )
 343         {
 344           // Destroy the timer when pan gesture is finished.
 345           mTimer.Stop();
 346           mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
 347           mTimer.Reset();
 348         }
 349
 350         if(itemView)
 351         {
 352           // Refresh the ItemView cache with extra items
 353           GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
 354         }
 355
 356         break;
 357       }
 358     }
 359
 360     if(itemView)
 361     {
 362       // Disable automatic refresh in ItemView during fast scrolling
 363       GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
 364     }
 365   }
 366 }
 367
 368 void ScrollBar::OnControlSizeSet( const Vector3& size )
 369 {
 370   if(mIndicatorHeightPolicy != Toolkit::ScrollBar::Fixed && mScrollConnector)
 371   {
 372     mIndicator.SetSize( IndicatorSize( size, mScrollConnector.GetContentLength() ) );
 373   }
 374 }
 375
 376 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
 377 {
 378   // Reapply constraints when the scroll domain is changed
 379   ApplyConstraints();
 380 }
 381
 382 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
 383 {
 384   mIndicatorHeightPolicy = policy;
 385   ApplyConstraints();
 386 }
 387
 388 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
 389 {
 390   return mIndicatorHeightPolicy;
 391 }
 392
 393 void ScrollBar::SetIndicatorFixedHeight( float height )
 394 {
 395   mIndicatorFixedHeight = height;
 396   ApplyConstraints();
 397 }
 398
 399 float ScrollBar::GetIndicatorFixedHeight()
 400 {
 401   return mIndicatorFixedHeight;
 402 }
 403
 404 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
 405 {
 406   mIndicatorShowDuration = durationSeconds;
 407 }
 408
 409 float ScrollBar::GetIndicatorShowDuration()
 410 {
 411   return mIndicatorShowDuration;
 412 }
 413
 414 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
 415 {
 416   mIndicatorHideDuration = durationSeconds;
 417 }
 418
 419 float ScrollBar::GetIndicatorHideDuration()
 420 {
 421   return mIndicatorHideDuration;
 422 }
 423
 424 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
 425 {
 426   std::string policyName( propertyValue.Get<std::string>() );
 427   if(policyName == "Variable")
 428   {
 429     SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
 430   }
 431   else if(policyName == "Fixed")
 432   {
 433     SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
 434   }
 435   else
 436   {
 437     DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
 438   }
 439 }
 440
 441 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 442 {
 443   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 444
 445   if( scrollBar )
 446   {
 447     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 448     switch( index )
 449     {
 450       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
 451       {
 452         scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
 453         break;
 454       }
 455       case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
 456       {
 457         scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
 458         break;
 459       }
 460       case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
 461       {
 462         scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
 463         break;
 464       }
 465       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
 466       {
 467         scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
 468         break;
 469       }
 470     }
 471   }
 472 }
 473
 474 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
 475 {
 476   Property::Value value;
 477
 478   Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
 479
 480   if( scrollBar )
 481   {
 482     ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
 483     switch( index )
 484     {
 485       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
 486       {
 487         value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
 488         break;
 489       }
 490       case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
 491       {
 492         value = scrollBarImpl.GetIndicatorFixedHeight();
 493         break;
 494       }
 495       case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
 496       {
 497         value = scrollBarImpl.GetIndicatorShowDuration();
 498         break;
 499       }
 500       case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
 501       {
 502         value = scrollBarImpl.GetIndicatorHideDuration();
 503         break;
 504       }
 505     }
 506   }
 507   return value;
 508 }
 509
 510 Toolkit::ScrollBar ScrollBar::New()
 511 {
 512   // Create the implementation, temporarily owned by this handle on stack
 513   IntrusivePtr< ScrollBar > impl = new ScrollBar();
 514
 515   // Pass ownership to CustomActor handle
 516   Toolkit::ScrollBar handle( *impl );
 517
 518   // Second-phase init of the implementation
 519   // This can only be done after the CustomActor connection has been made...
 520   impl->Initialize();
 521
 522   return handle;
 523 }
 524
 525 } // namespace Internal
 526
 527 } // namespace Toolkit
 528
 529 } // namespace Dali