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 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
24 namespace Dali DALI_IMPORT_API
32 class ScrollViewEffect;
34 namespace Internal DALI_INTERNAL
36 class ScrollViewTwistEffect;
40 * @brief ScrollView effect that twists pages onto screen when transitioning.
42 class ScrollViewTwistEffect : public ScrollViewEffect
47 static const float DEFAULT_MINIMUM_DISTANCE_FOR_SHRINK; ///< The min distance for shrink
52 * @brief Create an initialized ScrollViewTwistEffect.
54 * @return A handle to a newly allocated Dali resource.
56 static ScrollViewTwistEffect New();
59 * @brief Create an uninitialized ScrollViewTwistEffect; this can be initialized with ScrollViewTwistEffect::New().
61 * Calling member functions with an uninitialized Toolkit::ScrollViewTwistEffect is not allowed.
63 ScrollViewTwistEffect();
66 * @brief Downcast an Object handle to ScrollViewTwistEffect.
68 * If handle points to a ScrollViewTwistEffect the
69 * downcast produces valid handle. If not the returned handle is left uninitialized.
70 * @param[in] handle Handle to an object
71 * @return handle to a ScrollViewTwistEffect or an uninitialized handle
73 static ScrollViewTwistEffect DownCast( BaseHandle handle );
76 * @brief Gets the minimum animation distance for the shrink effect to
79 * @return The minimum distance in seconds is returned.
81 float GetMinimumDistanceForShrink() const;
84 * @brief Sets the minimum animation distance for the shrink effect
87 * @param[in] distance The minimum distance in pixels (default = 0.0)
88 * i.e. any flick will result in shrinking.
90 void SetMinimumDistanceForShrink(float distance);
93 * @brief Enable or disable this effect.
95 * @param[in] enableFlag Set to true if the effect should be enabled.
97 void EnableEffect(bool enableFlag);
100 * @brief Manually apply effect to an Actor.
102 * @param[in] child The child Actor to be affected by this effect.
103 * @param[in] additionalEffects Whether just the basic effect (delay)
104 * should be applied. Or all effects (delay, rotation, scaling).
105 * For all effects set to true. Default is true i.e. apply all effects.
106 * @param[in] angleSwing The maximum amount the child actor should
107 * rotate in radians for each axis (X and Y) if the scrollview reaches
108 * overshoot. Default is PI/2 i.e. 90 degrees rotation.
109 * @param[in] scaleAmount The relative amount to shrink Actors as they
110 * are panned fast (flick animation). default is 0.125 (12.5% shrinkage)
111 * @param[in] delayMin The minimum delay coefficient for Actors at the
112 * scroll-view center. Set to 0 for instantaneous, and 1 for infinite delay.
114 * @param[in] delayMax The maximum delay coefficient for Actors at the
115 * scroll-view approx 1 ScrollView size from the center. Set to 0 for
116 * instantaneous, and 1 for infinite delay. Default is 0.9f (a slight delay)
118 void ApplyToActor( Actor child,
119 bool additionalEffects = true,
120 const Vector2& angleSwing = Vector2( Math::PI_4, Math::PI_4 ),
121 float scaleAmount = 0.125f,
122 float delayMin = 0.0f,
123 float delayMax = 0.9f );
126 * @brief Set the maximum swing angle when at zero drop off.
128 * @param[in] maxSwingAngle maximum swing angle for x and y axes
130 void SetMaxSwingAngle(const Vector2& maxSwingAngle);
133 * @brief Retrieve the maximum swing angle when at zero drop off.
135 * @return The maximum swing angle for x and y axes
137 Vector2 GetMaxSwingAngle() const;
140 * @brief Set the drop off values to affect the amount of swing
141 * angle applied to an actor the further it is from the scroll
144 * A drop off of 0.0f means no angle drop off while 1.0f will reduce
145 * the angle to zero over the distance supplied for that axis.
147 * Example maxSwingAngle.x is Pi, dropOff.x is 0.5f and distance.x is 100.0f:
148 * The angle on the x axis will reduce to (0.5f * Pi) over 100 pixels
150 * @param[in] dropOff amount to reduce swing angle by in the range [0.0f, 1.0f]. 0.0f
151 * @param[in] distance distance to apply dropOff in pixels
152 * @param[in] function Alpha Function to affect how drop off is applied over distance, NULL for linear application
154 void SetSwingDropOff(const Vector2& dropOff, const Vector2& distance, AlphaFunction function = NULL);
157 * @brief Get the drop off values that affect the amount of swing angle that is applied to an actor.
159 * @param[out] dropOff The current drop-off amount.
160 * @param[out] distance The current distance to apply drop-off in pixels.
161 * @param[out] function The current alpha function used to affect how the drop iff is applied over the distance.
163 void GetSwingDropOff( Vector2& dropOff, Vector2& distance, AlphaFunction& function ) const;
168 * @brief This constructor is used by Dali New() methods.
170 * @param [in] impl A pointer to a newly allocated Dali resource
172 ScrollViewTwistEffect(Internal::ScrollViewTwistEffect *impl);
176 } // namespace Toolkit
180 #endif // __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__