inc/FUiAnimFrameAnimator.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://floralicense.org/license/
  10 //
  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.
  16 //
  17
  18 /**
  19  * @file        FUiAnimFrameAnimator.h
  20  * @brief       This is the header file for the %FrameAnimator class.
  21  *
  22  * This header file contains the declarations of the %FrameAnimator class.
  23  */
  24
  25 #ifndef _FUI_ANIM_FRAME_ANIMATOR_H_
  26 #define _FUI_ANIM_FRAME_ANIMATOR_H_
  27
  28 #include <FUiAnimIFrameAnimatorEventListener.h>
  29
  30
  31 namespace Tizen { namespace Ui {  namespace Controls
  32 {
  33 class Form;
  34 class _FrameImpl;
  35 } } }
  36
  37 namespace Tizen { namespace Ui { namespace Animations
  38 {
  39
  40
  41 /**
  42  * @class       FrameAnimator
  43  * @brief       This class defines the animation methods for Frame.
  44  *
  45  * @since       2.0
  46  *
  47  * @final   This class is not intended for extension.
  48  *
  49  * The %FrameAnimator class is used to control the animations operated on a Frame.
  50  *
  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>.
  52  *
  53  */
  54 class _OSP_EXPORT_ FrameAnimator
  55         : public Tizen::Base::Object
  56 {
  57 public:
  58
  59         /**
  60          * This is the destructor for this class.
  61          *
  62          * @since       2.0
  63          */
  64         virtual ~FrameAnimator(void);
  65
  66
  67         /**
  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.
  70          *
  71          * @since       2.0
  72          *
  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.
  79          */
  80         result AddFrameAnimatorEventListener(IFrameAnimatorEventListener& listener);
  81
  82
  83         /**
  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.
  86          *
  87          * @since       2.0
  88          *
  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.
  95          */
  96         result RemoveFrameAnimatorEventListener(IFrameAnimatorEventListener& listener);
  97
  98
  99         /**
 100          * Gets the animation status of the frame animator.
 101          *
 102          * @since       2.0
 103          *
 104          * @return      The animation state of the frame animator
 105          */
 106         AnimatorStatus GetStatus(void) const;
 107
 108
 109         /**
 110          * Sets the specified form as the current form of the frame with an animation.
 111          *
 112          * @since       2.0
 113          *
 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.
 121          */
 122         result SetCurrentForm(const Tizen::Ui::Controls::Form& form);
 123
 124         /**
 125          * Sets the specified form as the current form of the frame with an animation.
 126          *
 127          * @since       2.1
 128          *
 129          * @return              An error code
 130          * @param[in]           pForm                           A pointer to form object to set.
 131          * @exception     E_SUCCESS                             The method is successful.
 132          * @exception   E_INVALID_ARG                             The specified @c pForm is @c null.
 133          * @exception   E_INVALID_OPERATION             The current state of the instance prohibits the execution of the specified operation.
 134          * @exception     E_SYSTEM                              A system error has occurred.
 135          * @remarks             Control::Invalidate() need not be called to display the form. @n
 136          *                              To select the animation to be used during this method, use SetFormTransitionAnimation() before calling this method.
 137          */
 138         result SetCurrentForm(Tizen::Ui::Controls::Form* pForm);
 139
 140
 141         /**
 142          * Sets the type of the form transition animation.
 143          *
 144          * @since       2.0
 145          *
 146          * @param[in]   animation                       The type of form transition animation to set
 147          * @param[in]   duration                        The duration of animation in milliseconds @n
 148          *                                                                      The maximum duration is one second.
 149          * @param[in]   interpolator            The type of interpolator used for the intermediate value calculation of the animation
 150          */
 151         void SetFormTransitionAnimation(FrameAnimatorFormTransitionAnimation animation, long duration, AnimationInterpolatorType interpolator);
 152
 153
 154         /**
 155          * Gets the type of the form transition animation.
 156          *
 157          * @since       2.0
 158          *
 159          * @param[out]  animation                       The type of form transition animation used
 160          * @param[out]  duration                        The duration of animation in milliseconds
 161          * @param[out]  interpolator            The type of interpolator used for the intermediate value calculation of the animation
 162          */
 163         void GetFormTransitionAnimation(FrameAnimatorFormTransitionAnimation& animation, long& duration, AnimationInterpolatorType& interpolator) const;
 164
 165
 166         /**
 167          * Sets the control points for the Bezier interpolator. @n
 168          * The %SetFormTransitionBezierControlPoints() method is supported only if the interpolator is @c ANIMATION_INTERPOLATOR_BEZIER.
 169          *
 170          * @since       2.0
 171          *
 172          * @return              An error code
 173          * @param[in]   time1                           The control point 1 - Time @n
 174          *                                                                      The time must be within the range @c 0.0 to @c 1.0.
 175          * @param[in]   value1                          The control point 1 - Value @n
 176          *                                                                      The value must be within the range @c 0.0 to @c 1.0.
 177          * @param[in]   time2                           The control point 2 - Time @n
 178          *                                                                      The time must be within the range @c 0.0 to @c 1.0.
 179          * @param[in]   value2                          The control point 2 - Value @n
 180          *                                                                      The value must be within the range @c 0.0 to @c 1.0.
 181          * @exception   E_SUCCESS                       The method is successful.
 182          * @exception   E_INVALID_OPERATION The interpolator of this instance is not ANIMATION_INTERPOLATOR_BEZIER.
 183          * @exception   E_INVALID_ARG           A specified input parameter is invalid.
 184          */
 185         result SetFormTransitionBezierControlPoints(float time1, float value1, float time2, float value2);
 186
 187
 188         /**
 189          * Gets the control points of the Bezier interpolator. @n
 190          * The %GetFormTransitionBezierControlPoints() method is supported only if the interpolator is @c ANIMATION_INTERPOLATOR_BEZIER. @n
 191          * Therefore, @c 0 will be returned for other interpolators.
 192          *
 193          * @since       2.0
 194          *
 195          * @return              An error code
 196          * @param[out]  time1                           The control point 1 - Time
 197          * @param[out]  value1                          The control point 1 - Value
 198          * @param[out]  time2                           The control point 2 - Time
 199          * @param[out]  value2                          The control point 2 - Value
 200          * @exception   E_SUCCESS                       The method is successful.
 201          * @exception   E_INVALID_OPERATION The interpolator of this instance is not ANIMATION_INTERPOLATOR_BEZIER.
 202          */
 203         result GetFormTransitionBezierControlPoints(float& time1, float& value1, float& time2, float& value2) const;
 204
 205
 206         /**
 207          * Stops all the animations that are being played and jumps to the final frame of the animation.
 208          *
 209          * @since       2.0
 210          *
 211          * @return              An error code
 212          * @exception   E_SUCCESS                       The method is successful.
 213          * @exception   E_SYSTEM                        A system error has occurred.
 214          */
 215         result StopAllAnimations(void);
 216
 217
 218 protected:
 219
 220         friend class _FrameAnimatorImpl;
 221
 222
 223         //
 224         // This variable is for internal use only. Using this variable can cause behavioral, security-related,
 225         // and consistency-related issues in the application.
 226         //
 227         // The variable for internal usage.
 228         //
 229         // @since        2.0
 230         //
 231         class _FrameAnimatorImpl* _pFrameAnimatorImpl;
 232
 233
 234 private:
 235
 236         //
 237         // This method is for internal use only. Using this method can cause behavioral, security-related,
 238         // and consistency-related issues in the application.
 239         //
 240         // This is the constructor for this class.
 241         //
 242         // @since       2.0
 243         //
 244         FrameAnimator(void);
 245
 246
 247         //
 248         // This method is for internal use only. Using this method can cause behavioral, security-related,
 249         // and consistency-related issues in the application.
 250         //
 251         // Initializes this class.
 252         //
 253         // @since       2.0
 254         // @return              An error code
 255         // @param[in]   source                          An instance of the Frame class
 256         // @exception   E_SUCCESS                       The method is successful.
 257         // @exception   E_SYSTEM                        A system error has occurred.
 258         //
 259         result Construct(const Tizen::Ui::Controls::Frame& source);
 260
 261
 262         //
 263         // This method is for internal use only. Using this method can cause behavioral, security-related,
 264         // and consistency-related issues in the application.
 265         //
 266         // This is the copy constructor for the %FrameAnimator class.
 267         //
 268         // @since       2.0
 269         //
 270         FrameAnimator(const FrameAnimator& rhs);
 271
 272
 273         //
 274         // This method is for internal use only. Using this method can cause behavioral, security-related,
 275         // and consistency-related issues in the application.
 276         //
 277         // Assigns the value of the specified instance to the current instance of %FrameAnimator.
 278         //
 279         // @since       2.0
 280         //
 281         FrameAnimator& operator =(const FrameAnimator& rhs);
 282
 283
 284         friend class Tizen::Ui::Controls::_FrameImpl;
 285 };              // FrameAnimator
 286
 287
 288 }}}             // Tizen::Ui::Animations
 289
 290 #endif //_FUI_ANIM_FRAME_ANIMATOR_H_