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) 2018 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  26
  27 namespace Dali
  28 {
  29
  30 struct Vector2;
  31 struct Vector3;
  32 struct Vector4;
  33 class PropertyInput;
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal DALI_INTERNAL
  39 {
  40 class ScrollViewEffect;
  41 class ScrollViewWobbleEffect;
  42 }
  43 /**
  44  * @addtogroup dali_toolkit_controls_scroll_view
  45  * @{
  46  */
  47
  48 class ScrollView;
  49 class ScrollViewEffect;
  50
  51 /**
  52  * @brief ScrollView Effect base class, used to apply custom effects to a
  53  * ScrollView instance.
  54  *
  55  * Such effects are purely logical (i.e. physics), and may produce
  56  * properties that can be used with visual effects, such as creating
  57  * constraints that are applied to ShaderEffects or Actors using these
  58  * properties as inputs.
  59  * @SINCE_1_0.0
  60  */
  61 class DALI_TOOLKIT_API ScrollViewEffect : public Dali::BaseHandle
  62 {
  63
  64 public:
  65
  66   /**
  67    * @brief Creates 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    * @SINCE_1_0.0
  71    */
  72   ScrollViewEffect();
  73
  74 public: // Not intended for application developers
  75
  76   /// @cond internal
  77   /**
  78    * @brief This constructor is used by Dali New() methods.
  79    *
  80    * @SINCE_1_0.0
  81    * @param[in] impl A pointer to a newly allocated Dali resource
  82    */
  83   explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl);
  84   /// @endcond
  85
  86 };
  87
  88 /**
  89  * @}
  90  */
  91 } // namespace Toolkit
  92
  93 } // namespace Dali
  94
  95 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__