base/dali-toolkit/internal/controls/scrollable/scroll-view/scroll-view-carousel-effect-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__
   2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/animation/animation.h>
  23 #include <dali/public-api/animation/alpha-functions.h>
  24 #include <dali/public-api/animation/time-period.h>
  25 #include <dali/public-api/object/ref-object.h>
  26 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
  27 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
  28 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-carousel-effect.h>
  29
  30 namespace Dali
  31 {
  32
  33 class Animation;
  34
  35 namespace Toolkit
  36 {
  37
  38 class ScrollView;
  39
  40 namespace Internal
  41 {
  42
  43 class ScrollViewEffect;
  44
  45 /**
  46  * @copydoc Toolkit::ScrollViewCarouselEffect
  47  */
  48 class ScrollViewCarouselEffect : public ScrollViewEffect
  49 {
  50
  51 public:
  52
  53   /**
  54    * Constructor
  55    */
  56   ScrollViewCarouselEffect();
  57
  58 public:
  59
  60   /**
  61    * @copydoc ScrollViewEffect::ApplyToActor
  62    */
  63   void ApplyToActor(Actor child, const Vector2& angleSwing);
  64
  65 public:
  66
  67   /**
  68    * @copydoc ScrollViewEffect::OnAttach
  69    */
  70   virtual void OnAttach(Toolkit::ScrollView& scrollView);
  71
  72   /**
  73    * @copydoc ScrollViewEffect::OnDetach
  74    */
  75   virtual void OnDetach(Toolkit::ScrollView& scrollView);
  76
  77 protected:
  78
  79   /**
  80    * A reference counted object may only be deleted by calling Unreference()
  81    */
  82   virtual ~ScrollViewCarouselEffect();
  83
  84 private:
  85
  86   Property::Index mPropertyActivate;                      ///< Activation property (0.0 - deactivated, 1.0 - fully activated)
  87
  88 };
  89
  90 } // namespace Internal
  91
  92 // Helpers for public-api forwarding methods
  93
  94 inline Internal::ScrollViewCarouselEffect& GetImpl(Dali::Toolkit::ScrollViewCarouselEffect& obj)
  95 {
  96   DALI_ASSERT_ALWAYS(obj);
  97
  98   Dali::RefObject& handle = obj.GetBaseObject();
  99
 100   return static_cast<Internal::ScrollViewCarouselEffect&>(handle);
 101 }
 102
 103 inline const Internal::ScrollViewCarouselEffect& GetImpl(const Dali::Toolkit::ScrollViewCarouselEffect& obj)
 104 {
 105   DALI_ASSERT_ALWAYS(obj);
 106
 107   const Dali::RefObject& handle = obj.GetBaseObject();
 108
 109   return static_cast<const Internal::ScrollViewCarouselEffect&>(handle);
 110 }
 111
 112 } // namespace Toolkit
 113
 114 } // namespace Dali
 115
 116 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__