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