diff gnv-artifacts/src/main/java/de/intevation/gnv/math/Interpolator.java @ 805:bb7afd783321

Removed trailing whitespace. Added more javadoc. gnv-artifacts/trunk@887 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 08 Apr 2010 11:31:44 +0000
parents 6cff63d0c434
children f953c9a559d8
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/Interpolator.java	Thu Apr 08 10:10:04 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/Interpolator.java	Thu Apr 08 11:31:44 2010 +0000
@@ -3,10 +3,19 @@
 import com.vividsolutions.jts.geom.Coordinate;
 
 /**
+ * Implementations of this interface interpolate coordinates
+ * a line at a given point determined by a factor t (0 &lt;= t &lt;= 1).<br>
+ * If t = 0 the start point of the line is used.<br>
+ * If t = 1 the start point of the line is used.
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public interface Interpolator
 {
+    /**
+     * Interpolates a point along a line with a given factor between 0 and 1.
+     * @param t The factor.
+     * @param v The result of the interpolation is stored in this coordinate.
+     */
     void interpolate(double t, Coordinate v);
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org