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_TOOLKIT_SCROLL_VIEW_MODULE
  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; ///< Container of Dali::Toolkit::ScrollViewEffect%s
  49 typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer
  50 typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter; ///< Const Iterator for Dali::Toolkit::ScrollViewEffectContainer
  51
  52 /**
  53  * @brief ScrollView Effect base class, used to apply custom effects to a
  54  * ScrollView instance.
  55  *
  56  * Such effects are purely logical (i.e. physics), and may produce
  57  * properties that can be used with visual effects.  Such as creating
  58  * constraints that are applied to ShaderEffects or Actors using these
  59  * properties as inputs.
  60  */
  61 class ScrollViewEffect : public Dali::BaseHandle
  62 {
  63
  64 public:
  65
  66   /**
  67    * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
  68    *
  69    * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
  70    */
  71   ScrollViewEffect();
  72
  73 public: // Not intended for application developers
  74
  75   /**
  76    * @brief This constructor is used by Dali New() methods.
  77    *
  78    * @param [in] impl A pointer to a newly allocated Dali resource
  79    */
  80   ScrollViewEffect(Internal::ScrollViewEffect *impl);
  81
  82 };
  83
  84 } // namespace Toolkit
  85
  86 } // namespace Dali
  87
  88 /**
  89  * @}
  90  */
  91 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__