Improved code readability

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

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/math/Vertex.java b/src/main/java/eu/svjatoslav/sixth/e3d/math/Vertex.java
index 69b3095..50423b1 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/math/Vertex.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/math/Vertex.java
@@ -9,8 +9,9 @@ import eu.svjatoslav.sixth.e3d.geometry.Point3D;
 import eu.svjatoslav.sixth.e3d.gui.RenderingContext;
 
 /**
- * It is used to store coordinates of vertices of 3D objects.
- * It is also used to store coordinates of points in 3D space.
+ * Vertex is a point where two or more lines, line segments, or rays come together.
+ * In other words, it's a corner of a polygon, polyhedron, or other geometric shape.
+ * For example, a triangle has three vertices, a square has four, and a cube has eight.
  */
 public class Vertex {
 
@@ -23,11 +24,13 @@ public class Vertex {
      * Vertex coordinate relative to the viewer after transformation.
      * Visible vertices have positive z coordinate.
      * Viewer is located at (0, 0, 0).
+     * No perspective correction is applied.
      */
     public Point3D transformedCoordinate;
 
     /**
-     * Vertex coordinate in pixels relative to the top left corner of the screen after transformation.
+     * Vertex coordinate in pixels relative to the top left corner of the screen after transformation
+     * and perspective correction.
      */
     public Point2D onScreenCoordinate;