inc/FUiAnimExpOutTimingFunction.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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        FUiAnimExpOutTimingFunction.h
  20  * @brief       This is the header file for the %ExpOutTimingFunction class.
  21  *
  22  * This header file contains the declarations of the %ExpOutTimingFunction class.
  23  */
  24
  25 #ifndef _FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_
  26 #define _FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_
  27
  28 #include <FUiAnimIVisualElementAnimationTimingFunction.h>
  29
  30 namespace Tizen { namespace Ui { namespace Animations
  31 {
  32
  33
  34 /**
  35  * @class       ExpOutTimingFunction
  36  * @brief       This class stores the information of an exp-out timing function.
  37  *
  38  * @since       2.0
  39  *
  40  * The %ExpOutTimingFunction class provides exp-out timing function related information.
  41  *
  42  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/timing_function.htm">Timing Function</a>.
  43  *
  44  */
  45 class _OSP_EXPORT_ ExpOutTimingFunction
  46         : public Tizen::Base::Object
  47         , public IVisualElementAnimationTimingFunction
  48 {
  49 public:
  50
  51         /**
  52          * This is the constructor for this class.
  53          *
  54          * @since       2.0
  55          */
  56         ExpOutTimingFunction(void);
  57
  58
  59         /**
  60          * This is the destructor for this class.
  61          *
  62          * @since       2.0
  63          */
  64         virtual ~ExpOutTimingFunction(void);
  65
  66
  67         /**
  68          * Calculates the progress(pace) of an animation regarding the time elapsed.
  69          *
  70          * @since       2.0
  71          *
  72          * @return      The progress(pace) value calculated by exp-in equation with scale value @n
  73          *                      @c 0 and @c 1 are the start and end values of an animation, respectively.
  74          * @param[in]   timeProgress    The time progress value @n
  75          *                                                              This must be in the range @c 0.0 to @c 1.0.
  76          */
  77         virtual float CalculateProgress(float timeProgress) const;
  78
  79
  80         /**
  81          * Sets the scale value.
  82          *
  83          * @since       2.0
  84          *
  85          * @return      An error code
  86          * @param[in]   scale                           The scale value
  87          * @exception   E_SUCCESS                       The method is successful.
  88          * @exception   E_INVALID_ARG           The value of the specified parameter is @c 0.0 or negative.
  89          * @see         GetScaleValue()
  90          */
  91         result SetScaleValue(float scale);
  92
  93
  94         /**
  95          * Gets the scale value.
  96          *
  97          * @since       2.0
  98          *
  99          * @return  The scale value
 100          * @see         SetScaleValue()
 101          */
 102         float GetScaleValue(void) const;
 103
 104 private:
 105
 106         //
 107         // This method is for internal use only. Using this method can cause behavioral, security-related,
 108         // and consistency-related issues in the application.
 109         //
 110         // This is the assignment operator for this class.
 111         //
 112         // @since  2.0
 113         //
 114         ExpOutTimingFunction(const ExpOutTimingFunction& rhs);
 115
 116
 117         //
 118         // This method is for internal use only. Using this method can cause behavioral, security-related,
 119         // and consistency-related issues in the application.
 120         //
 121         // Assigns the value of the specified instance to the current instance of %ExpOutTimingFunction.
 122         //
 123         // @since  2.0
 124         //
 125         ExpOutTimingFunction& operator =(const ExpOutTimingFunction& rhs);
 126
 127
 128 private:
 129
 130         /**
 131          * The scale value.
 132          *
 133          * @since       2.0
 134          */
 135         float __scale;
 136
 137         /**
 138          * The divisor for exponential timing function.
 139          *
 140          * @since       2.0
 141          */
 142         float __divisor;
 143 };              // ExpOutTimingFunction
 144
 145
 146 }}}             // Tizen::Ui::Animations
 147
 148 #endif //_FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_