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

   1 #ifndef DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H
   2 #define DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  26
  27 namespace Dali
  28 {
  29 class Actor;
  30 class Path;
  31
  32 namespace Toolkit
  33 {
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class ScrollViewPagePathEffect;
  37 }
  38 /**
  39  * @addtogroup dali_toolkit_controls_scroll_view
  40  * @{
  41  */
  42
  43 /**
  44  * @brief ScrollView Page Path Effect.
  45  *
  46  * This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
  47  * the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
  48  * to 0.0 at the end of the path.
  49  *
  50  *
  51  * ScrollView
  52  * |
  53  * Page (1..n)
  54  *
  55  * You should ensure ScrollView's default constraints have been removed,
  56  * by calling ScrollView::RemoveConstraintsFromChildren() before applying
  57  * this effect to ScrollView.
  58  *
  59  * Manual operation:
  60  * ApplyToPage(...) method should be called on every page.
  61  *
  62  * Automatic operation:
  63  * not implemented.
  64  * @SINCE_1_0.0
  65  */
  66 class DALI_TOOLKIT_API ScrollViewPagePathEffect : public ScrollViewEffect
  67 {
  68 public:
  69   /**
  70    * @brief Creates an initialized ScrollViewPagePathEffect.
  71    * @SINCE_1_0.0
  72    * @param[in] path The path that will be used by the scroll effect
  73    * @param[in] forward Vector in page object space which will be aligned with the tangent of the path
  74    * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path
  75    * @param[in] viewPageSize Size of a page in the scrollview
  76    * @param[in] pageCount Total number of pages in the scrollview
  77    * @return A handle to a newly allocated Dali resource
  78    */
  79   static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& viewPageSize, unsigned int pageCount);
  80
  81   /**
  82    * @brief Creates an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New().
  83    * Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.
  84    * @SINCE_1_0.0
  85    */
  86   ScrollViewPagePathEffect();
  87
  88   /**
  89    * @brief Downcasts a handle to ScrollViewPagePathEffect handle.
  90    *
  91    * If handle points to a ScrollViewPagePathEffect, the downcast produces valid handle.
  92    * If not, the returned handle is left uninitialized.
  93    * @SINCE_1_0.0
  94    * @param[in] handle Handle to an object
  95    * @return Handle to a ScrollViewPagePathEffect or an uninitialized handle
  96    */
  97   static ScrollViewPagePathEffect DownCast(BaseHandle handle);
  98
  99   /**
 100    * @brief Manually apply effect to a page in the scroll-view.
 101    * @SINCE_1_0.0
 102    * @param[in] page The page to be affected by this effect
 103    * @param[in] pageOrder The order of the page in the scroll view
 104    */
 105   void ApplyToPage(Actor page, unsigned int pageOrder);
 106
 107 protected:
 108   /// @cond internal
 109   /**
 110    * @brief This constructor is used by Dali New() methods.
 111    * @SINCE_1_0.0
 112    * @param[in] impl A pointer to a newly allocated Dali resource
 113    */
 114   explicit DALI_INTERNAL ScrollViewPagePathEffect(Internal::ScrollViewPagePathEffect* impl);
 115   /// @endcond
 116 };
 117
 118 /**
 119  * @}
 120  */
 121 } // namespace Toolkit
 122
 123 } // namespace Dali
 124
 125 #endif // DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H