Improved code readability

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / renderer / octree / OctreeVolume.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/renderer/octree/OctreeVolume.java b/src/main/java/eu/svjatoslav/sixth/e3d/renderer/octree/OctreeVolume.java
index 87c42c7..27b9488 100755 (executable)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/renderer/octree/OctreeVolume.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/renderer/octree/OctreeVolume.java
@@ -26,13 +26,17 @@ import eu.svjatoslav.sixth.e3d.renderer.raster.shapes.basic.line.LineAppearance;
 
 public class OctreeVolume {
 
+    // cell is not hit by the ray
     public static final int TRACE_NO_HIT = -1;
-    /**
-     * Single solid color.
-     */
+
+    // solid cell (contains color and illumination)
     private static final int CELL_STATE_SOLID = -2;
+
+    // unused cell
     private static final int CELL_STATE_UNUSED = -1;
     final LineAppearance factory = new LineAppearance();
+
+
     public int ce1[];
     public int ce2[];
     public int ce3[];
@@ -406,8 +410,9 @@ public class OctreeVolume {
     }
 
     /**
-     * @return intersecting cell pointer or -1 if no cell in intersecting this
-     * ray.
+     * Trace ray through the world and return pointer to intersecting cell.
+     *
+     * @return pointer to intersecting cell or TRACE_NO_HIT if no intersection.
      */
     public int traceCell(final int cellX, final int cellY, final int cellZ,
                          final int cellSize, final int pointer, final Ray ray) {