base/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-wobble-effect.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_EFFECT_H__
   2 #define __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_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-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 class ScrollViewEffect;
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class ScrollViewWobbleEffect;
  35 }
  36
  37 /**
  38  * ScrollView Wobble-Effect.
  39  *
  40  * Using this effect, a %wobble% property is produced which swings
  41  * towards the origin in accordance to how the user pans the ScrollView.
  42  */
  43 class DALI_IMPORT_API ScrollViewWobbleEffect : public ScrollViewEffect
  44 {
  45 public:
  46
  47   static const std::string EFFECT_OVERSHOOT;
  48   static const std::string EFFECT_TIME;
  49
  50 public:
  51
  52   /**
  53    * Create an initialized ScrollViewWobbleEffect.
  54    * @return A handle to a newly allocated Dali resource.
  55    */
  56   static ScrollViewWobbleEffect New();
  57
  58   /**
  59    * Create an uninitialized ScrollViewWobbleEffect; this can be initialized with ScrollViewWobbleEffect::New()
  60    * Calling member functions with an uninitialized Toolkit::ScrollViewWobbleEffect is not allowed.
  61    */
  62   ScrollViewWobbleEffect();
  63
  64 protected:
  65
  66   /**
  67    * This constructor is used by Dali New() methods.
  68    * @param [in] impl A pointer to a newly allocated Dali resource
  69    */
  70   explicit DALI_INTERNAL ScrollViewWobbleEffect(Internal::ScrollViewWobbleEffect *impl);
  71
  72 };
  73
  74 } // namespace Toolkit
  75
  76 } // namespace Dali
  77
  78 #endif // __DALI_TOOLKIT_SCROLL_VIEW_WOBBLE_EFFECT_H__