diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/ExpressionSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/ExpressionSampler.java index b400caa72..9b1fbbc4c 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/ExpressionSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/ExpressionSampler.java @@ -5,16 +5,16 @@ import com.dfsek.paralithic.eval.parser.Parser; import com.dfsek.paralithic.eval.parser.Scope; import com.dfsek.paralithic.eval.tokenizer.ParseException; import com.dfsek.terra.api.math.noise.NoiseSampler; -import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3; +import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3; import com.dfsek.terra.api.util.seeded.NoiseSeeded; import com.dfsek.terra.config.loaders.config.function.FunctionTemplate; import java.util.Map; /** - * Sampler implementation using parsii expression + * Sampler implementation using Paralithic expression */ public class ExpressionSampler implements NoiseSampler { private final Expression expression; diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/CellularSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/CellularSampler.java index ced0636dd..b5488a8dd 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/CellularSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/CellularSampler.java @@ -5,6 +5,9 @@ import com.dfsek.terra.api.math.noise.samplers.noise.simplex.OpenSimplex2Sampler import com.dfsek.terra.api.math.vector.Vector2; import com.dfsek.terra.api.math.vector.Vector3; +/** + * NoiseSampler implementation for Cellular (Voronoi/Worley) Noise. + */ public class CellularSampler extends NoiseFunction { private static final double[] RAND_VECS_3D = { -0.7292736885d, -0.6618439697d, 0.1735581948d, 0, 0.790292081d, -0.5480887466d, -0.2739291014d, 0, 0.7217578935d, 0.6226212466d, diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/ExpressionFunction.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/ExpressionFunction.java index 341f31484..305aa1075 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/ExpressionFunction.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/ExpressionFunction.java @@ -8,6 +8,9 @@ import com.dfsek.paralithic.functions.Function; import java.util.Map; +/** + * NoiseSampler implementation using a Paralithic expression. + */ public class ExpressionFunction extends NoiseFunction { private final Expression expression; diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/GaussianNoiseSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/GaussianNoiseSampler.java index e094ed7e6..9843df3e4 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/GaussianNoiseSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/GaussianNoiseSampler.java @@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.random; import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction; +/** + * NoiseSampler implementation to provide random, normally distributed (Gaussian) noise. + */ public class GaussianNoiseSampler extends NoiseFunction { private final WhiteNoiseSampler whiteNoiseSampler; // Back with a white noise sampler. diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/WhiteNoiseSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/WhiteNoiseSampler.java index 4dcfeb3b9..80660949f 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/WhiteNoiseSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/random/WhiteNoiseSampler.java @@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.random; import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction; +/** + * NoiseSampler implementation to produce random, uniformly distributed (white) noise. + */ public class WhiteNoiseSampler extends NoiseFunction { private static final long POSITIVE_POW1 = 0b01111111111L << 52; // Bits that when applied to the exponent/sign section of a double, produce a positive number with a power of 1. @@ -29,7 +32,13 @@ public class WhiteNoiseSampler extends NoiseFunction { return (Double.longBitsToDouble(base) - 1.5) * 2; } - private long murmur64(long h) { + /** + * Murmur64 hashing function + * + * @param h Input value + * @return Hashed value + */ + private static long murmur64(long h) { h ^= h >>> 33; h *= 0xff51afd7ed558ccdL; h ^= h >>> 33; diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2SSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2SSampler.java index 7a22b4afd..2ed7fc612 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2SSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2SSampler.java @@ -1,5 +1,8 @@ package com.dfsek.terra.api.math.noise.samplers.noise.simplex; +/** + * NoiseSampler implementation to provide OpenSimplex2 (Smooth Variant) noise. + */ public class OpenSimplex2SSampler extends SimplexStyleSampler { public OpenSimplex2SSampler(int seed) { super(seed); diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2Sampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2Sampler.java index ec090a840..767ce45cb 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2Sampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/OpenSimplex2Sampler.java @@ -1,5 +1,8 @@ package com.dfsek.terra.api.math.noise.samplers.noise.simplex; +/** + * NoiseSampler implementation to provide OpenSimplex2 noise. + */ public class OpenSimplex2Sampler extends SimplexStyleSampler { private static final double SQRT3 = 1.7320508075688772935274463415059; diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/PerlinSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/PerlinSampler.java index e5bc3d339..86469fd18 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/PerlinSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/PerlinSampler.java @@ -1,5 +1,8 @@ package com.dfsek.terra.api.math.noise.samplers.noise.simplex; +/** + * NoiseSampler implementation to provide Perlin Noise. + */ public class PerlinSampler extends SimplexStyleSampler { public PerlinSampler(int seed) { super(seed); diff --git a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/SimplexStyleSampler.java b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/SimplexStyleSampler.java index b27aed62f..51e4a75ab 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/SimplexStyleSampler.java +++ b/common/src/main/java/com/dfsek/terra/api/math/noise/samplers/noise/simplex/SimplexStyleSampler.java @@ -2,6 +2,9 @@ package com.dfsek.terra.api.math.noise.samplers.noise.simplex; import com.dfsek.terra.api.math.noise.samplers.noise.NoiseFunction; +/** + * Abstract NoiseSampler implementation for simplex-style noise functions. + */ public abstract class SimplexStyleSampler extends NoiseFunction { protected static final double[] GRADIENTS_2_D = { 0.130526192220052d, 0.99144486137381d, 0.38268343236509d, 0.923879532511287d, 0.608761429008721d, 0.793353340291235d, diff --git a/common/src/main/java/com/dfsek/terra/api/math/parsii/BlankFunction.java b/common/src/main/java/com/dfsek/terra/api/math/paralithic/BlankFunction.java similarity index 90% rename from common/src/main/java/com/dfsek/terra/api/math/parsii/BlankFunction.java rename to common/src/main/java/com/dfsek/terra/api/math/paralithic/BlankFunction.java index b506b8323..12cd1872a 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/parsii/BlankFunction.java +++ b/common/src/main/java/com/dfsek/terra/api/math/paralithic/BlankFunction.java @@ -1,4 +1,4 @@ -package com.dfsek.terra.api.math.parsii; +package com.dfsek.terra.api.math.paralithic; import com.dfsek.paralithic.functions.dynamic.DynamicFunction; diff --git a/common/src/main/java/com/dfsek/terra/api/math/parsii/defined/UserDefinedFunction.java b/common/src/main/java/com/dfsek/terra/api/math/paralithic/defined/UserDefinedFunction.java similarity index 95% rename from common/src/main/java/com/dfsek/terra/api/math/parsii/defined/UserDefinedFunction.java rename to common/src/main/java/com/dfsek/terra/api/math/paralithic/defined/UserDefinedFunction.java index 020f5c8ef..7058d8085 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/parsii/defined/UserDefinedFunction.java +++ b/common/src/main/java/com/dfsek/terra/api/math/paralithic/defined/UserDefinedFunction.java @@ -1,4 +1,4 @@ -package com.dfsek.terra.api.math.parsii.defined; +package com.dfsek.terra.api.math.paralithic.defined; import com.dfsek.paralithic.Expression; import com.dfsek.paralithic.eval.parser.Parser; diff --git a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction.java b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction.java similarity index 71% rename from common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction.java rename to common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction.java index 6da1dd45b..76b2bf39e 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction.java +++ b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction.java @@ -1,4 +1,4 @@ -package com.dfsek.terra.api.math.parsii.noise; +package com.dfsek.terra.api.math.paralithic.noise; import com.dfsek.paralithic.functions.dynamic.DynamicFunction; diff --git a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction2.java b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction2.java similarity index 96% rename from common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction2.java rename to common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction2.java index 37a623d91..3b51cdd48 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction2.java +++ b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction2.java @@ -1,4 +1,4 @@ -package com.dfsek.terra.api.math.parsii.noise; +package com.dfsek.terra.api.math.paralithic.noise; import com.dfsek.terra.api.math.noise.NoiseSampler; import com.dfsek.terra.util.hash.HashMapDoubleDouble; diff --git a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction3.java b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction3.java similarity index 90% rename from common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction3.java rename to common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction3.java index 83c86aa29..297a0d2cb 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/parsii/noise/NoiseFunction3.java +++ b/common/src/main/java/com/dfsek/terra/api/math/paralithic/noise/NoiseFunction3.java @@ -1,4 +1,4 @@ -package com.dfsek.terra.api.math.parsii.noise; +package com.dfsek.terra.api.math.paralithic.noise; import com.dfsek.terra.api.math.noise.NoiseSampler; diff --git a/common/src/main/java/com/dfsek/terra/api/math/vector/Vector2.java b/common/src/main/java/com/dfsek/terra/api/math/vector/Vector2.java index aacf31660..8513e56d2 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/vector/Vector2.java +++ b/common/src/main/java/com/dfsek/terra/api/math/vector/Vector2.java @@ -6,7 +6,6 @@ import net.jafama.FastMath; /** * oh yeah */ -@SuppressWarnings("unused") public class Vector2 implements Cloneable { private double x; private double z; diff --git a/common/src/main/java/com/dfsek/terra/api/math/vector/Vector3.java b/common/src/main/java/com/dfsek/terra/api/math/vector/Vector3.java index cafff1ea7..b422a1019 100644 --- a/common/src/main/java/com/dfsek/terra/api/math/vector/Vector3.java +++ b/common/src/main/java/com/dfsek/terra/api/math/vector/Vector3.java @@ -5,6 +5,9 @@ import com.dfsek.terra.api.platform.world.World; import net.jafama.FastMath; import org.jetbrains.annotations.NotNull; +/** + * 3D Mutable Vector + */ public class Vector3 implements Cloneable { diff --git a/common/src/main/java/com/dfsek/terra/carving/UserDefinedCarver.java b/common/src/main/java/com/dfsek/terra/carving/UserDefinedCarver.java index 9e48e4caf..4c9a9a80a 100644 --- a/common/src/main/java/com/dfsek/terra/carving/UserDefinedCarver.java +++ b/common/src/main/java/com/dfsek/terra/carving/UserDefinedCarver.java @@ -6,9 +6,9 @@ import com.dfsek.paralithic.eval.parser.Scope; import com.dfsek.paralithic.eval.tokenizer.ParseException; import com.dfsek.terra.api.core.TerraPlugin; import com.dfsek.terra.api.math.Range; -import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3; +import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3; import com.dfsek.terra.api.math.vector.Vector3; import com.dfsek.terra.api.platform.world.World; import com.dfsek.terra.api.util.FastRandom; diff --git a/common/src/main/java/com/dfsek/terra/config/loaders/config/sampler/templates/noise/ExpressionFunctionTemplate.java b/common/src/main/java/com/dfsek/terra/config/loaders/config/sampler/templates/noise/ExpressionFunctionTemplate.java index b281bd40c..256106a99 100644 --- a/common/src/main/java/com/dfsek/terra/config/loaders/config/sampler/templates/noise/ExpressionFunctionTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/loaders/config/sampler/templates/noise/ExpressionFunctionTemplate.java @@ -8,9 +8,9 @@ import com.dfsek.tectonic.config.ValidatedConfigTemplate; import com.dfsek.tectonic.exception.ValidationException; import com.dfsek.terra.api.math.noise.NoiseSampler; import com.dfsek.terra.api.math.noise.samplers.noise.ExpressionFunction; -import com.dfsek.terra.api.math.parsii.BlankFunction; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction2; -import com.dfsek.terra.api.math.parsii.noise.NoiseFunction3; +import com.dfsek.terra.api.math.paralithic.BlankFunction; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction2; +import com.dfsek.terra.api.math.paralithic.noise.NoiseFunction3; import com.dfsek.terra.api.util.seeded.NoiseSeeded; import com.dfsek.terra.config.loaders.config.sampler.templates.SamplerTemplate; diff --git a/common/src/main/java/com/dfsek/terra/config/templates/BiomeTemplate.java b/common/src/main/java/com/dfsek/terra/config/templates/BiomeTemplate.java index e02883f85..230be1ea1 100644 --- a/common/src/main/java/com/dfsek/terra/config/templates/BiomeTemplate.java +++ b/common/src/main/java/com/dfsek/terra/config/templates/BiomeTemplate.java @@ -12,8 +12,8 @@ import com.dfsek.terra.api.core.TerraPlugin; import com.dfsek.terra.api.math.ProbabilityCollection; import com.dfsek.terra.api.math.noise.NoiseSampler; import com.dfsek.terra.api.math.noise.samplers.noise.ConstantSampler; -import com.dfsek.terra.api.math.parsii.BlankFunction; -import com.dfsek.terra.api.math.parsii.defined.UserDefinedFunction; +import com.dfsek.terra.api.math.paralithic.BlankFunction; +import com.dfsek.terra.api.math.paralithic.defined.UserDefinedFunction; import com.dfsek.terra.api.platform.block.BlockData; import com.dfsek.terra.api.platform.block.MaterialData; import com.dfsek.terra.api.platform.world.Biome;