Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here. By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -66,7 +66,8 @@ public abstract class NoiseGenerator {
|
||||
public abstract double noise(double x, double y, double z);
|
||||
|
||||
/**
|
||||
* Generates noise for the 1D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 1D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param octaves Number of octaves to use
|
||||
@@ -79,7 +80,8 @@ public abstract class NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 1D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 1D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param octaves Number of octaves to use
|
||||
@@ -93,7 +95,8 @@ public abstract class NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 2D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 2D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -107,7 +110,8 @@ public abstract class NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 2D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 2D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -122,7 +126,8 @@ public abstract class NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -137,7 +142,8 @@ public abstract class NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
|
||||
@@ -16,7 +16,8 @@ public abstract class OctaveGenerator {
|
||||
/**
|
||||
* Sets the scale used for all coordinates passed to this generator.
|
||||
* <p>
|
||||
* This is the equivalent to setting each coordinate to the specified value.
|
||||
* This is the equivalent to setting each coordinate to the specified
|
||||
* value.
|
||||
*
|
||||
* @param scale New value to scale each coordinate by
|
||||
*/
|
||||
@@ -90,7 +91,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 1D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 1D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param frequency How much to alter the frequency by each octave
|
||||
@@ -102,7 +104,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 1D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 1D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param frequency How much to alter the frequency by each octave
|
||||
@@ -115,7 +118,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 2D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 2D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -128,7 +132,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 2D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 2D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -142,7 +147,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -156,7 +162,8 @@ public abstract class OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
|
||||
@@ -6,7 +6,8 @@ import org.bukkit.World;
|
||||
/**
|
||||
* Generates noise using the "classic" perlin generator
|
||||
*
|
||||
* @see SimplexNoiseGenerator "Improved" and faster version with slighly different results
|
||||
* @see SimplexNoiseGenerator "Improved" and faster version with slighly
|
||||
* different results
|
||||
*/
|
||||
public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
protected static final int grad3[][] = {{1, 1, 0}, {-1, 1, 0}, {1, -1, 0}, {-1, -1, 0},
|
||||
@@ -82,7 +83,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 1D unseeded perlin noise for the given coordinates in 1D space
|
||||
* Computes and returns the 1D unseeded perlin noise for the given
|
||||
* coordinates in 1D space
|
||||
*
|
||||
* @param x X coordinate
|
||||
* @return Noise at given location, from range -1 to 1
|
||||
@@ -92,7 +94,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 2D unseeded perlin noise for the given coordinates in 2D space
|
||||
* Computes and returns the 2D unseeded perlin noise for the given
|
||||
* coordinates in 2D space
|
||||
*
|
||||
* @param x X coordinate
|
||||
* @param y Y coordinate
|
||||
@@ -103,7 +106,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 3D unseeded perlin noise for the given coordinates in 3D space
|
||||
* Computes and returns the 3D unseeded perlin noise for the given
|
||||
* coordinates in 3D space
|
||||
*
|
||||
* @param x X coordinate
|
||||
* @param y Y coordinate
|
||||
@@ -167,7 +171,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 1D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 1D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param octaves Number of octaves to use
|
||||
@@ -180,7 +185,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 2D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 2D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -194,7 +200,8 @@ public class PerlinNoiseGenerator extends NoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
|
||||
@@ -7,6 +7,7 @@ import org.bukkit.World;
|
||||
* Creates perlin noise through unbiased octaves
|
||||
*/
|
||||
public class PerlinOctaveGenerator extends OctaveGenerator {
|
||||
|
||||
/**
|
||||
* Creates a perlin octave generator for the given world
|
||||
*
|
||||
|
||||
@@ -7,7 +7,9 @@ import org.bukkit.World;
|
||||
* Generates simplex-based noise.
|
||||
* <p>
|
||||
* This is a modified version of the freely published version in the paper by
|
||||
* Stefan Gustavson at http://staffwww.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf
|
||||
* Stefan Gustavson at
|
||||
* <a href="http://staffwww.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf">
|
||||
* http://staffwww.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf</a>
|
||||
*/
|
||||
public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
protected static final double SQRT_3 = Math.sqrt(3);
|
||||
@@ -87,7 +89,8 @@ public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 1D unseeded simplex noise for the given coordinates in 1D space
|
||||
* Computes and returns the 1D unseeded simplex noise for the given
|
||||
* coordinates in 1D space
|
||||
*
|
||||
* @param xin X coordinate
|
||||
* @return Noise at given location, from range -1 to 1
|
||||
@@ -97,7 +100,8 @@ public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 2D unseeded simplex noise for the given coordinates in 2D space
|
||||
* Computes and returns the 2D unseeded simplex noise for the given
|
||||
* coordinates in 2D space
|
||||
*
|
||||
* @param xin X coordinate
|
||||
* @param yin Y coordinate
|
||||
@@ -108,7 +112,8 @@ public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 3D unseeded simplex noise for the given coordinates in 3D space
|
||||
* Computes and returns the 3D unseeded simplex noise for the given
|
||||
* coordinates in 3D space
|
||||
*
|
||||
* @param xin X coordinate
|
||||
* @param yin Y coordinate
|
||||
@@ -120,7 +125,8 @@ public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 4D simplex noise for the given coordinates in 4D space
|
||||
* Computes and returns the 4D simplex noise for the given coordinates in
|
||||
* 4D space
|
||||
*
|
||||
* @param x X coordinate
|
||||
* @param y Y coordinate
|
||||
@@ -348,7 +354,8 @@ public class SimplexNoiseGenerator extends PerlinNoiseGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes and returns the 4D simplex noise for the given coordinates in 4D space
|
||||
* Computes and returns the 4D simplex noise for the given coordinates in
|
||||
* 4D space
|
||||
*
|
||||
* @param x X coordinate
|
||||
* @param y Y coordinate
|
||||
|
||||
@@ -64,7 +64,8 @@ public class SimplexOctaveGenerator extends OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
@@ -79,7 +80,8 @@ public class SimplexOctaveGenerator extends OctaveGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates noise for the 3D coordinates using the specified number of octaves and parameters
|
||||
* Generates noise for the 3D coordinates using the specified number of
|
||||
* octaves and parameters
|
||||
*
|
||||
* @param x X-coordinate
|
||||
* @param y Y-coordinate
|
||||
|
||||
Reference in New Issue
Block a user