From b3dc87750a2a7215f5fac169c6a0187becfa5b47 Mon Sep 17 00:00:00 2001 From: Nick Minkler Date: Wed, 19 Mar 2014 06:57:39 -0700 Subject: [PATCH] cleanup voronoi docs a bit --- .../java/net/jlibnoise/filter/Voronoi.java | 22 +++++++------------ 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/src/main/java/net/jlibnoise/filter/Voronoi.java b/src/main/java/net/jlibnoise/filter/Voronoi.java index 1a32568..69e38ba 100644 --- a/src/main/java/net/jlibnoise/filter/Voronoi.java +++ b/src/main/java/net/jlibnoise/filter/Voronoi.java @@ -50,7 +50,7 @@ This is a port of libnoise ( http://libnoise.sourceforge.net/index.html ). Orig * * This noise module can optionally add the distance from the nearest * seed to the output value. To enable this feature, call the - * EnableDistance() method. This causes the points in the Voronoi cells + * enableDistance() method. This causes the points in the Voronoi cells * to increase in value the further away that point is from the nearest * seed point. * @@ -61,30 +61,25 @@ This is a port of libnoise ( http://libnoise.sourceforge.net/index.html ). Orig */ public class Voronoi extends Module { - // Default displacement to apply to each cell for the - // noise::module::Voronoi noise module. + // Default displacement to apply to each cell for the noise module. public static final double DEFAULT_VORONOI_DISPLACEMENT = 1.0; - // Default frequency of the seed points for the noise::module::Voronoi - // noise module. + // Default frequency of the seed points for the noise module. public static final double DEFAULT_VORONOI_FREQUENCY = 1.0; - // Default seed of the noise function for the noise::module::Voronoi - // noise module. + // Default seed of the noise function for the noise module. public static final int DEFAULT_VORONOI_SEED = 0; // Scale of the random displacement to apply to each Voronoi cell. double displacement = DEFAULT_VORONOI_DISPLACEMENT; - // Determines if the distance from the nearest seed point is applied to - // the output value. + // Determines if the distance from the nearest seed point is applied to the output value. boolean enableDistance = false; // Frequency of the seed points. double frequency = DEFAULT_VORONOI_FREQUENCY; - // Seed value used by the coherent-noise function to determine the - // positions of the seed points. + // Seed value used by the coherent-noise function to determine the positions of the seed points. int seed = DEFAULT_VORONOI_SEED; public Voronoi() { @@ -113,7 +108,7 @@ public boolean isEnableDistance() { * Applying the distance from the nearest seed point to the output * value causes the points in the Voronoi cells to increase in value * the further away that point is from the nearest seed point. - * Setting this value to @a true (and setting the displacement to a + * Setting this value to true (and setting the displacement to a * near-zero value) causes this noise module to generate cracked mud * formations. */ @@ -147,8 +142,7 @@ public double getValue(double x, double y, double z) { double x1 = x; double y1 = y; double z1 = z; - // This method could be more efficient by caching the seed values. Fix - // later. + // This method could be more efficient by caching the seed values. Fix later. x1 *= frequency; y1 *= frequency;