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  * This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
  45  * the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
  46  * to 0.0 at the end of the path
  47  *
  48  *
  49  * ScrollView
  50  * |
  51  * Page (1..n)
  52  *
  53  * You should ensure ScrollView's default constraints have been removed,
  54  * by calling ScrollView::RemoveConstraintsFromChildren() before applying
  55  * this effect to ScrollView.
  56  *
  57  * Manual operation:
  58  * ApplyToPage(...) method should be called on every page.
  59  *
  60  * Automatic operation:
  61  * not implemented.
  62  * @SINCE_1_0.0
  63  */
  64 class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect
  65 {
  66
  67 public:
  68
  69   /**
  70    * @brief Create 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] pageSize 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& pageSize, unsigned int pageCount);
  80
  81   /**
  82    * @brief Create 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 Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect the
  90    * downcast produces valid handle. If not the returned handle is left uninitialized.
  91    * @SINCE_1_0.0
  92    * @param[in] handle Handle to an object
  93    * @return handle to a ScrollViewPagePathEffect or an uninitialized handle
  94    */
  95   static ScrollViewPagePathEffect DownCast( BaseHandle handle );
  96
  97   /**
  98    * @brief Manually apply effect to a page in the scroll-view.
  99    * @SINCE_1_0.0
 100    * @param[in] page The page to be affected by this effect.
 101    * @param[in] pageOrder The order of the page in the scroll-view
 102    */
 103   void ApplyToPage( Actor page, unsigned int pageOrder );
 104
 105 protected:
 106
 107   /**
 108    * @brief This constructor is used by Dali New() methods.
 109    * @SINCE_1_0.0
 110    * @param [in] impl A pointer to a newly allocated Dali resource
 111    */
 112   explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl );
 113
 114 };
 115
 116 /**
 117  * @}
 118  */
 119 } // namespace Toolkit
 120
 121 } // namespace Dali
 122
 123 #endif // __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__