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

   1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
   2 #define __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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  * @addtogroup CAPI_DALI_FRAMEWORK
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 struct Vector2;
  32 struct Vector3;
  33 struct Vector4;
  34 class PropertyInput;
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal DALI_INTERNAL
  40 {
  41 class ScrollViewEffect;
  42 class ScrollViewWobbleEffect;
  43 }
  44
  45 class ScrollView;
  46 class ScrollViewEffect;
  47
  48 typedef std::vector<ScrollViewEffect> ScrollViewEffectContainer;
  49 typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter;
  50 typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter;
  51
  52 /**
  53  * ScrollView Effect base class, used to apply custom
  54  * effects to a ScrollView instance. Such effects are
  55  * purely logical (i.e. physics), and may produce
  56  * properties that can be used with visual effects.
  57  * Such as creating constraints that are applied to ShaderEffects
  58  * or Actors using these properties as inputs.
  59  */
  60 class ScrollViewEffect : public Dali::BaseHandle
  61 {
  62
  63 public:
  64
  65   /**
  66    * Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes
  67    * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
  68    */
  69   ScrollViewEffect();
  70
  71 public: // Not intended for application developers
  72
  73   /**
  74    * This constructor is used by Dali New() methods.
  75    * @param [in] impl A pointer to a newly allocated Dali resource
  76    */
  77   ScrollViewEffect(Internal::ScrollViewEffect *impl);
  78
  79 };
  80
  81 } // namespace Toolkit
  82
  83 } // namespace Dali
  84
  85 /**
  86  * @}
  87  */
  88 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__