2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h>
22 #include <dali/public-api/animation/constraint.h>
23 #include <dali/public-api/animation/constraints.h>
24 #include <dali/public-api/object/type-registry.h>
25 #include <dali/public-api/images/resource-image.h>
28 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
35 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
36 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
37 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
38 const float DEFAULT_SLIDER_DEPTH(1.0f);
39 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
40 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
41 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
42 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
45 * Indicator size depends on both indicator's parent size and the scroll content size
47 Vector3 IndicatorSize( const Vector3& parentSize, float contentSize)
49 float height = contentSize > parentSize.height ?
50 parentSize.height * ( parentSize.height / contentSize ) :
51 parentSize.height * ( (parentSize.height - contentSize * 0.5f) / parentSize.height);
52 return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
56 * Indicator position constraint
57 * Positions the indicator to reflect the current scroll position within the scroll domain.
59 struct IndicatorPositionConstraint
62 * @param[in] minPosition The minimum limit of scroll position
63 * @param[in] maxPosition the maximum limit of scroll position
65 IndicatorPositionConstraint(float minPosition, float maxPosition)
66 : mMinPosition(minPosition),
67 mMaxPosition(maxPosition)
73 * @param[in] current The current indicator position
74 * @param[in] indicatorSizeProperty The size of indicator.
75 * @param[in] parentSizeProperty The parent size of indicator.
76 * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
77 * @return The new indicator position is returned.
79 Vector3 operator()(const Vector3& current,
80 const PropertyInput& indicatorSizeProperty,
81 const PropertyInput& parentSizeProperty,
82 const PropertyInput& scrollPositionProperty)
84 Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
85 Vector3 parentSize = parentSizeProperty.GetVector3();
86 float scrollPosition = scrollPositionProperty.GetFloat();
88 const float domainSize = fabs(mMaxPosition - mMinPosition);
89 float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
90 return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
93 float mMinPosition; ///< The minimum scroll position
94 float mMaxPosition; ///< The maximum scroll position
97 } // unnamed namespace
105 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
106 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
107 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
108 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
116 using namespace Dali;
118 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
122 return Toolkit::ScrollBar::New();
125 TypeRegistration typeRegistration( typeid( Toolkit::ScrollBar ), typeid( Toolkit::ScrollComponent ), Create );
127 const char* const SCROLL_POSITION_NOTIFIED_SIGNAL_NAME = "scroll-position-notified";
129 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
130 PropertyRegistration property2( typeRegistration, "indicator-fixed-height", Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
131 PropertyRegistration property3( typeRegistration, "indicator-show-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
132 PropertyRegistration property4( typeRegistration, "indicator-hide-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
135 ScrollBar::ScrollBar()
136 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
137 mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
140 mCurrentScrollPosition(0.0f),
141 mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
142 mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT),
143 mPropertyIndicatorPosition(Property::INVALID_INDEX)
147 ScrollBar::~ScrollBar()
151 void ScrollBar::OnInitialize()
155 Image indicatorImage = ResourceImage::New( DEFAULT_INDICATOR_IMAGE_PATH );
156 mIndicator = ImageActor::New( indicatorImage );
157 mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
158 mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
159 mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
160 mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
161 self.Add(mIndicator);
163 self.SetDrawMode(DrawMode::OVERLAY);
165 // Enable the pan gesture which is attached to the control
166 EnableGestureDetection(Gesture::Type(Gesture::Pan));
169 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
173 oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
175 mScrollPositionObject.Reset();
178 if( mScrollConnector )
180 mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
183 mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
187 void ScrollBar::SetIndicatorImage( Image image )
189 mIndicator.SetImage(image);
192 Actor ScrollBar::GetScrollIndicator()
197 void ScrollBar::ApplyConstraints()
199 if( mScrollConnector )
201 Constraint constraint;
203 if(mIndicatorSizeConstraint)
205 mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
208 // Set indicator height according to the indicator's height policy
209 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
211 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
215 mIndicator.SetSize( IndicatorSize( Self().GetCurrentSize(), mScrollConnector.GetContentLength() ) );
218 if(mIndicatorPositionConstraint)
220 mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
223 constraint = Constraint::New<Vector3>( Actor::Property::Position,
224 LocalSource( Actor::Property::Size ),
225 ParentSource( Actor::Property::Size ),
226 Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
227 IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
228 mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
232 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
234 if(mScrollPositionObject)
236 if(mPositionNotification)
238 mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
240 mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
241 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
245 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
247 // Emit the signal to notify the scroll position crossing
248 mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
251 void ScrollBar::Show()
253 // Cancel any animation
260 if(mIndicatorShowDuration > 0.0f)
262 mAnimation = Animation::New( mIndicatorShowDuration );
263 mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
268 Self().SetOpacity(1.0f);
272 void ScrollBar::Hide()
274 // Cancel any animation
281 if(mIndicatorHideDuration > 0.0f)
283 mAnimation = Animation::New( mIndicatorHideDuration );
284 mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
289 Self().SetOpacity(0.0f);
293 bool ScrollBar::OnPanGestureProcessTick()
295 // Update the scroll position property.
296 if( mScrollConnector )
298 mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
304 void ScrollBar::OnPan( PanGesture gesture )
308 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
310 switch(gesture.state)
312 case Gesture::Started:
316 // Make sure the pan gesture is only being processed once per frame.
317 mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
318 mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
323 mScrollStart = mScrollConnector.GetScrollPosition();
324 mGestureDisplacement = Vector3::ZERO;
329 case Gesture::Continuing:
331 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
332 mGestureDisplacement+=delta;
334 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
335 const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
336 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
337 mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
347 // Destroy the timer when pan gesture is finished.
349 mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
355 // Refresh the ItemView cache with extra items
356 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
365 // Disable automatic refresh in ItemView during fast scrolling
366 GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
371 void ScrollBar::OnControlSizeSet( const Vector3& size )
373 if(mIndicatorHeightPolicy != Toolkit::ScrollBar::Fixed && mScrollConnector)
375 mIndicator.SetSize( IndicatorSize( size, mScrollConnector.GetContentLength() ) );
379 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
381 // Reapply constraints when the scroll domain is changed
385 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
387 mIndicatorHeightPolicy = policy;
391 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
393 return mIndicatorHeightPolicy;
396 void ScrollBar::SetIndicatorFixedHeight( float height )
398 mIndicatorFixedHeight = height;
402 float ScrollBar::GetIndicatorFixedHeight()
404 return mIndicatorFixedHeight;
407 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
409 mIndicatorShowDuration = durationSeconds;
412 float ScrollBar::GetIndicatorShowDuration()
414 return mIndicatorShowDuration;
417 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
419 mIndicatorHideDuration = durationSeconds;
422 float ScrollBar::GetIndicatorHideDuration()
424 return mIndicatorHideDuration;
427 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
429 std::string policyName( propertyValue.Get<std::string>() );
430 if(policyName == "Variable")
432 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
434 else if(policyName == "Fixed")
436 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
440 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
444 bool ScrollBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
446 Dali::BaseHandle handle( object );
448 bool connected( true );
449 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( handle );
451 if( 0 == strcmp( signalName.c_str(), SCROLL_POSITION_NOTIFIED_SIGNAL_NAME ) )
453 scrollBar.ScrollPositionNotifiedSignal().Connect( tracker, functor );
457 // signalName does not match any signal
464 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
466 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
470 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
473 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
475 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
478 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
480 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
483 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
485 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
488 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
490 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
497 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
499 Property::Value value;
501 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
505 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
508 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
510 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
513 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
515 value = scrollBarImpl.GetIndicatorFixedHeight();
518 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
520 value = scrollBarImpl.GetIndicatorShowDuration();
523 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
525 value = scrollBarImpl.GetIndicatorHideDuration();
533 Toolkit::ScrollBar ScrollBar::New()
535 // Create the implementation, temporarily owned by this handle on stack
536 IntrusivePtr< ScrollBar > impl = new ScrollBar();
538 // Pass ownership to CustomActor handle
539 Toolkit::ScrollBar handle( *impl );
541 // Second-phase init of the implementation
542 // This can only be done after the CustomActor connection has been made...
548 } // namespace Internal
550 } // namespace Toolkit