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_FRAMEWORK
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 * ScrollView Twist-Effect.
46 class ScrollViewTwistEffect : public ScrollViewEffect
51 static const std::string EFFECT_TIME;
52 static const std::string EFFECT_REFERENCE;
53 static const std::string EFFECT_DEPTH;
54 static const std::string EFFECT_ACTIVATE;
55 static const float DEFAULT_MINIMUM_DISTANCE_FOR_SHRINK;
60 * Create an initialized ScrollViewTwistEffect.
61 * @return A handle to a newly allocated Dali resource.
63 static ScrollViewTwistEffect New();
66 * Create an uninitialized ScrollViewTwistEffect; this can be initialized with ScrollViewTwistEffect::New()
67 * Calling member functions with an uninitialized Toolkit::ScrollViewTwistEffect is not allowed.
69 ScrollViewTwistEffect();
72 * Downcast an Object handle to ScrollViewTwistEffect. 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 * Gets the minimum animation distance for the shrink effect to
82 * @return The minimum distance in seconds is returned.
84 float GetMinimumDistanceForShrink() const;
87 * Sets the minimum animation distance for the shrink effect
89 * @param[in] distance The minimum distance in pixels (default = 0.0)
90 * i.e. any flick will result in shrinking.
92 void SetMinimumDistanceForShrink(float distance);
95 * Enable or disable this effect.
96 * @param[in] enableFlag Set to true if the effect should be enabled.
98 void EnableEffect(bool enableFlag);
101 * 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 * 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 * Set the drop off values to affect the amount of swing angle applied to an actor the further it is from
134 * the scroll position. A drop off of 0.0f means no angle drop off while 1.0f will reduce the angle to zero
135 * over the distance supplied for that axis.
137 * Example maxSwingAngle.x is Pi, dropOff.x is 0.5f and distance.x is 100.0f:
138 * The angle on the x axis will reduce to (0.5f * Pi) over 100 pixels
140 * @param[in] dropOff amount to reduce swing angle by in the range [0.0f, 1.0f]. 0.0f
141 * @param[in] distance distance to apply dropOff in pixels
142 * @param[in] function Alpha Function to affect how drop off is applied over distance, NULL for linear application
144 void SetSwingDropOff(const Vector2& dropOff, const Vector2& distance, AlphaFunction function = NULL);
149 * This constructor is used by Dali New() methods.
150 * @param [in] impl A pointer to a newly allocated Dali resource
152 ScrollViewTwistEffect(Internal::ScrollViewTwistEffect *impl);
156 } // namespace Toolkit
163 #endif // __DALI_TOOLKIT_SCROLL_VIEW_TWIST_EFFECT_H__