inc/FUiAnimIVisualElementAnimationTimingFunction.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        FUiAnimIVisualElementAnimationTimingFunction.h
  20  * @brief       This is the header file for the %IVisualElementAnimationTimingFunction interface.
  21  *
  22  * This header file contains the declarations of the %IVisualElementAnimationTimingFunction interface.
  23  */
  24
  25 #ifndef _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TIMING_FUNCTION_H_
  26 #define _FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TIMING_FUNCTION_H_
  27
  28 #include <FBaseObject.h>
  29
  30 namespace Tizen { namespace Ui { namespace Animations
  31 {
  32
  33
  34 /**
  35  * @interface   IVisualElementAnimationTimingFunction
  36  * @brief               This interface implements the timing function for the VisualElementAnimation defined in the Tizen::Ui::Animations namespace.
  37  *
  38  * @since               2.0
  39  *
  40  * The %IVisualElementAnimationTimingFunction interface is the timing function interface for the pacing of an animation.
  41  * The class that defines the pacing of an animation as a timing curve implements this interface,
  42  * and the instance created with that class is registered with an animation,
  43  * using the VisualElementAnimation::SetTimingFunction() method or the AnimationTransaction::SetVisualElementAnimationTimingFunction() method.
  44  * When tick of the animation occurs, a method of that instance is invoked.
  45  *
  46  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/timing_function.htm">Timing Function</a>.
  47  *
  48  */
  49 class _OSP_EXPORT_ IVisualElementAnimationTimingFunction
  50 {
  51 public:
  52
  53         /**
  54          * This is the default constructor for this class.
  55          *
  56          * @since       2.0
  57          */
  58         IVisualElementAnimationTimingFunction(void);
  59
  60
  61         /**
  62          * This is the destructor for this class.
  63          *
  64          * @since       2.0
  65          */
  66         virtual ~IVisualElementAnimationTimingFunction(void);
  67
  68
  69         /**
  70          * Calculates the progress(pace) of an animation regarding the time elapsed.
  71          *
  72          * @since       2.0
  73          *
  74          * @return      The progress(pace) value calculated by the time progress value and the timing function type @n
  75          *                      @c 0 and @c 1 are the start and end values of an animation, respectively.
  76          * @param[in]   timeProgress    The time progress value @n
  77          *                               This must be in the range @c 0.0 to @c 1.0.
  78          */
  79         virtual float CalculateProgress(float timeProgress) const = 0;
  80
  81
  82 private:
  83
  84         //
  85         // This method is for internal use only. Using this method can cause behavioral, security-related,
  86         // and consistency-related issues in the application.
  87         //
  88         // This is the assignment operator for this class.
  89         //
  90         // @since  2.0
  91         //
  92         IVisualElementAnimationTimingFunction(const IVisualElementAnimationTimingFunction& rhs);
  93
  94
  95         //
  96         // This method is for internal use only. Using this method can cause behavioral, security-related,
  97         // and consistency-related issues in the application.
  98         //
  99         // Assigns the value of the specified instance to the current instance of %IVisualElementAnimationTimingFunction.
 100         //
 101         // @since  2.0
 102         //
 103         IVisualElementAnimationTimingFunction& operator =(const IVisualElementAnimationTimingFunction& rhs);
 104 };              // IVisualElementAnimationTimingFunction
 105
 106
 107 }}}             // Tizen::Ui::Animations
 108
 109 #endif //_FUI_ANIM_IVISUAL_ELEMENT_ANIMATION_TIMING_FUNCTION_H_