src/ui/animations/FUiAnim_FloatAnimationImpl.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        FUiAnim_FloatAnimationImpl.h
  20  * @brief       This is the header file for the _FloatAnimationImpl class.
  21  *
  22  * This header file contains the declarations of the _FloatAnimationImpl class.
  23  */
  24
  25 #ifndef _FUI_ANIM_INTERNAL_FLOAT_ANIMATION_IMPL_H_
  26 #define _FUI_ANIM_INTERNAL_FLOAT_ANIMATION_IMPL_H_
  27
  28 #include <FUiAnimFloatAnimation.h>
  29
  30 namespace Tizen { namespace Ui { namespace Animations
  31 {
  32
  33 class _FloatAnimationImpl
  34         : public Tizen::Base::Object
  35 {
  36
  37 public:
  38         /**
  39          * Destructor for %_FloatAnimationImpl class.
  40          */
  41         ~_FloatAnimationImpl(void);
  42
  43         /**
  44          * Default constructor for %_FloatAnimationImpl class.
  45          */
  46         _FloatAnimationImpl(FloatAnimation* pFloat);
  47
  48         /**
  49          * To copy float animation object
  50          *
  51          * @since       2.0
  52          * @return              An error code
  53          * @param[in]   floatAnimation                  Float animation object
  54          * @exception   E_SUCCESS                       The method was successful.
  55          * @exception   E_SYSTEM                        A system error occurred.
  56          * @exception   E_INVALID_ARG           A specified input parameter is invalid.
  57          */
  58         result CopyFloatAnimationValue(const FloatAnimation& floatAnimation);
  59
  60         /**
  61          * Gets the animated value for the current time.
  62          *
  63          * @since 2.0
  64          * @return      An error code
  65          * @param[in]   actualProgress  The current time value of the animation @n
  66          *                                                              The value should be between @c 0 and 1
  67          * @param[out]  animatedValue   The animated value for the current time passed as the input parameter
  68          * @exception   E_SUCCESS               The method is successful.
  69          * @exception   E_INVALID_ARG   A specified input parameter is invalid.
  70          * @exception   E_INVALID_STATE This instance has not been properly constructed.
  71          * @exception   E_SYSTEM                A system error has occurred.
  72          *
  73          */
  74         result GetAnimatedValue(float actualProgress, float& animatedValue) const;
  75
  76         /**
  77          *      The start value of the animation
  78          */
  79         Tizen::Base::Float startValue;
  80
  81         /**
  82          *      The end value of the animation
  83          */
  84         Tizen::Base::Float endValue;
  85
  86
  87 private:
  88         /**
  89          *  Private copy constructor.
  90          */
  91         _FloatAnimationImpl(const _FloatAnimationImpl& rhs);
  92
  93         /**
  94          *  Private assignment operator.
  95          */
  96         _FloatAnimationImpl& operator =(const _FloatAnimationImpl& rhs);
  97
  98         /**
  99          * This is object of FloatAnimation class
 100          *
 101          */
 102         FloatAnimation* __pFloatAnimation;
 103
 104 };      //_FloatAnimationImpl
 105
 106 }}}     // Tizen::Ui::Animations
 107
 108 #endif //_FUI_ANIM_INTERNAL_FLOAT_ANIMATION_IMPL_H_