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

Class Plane

java.lang.Object
org.spongepowered.noise.model.Plane
public class Plane extends Object
Model that defines the surface of a plane.

This model returns an output value from a noise module given the coordinates of an input value located on the surface of an (x, z) plane.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Plane(NoiseModule module)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    get(double x, double z)
    Returns the output value from the noise module given the ( x, z ) coordinates of the specified input value located on the surface of the plane.
    NoiseModule
    module()
    Returns the noise module that is used to generate the output values.
    void
    setModule(NoiseModule module)
    Sets the noise module that is used to generate the output values.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Plane

      public Plane(NoiseModule module)
      Constructor
      Parameters:
      module - The noise module that is used to generate the output values.

  • Method Details

    • module

      public NoiseModule module()
      Returns the noise module that is used to generate the output values.
      Returns:
      the module used to generate output values

    • setModule

      public void setModule(NoiseModule module)
      Sets the noise module that is used to generate the output values.

      This noise module must exist for the lifetime of this object, until you pass a new noise module to this method.

      Parameters:
      module - The noise module that is used to generate the output values.

    • get

      public double get(double x, double z)
      Returns the output value from the noise module given the ( x, z ) coordinates of the specified input value located on the surface of the plane.
      Parameters:
      x - The x coordinate of the input value.
      z - The z coordinate of the input value.
      Returns:
      The output value from the noise module.