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.
18 #include <dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h>
19 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
26 const char* DEFAULT_INDICATOR_IMAGE_PATH = DALI_IMAGE_DIR "popup_scroll.png";
27 const Vector4 DEFAULT_INDICATOR_NINE_PATCH_BORDER(4.0f, 9.0f, 7.0f, 11.0f);
28 const float MINIMUM_INDICATOR_HEIGHT(20.0f); // The minimum indicator height for the nine patch border
29 const float DEFAULT_SLIDER_DEPTH(1.0f);
30 const float DEFAULT_INDICATOR_SHOW_DURATION(0.5f);
31 const float DEFAULT_INDICATOR_HIDE_DURATION(0.5f);
32 const float DEFAULT_PAN_GESTURE_PROCESS_TIME(16.7f); // 16.7 milliseconds, i.e. one frame
33 const float DEFAULT_INDICATOR_FIXED_HEIGHT(80.0f);
36 * Indicator size constraint
37 * Indicator size depends on both indicator's parent size and the scroll content size
39 struct IndicatorSizeConstraint
42 * @param[in] contentSize The size of scrollable content
44 IndicatorSizeConstraint(float contentSize)
45 : mContentSize(contentSize)
51 * @param[in] current The current indicator size
52 * @param[in] parentSizeProperty The parent size of scroll indicator.
53 * @return The new scroll indicator size.
55 Vector3 operator()(const Vector3& current,
56 const PropertyInput& parentSizeProperty)
58 const Vector3& parentSize = parentSizeProperty.GetVector3();
59 float height = mContentSize > parentSize.height ? parentSize.height * ( parentSize.height / mContentSize ) : parentSize.height * ( (parentSize.height - mContentSize * 0.5f) / parentSize.height);
60 return Vector3( parentSize.width, std::max(MINIMUM_INDICATOR_HEIGHT, height), parentSize.depth );
63 float mContentSize; ///< The size of scrollable content
67 * Indicator position constraint
68 * Positions the indicator to reflect the current scroll position within the scroll domain.
70 struct IndicatorPositionConstraint
73 * @param[in] minPosition The minimum limit of scroll position
74 * @param[in] maxPosition the maximum limit of scroll position
76 IndicatorPositionConstraint(float minPosition, float maxPosition)
77 : mMinPosition(minPosition),
78 mMaxPosition(maxPosition)
84 * @param[in] current The current indicator position
85 * @param[in] indicatorSizeProperty The size of indicator.
86 * @param[in] parentSizeProperty The parent size of indicator.
87 * @param[in] scrollPositionProperty The scroll position of the scrollable container // (from 0.0 -> 1.0 in each axis)
88 * @return The new indicator position is returned.
90 Vector3 operator()(const Vector3& current,
91 const PropertyInput& indicatorSizeProperty,
92 const PropertyInput& parentSizeProperty,
93 const PropertyInput& scrollPositionProperty)
95 Vector3 indicatorSize = indicatorSizeProperty.GetVector3();
96 Vector3 parentSize = parentSizeProperty.GetVector3();
97 float scrollPosition = scrollPositionProperty.GetFloat();
99 const float domainSize = fabs(mMaxPosition - mMinPosition);
100 float relativePosition = (mMaxPosition - scrollPosition) / domainSize;
101 return Vector3(current.x, relativePosition * (parentSize.height - indicatorSize.height), DEFAULT_SLIDER_DEPTH);
104 float mMinPosition; ///< The minimum scroll position
105 float mMaxPosition; ///< The maximum scroll position
108 } // unnamed namespace
116 const Property::Index ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX );
117 const Property::Index ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 1 );
118 const Property::Index ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 2 );
119 const Property::Index ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION( Internal::ScrollBar::SCROLLBAR_PROPERTY_START_INDEX + 3 );
127 using namespace Dali;
129 const char* INDICATOR_HEIGHT_POLICY_NAME[] = {"Variable", "Fixed"};
133 return Toolkit::ScrollBar::New();
136 TypeRegistration typeRegistration( typeid(Toolkit::ScrollBar), typeid(Toolkit::ScrollComponent), Create );
138 PropertyRegistration property1( typeRegistration, "indicator-height-policy", Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY, Property::STRING, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
139 PropertyRegistration property2( typeRegistration, "indicator-fixed-height", Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
140 PropertyRegistration property3( typeRegistration, "indicator-show-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
141 PropertyRegistration property4( typeRegistration, "indicator-hide-duration", Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION, Property::FLOAT, &ScrollBar::SetProperty, &ScrollBar::GetProperty );
144 ScrollBar::ScrollBar()
145 : mIndicatorShowDuration(DEFAULT_INDICATOR_SHOW_DURATION),
146 mIndicatorHideDuration(DEFAULT_INDICATOR_HIDE_DURATION),
149 mCurrentScrollPosition(0.0f),
150 mIndicatorHeightPolicy(Toolkit::ScrollBar::Variable),
151 mIndicatorFixedHeight(DEFAULT_INDICATOR_FIXED_HEIGHT)
155 ScrollBar::~ScrollBar()
159 void ScrollBar::OnInitialize()
163 Image indicatorImage = Image::New( DEFAULT_INDICATOR_IMAGE_PATH );
164 mIndicator = ImageActor::New( indicatorImage );
165 mIndicator.SetNinePatchBorder( DEFAULT_INDICATOR_NINE_PATCH_BORDER );
166 mIndicator.SetStyle( ImageActor::STYLE_NINE_PATCH );
167 mIndicator.SetParentOrigin( ParentOrigin::TOP_LEFT );
168 mIndicator.SetAnchorPoint( AnchorPoint::TOP_LEFT );
169 self.Add(mIndicator);
171 self.SetDrawMode(DrawMode::OVERLAY);
173 // Enable the pan gesture which is attached to the control
174 EnableGestureDetection(Gesture::Type(Gesture::Pan));
177 void ScrollBar::OnScrollConnectorSet( Toolkit::ScrollConnector oldConnector )
181 oldConnector.DomainChangedSignal().Disconnect(this, &ScrollBar::OnScrollDomainChanged);
183 mScrollPositionObject.Reset();
186 if( mScrollConnector )
188 mScrollPositionObject = mScrollConnector.GetScrollPositionObject();
191 mScrollConnector.DomainChangedSignal().Connect(this, &ScrollBar::OnScrollDomainChanged);
195 void ScrollBar::SetIndicatorImage( Image image )
197 mIndicator.SetImage(image);
200 Actor ScrollBar::GetScrollIndicator()
205 void ScrollBar::ApplyConstraints()
207 if( mScrollConnector )
209 Constraint constraint;
211 if(mIndicatorSizeConstraint)
213 mIndicator.RemoveConstraint(mIndicatorSizeConstraint);
216 // Set indicator height according to the indicator's height policy
217 if(mIndicatorHeightPolicy == Toolkit::ScrollBar::Fixed)
219 mIndicator.SetSize(Self().GetCurrentSize().width, mIndicatorFixedHeight);
223 constraint = Constraint::New<Vector3>( Actor::SIZE,
224 ParentSource( Actor::SIZE ),
225 IndicatorSizeConstraint( mScrollConnector.GetContentLength() ) );
226 mIndicatorSizeConstraint = mIndicator.ApplyConstraint( constraint );
229 if(mIndicatorPositionConstraint)
231 mIndicator.RemoveConstraint(mIndicatorPositionConstraint);
234 constraint = Constraint::New<Vector3>( Actor::POSITION,
235 LocalSource( Actor::SIZE ),
236 ParentSource( Actor::SIZE ),
237 Source( mScrollPositionObject, Toolkit::ScrollConnector::SCROLL_POSITION ),
238 IndicatorPositionConstraint( mScrollConnector.GetMinLimit(), mScrollConnector.GetMaxLimit() ) );
239 mIndicatorPositionConstraint = mIndicator.ApplyConstraint( constraint );
243 mBackground.RemoveConstraints();
245 constraint = Constraint::New<Vector3>(Actor::SIZE,
246 ParentSource(Actor::SIZE),
247 EqualToConstraint());
248 mBackground.ApplyConstraint(constraint);
253 void ScrollBar::SetPositionNotifications( const std::vector<float>& positions )
255 if(mScrollPositionObject)
257 if(mPositionNotification)
259 mScrollPositionObject.RemovePropertyNotification(mPositionNotification);
261 mPositionNotification = mScrollPositionObject.AddPropertyNotification( Toolkit::ScrollConnector::SCROLL_POSITION, VariableStepCondition(positions) );
262 mPositionNotification.NotifySignal().Connect( this, &ScrollBar::OnScrollPositionNotified );
266 void ScrollBar::OnScrollPositionNotified(PropertyNotification& source)
268 // Emit the signal to notify the scroll position crossing
269 mScrollPositionNotifiedSignal.Emit(mScrollConnector.GetScrollPosition());
272 void ScrollBar::Show()
274 // Cancel any animation
281 if(mIndicatorShowDuration > 0.0f)
283 mAnimation = Animation::New( mIndicatorShowDuration );
284 mAnimation.OpacityTo( Self(), 1.0f, AlphaFunctions::EaseIn );
289 Self().SetOpacity(1.0f);
293 void ScrollBar::Hide()
295 // Cancel any animation
302 if(mIndicatorHideDuration > 0.0f)
304 mAnimation = Animation::New( mIndicatorHideDuration );
305 mAnimation.OpacityTo( Self(), 0.0f, AlphaFunctions::EaseIn );
310 Self().SetOpacity(0.0f);
314 bool ScrollBar::OnPanGestureProcessTick()
316 // Update the scroll position property.
317 if( mScrollConnector )
319 mScrollConnector.SetScrollPosition(mCurrentScrollPosition);
325 void ScrollBar::OnPan( PanGesture gesture )
329 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast(Self().GetParent());
331 switch(gesture.state)
333 case Gesture::Started:
337 // Make sure the pan gesture is only being processed once per frame.
338 mTimer = Timer::New( DEFAULT_PAN_GESTURE_PROCESS_TIME );
339 mTimer.TickSignal().Connect( this, &ScrollBar::OnPanGestureProcessTick );
344 mScrollStart = mScrollConnector.GetScrollPosition();
345 mGestureDisplacement = Vector3::ZERO;
350 case Gesture::Continuing:
352 Vector3 delta(gesture.displacement.x, gesture.displacement.y, 0.0f);
353 mGestureDisplacement+=delta;
355 Vector3 span = Self().GetCurrentSize() - mIndicator.GetCurrentSize();
356 const float domainSize = fabs(mScrollConnector.GetMaxLimit() - mScrollConnector.GetMinLimit());
357 mCurrentScrollPosition = mScrollStart - mGestureDisplacement.y * domainSize / span.y;
358 mCurrentScrollPosition = std::min(mScrollConnector.GetMaxLimit(), std::max(mCurrentScrollPosition, mScrollConnector.GetMinLimit()));
368 // Destroy the timer when pan gesture is finished.
370 mTimer.TickSignal().Disconnect( this, &ScrollBar::OnPanGestureProcessTick );
376 // Refresh the ItemView cache with extra items
377 GetImpl(itemView).DoRefresh(mCurrentScrollPosition, true);
386 // Disable automatic refresh in ItemView during fast scrolling
387 GetImpl(itemView).SetRefreshEnabled(!mIsPanning);
392 void ScrollBar::OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize)
394 // Reapply constraints when the scroll domain is changed
398 void ScrollBar::SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy )
400 mIndicatorHeightPolicy = policy;
404 Toolkit::ScrollBar::IndicatorHeightPolicy ScrollBar::GetIndicatorHeightPolicy()
406 return mIndicatorHeightPolicy;
409 void ScrollBar::SetIndicatorFixedHeight( float height )
411 mIndicatorFixedHeight = height;
415 float ScrollBar::GetIndicatorFixedHeight()
417 return mIndicatorFixedHeight;
420 void ScrollBar::SetIndicatorShowDuration( float durationSeconds )
422 mIndicatorShowDuration = durationSeconds;
425 float ScrollBar::GetIndicatorShowDuration()
427 return mIndicatorShowDuration;
430 void ScrollBar::SetIndicatorHideDuration( float durationSeconds )
432 mIndicatorHideDuration = durationSeconds;
435 float ScrollBar::GetIndicatorHideDuration()
437 return mIndicatorHideDuration;
440 void ScrollBar::OnIndicatorHeightPolicyPropertySet( Property::Value propertyValue )
442 std::string policyName( propertyValue.Get<std::string>() );
443 if(policyName == "Variable")
445 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Variable);
447 else if(policyName == "Fixed")
449 SetIndicatorHeightPolicy(Toolkit::ScrollBar::Fixed);
453 DALI_ASSERT_ALWAYS( !"ScrollBar::OnIndicatorHeightPolicyPropertySet(). Invalid Property value." );
457 void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
459 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
463 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
466 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
468 scrollBarImpl.OnIndicatorHeightPolicyPropertySet( value );
471 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
473 scrollBarImpl.SetIndicatorFixedHeight(value.Get<float>());
476 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
478 scrollBarImpl.SetIndicatorShowDuration(value.Get<float>());
481 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
483 scrollBarImpl.SetIndicatorHideDuration(value.Get<float>());
490 Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index index )
492 Property::Value value;
494 Toolkit::ScrollBar scrollBar = Toolkit::ScrollBar::DownCast( Dali::BaseHandle( object ) );
498 ScrollBar& scrollBarImpl( GetImpl( scrollBar ) );
501 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HEIGHT_POLICY:
503 value = INDICATOR_HEIGHT_POLICY_NAME[ scrollBarImpl.GetIndicatorHeightPolicy() ];
506 case Toolkit::ScrollBar::PROPERTY_INDICATOR_FIXED_HEIGHT:
508 value = scrollBarImpl.GetIndicatorFixedHeight();
511 case Toolkit::ScrollBar::PROPERTY_INDICATOR_SHOW_DURATION:
513 value = scrollBarImpl.GetIndicatorShowDuration();
516 case Toolkit::ScrollBar::PROPERTY_INDICATOR_HIDE_DURATION:
518 value = scrollBarImpl.GetIndicatorHideDuration();
526 Toolkit::ScrollBar ScrollBar::New()
528 // Create the implementation, temporarily owned by this handle on stack
529 IntrusivePtr< ScrollBar > impl = new ScrollBar();
531 // Pass ownership to CustomActor handle
532 Toolkit::ScrollBar handle( *impl );
534 // Second-phase init of the implementation
535 // This can only be done after the CustomActor connection has been made...
541 } // namespace Internal
543 } // namespace Toolkit