Class LocalMap

java.lang.Object
com.github.yellowstonegames.world.WorldMapGenerator
com.github.yellowstonegames.world.LocalMap
Direct Known Subclasses:
MimicLocalMap
public class LocalMap extends WorldMapGenerator
A concrete implementation of WorldMapGenerator that does no projection of the map, as if the area were completely flat or small enough that curvature is impossible to see. This also does not change heat levels at the far north and south regions of the map, since it is meant for areas that are all about the same heat level. Example map, showing lack of polar ice

  • Field Details

    • terrainFreq

      protected static final float terrainFreq
      See Also:

    • terrainLayeredFreq

      protected static final float terrainLayeredFreq
      See Also:

    • heatFreq

      protected static final float heatFreq
      See Also:

    • moistureFreq

      protected static final float moistureFreq
      See Also:

    • otherFreq

      protected static final float otherFreq
      See Also:

    • minHeat0

      protected float minHeat0

    • maxHeat0

      protected float maxHeat0

    • minHeat1

      protected float minHeat1

    • maxHeat1

      protected float maxHeat1

    • minWet0

      protected float minWet0

    • maxWet0

      protected float maxWet0

    • terrainRidged

      public final com.github.yellowstonegames.grid.NoiseWrapper terrainRidged

    • heat

      public final com.github.yellowstonegames.grid.NoiseWrapper heat

    • moisture

      public final com.github.yellowstonegames.grid.NoiseWrapper moisture

    • otherRidged

      public final com.github.yellowstonegames.grid.NoiseWrapper otherRidged

    • terrainBasic

      public final com.github.yellowstonegames.grid.NoiseWrapper terrainBasic

    • xPositions

      public final float[][] xPositions

    • yPositions

      public final float[][] yPositions

    • zPositions

      public final float[][] zPositions

  • Constructor Details

    • LocalMap

      public LocalMap()
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Always makes a 256x128 map. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail. If you were using LocalMap(long, int, int, INoise, float), then this would be the same as passing the parameters 0x1337BABE1337D00DL, 256, 128, new Noise(DEFAULT_NOISE), 1f.

    • LocalMap

      public LocalMap(int mapWidth, int mapHeight)
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Takes only the width/height of the map. The initial seed is set to the same large long every time, and it's likely that you would set the seed when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact, but you can zoom in. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      mapWidth - the width of the map(s) to generate; cannot be changed later
      mapHeight - the height of the map(s) to generate; cannot be changed later

    • LocalMap

      public LocalMap(long initialSeed, int mapWidth, int mapHeight)
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Takes an initial seed and the width/height of the map. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact, but you can zoom in. Uses Noise as its noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      mapWidth - the width of the map(s) to generate; cannot be changed later
      mapHeight - the height of the map(s) to generate; cannot be changed later

    • LocalMap

      public LocalMap(long initialSeed, int mapWidth, int mapHeight, float octaveMultiplier)
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Takes an initial seed and the width/height of the map. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact, but you can zoom in. Uses Noise as its noise generator, with the given octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      mapWidth - the width of the map(s) to generate; cannot be changed later
      mapHeight - the height of the map(s) to generate; cannot be changed later
      octaveMultiplier - used to adjust the level of detail, with 0.5f at the bare-minimum detail and 1f normal

    • LocalMap

      public LocalMap(long initialSeed, int mapWidth, int mapHeight, com.github.yellowstonegames.grid.INoise noiseGenerator)
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Takes an initial seed and the width/height of the map. The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact, but you can zoom in. Uses the given noise generator, with 1f as the octave multiplier affecting detail.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      mapWidth - the width of the map(s) to generate; cannot be changed later
      mapHeight - the height of the map(s) to generate; cannot be changed later
      noiseGenerator - an instance of a noise generator capable of 3D noise, usually Noise

    • LocalMap

      public LocalMap(long initialSeed, int mapWidth, int mapHeight, com.github.yellowstonegames.grid.INoise noiseGenerator, float octaveMultiplier)
      Constructs a concrete WorldMapGenerator for a map that can be used to wrap a sphere (as with a texture on a 3D model), with seamless east-west wrapping, no north-south wrapping, and distortion that causes the poles to have significantly-exaggerated-in-size features while the equator is not distorted. Takes an initial seed, the width/height of the map, and parameters for noise generation (a Noise implementation, which is usually Noise.instance, and a multiplier on how many octaves of noise to use, with 1f being normal (high) detail and higher multipliers producing even more detailed noise when zoomed-in). The initialSeed parameter may or may not be used, since you can specify the seed to use when you call WorldMapGenerator.generate(long, long). The width and height of the map cannot be changed after the fact, but you can zoom in. Noise will be the fastest 3D generator to use for noiseGenerator, and the seed it's constructed with doesn't matter because this will change the seed several times at different scales of noise (it's fine to use the static Noise.instance because it has no changing state between runs of the program). The octaveMultiplier parameter should probably be no lower than 0.5f, but can be arbitrarily high if you're willing to spend much more time on generating detail only noticeable at very high zoom; normally 1f is fine and may even be too high for maps that don't require zooming.
      Parameters:
      initialSeed - the seed for the FlowRandom this uses; this may also be set per-call to generate
      mapWidth - the width of the map(s) to generate; cannot be changed later
      mapHeight - the height of the map(s) to generate; cannot be changed later
      noiseGenerator - an instance of a noise generator capable of 3D noise, often Noise.instance
      octaveMultiplier - used to adjust the level of detail, with 0.5f at the bare-minimum detail and 1f normal

    • LocalMap

      public LocalMap(LocalMap other)
      Copies the LocalMap other to construct a new one that is exactly the same. References will only be shared to Noise classes.
      Parameters:
      other - a LocalMap to copy

    • LocalMap

      public LocalMap(int width, int height, String serialized)
      Creates a new generator from the given serialized String, produced by stringSerialize(), but this also requires width and height that match the first two lines of the given String (in Base.BASE86). It is almost always easier to use recreateFromString(String) instead.
      Parameters:
      width - width of the map or maps to generate; must match the first line of the given String in Base.BASE86
      height - height of the map or maps to generate; must match the second line of the given String in Base.BASE86
      serialized - should have been produced by stringSerialize()

  • Method Details

    • stringSerialize

      public String stringSerialize()
      Serializes this generator's entire state to a String; it can be read back when creating a new instance of this type with LocalMap(int, int, String) or (preferably) recreateFromString(String). Uses Base.BASE86 to represent values very concisely, but not at all readably. The String this produces tends to be very long because it includes several 2D arrays and a Region as Strings.
      Overrides:
      stringSerialize in class WorldMapGenerator
      Returns:
      a String that stores the entire state of this generator

    • recreateFromString

      public static LocalMap recreateFromString(String data)
      Creates a new instance of this class from a serialized String produced by stringSerialize(). This can get the width and height from the String, which makes this probably preferable to using the constructor LocalMap(int, int, String). This stores the last-generated map in this WorldMapGenerator, where it can be used by other code like a WorldMapView.
      Parameters:
      data - the output of stringSerialize()
      Returns:
      the map that was serialized, as a new generator

    • wrapX

      public int wrapX(int x, int y)
      Overrides:
      wrapX in class WorldMapGenerator

    • wrapY

      public int wrapY(int x, int y)
      Overrides:
      wrapY in class WorldMapGenerator

    • regenerate

      protected void regenerate(int startX, int startY, int usedWidth, int usedHeight, float landMod, float heatMod, long stateA, long stateB)
      Specified by:
      regenerate in class WorldMapGenerator

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object