Remove deprecated SetRemoveTime API
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / public-api / controls / scrollable / item-view / item-layout.cpp
index 177c1d8..32aeb7a 100644 (file)
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 #include <dali-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
+#include <dali-toolkit/public-api/controls/scrollable/item-view/item-view.h>
+
+namespace
+{
+
+  // Functors which wrap constraint functions with stored item IDs
+  struct WrappedQuaternionConstraint
+  {
+    WrappedQuaternionConstraint(Dali::Toolkit::ItemLayout::QuaternionFunction wrapMe, unsigned int itemId)
+    :mWrapMe(wrapMe),
+     mItemId(itemId)
+    {
+    }
+
+    Dali::Quaternion operator()(const Dali::Quaternion& current, const Dali::PropertyInput& layoutPosition, const Dali::PropertyInput& scrollSpeed, const Dali::PropertyInput& layoutSize)
+    {
+      float offsetLayoutPosition = layoutPosition.GetFloat() + static_cast<float>(mItemId);
+
+      return mWrapMe(current, offsetLayoutPosition, scrollSpeed.GetFloat(), layoutSize.GetVector3());
+    }
+
+    Dali::Toolkit::ItemLayout::QuaternionFunction mWrapMe;
+    unsigned int mItemId;
+  };
+
+  struct WrappedVector3Constraint
+  {
+    WrappedVector3Constraint(Dali::Toolkit::ItemLayout::Vector3Function wrapMe, unsigned int itemId)
+    : mWrapMe(wrapMe),
+      mItemId(itemId)
+    {
+    }
+
+    Dali::Vector3 operator()(const Dali::Vector3& current, const Dali::PropertyInput& layoutPosition, const Dali::PropertyInput& scrollSpeed, const Dali::PropertyInput& layoutSize)
+    {
+      float offsetLayoutPosition = layoutPosition.GetFloat() + static_cast<float>(mItemId);
+
+      return mWrapMe(current, offsetLayoutPosition, scrollSpeed.GetFloat(), layoutSize.GetVector3());
+    }
+
+    Dali::Toolkit::ItemLayout::Vector3Function mWrapMe;
+    unsigned int mItemId;
+  };
+
+  struct WrappedVector4Constraint
+  {
+    WrappedVector4Constraint(Dali::Toolkit::ItemLayout::Vector4Function wrapMe, unsigned int itemId)
+    : mWrapMe(wrapMe),
+      mItemId(itemId)
+    {
+    }
+
+    Dali::Vector4 operator()(const Dali::Vector4& current, const Dali::PropertyInput& layoutPosition, const Dali::PropertyInput& scrollSpeed, const Dali::PropertyInput& layoutSize)
+    {
+      float offsetLayoutPosition = layoutPosition.GetFloat() + static_cast<float>(mItemId);
+
+      return mWrapMe(current, offsetLayoutPosition, scrollSpeed.GetFloat(), layoutSize.GetVector3());
+    }
+
+    Dali::Toolkit::ItemLayout::Vector4Function mWrapMe;
+    unsigned int mItemId;
+  };
+
+  struct WrappedBoolConstraint
+  {
+    WrappedBoolConstraint(Dali::Toolkit::ItemLayout::BoolFunction wrapMe, unsigned int itemId)
+    : mWrapMe(wrapMe),
+      mItemId(itemId)
+    {
+    }
+
+    bool operator()(const bool& current, const Dali::PropertyInput& layoutPosition, const Dali::PropertyInput& scrollSpeed, const Dali::PropertyInput& layoutSize)
+    {
+      float offsetLayoutPosition = layoutPosition.GetFloat() + static_cast<float>(mItemId);
+
+      return mWrapMe(current, offsetLayoutPosition, scrollSpeed.GetFloat(), layoutSize.GetVector3());
+    }
+
+    Dali::Toolkit::ItemLayout::BoolFunction mWrapMe;
+    unsigned int mItemId;
+  };
+
+}  //Unnamed namespace
 
 namespace Dali
 {
@@ -23,7 +107,8 @@ namespace Toolkit
 {
 
 ItemLayout::ItemLayout()
-: mOrientation(ControlOrientation::Up)
+: mOrientation(ControlOrientation::Up),
+  mAlphaFunction(Dali::Constraint::DEFAULT_ALPHA_FUNCTION)
 {
 }
 
@@ -43,12 +128,7 @@ ControlOrientation::Type ItemLayout::GetOrientation() const
 
 float ItemLayout::GetClosestOnScreenLayoutPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize)
 {
-  ItemLayout::Vector3Function positionConstraint;
-  Vector3 itemPosition = Vector3::ZERO;
-  if (GetPositionConstraint(itemID, positionConstraint))
-  {
-    itemPosition = positionConstraint(Vector3::ZERO, currentLayoutPosition + itemID, 0.0f, layoutSize);
-  }
+  Vector3 itemPosition = GetItemPosition( itemID, currentLayoutPosition, layoutSize );
   Vector3 itemSize;
   GetItemSize(itemID, layoutSize, itemSize);
   Vector3 onScreenArea = (layoutSize - itemSize) * 0.5f;
@@ -236,6 +316,132 @@ int ItemLayout::GetNextFocusItemID(int itemID, int maxItems, Dali::Toolkit::Cont
   return itemID;
 }
 
+float ItemLayout::GetFlickSpeedFactor() const
+{
+  // By default, the speed factor while dragging and swiping is the same.
+  return GetScrollSpeedFactor();
+}
+
+void ItemLayout::ApplyConstraints( Actor& actor, const int itemId, const float durationSeconds, Constrainable scrollPositionObject, const Actor& itemViewActor )
+{
+  // This just implements the default behaviour of constraint application.
+  // Custom layouts can override this function to apply their custom constraints.
+  Dali::Toolkit::ItemView itemView = Dali::Toolkit::ItemView::DownCast( itemViewActor );
+  if(itemView && scrollPositionObject)
+  {
+    Property::Index scrollSpeedProperty = itemView.GetPropertyIndex("item-view-scroll-speed");
+    Property::Index scrollPositionProperty = scrollPositionObject.GetPropertyIndex("scroll-position");
+
+    ItemLayout::Vector3Function positionConstraint;
+    if (GetPositionConstraint(itemId, positionConstraint))
+    {
+      WrappedVector3Constraint wrapped(positionConstraint, itemId);
+      Constraint constraint = Constraint::New<Vector3>( Actor::POSITION,
+                                                        Source( scrollPositionObject, scrollPositionProperty ),
+                                                        ParentSource( scrollSpeedProperty ),
+                                                        ParentSource( Actor::SIZE ),
+                                                        wrapped );
+      constraint.SetApplyTime(durationSeconds);
+      constraint.SetAlphaFunction(mAlphaFunction);
+      actor.ApplyConstraint(constraint);
+    }
+
+    ItemLayout::QuaternionFunction rotationConstraint;
+    if (GetRotationConstraint(itemId, rotationConstraint))
+    {
+      WrappedQuaternionConstraint wrapped(rotationConstraint, itemId);
+
+      Constraint constraint = Constraint::New<Quaternion>( Actor::ROTATION,
+                                                           Source( scrollPositionObject, scrollPositionProperty ),
+                                                           ParentSource( scrollSpeedProperty ),
+                                                           ParentSource( Actor::SIZE ),
+                                                           wrapped );
+      constraint.SetApplyTime(durationSeconds);
+      constraint.SetAlphaFunction(mAlphaFunction);
+
+      actor.ApplyConstraint(constraint);
+    }
+
+    ItemLayout::Vector3Function scaleConstraint;
+    if (GetScaleConstraint(itemId, scaleConstraint))
+    {
+      WrappedVector3Constraint wrapped(scaleConstraint, itemId);
+
+      Constraint constraint = Constraint::New<Vector3>( Actor::SCALE,
+                                                        Source( scrollPositionObject, scrollPositionProperty ),
+                                                        ParentSource( scrollSpeedProperty ),
+                                                        ParentSource( Actor::SIZE ),
+                                                        wrapped );
+      constraint.SetApplyTime(durationSeconds);
+      constraint.SetAlphaFunction(mAlphaFunction);
+
+      actor.ApplyConstraint(constraint);
+    }
+
+    ItemLayout::Vector4Function colorConstraint;
+    if (GetColorConstraint(itemId, colorConstraint))
+    {
+      WrappedVector4Constraint wrapped(colorConstraint, itemId);
+
+      Constraint constraint = Constraint::New<Vector4>( Actor::COLOR,
+                                                        Source( scrollPositionObject, scrollPositionProperty ),
+                                                        ParentSource( scrollSpeedProperty ),
+                                                        ParentSource( Actor::SIZE ),
+                                                        wrapped );
+
+      constraint.SetApplyTime(durationSeconds);
+      constraint.SetAlphaFunction(mAlphaFunction);
+      constraint.SetRemoveAction(Dali::Constraint::Discard);
+
+      actor.ApplyConstraint(constraint);
+    }
+
+    ItemLayout::BoolFunction visibilityConstraint;
+    if (GetVisibilityConstraint(itemId, visibilityConstraint))
+    {
+      WrappedBoolConstraint wrapped(visibilityConstraint, itemId);
+
+      Constraint constraint = Constraint::New<bool>( Actor::VISIBLE,
+                                                     Source( scrollPositionObject, scrollPositionProperty ),
+                                                     ParentSource( scrollSpeedProperty ),
+                                                     ParentSource( Actor::SIZE ),
+                                                     wrapped );
+
+      constraint.SetApplyTime(durationSeconds);
+      constraint.SetAlphaFunction(mAlphaFunction);
+
+      // Release visibility constraints the same time as the color constraint
+      constraint.SetRemoveAction(Dali::Constraint::Discard);
+
+      actor.ApplyConstraint(constraint);
+    }
+  }
+}
+
+Vector3 ItemLayout::GetItemPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize) const
+{
+  Vector3 itemPosition = Vector3::ZERO;
+
+  ItemLayout::Vector3Function positionConstraint;
+  if (GetPositionConstraint(itemID, positionConstraint))
+  {
+    itemPosition = positionConstraint(Vector3::ZERO, currentLayoutPosition + itemID, 0.0f, layoutSize);
+  }
+
+  return itemPosition;
+}
+
+void ItemLayout::SetAlphaFunction(AlphaFunction func)
+{
+  mAlphaFunction = func;
+}
+
+AlphaFunction ItemLayout::GetAlphaFunction() const
+{
+  return mAlphaFunction;
+}
+
+
 } // namespace Toolkit
 
 } // namespace Dali