Author: rwhitcomb
Date: Thu May 3 17:06:05 2018
New Revision: 1830844
URL: http://svn.apache.org/viewvc?rev=1830844&view=rev
Log:
Add Javadoc to the Easing interface to explain the methods
and parameters.
Modified:
pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/easing/Easing.java
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/easing/Easing.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/easing/Easing.java?rev=1830844&r1=1830843&r2=1830844&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/easing/Easing.java
(original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/effects/easing/Easing.java Thu May
3 17:06:05 2018
@@ -20,9 +20,42 @@ package org.apache.pivot.wtk.effects.eas
* Base interface for easing operations.
*/
public interface Easing {
+ /**
+ * Easing in - accelerating from zero velocity.
+ *
+ * @param time The current time since the beginning, or how long into
the
+ * easing we are.
+ * @param begin The beginning position.
+ * @param change The total change in position.
+ * @param duration The total duration of the easing.
+ * @return The updated position at the current point in time, according to
the
+ * easing equation.
+ */
public float easeIn(float time, float begin, float change, float duration);
+ /**
+ * Easing out - decelerating to zero velocity.
+ *
+ * @param time The current time since the beginning, or how long into
the
+ * easing we are.
+ * @param begin The beginning position.
+ * @param change The total change in position.
+ * @param duration The total duration of the easing.
+ * @return The updated position at the current point in time, according to
the
+ * easing equation.
+ */
public float easeOut(float time, float begin, float change, float
duration);
+ /**
+ * Easing in and out - acceleration until halfway, then deceleration.
+ *
+ * @param time The current time since the beginning, or how long into
the
+ * easing we are.
+ * @param begin The beginning position.
+ * @param change The total change in position.
+ * @param duration The total duration of the easing.
+ * @return The updated position at the current point in time, according to
the
+ * easing equation.
+ */
public float easeInOut(float time, float begin, float change, float
duration);
}
