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) 2020 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 struct Vector2;
  30 struct Vector3;
  31 struct Vector4;
  32 class PropertyInput;
  33
  34 namespace Toolkit
  35 {
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class ScrollViewEffect;
  39 class ScrollViewWobbleEffect;
  40 } // namespace DALI_INTERNAL
  41 /**
  42  * @addtogroup dali_toolkit_controls_scroll_view
  43  * @{
  44  */
  45
  46 class ScrollView;
  47 class ScrollViewEffect;
  48
  49 /**
  50  * @brief ScrollView Effect base class, used to apply custom effects to a
  51  * ScrollView instance.
  52  *
  53  * Such effects are purely logical (i.e. physics), and may produce
  54  * properties that can be used with visual effects, such as creating
  55  * constraints that are applied to ShaderEffects or Actors using these
  56  * properties as inputs.
  57  * @SINCE_1_0.0
  58  */
  59 class DALI_TOOLKIT_API ScrollViewEffect : public Dali::BaseHandle
  60 {
  61 public:
  62   /**
  63    * @brief Creates an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
  64    *
  65    * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
  66    * @SINCE_1_0.0
  67    */
  68   ScrollViewEffect();
  69
  70 public: // Not intended for application developers
  71   /// @cond internal
  72   /**
  73    * @brief This constructor is used by Dali New() methods.
  74    *
  75    * @SINCE_1_0.0
  76    * @param[in] impl A pointer to a newly allocated Dali resource
  77    */
  78   explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect* impl);
  79   /// @endcond
  80 };
  81
  82 /**
  83  * @}
  84  */
  85 } // namespace Toolkit
  86
  87 } // namespace Dali
  88
  89 #endif // DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H