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 FUiAnimDiscreteTimingFunction.h
20 * @brief This is the header file for the %DiscreteTimingFunction class.
22 * This header file contains the declarations of the %DiscreteTimingFunction class.
25 #ifndef _FUI_ANIM_DISCRETE_TIMING_FUNCTION_H_
26 #define _FUI_ANIM_DISCRETE_TIMING_FUNCTION_H_
28 #include <FUiAnimIVisualElementAnimationTimingFunction.h>
30 namespace Tizen { namespace Ui { namespace Animations
34 * @class DiscreteTimingFunction
35 * @brief This class stores the information of a discrete timing function.
39 * The %DiscreteTimingFunction class provides discrete 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_ DiscreteTimingFunction
45 : public Tizen::Base::Object
46 , public IVisualElementAnimationTimingFunction
51 * This is the constructor for this class.
55 DiscreteTimingFunction(void);
59 * This is the destructor for this class.
63 virtual ~DiscreteTimingFunction(void);
67 * Calculates the progress(pace) of an animation regarding the time elapsed.
71 * @return The progress(pace) value calculated with trigger time progress value @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 time progress value of trigger point.
84 * @return An error code
85 * @param[in] timeProgress The time progress value of trigger point @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 less than @c 0 or greater than @c 1.
89 * @see GetTriggerTimeProgress()
91 result SetTriggerTimeProgress(float timeProgress);
95 * Gets the time progress value of trigger point.
99 * @return The time progress value of trigger point
100 * @see SetTriggerTimeProgress()
102 float GetTriggerTimeProgress(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 DiscreteTimingFunction(const DiscreteTimingFunction& 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 // Assigns the value of the specified instance to the current instance of %DiscreteTimingFunction.
126 DiscreteTimingFunction& operator =(const DiscreteTimingFunction& rhs);
132 * The time progress value of trigger point.
136 float __triggerTimeProgress;
137 }; // DiscreteTimingFunction
140 }}} // Tizen::Ui::Animations
142 #endif //_FUI_ANIM_DISCRETE_TIMING_FUNCTION_H_