Module org.spongepowered.noise
Package org.spongepowered.noise

Enum LatticeOrientation

java.lang.Object
java.lang.Enum<LatticeOrientation>
org.spongepowered.noise.LatticeOrientation
All Implemented Interfaces:
Serializable, Comparable<LatticeOrientation>
public enum LatticeOrientation extends Enum<LatticeOrientation>
A lattice orientation for use with Simplex-type noise.
See Also:

  • Enum Constant Details

    • CLASSIC

      public static final LatticeOrientation CLASSIC
      Generates the simplex-style coherent noise with the classic lattice orientation.

      Might be better for texturing 3D models, but less good for generating terrain which has a vertical direction that works differently than the two horizontal directions. There may be subtle diagonal artifacts, similar to classic Simplex.

    • XZ_BEFORE_Y

      public static final LatticeOrientation XZ_BEFORE_Y
      Generates simplex-style noise with Y pointing up the main diagonal on the noise lattice.

      If used properly, this can produce better results than CLASSIC, when generating 3D worlds with vertical direction that works differently than the two horizontal directions.

      See the following recommended usage patterns:

      • If Y is vertical and X/Z are horizontal, call noise(x, Y, z)
      • If Z is vertical and X/Y are horizontal, call noise(x, Z, y) or use mode XY_BEFORE_Z.
      • If T is time and X/Y or X/Z are horizontal, call noise(x, T, y) or noise(x, T, z), or use mode XY_BEFORE_Z.
      • If only two coordinates are needed for a 2D noise plane, call noise(x, 0, y) or noise(x, 0, z), or use mode XY_BEFORE_Z

    • XY_BEFORE_Z

      public static final LatticeOrientation XY_BEFORE_Z
      Generates simplex-style noise with Z pointing up the main diagonal on the noise lattice.

      If used properly, this can produce better results than CLASSIC, when generating 3D worlds with vertical direction that works differently than the two horizontal directions.

      See the following recommended usage patterns:

      • If Y is vertical and X/Z are horizontal, call noise(x, z, Y) or use mode XZ_BEFORE_Y.
      • If Z is vertical and X/Y are horizontal, call noise(x, y, Z)
      • If T is time and X/Y or X/Z are horizontal, call noise(x, y, T) or noise(x, z, T), or use mode XZ_BEFORE_Y.
      • If only two coordinates are needed for a 2D noise plane, call noise(x, y, 0) or noise(x, z, 0), or use mode XZ_BEFORE_Y.

  • Method Details

    • values

      public static LatticeOrientation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static LatticeOrientation valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null