2 * Copyright (c) 2015 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/public-api/controls/scrollable/item-view/item-layout.h>
22 #include <dali/public-api/animation/animation.h>
23 #include <dali/public-api/animation/constraint.h>
24 #include <dali/public-api/animation/time-period.h>
27 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
32 // Lerps between initial and target using the progress
33 template< typename Type >
34 void Lerp( Type& current, const Type& initial, const Type& target, float progress )
36 current = initial + ((target - initial) * progress);
39 // Functors which wrap constraint functions with stored item IDs
40 struct WrappedQuaternionConstraint
42 WrappedQuaternionConstraint( Dali::Toolkit::ItemLayout::QuaternionFunction wrapMe, unsigned int itemId )
49 void operator()( Dali::Quaternion& current, const Dali::PropertyInputContainer& inputs )
51 float offsetLayoutPosition = inputs[0]->GetFloat() + static_cast<float>(mItemId);
52 float weight = inputs[3]->GetFloat();
60 current = Dali::Quaternion::Slerp( mInitial, mWrapMe( current, offsetLayoutPosition, inputs[1]->GetFloat(), inputs[2]->GetVector3() ), weight );
63 Dali::Toolkit::ItemLayout::QuaternionFunction mWrapMe;
65 Dali::Quaternion mInitial;
69 struct WrappedVector3Constraint
71 WrappedVector3Constraint( Dali::Toolkit::ItemLayout::Vector3Function wrapMe, unsigned int itemId )
79 void operator()( Dali::Vector3& current, const Dali::PropertyInputContainer& inputs )
81 float offsetLayoutPosition = inputs[0]->GetFloat() + static_cast<float>(mItemId);
82 float weight = inputs[3]->GetFloat();
90 Lerp( current, mInitial, mWrapMe( current, offsetLayoutPosition, inputs[1]->GetFloat(), inputs[2]->GetVector3() ), weight );
93 Dali::Toolkit::ItemLayout::Vector3Function mWrapMe;
95 Dali::Vector3 mInitial;
99 struct WrappedVector4Constraint
101 WrappedVector4Constraint( Dali::Toolkit::ItemLayout::Vector4Function wrapMe, unsigned int itemId )
105 mInitialised( false )
109 void operator()( Dali::Vector4& current, const Dali::PropertyInputContainer& inputs )
111 float offsetLayoutPosition = inputs[0]->GetFloat() + static_cast<float>(mItemId);
112 float weight = inputs[3]->GetFloat();
120 Lerp( current, mInitial, mWrapMe( current, offsetLayoutPosition, inputs[1]->GetFloat(), inputs[2]->GetVector3() ), weight );
123 Dali::Toolkit::ItemLayout::Vector4Function mWrapMe;
124 unsigned int mItemId;
125 Dali::Vector4 mInitial;
129 struct WrappedBoolConstraint
131 WrappedBoolConstraint( Dali::Toolkit::ItemLayout::BoolFunction wrapMe, unsigned int itemId )
137 void operator()( bool& current, const Dali::PropertyInputContainer& inputs )
139 float weight = inputs[3]->GetFloat();
141 if ( weight >= 1.0f )
143 float offsetLayoutPosition = inputs[0]->GetFloat() + static_cast<float>(mItemId);
144 current = mWrapMe( current, offsetLayoutPosition, inputs[1]->GetFloat(), inputs[2]->GetVector3() );
148 Dali::Toolkit::ItemLayout::BoolFunction mWrapMe;
149 unsigned int mItemId;
152 } //Unnamed namespace
160 ItemLayout::ItemLayout()
161 : mOrientation( ControlOrientation::Up ),
162 mAlphaFunction( AlphaFunction::LINEAR ),
167 ItemLayout::~ItemLayout()
171 void ItemLayout::SetOrientation(ControlOrientation::Type orientation)
173 mOrientation = orientation;
176 ControlOrientation::Type ItemLayout::GetOrientation() const
181 float ItemLayout::GetClosestOnScreenLayoutPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize)
183 Vector3 itemPosition = GetItemPosition( itemID, currentLayoutPosition, layoutSize );
185 GetItemSize(itemID, layoutSize, itemSize);
186 Vector3 onScreenArea = (layoutSize - itemSize) * 0.5f;
187 if (itemPosition.x < -onScreenArea.x
188 || itemPosition.x > onScreenArea.x
189 || itemPosition.y < -onScreenArea.y
190 || itemPosition.y > onScreenArea.y)
192 // item not within viewable area
193 // safest thing to do here since we have no idea how the implementation will work is to return the scroll to position
194 return GetItemScrollToPosition(itemID);
196 return currentLayoutPosition;
199 int ItemLayout::GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled)
209 itemID = loopEnabled ? maxItems - 1 : 0;
217 if( itemID >= maxItems )
219 itemID = loopEnabled ? 0 : maxItems - 1;
227 float ItemLayout::GetFlickSpeedFactor() const
229 // By default, the speed factor while dragging and swiping is the same.
230 return GetScrollSpeedFactor();
233 void ItemLayout::ApplyConstraints( Actor& actor, const int itemId, const float durationSeconds, Handle scrollPositionObject, const Actor& itemViewActor )
235 // This just implements the default behaviour of constraint application.
236 // Custom layouts can override this function to apply their custom constraints.
237 Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast( itemViewActor );
238 if(itemView && scrollPositionObject)
240 Property::Index scrollSpeedProperty = itemView.GetPropertyIndex("item-view-scroll-speed");
241 Property::Index scrollPositionProperty = scrollPositionObject.GetPropertyIndex("scroll-position");
243 // We want to animate the layout in so use a weight object to do this
244 if ( !mWeightObject )
246 mWeightObject = WeightObject::New();
249 ItemLayout::Vector3Function positionConstraint;
250 if (GetPositionConstraint(itemId, positionConstraint))
252 WrappedVector3Constraint wrapped(positionConstraint, itemId);
253 Constraint constraint = Constraint::New<Vector3>( actor, Actor::Property::POSITION, wrapped );
254 constraint.AddSource( Source( scrollPositionObject, scrollPositionProperty ) );
255 constraint.AddSource( ParentSource( scrollSpeedProperty ) );
256 constraint.AddSource( ParentSource( Actor::Property::SIZE ) );
257 constraint.AddSource( Source( mWeightObject, WeightObject::WEIGHT ) );
261 ItemLayout::QuaternionFunction rotationConstraint;
262 if (GetRotationConstraint(itemId, rotationConstraint))
264 WrappedQuaternionConstraint wrapped(rotationConstraint, itemId);
266 Constraint constraint = Constraint::New<Quaternion>( actor, Actor::Property::ORIENTATION, wrapped );
267 constraint.AddSource( Source( scrollPositionObject, scrollPositionProperty ) );
268 constraint.AddSource( ParentSource( scrollSpeedProperty ) );
269 constraint.AddSource( ParentSource( Actor::Property::SIZE ) );
270 constraint.AddSource( Source( mWeightObject, WeightObject::WEIGHT ) );
274 ItemLayout::Vector3Function scaleConstraint;
275 if (GetScaleConstraint(itemId, scaleConstraint))
277 WrappedVector3Constraint wrapped(scaleConstraint, itemId);
279 Constraint constraint = Constraint::New<Vector3>( actor, Actor::Property::SCALE, wrapped );
280 constraint.AddSource( Source( scrollPositionObject, scrollPositionProperty ) );
281 constraint.AddSource( ParentSource( scrollSpeedProperty ) );
282 constraint.AddSource( ParentSource( Actor::Property::SIZE ) );
283 constraint.AddSource( Source( mWeightObject, WeightObject::WEIGHT ) );
287 ItemLayout::Vector4Function colorConstraint;
288 if (GetColorConstraint(itemId, colorConstraint))
290 WrappedVector4Constraint wrapped(colorConstraint, itemId);
292 Constraint constraint = Constraint::New<Vector4>( actor, Actor::Property::COLOR, wrapped );
293 constraint.AddSource( Source( scrollPositionObject, scrollPositionProperty ) );
294 constraint.AddSource( ParentSource( scrollSpeedProperty ) );
295 constraint.AddSource( ParentSource( Actor::Property::SIZE ) );
296 constraint.AddSource( Source( mWeightObject, WeightObject::WEIGHT ) );
297 constraint.SetRemoveAction(Dali::Constraint::Discard);
301 ItemLayout::BoolFunction visibilityConstraint;
302 if (GetVisibilityConstraint(itemId, visibilityConstraint))
304 WrappedBoolConstraint wrapped(visibilityConstraint, itemId);
306 Constraint constraint = Constraint::New<bool>( actor, Actor::Property::VISIBLE, wrapped );
307 constraint.AddSource( Source( scrollPositionObject, scrollPositionProperty ) );
308 constraint.AddSource( ParentSource( scrollSpeedProperty ) );
309 constraint.AddSource( ParentSource( Actor::Property::SIZE ) );
310 constraint.AddSource( Source( mWeightObject, WeightObject::WEIGHT ) );
312 // Release visibility constraints the same time as the color constraint
313 constraint.SetRemoveAction(Dali::Constraint::Discard);
318 KeyFrames keyFrames = KeyFrames::New();
319 keyFrames.Add( 0.0f, 0.0f );
320 keyFrames.Add( 1.0f, 1.0f );
322 Animation applyAnimation = Dali::Animation::New( durationSeconds );
323 applyAnimation.AnimateBetween( Property( mWeightObject, WeightObject::WEIGHT ), keyFrames, mAlphaFunction, TimePeriod(durationSeconds) );
324 applyAnimation.Play();
328 Vector3 ItemLayout::GetItemPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize) const
330 Vector3 itemPosition = Vector3::ZERO;
332 ItemLayout::Vector3Function positionConstraint;
333 if (GetPositionConstraint(itemID, positionConstraint))
335 itemPosition = positionConstraint(Vector3::ZERO, currentLayoutPosition + itemID, 0.0f, layoutSize);
341 void ItemLayout::SetAlphaFunction(AlphaFunction func)
343 mAlphaFunction = func;
346 AlphaFunction ItemLayout::GetAlphaFunction() const
348 return mAlphaFunction;
352 } // namespace Toolkit