Class MutantNoiseWrapper

java.lang.Object
com.github.yellowstonegames.grid.MutantNoiseWrapper
All Implemented Interfaces:
com.github.yellowstonegames.core.ISerializersNeeded, INoise, Externalizable, Serializable
public class MutantNoiseWrapper extends Object implements INoise, com.github.yellowstonegames.core.ISerializersNeeded
A wrapper around an INoise that allows an extra degree of freedom to adjust the inputs by a small amount, continuously rather than in jumps (as adjusting the seed would do). You can change the mutation by any amount at a time, though usually it is a small change you can preview to see how each adjustment affects some result.
Internally this works by calling the same method you call here on an internal INoise, basis, but using a higher dimension and passing mutation in as that higher-dimensional input. This means if you call getNoise(float, float), passing x and y, internally this calls INoise.getNoise(float, float, float) and passes x, y, and mutation.
This defaults to using a FoamNoise for its basis INoise, which allows dimensions 2 through 6 to be produced with a mutation value. Using a FoamNoise means this defaults to acting like Noise with Noise.MUTANT as its NoiseType.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface INoise

    INoise.Serializer

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    INoise
    basis
    The INoise this uses for all its internal noise generation.
    float
    mutation
    The extra input that is passed to basis, in addition to the inputs to each noise call.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MutantNoiseWrapper()
    Makes a MutantNoise with a FoamNoise basis (seeded with 1234567890L) and a mutation of 0.0f .
    MutantNoiseWrapper(long seed)
    Makes a MutantNoise with a FoamNoise basis (seeded with the given seed) and a mutation of 0.0f.
    MutantNoiseWrapper(long seed, float mutation)
    Makes a MutantNoise with a FoamNoise basis (seeded with the given seed) and the given mutation.
    MutantNoiseWrapper(INoise base)
    Makes a MutantNoise with the given basis INoise and a mutation of 0.0f.
    MutantNoiseWrapper(INoise base, float mutation)
    Makes a MutantNoise with the given basis INoise and mutation.

  • Method Summary

    Modifier and Type
    Method
    Description
    MutantNoiseWrapper
    copy()
    Creates a copy of this INoise, which should be a deep copy for any mutable state but can be shallow for immutable types such as functions.
    final boolean
    equals(Object o)
     
    int
    getMaxDimension()
    Maximum dimension is one less than the maximum dimension of the basis INoise.
    int
    getMinDimension()
    Minimum dimension is 2, unless the basis INoise has a minimum dimension of 4 or greater.
    float
    getMutation()
    Gets the mutation value.
    float
    getNoise(float x, float y)
    Gets 2D noise with a default or pre-set seed.
    float
    getNoise(float x, float y, float z)
    Gets 3D noise with a default or pre-set seed.
    float
    getNoise(float x, float y, float z, float w)
    Gets 4D noise with a default or pre-set seed.
    float
    getNoise(float x, float y, float z, float w, float u)
    Gets 5D noise with a default or pre-set seed.
    float
    getNoise(float x, float y, float z, float w, float u, float v)
    Gets 6D noise with a default or pre-set seed.
    float
    getNoiseWithSeed(float x, float y, float z, float w, float u, float v, long seed)
    Gets 6D noise with a specific seed.
    float
    getNoiseWithSeed(float x, float y, float z, float w, float u, long seed)
    Gets 5D noise with a specific seed.
    float
    getNoiseWithSeed(float x, float y, float z, float w, long seed)
    Gets 4D noise with a specific seed.
    float
    getNoiseWithSeed(float x, float y, float z, long seed)
    Gets 3D noise with a specific seed.
    float
    getNoiseWithSeed(float x, float y, long seed)
    Gets 2D noise with a specific seed.
    long
    getSeed()
    Gets the current seed of the generator, as a long even if the seed is stored internally as an int.
    List<Class<?>>
    getSerializersNeeded()
     
    String
    getTag()
    The String "Muta" .
    boolean
    hasEfficientSetSeed()
    Setting the seed is efficient here if and only if it is efficient for the basis INoise.
    int
    hashCode()
     
    static MutantNoiseWrapper
    recreateFromString(String data)
     
    void
    setMutation(float mutation)
    Sets the mutation value.
    void
    setSeed(long seed)
    Sets the seed to the given long, if long seeds are supported, or (int)seed if only int seeds are supported.
    MutantNoiseWrapper
    stringDeserialize(String data)
    Given a serialized String produced by INoise.stringSerialize(), reassigns this INoise to have the described state from the given String.
    String
    stringSerialize()
    Produces a String that describes everything needed to recreate this INoise in full.
    String
    toString()
     

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface INoise

    getNoise, getNoiseWithSeed, readExternal, writeExternal

  • Field Details

    • basis

      public INoise basis
      The INoise this uses for all its internal noise generation. This defaults to a FoamNoise, but can be any INoise with INoise.getMaxDimension() greater than 2.

    • mutation

      public float mutation
      The extra input that is passed to basis, in addition to the inputs to each noise call. This typically changes only be a small amount at a time, to make minor continuous adjustments to a noise result, instead of using setSeed(long) to make a non-continuous adjustment that "jumps." This defaults to 0.

  • Constructor Details

    • MutantNoiseWrapper

      public MutantNoiseWrapper()
      Makes a MutantNoise with a FoamNoise basis (seeded with 1234567890L) and a mutation of 0.0f .

    • MutantNoiseWrapper

      public MutantNoiseWrapper(long seed)
      Makes a MutantNoise with a FoamNoise basis (seeded with the given seed) and a mutation of 0.0f.
      Parameters:
      seed - the seed to use for any noise call that doesn't take a seed already

    • MutantNoiseWrapper

      public MutantNoiseWrapper(long seed, float mutation)
      Makes a MutantNoise with a FoamNoise basis (seeded with the given seed) and the given mutation.
      Parameters:
      seed - the seed to use for any noise call that doesn't take a seed already
      mutation - the initial value for the extra input to be passed in addition to the inputs to each noise call

    • MutantNoiseWrapper

      public MutantNoiseWrapper(INoise base)
      Makes a MutantNoise with the given basis INoise and a mutation of 0.0f.
      Parameters:
      base - the INoise to use as a basis

    • MutantNoiseWrapper

      public MutantNoiseWrapper(INoise base, float mutation)
      Makes a MutantNoise with the given basis INoise and mutation.
      Parameters:
      base - the INoise to use as a basis
      mutation - the initial value for the extra input to be passed in addition to the inputs to each noise call

  • Method Details

    • getMinDimension

      public int getMinDimension()
      Minimum dimension is 2, unless the basis INoise has a minimum dimension of 4 or greater. With the default basis, a FoamNoise, this will be 2.
      Specified by:
      getMinDimension in interface INoise
      Returns:
      2, in almost all cases

    • getMaxDimension

      public int getMaxDimension()
      Maximum dimension is one less than the maximum dimension of the basis INoise. With the default basis, a FoamNoise, this will be 6.
      Specified by:
      getMaxDimension in interface INoise
      Returns:
      one less than basis.getMaxDimension()

    • hasEfficientSetSeed

      public boolean hasEfficientSetSeed()
      Setting the seed is efficient here if and only if it is efficient for the basis INoise.
      Specified by:
      hasEfficientSetSeed in interface INoise
      Returns:
      basis.hasEfficientSetSeed()

    • getNoise

      public float getNoise(float x, float y)
      Description copied from interface: INoise
      Gets 2D noise with a default or pre-set seed.
      Specified by:
      getNoise in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoise

      public float getNoise(float x, float y, float z)
      Description copied from interface: INoise
      Gets 3D noise with a default or pre-set seed.
      Specified by:
      getNoise in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoise

      public float getNoise(float x, float y, float z, float w)
      Description copied from interface: INoise
      Gets 4D noise with a default or pre-set seed.
      Specified by:
      getNoise in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoise

      public float getNoise(float x, float y, float z, float w, float u)
      Description copied from interface: INoise
      Gets 5D noise with a default or pre-set seed.
      Specified by:
      getNoise in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      u - u position; can be any finite float
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoise

      public float getNoise(float x, float y, float z, float w, float u, float v)
      Description copied from interface: INoise
      Gets 6D noise with a default or pre-set seed.
      Specified by:
      getNoise in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      u - u position; can be any finite float
      v - v position; can be any finite float
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • setSeed

      public void setSeed(long seed)
      Description copied from interface: INoise
      Sets the seed to the given long, if long seeds are supported, or (int)seed if only int seeds are supported. If this generator cannot be seeded, this should do nothing, and should not throw an exception. If this operation allocates or is time-intensive, then INoise.hasEfficientSetSeed() should return false. That method is checked in INoise.getNoiseWithSeed(float, float, long), and if it returns false, the noise call will avoid calling setSeed(). You can always at least try to set the seed, even if it does nothing or is heavy on performance, and doing it a few times each frame should typically be fine for any generator. In the case this is called thousands of times each frame, check INoise.hasEfficientSetSeed().
      Specified by:
      setSeed in interface INoise
      Parameters:
      seed - a long or int seed, with no restrictions unless otherwise documented

    • getSeed

      public long getSeed()
      Description copied from interface: INoise
      Gets the current seed of the generator, as a long even if the seed is stored internally as an int. This must be implemented, but if the generator doesn't have a seed that can be expressed as a long (potentially using BitConversion.floatToIntBits(float)), this can just return 0.
      Specified by:
      getSeed in interface INoise
      Returns:
      the current seed, as a long

    • getMutation

      public float getMutation()
      Gets the mutation value. The mutation is an extra input that is passed to basis, in addition to the inputs to each noise call. This typically changes only be a small amount at a time, to make minor continuous adjustments to a noise result, instead of using setSeed(long) to make a non-continuous adjustment that "jumps."

    • setMutation

      public void setMutation(float mutation)
      Sets the mutation value. The mutation is an extra input that is passed to basis, in addition to the inputs to each noise call. This typically changes only be a small amount at a time, to make minor continuous adjustments to a noise result, instead of using setSeed(long) to make a non-continuous adjustment that "jumps."
      Parameters:
      mutation - the float value to use for the mutation

    • getTag

      public String getTag()
      The String "Muta" .
      Specified by:
      getTag in interface INoise
      Returns:
      "Muta"

    • stringSerialize

      public String stringSerialize()
      Description copied from interface: INoise
      Produces a String that describes everything needed to recreate this INoise in full. This String can be read back in by INoise.stringDeserialize(String) to reassign the described state to another INoise. The syntax here should always start and end with the ` character, which is used by INoise.stringDeserialize(String) to identify the portion of a String that can be read back. The ` character should not be otherwise used unless to serialize another INoise that this uses.
      If you use Base to produce String representations for numeric fields in an INoise, Base.BASE10 is strongly recommended; in most cases, you can just use string concatenation with the fields separated by the tilde character, "~". For printing a float field with Base to a StringBuilder sb, use Base.BASE10.appendGeneral(sb, field).
      The default implementation throws an UnsupportedOperationException only. INoise classes do not have to implement any serialization methods, but they aren't serializable by the methods in this class or in INoise.Serializer unless they do implement this, INoise.getTag(), INoise.stringDeserialize(String), and INoise.copy().
      Specified by:
      stringSerialize in interface INoise
      Returns:
      a String that describes this INoise for serialization

    • stringDeserialize

      public MutantNoiseWrapper stringDeserialize(String data)
      Description copied from interface: INoise
      Given a serialized String produced by INoise.stringSerialize(), reassigns this INoise to have the described state from the given String. The serialized String must have been produced by the same class as this object is.
      Any class that implements INoise.stringSerialize() should also implement this method in a compatible way. Using base-10 is expected for most uses. Using Base.BASE10.readFloat(data, start, end) may be useful to parse only the part of data between start and end.
      The default implementation throws an UnsupportedOperationException only. INoise classes do not have to implement any serialization methods, but they aren't serializable by the methods in this class or in INoise.Serializer unless they do implement this, INoise.getTag(), INoise.stringSerialize(), and INoise.copy().
      Specified by:
      stringDeserialize in interface INoise
      Parameters:
      data - a serialized String, typically produced by INoise.stringSerialize()
      Returns:
      this INoise, after being modified (if possible)

    • recreateFromString

      public static MutantNoiseWrapper recreateFromString(String data)

    • getSerializersNeeded

      public List<Class<?>> getSerializersNeeded()
      Specified by:
      getSerializersNeeded in interface com.github.yellowstonegames.core.ISerializersNeeded

    • copy

      public MutantNoiseWrapper copy()
      Description copied from interface: INoise
      Creates a copy of this INoise, which should be a deep copy for any mutable state but can be shallow for immutable types such as functions. This almost always just calls a copy constructor.
      The default implementation throws an UnsupportedOperationException only. Implementors are strongly encouraged to implement this in general, and that is required to use an INoise class with INoise.Serializer.
      Specified by:
      copy in interface INoise
      Returns:
      a copy of this INoise

    • equals

      public final boolean equals(Object o)
      Specified by:
      equals in interface INoise
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getNoiseWithSeed

      public float getNoiseWithSeed(float x, float y, long seed)
      Description copied from interface: INoise
      Gets 2D noise with a specific seed. If the seed cannot be retrieved or changed per-call, then this falls back to changing the position instead of the seed; you can check if this will happen with INoise.hasEfficientSetSeed().
      Specified by:
      getNoiseWithSeed in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      seed - can be any long
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoiseWithSeed

      public float getNoiseWithSeed(float x, float y, float z, long seed)
      Description copied from interface: INoise
      Gets 3D noise with a specific seed. If the seed cannot be retrieved or changed per-call, then this falls back to changing the position instead of the seed; you can check if this will happen with INoise.hasEfficientSetSeed().
      Specified by:
      getNoiseWithSeed in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      seed - can be any long
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoiseWithSeed

      public float getNoiseWithSeed(float x, float y, float z, float w, long seed)
      Description copied from interface: INoise
      Gets 4D noise with a specific seed. If the seed cannot be retrieved or changed per-call, then this falls back to changing the position instead of the seed; you can check if this will happen with INoise.hasEfficientSetSeed().
      Specified by:
      getNoiseWithSeed in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      seed - can be any long
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoiseWithSeed

      public float getNoiseWithSeed(float x, float y, float z, float w, float u, long seed)
      Description copied from interface: INoise
      Gets 5D noise with a specific seed. If the seed cannot be retrieved or changed per-call, then this falls back to changing the position instead of the seed; you can check if this will happen with INoise.hasEfficientSetSeed().
      Specified by:
      getNoiseWithSeed in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      u - u position; can be any finite float
      seed - can be any long
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive

    • getNoiseWithSeed

      public float getNoiseWithSeed(float x, float y, float z, float w, float u, float v, long seed)
      Description copied from interface: INoise
      Gets 6D noise with a specific seed. If the seed cannot be retrieved or changed per-call, then this falls back to changing the position instead of the seed; you can check if this will happen with INoise.hasEfficientSetSeed().
      Specified by:
      getNoiseWithSeed in interface INoise
      Parameters:
      x - x position; can be any finite float
      y - y position; can be any finite float
      z - z position; can be any finite float
      w - w position; can be any finite float
      u - u position; can be any finite float
      v - v position; can be any finite float
      seed - can be any long
      Returns:
      a noise value between -1.0f and 1.0f, both inclusive