2 * Copyright (c) 2020 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/default-item-layout-property.h>
28 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
34 struct ItemLayout::Impl
36 Vector3 mItemSize; ///< The size of an item in the layout
37 ControlOrientation::Type mOrientation; ///< the orientation of the layout.
38 Property::Map mProperties;
41 ItemLayout::ItemLayout()
44 mImpl->mOrientation = ControlOrientation::Up;
47 ItemLayout::~ItemLayout()
52 void ItemLayout::SetOrientation(ControlOrientation::Type orientation)
54 mImpl->mOrientation = orientation;
57 ControlOrientation::Type ItemLayout::GetOrientation() const
59 return mImpl->mOrientation;
62 void ItemLayout::GetItemSize(unsigned int itemId, const Vector3& layoutSize, Vector3& itemSize) const
64 // If item-size has not been set then get the default size
65 if(mImpl->mItemSize == Vector3::ZERO)
67 GetDefaultItemSize(itemId, layoutSize, itemSize);
71 itemSize = mImpl->mItemSize;
75 void ItemLayout::SetItemSize(const Vector3& itemSize)
77 mImpl->mItemSize = itemSize;
80 float ItemLayout::GetClosestOnScreenLayoutPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize)
82 Vector3 itemPosition = GetItemPosition(itemID, currentLayoutPosition, layoutSize);
84 GetItemSize(itemID, layoutSize, itemSize);
85 Vector3 onScreenArea = (layoutSize - itemSize) * 0.5f;
86 if(itemPosition.x < -onScreenArea.x || itemPosition.x > onScreenArea.x || itemPosition.y < -onScreenArea.y || itemPosition.y > onScreenArea.y)
88 // item not within viewable area
89 // safest thing to do here since we have no idea how the implementation will work is to return the scroll to position
90 return GetItemScrollToPosition(itemID);
92 return currentLayoutPosition;
95 int ItemLayout::GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
99 case Control::KeyboardFocus::LEFT:
100 case Control::KeyboardFocus::UP:
105 itemID = loopEnabled ? maxItems - 1 : 0;
109 case Control::KeyboardFocus::RIGHT:
110 case Control::KeyboardFocus::DOWN:
113 if(itemID >= maxItems)
115 itemID = loopEnabled ? 0 : maxItems - 1;
127 float ItemLayout::GetFlickSpeedFactor() const
129 // By default, the speed factor while dragging and swiping is the same.
130 return GetScrollSpeedFactor();
133 void ItemLayout::SetLayoutProperties(const Property::Map& properties)
135 for(unsigned int idx = 0, mapCount = properties.Count(); idx < mapCount; ++idx)
137 KeyValuePair propertyPair(properties.GetKeyValue(idx));
139 if(propertyPair.first == DefaultItemLayoutProperty::ITEM_SIZE)
141 SetItemSize(propertyPair.second.Get<Vector3>());
143 else if(propertyPair.first == DefaultItemLayoutProperty::ORIENTATION)
145 //Up, Left, Down, Right
146 int orientationType = propertyPair.second.Get<int>();
147 if(orientationType <= ControlOrientation::Right && orientationType >= ControlOrientation::Up)
149 SetOrientation(ControlOrientation::Type(orientationType));
153 mImpl->mProperties = properties;
156 Property::Map ItemLayout::GetLayoutProperties()
158 return mImpl->mProperties;
161 } // namespace Toolkit