1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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
11 // http://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
26 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
28 namespace Dali DALI_IMPORT_API
36 class ScrollViewEffect;
38 namespace Internal DALI_INTERNAL
40 class ScrollViewTwistEffect;
44 * @brief ScrollView effect that twists pages onto screen when transitioning.
46 class ScrollViewTwistEffect : public ScrollViewEffect
51 static const float DEFAULT_MINIMUM_DISTANCE_FOR_SHRINK; ///< The min distance for shrink
56 * @brief Create an initialized ScrollViewTwistEffect.
58 * @return A handle to a newly allocated Dali resource.
60 static ScrollViewTwistEffect New();
63 * @brief Create an uninitialized ScrollViewTwistEffect; this can be initialized with ScrollViewTwistEffect::New().
65 * Calling member functions with an uninitialized Toolkit::ScrollViewTwistEffect is not allowed.
67 ScrollViewTwistEffect();
70 * @brief Downcast an Object handle to ScrollViewTwistEffect.
72 * If handle points to a ScrollViewTwistEffect the
73 * downcast produces valid handle. If not the returned handle is left uninitialized.
74 * @param[in] handle Handle to an object
75 * @return handle to a ScrollViewTwistEffect or an uninitialized handle
77 static ScrollViewTwistEffect DownCast( BaseHandle handle );
80 * @brief Gets the minimum animation distance for the shrink effect to
83 * @return The minimum distance in seconds is returned.
85 float GetMinimumDistanceForShrink() const;
88 * @brief Sets the minimum animation distance for the shrink effect
91 * @param[in] distance The minimum distance in pixels (default = 0.0)
92 * i.e. any flick will result in shrinking.
94 void SetMinimumDistanceForShrink(float distance);
97 * @brief Enable or disable this effect.
99 * @param[in] enableFlag Set to true if the effect should be enabled.
101 void EnableEffect(bool enableFlag);
104 * @brief Manually apply effect to an Actor.
106 * @param[in] child The child Actor to be affected by this effect.
107 * @param[in] additionalEffects Whether just the basic effect (delay)
108 * should be applied. Or all effects (delay, rotation, scaling).
109 * For all effects set to true. Default is true i.e. apply all effects.
110 * @param[in] angleSwing The maximum amount the child actor should
111 * rotate in radians for each axis (X and Y) if the scrollview reaches
112 * overshoot. Default is PI/2 i.e. 90 degrees rotation.
113 * @param[in] scaleAmount The relative amount to shrink Actors as they
114 * are panned fast (flick animation). default is 0.125 (12.5% shrinkage)
115 * @param[in] delayMin The minimum delay coefficient for Actors at the
116 * scroll-view center. Set to 0 for instantaneous, and 1 for infinite delay.
118 * @param[in] delayMax The maximum delay coefficient for Actors at the
119 * scroll-view approx 1 ScrollView size from the center. Set to 0 for
120 * instantaneous, and 1 for infinite delay. Default is 0.9f (a slight delay)
122 void ApplyToActor( Actor child,
123 bool additionalEffects = true,
124 const Vector2& angleSwing = Vector2( Math::PI_4, Math::PI_4 ),
125 float scaleAmount = 0.125f,
126 float delayMin = 0.0f,
127 float delayMax = 0.9f );
130 * @brief Set the maximum swing angle when at zero drop off.
132 * @param[in] maxSwingAngle maximum swing angle for x and y axes
134 void SetMaxSwingAngle(const Vector2& maxSwingAngle);
137 * @brief Set the drop off values to affect the amount of swing
138 * angle applied to an actor the further it is from the scroll
141 * A drop off of 0.0f means no angle drop off while 1.0f will reduce
142 * the angle to zero over the distance supplied for that axis.
144 * Example maxSwingAngle.x is Pi, dropOff.x is 0.5f and distance.x is 100.0f:
145 * The angle on the x axis will reduce to (0.5f * Pi) over 100 pixels
147 * @param[in] dropOff amount to reduce swing angle by in the range [0.0f, 1.0f]. 0.0f
148 * @param[in] distance distance to apply dropOff in pixels
149 * @param[in] function Alpha Function to affect how drop off is applied over distance, NULL for linear application
151 void SetSwingDropOff(const Vector2& dropOff, const Vector2& distance, AlphaFunction function = NULL);
156 * @brief This constructor is used by Dali New() methods.
158 * @param [in] impl A pointer to a newly allocated Dali resource
160 ScrollViewTwistEffect(Internal::ScrollViewTwistEffect *impl);
164 } // namespace Toolkit
171 #endif // __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__