Improved code readability

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / math / GeometryCoordinate.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/math/GeometryCoordinate.java b/src/main/java/eu/svjatoslav/sixth/e3d/math/GeometryCoordinate.java
index e159295..af3d3d3 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/GeometryCoordinate.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/GeometryCoordinate.java
@@ -8,10 +8,24 @@ import eu.svjatoslav.sixth.e3d.geometry.Point2D;
 import eu.svjatoslav.sixth.e3d.geometry.Point3D;
 import eu.svjatoslav.sixth.e3d.gui.RenderingContext;
 
+/**
+ * A point in 3D space with a transformed and on-screen coordinates.
+ */
 public class GeometryCoordinate {
 
+    /**
+     * The original coordinate.
+     */
     public Point3D coordinate;
+
+    /**
+     * The transformed coordinate.
+     */
     public Point3D transformedCoordinate;
+
+    /**
+     * The on-screen coordinate.
+     */
     public Point2D onScreenCoordinate;
 
     private int lastTransformedFrame;
@@ -28,7 +42,15 @@ public class GeometryCoordinate {
         onScreenCoordinate = new Point2D();
     }
 
-    public void transform(final TransformPipe transforms,
+    /**
+     * Transforms the coordinate.
+     *
+     * @param transforms
+     *            The transform pipe.
+     * @param renderContext
+     *            The rendering context.
+     */
+    public void transform(final TransformsPipeline transforms,
                           final RenderingContext renderContext) {
 
         if (lastTransformedFrame == renderContext.frameNumber)