dali-toolkit/internal/controls/scrollable/scroll-view/scroll-base-impl.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali-toolkit/internal/controls/scrollable/scroll-view/scroll-base-impl.h>
  20
  21 using namespace Dali;
  22
  23 namespace Dali
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 ///////////////////////////////////////////////////////////////////////////////////////////////////
  33 // ScrollBase
  34 ///////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 const std::string ScrollBase::SCROLL_DOMAIN_OFFSET_PROPERTY_NAME( "domain-offset" );
  37
  38 ScrollBase::ScrollBase()
  39 : Scrollable(),
  40   mParent(NULL),
  41   mPropertyTime(Property::INVALID_INDEX),
  42   mPropertyPrePosition(Property::INVALID_INDEX),
  43   mPropertyPosition(Property::INVALID_INDEX),
  44   mPropertyOvershootX(Property::INVALID_INDEX),
  45   mPropertyOvershootY(Property::INVALID_INDEX),
  46   mPropertyWrap(Property::INVALID_INDEX),
  47   mPropertyPanning(Property::INVALID_INDEX),
  48   mPropertyScrolling(Property::INVALID_INDEX),
  49   mPropertyFinal(Property::INVALID_INDEX),
  50   mPropertyDomainOffset(Property::INVALID_INDEX),
  51   mPropertyPositionDelta(Property::INVALID_INDEX),
  52   mPropertyScrollStartPagePosition(Property::INVALID_INDEX),
  53   mDelay(0.0f)
  54 {
  55 }
  56
  57 void ScrollBase::SetParent(ScrollBase *parent)
  58 {
  59   mParent = parent;
  60 }
  61
  62 void ScrollBase::RegisterProperties()
  63 {
  64   Actor self = Self();
  65
  66   // Register common properties
  67   RegisterCommonProperties();
  68
  69   // Register Scroll Properties.
  70   mPropertyTime = self.RegisterProperty(Toolkit::ScrollView::SCROLL_TIME_PROPERTY_NAME, 0.0f);
  71   mPropertyPrePosition = self.RegisterProperty(Toolkit::ScrollView::SCROLL_PRE_POSITION_PROPERTY_NAME, Vector3::ZERO);
  72   mPropertyPosition = self.RegisterProperty(Toolkit::ScrollView::SCROLL_POSITION_PROPERTY_NAME, Vector3::ZERO);
  73   mPropertyOvershootX = self.RegisterProperty(Toolkit::ScrollView::SCROLL_OVERSHOOT_X_PROPERTY_NAME, 0.0f);
  74   mPropertyOvershootY = self.RegisterProperty(Toolkit::ScrollView::SCROLL_OVERSHOOT_Y_PROPERTY_NAME, 0.0f);
  75   mPropertyFinal = self.RegisterProperty(Toolkit::ScrollView::SCROLL_FINAL_PROPERTY_NAME, Vector3::ZERO);
  76   mPropertyWrap = self.RegisterProperty(Toolkit::ScrollView::SCROLL_WRAP_PROPERTY_NAME, false);
  77   mPropertyPanning = self.RegisterProperty(Toolkit::ScrollView::SCROLL_PANNING_PROPERTY_NAME, false);
  78   mPropertyScrolling = self.RegisterProperty(Toolkit::ScrollView::SCROLL_SCROLLING_PROPERTY_NAME, false);
  79   mPropertyDomainOffset = self.RegisterProperty(SCROLL_DOMAIN_OFFSET_PROPERTY_NAME, Vector3::ZERO);
  80   mPropertyPositionDelta = self.RegisterProperty(Toolkit::ScrollView::SCROLL_POSITION_DELTA_PROPERTY_NAME, Vector3::ZERO);
  81   mPropertyScrollStartPagePosition = self.RegisterProperty(Toolkit::ScrollView::SCROLL_START_PAGE_POSITION_PROPERTY_NAME, Vector3::ZERO);
  82 }
  83
  84 void ScrollBase::BindActor(Actor child)
  85 {
  86   FindAndUnbindActor(child);
  87
  88   ActorInfoPtr actorInfo(new ActorInfo(child));
  89   mBoundActors.push_back(actorInfo);
  90
  91   // Apply all our constraints to this new child.
  92   ConstraintStack::iterator i;
  93
  94   for(i = mConstraintStack.begin();i!=mConstraintStack.end();i++)
  95   {
  96     actorInfo->ApplyConstraint(*i);
  97   }
  98 }
  99
 100 void ScrollBase::UnbindActor(Actor child)
 101 {
 102   // Find the child in mBoundActors, and unparent it
 103   for (ActorInfoIter iter = mBoundActors.begin(); iter != mBoundActors.end(); ++iter)
 104   {
 105     ActorInfoPtr actorInfo = *iter;
 106
 107     if( actorInfo->mActor == child )
 108     {
 109       mBoundActors.erase(iter);
 110       break;
 111     }
 112   }
 113 }
 114
 115 void ScrollBase::FindAndUnbindActor(Actor child)
 116 {
 117   // Since we don't know if and where child may have been bound
 118   // (as we cannot store such information inside the Actor), we
 119   // perform a search on all associated ScrollBases
 120   // This is done by recursively calling the parent of this ScrollBase
 121   // until reaching the top (at which point implementation may be
 122   // different as this is virtual)
 123
 124   if(mParent) // continuously ascend until reaches root ScrollBase.
 125   {
 126     mParent->FindAndUnbindActor(child);
 127   }
 128 }
 129
 130 void ScrollBase::ApplyConstraintToBoundActors(Constraint constraint)
 131 {
 132   mConstraintStack.push_back(constraint);
 133
 134   for(ActorInfoIter i = mBoundActors.begin();i != mBoundActors.end(); ++i)
 135   {
 136     (*i)->ApplyConstraint(constraint);
 137   }
 138 }
 139
 140 void ScrollBase::RemoveConstraintsFromBoundActors()
 141 {
 142   mConstraintStack.clear();
 143
 144   for(ActorInfoIter i = mBoundActors.begin();i != mBoundActors.end(); ++i)
 145   {
 146     (*i)->RemoveConstraints();
 147   }
 148 }
 149
 150 } // namespace Internal
 151
 152 } // namespace Toolkit
 153
 154 } // namespace Dali