2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0/
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 FUiAnimExpOutTimingFunction.h
20 * @brief This is the header file for the %ExpOutTimingFunction class.
22 * This header file contains the declarations of the %ExpOutTimingFunction class.
25 #ifndef _FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_
26 #define _FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_
28 #include <FUiAnimIVisualElementAnimationTimingFunction.h>
30 namespace Tizen { namespace Ui { namespace Animations
35 * @class ExpOutTimingFunction
36 * @brief This class stores the information of an exp-out timing function.
40 * The %ExpOutTimingFunction class provides exp-out timing function related information.
42 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/timing_function.htm">Timing Function</a>.
45 class _OSP_EXPORT_ ExpOutTimingFunction
46 : public Tizen::Base::Object
47 , public IVisualElementAnimationTimingFunction
52 * This is the constructor for this class.
56 ExpOutTimingFunction(void);
60 * This is the destructor for this class.
64 virtual ~ExpOutTimingFunction(void);
68 * Calculates the progress(pace) of an animation regarding the time elapsed.
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.
77 virtual float CalculateProgress(float timeProgress) const;
81 * Sets the scale value.
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()
91 result SetScaleValue(float scale);
95 * Gets the scale value.
99 * @return The scale value
100 * @see SetScaleValue()
102 float GetScaleValue(void) const;
107 // This method is for internal use only. Using this method can cause behavioral, security-related,
108 // and consistency-related issues in the application.
110 // This is the assignment operator for this class.
114 ExpOutTimingFunction(const ExpOutTimingFunction& rhs);
118 // This method is for internal use only. Using this method can cause behavioral, security-related,
119 // and consistency-related issues in the application.
121 // Assigns the value of the specified instance to the current instance of %ExpOutTimingFunction.
125 ExpOutTimingFunction& operator =(const ExpOutTimingFunction& rhs);
138 * The divisor for exponential timing function.
143 }; // ExpOutTimingFunction
146 }}} // Tizen::Ui::Animations
148 #endif //_FUI_ANIM_EXP_OUT_TIMING_FUNCTION_H_