2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://floralicense.org/license/
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 FUiAnimEaseElasticInTimingFunction.h
20 * @brief This is the header file for the %EaseElasticInTimingFunction class.
22 * This header file contains the declarations of the %EaseElasticInTimingFunction class.
25 #ifndef _FUI_ANIM_EASE_ELASTIC_IN_TIMING_FUNCTION_H_
26 #define _FUI_ANIM_EASE_ELASTIC_IN_TIMING_FUNCTION_H_
28 #include <FUiAnimIVisualElementAnimationTimingFunction.h>
30 namespace Tizen { namespace Ui { namespace Animations
34 * @class EaseElasticInTimingFunction
35 * @brief This class stores the information of an ease-elastic-in timing function.
39 * The %EaseElasticInTimingFunction class provides ease-elastic-in timing function related information.
41 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/timing_function.htm">Timing Function</a>.
44 class _OSP_EXPORT_ EaseElasticInTimingFunction
45 : public Tizen::Base::Object
46 , public IVisualElementAnimationTimingFunction
51 * This is the constructor for this class.
55 EaseElasticInTimingFunction(void);
59 * This is the destructor for this class.
63 virtual ~EaseElasticInTimingFunction(void);
67 * Calculates the progress(pace) of an animation regarding the time elapsed.
71 * @return The progress(pace) value calculated by ease-elastic-in equation with period @n
72 * @c 0 and @c 1 are the start and end values of an animation, respectively.
73 * @param[in] timeProgress The time progress value @n
74 * This must be in the range @c 0.0 to @c 1.0.
76 virtual float CalculateProgress(float timeProgress) const;
80 * Sets the period value as period of sine curve.
84 * @return An error code
85 * @param[in] period The period value @n
86 * This must be in the range @c 0.0 to @c 1.0 and cannot be @c 0.0 and @c 1.0.
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.
91 result SetPeriod(float period);
95 * Gets the period value.
99 * @return The period value
102 float GetPeriod(void) const;
108 // This method is for internal use only. Using this method can cause behavioral, security-related,
109 // and consistency-related issues in the application.
111 // This is the assignment operator for this class.
115 EaseElasticInTimingFunction(const EaseElasticInTimingFunction& rhs);
119 // This method is for internal use only. Using this method can cause behavioral, security-related,
120 // and consistency-related issues in the application.
122 // This is the copy constructor for the EaseElasticInTimingFunction class.
126 EaseElasticInTimingFunction& operator= (const EaseElasticInTimingFunction& rhs);
137 }; // EaseElasticInTimingFunction
140 }}} // Tizen::Ui::Animations
142 #endif //_FUI_ANIM_EASE_ELASTIC_IN_TIMING_FUNCTION_H_