2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Flora License, Version 1.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://floralicense.org/license/
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an AS IS BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FUiAnimFrameAnimator.h
20 * @brief This is the header file for the %FrameAnimator class.
22 * This header file contains the declarations of the %FrameAnimator class.
25 #ifndef _FUI_ANIM_FRAME_ANIMATOR_H_
26 #define _FUI_ANIM_FRAME_ANIMATOR_H_
28 #include <FUiAnimIFrameAnimatorEventListener.h>
31 namespace Tizen { namespace Ui { namespace Controls
37 namespace Tizen { namespace Ui { namespace Animations
42 * @class FrameAnimator
43 * @brief This class defines the animation methods for Frame.
47 * @final This class is not intended for extension.
49 * The %FrameAnimator class is used to control the animations operated on a Frame.
51 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/animating_formstransition.htm">Animating a Form Transition</a>.
54 class _OSP_EXPORT_ FrameAnimator
55 : public Tizen::Base::Object
60 * This is the destructor for this class.
64 virtual ~FrameAnimator(void);
68 * Adds an IFrameAnimatorEventListener instance to the current instance of the frame. @n
69 * The added listener can listen to events on the given event dispatcher's context when they are fired.
73 * @return An error code
74 * @param[in] listener The listener to add
75 * @exception E_SUCCESS The method is successful.
76 * @exception E_UNSUPPORTED_OPERATION The animation support is unavailable.
77 * @exception E_OBJ_ALREADY_EXIST The specified @c listener is already added.
78 * @exception E_SYSTEM A system error has occurred.
80 result AddFrameAnimatorEventListener(IFrameAnimatorEventListener& listener);
84 * Removes an IFrameAnimatorEventListener instance from the current instance of the frame. @n
85 * The removed listener cannot listen to events when they are fired.
89 * @return An error code
90 * @param[in] listener The listener to remove
91 * @exception E_SUCCESS The method is successful.
92 * @exception E_UNSUPPORTED_OPERATION The animation support is unavailable.
93 * @exception E_OBJ_NOT_FOUND The specified @c listener is not found.
94 * @exception E_SYSTEM A system error has occurred.
96 result RemoveFrameAnimatorEventListener(IFrameAnimatorEventListener& listener);
100 * Gets the animation status of the frame animator.
104 * @return The animation state of the frame animator
106 AnimatorStatus GetStatus(void) const;
110 * Sets the specified form as the current form of the frame with an animation.
114 * @return An error code
115 * @param[in] form The form object to set
116 * @exception E_SUCCESS The method is successful.
117 * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation.
118 * @exception E_SYSTEM A system error has occurred.
119 * @remarks Control::Invalidate() need not be called to display the form. @n
120 * To select the animation to be used during this method, use SetFormTransitionAnimation() before calling this method.
122 result SetCurrentForm(const Tizen::Ui::Controls::Form& form);
126 * Sets the type of the form transition animation.
130 * @param[in] animation The type of form transition animation to set
131 * @param[in] duration The duration of animation in milliseconds @n
132 * The maximum duration is one second.
133 * @param[in] interpolator The type of interpolator used for the intermediate value calculation of the animation
135 void SetFormTransitionAnimation(FrameAnimatorFormTransitionAnimation animation, long duration, AnimationInterpolatorType interpolator);
139 * Gets the type of the form transition animation.
143 * @param[out] animation The type of form transition animation used
144 * @param[out] duration The duration of animation in milliseconds
145 * @param[out] interpolator The type of interpolator used for the intermediate value calculation of the animation
147 void GetFormTransitionAnimation(FrameAnimatorFormTransitionAnimation& animation, long& duration, AnimationInterpolatorType& interpolator) const;
151 * Sets the control points for the Bezier interpolator. @n
152 * The %SetFormTransitionBezierControlPoints() method is supported only if the interpolator is @c ANIMATION_INTERPOLATOR_BEZIER.
156 * @return An error code
157 * @param[in] time1 The control point 1 - Time @n
158 * The time must be within the range @c 0.0 to @c 1.0.
159 * @param[in] value1 The control point 1 - Value @n
160 * The value must be within the range @c 0.0 to @c 1.0.
161 * @param[in] time2 The control point 2 - Time @n
162 * The time must be within the range @c 0.0 to @c 1.0.
163 * @param[in] value2 The control point 2 - Value @n
164 * The value must be within the range @c 0.0 to @c 1.0.
165 * @exception E_SUCCESS The method is successful.
166 * @exception E_INVALID_OPERATION The interpolator of this instance is not ANIMATION_INTERPOLATOR_BEZIER.
167 * @exception E_INVALID_ARG A specified input parameter is invalid.
169 result SetFormTransitionBezierControlPoints(float time1, float value1, float time2, float value2);
173 * Gets the control points of the Bezier interpolator. @n
174 * The %GetFormTransitionBezierControlPoints() method is supported only if the interpolator is @c ANIMATION_INTERPOLATOR_BEZIER. @n
175 * Therefore, @c 0 will be returned for other interpolators.
179 * @return An error code
180 * @param[out] time1 The control point 1 - Time
181 * @param[out] value1 The control point 1 - Value
182 * @param[out] time2 The control point 2 - Time
183 * @param[out] value2 The control point 2 - Value
184 * @exception E_SUCCESS The method is successful.
185 * @exception E_INVALID_OPERATION The interpolator of this instance is not ANIMATION_INTERPOLATOR_BEZIER.
187 result GetFormTransitionBezierControlPoints(float& time1, float& value1, float& time2, float& value2) const;
191 * Stops all the animations that are being played and jumps to the final frame of the animation.
195 * @return An error code
196 * @exception E_SUCCESS The method is successful.
197 * @exception E_SYSTEM A system error has occurred.
199 result StopAllAnimations(void);
204 friend class _FrameAnimatorImpl;
208 // This variable is for internal use only. Using this variable can cause behavioral, security-related,
209 // and consistency-related issues in the application.
211 // The variable for internal usage.
215 class _FrameAnimatorImpl* _pFrameAnimatorImpl;
221 // This method is for internal use only. Using this method can cause behavioral, security-related,
222 // and consistency-related issues in the application.
224 // This is the constructor for this class.
232 // This method is for internal use only. Using this method can cause behavioral, security-related,
233 // and consistency-related issues in the application.
235 // Initializes this class.
238 // @return An error code
239 // @param[in] source An instance of the Frame class
240 // @exception E_SUCCESS The method is successful.
241 // @exception E_SYSTEM A system error has occurred.
243 result Construct(const Tizen::Ui::Controls::Frame& source);
247 // This method is for internal use only. Using this method can cause behavioral, security-related,
248 // and consistency-related issues in the application.
250 // This is the copy constructor for the %FrameAnimator class.
254 FrameAnimator(const FrameAnimator& rhs);
258 // This method is for internal use only. Using this method can cause behavioral, security-related,
259 // and consistency-related issues in the application.
261 // Assigns the value of the specified instance to the current instance of %FrameAnimator.
265 FrameAnimator& operator =(const FrameAnimator& rhs);
268 friend class Tizen::Ui::Controls::_FrameImpl;
272 }}} // Tizen::Ui::Animations
274 #endif //_FUI_ANIM_FRAME_ANIMATOR_H_