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