Improved code readability

[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / renderer / raster / shapes / basic / GlowingPoint.java

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/basic/GlowingPoint.java b/src/main/java/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/basic/GlowingPoint.java
index a7b4784..14e213c 100644 (file)
--- a/src/main/java/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/basic/GlowingPoint.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/renderer/raster/shapes/basic/GlowingPoint.java
@@ -18,6 +18,10 @@ import static java.lang.Math.sqrt;
 public class GlowingPoint extends ForwardOrientedTexture {
 
     private static final int TEXTURE_RESOLUTION_PIXELS = 100;
+    /**
+     * A set of all existing glowing points.
+     * Used to reuse textures of glowing points of the same color.
+     */
     private static final Set<GlowingPoint> glowingPoints = Collections.newSetFromMap(new WeakHashMap<>());
     private final Color color;
 
@@ -31,10 +35,15 @@ public class GlowingPoint extends ForwardOrientedTexture {
         }
     }
 
+
     private static double computeScale(double pointSize) {
         return pointSize / ((double) (TEXTURE_RESOLUTION_PIXELS / 50f));
     }
 
+    /**
+     * Returns a texture for a glowing point of the given color.
+     * The texture is a circle with a gradient from transparent to the given color.
+     */
     private static Texture getTexture(final Color color) {
         // attempt to reuse texture from existing glowing point of the same color
         synchronized (glowingPoints) {
@@ -47,6 +56,10 @@ public class GlowingPoint extends ForwardOrientedTexture {
         return createTexture(color);
     }
 
+    /**
+     * Creates a texture for a glowing point of the given color.
+     * The texture is a circle with a gradient from transparent to the given color.
+     */
     private static Texture createTexture(final Color color) {
         final Texture texture = new Texture(TEXTURE_RESOLUTION_PIXELS, TEXTURE_RESOLUTION_PIXELS, 1);
         int halfResolution = TEXTURE_RESOLUTION_PIXELS / 2;