Module org.spongepowered.noise
Package org.spongepowered.noise.module.modifier

Class ScaleBias

java.lang.Object
org.spongepowered.noise.module.NoiseModule
org.spongepowered.noise.module.modifier.ScaleBias
public class ScaleBias extends NoiseModule
Noise module that applies a scaling factor and a bias to the output value from a source module.

The get(double, double, double) method retrieves the output value from the source module, multiplies it with a scaling factor, adds a bias to it, then outputs the value.

Source Modules
This module requires one source module.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    DEFAULT_BIAS
    Default bias for the ScaleBias noise module.
    static final double
    DEFAULT_SCALE
    Default scale for the ScaleBias noise module.

    Fields inherited from class org.spongepowered.noise.module.NoiseModule

    sourceModule

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScaleBias()
     
    ScaleBias(NoiseModule source)
    Create a new ScaleBias module with the source modules pre-configured.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    bias()
    Get the bias to apply to the scaled output value from the source module.
    double
    get(double x, double y, double z)
    Generates an output value given the coordinates of the specified input value.
    double
    scale()
    Get the scaling factor to apply to the output value from the source module.
    void
    setBias(double bias)
    Set the bias to apply to the scaled output value from the source module.
    void
    setScale(double scale)
    Set the scaling factor to apply to the output value from the source module.

    Methods inherited from class org.spongepowered.noise.module.NoiseModule

    setSourceModule, sourceModule, sourceModuleCount

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ScaleBias

      public ScaleBias()

    • ScaleBias

      public ScaleBias(NoiseModule source)
      Create a new ScaleBias module with the source modules pre-configured.
      Parameters:
      source - the input module

  • Method Details

    • bias

      public double bias()
      Get the bias to apply to the scaled output value from the source module.

      The get(double, double, double) method retrieves the output value from the source module, multiplies it with a scaling factor, adds a bias to it, then outputs the value.

      Returns:
      the bias to apply

    • setBias

      public void setBias(double bias)
      Set the bias to apply to the scaled output value from the source module.

      The get(double, double, double) method retrieves the output value from the source module, multiplies it with a scaling factor, adds a bias to it, then outputs the value.

      Parameters:
      bias - the bias to apply

    • scale

      public double scale()
      Get the scaling factor to apply to the output value from the source module.

      The get(double, double, double) method retrieves the output value from the source module, multiplies it with a scaling factor, adds a bias to it, then outputs the value.

      Returns:
      the scaling factor to apply

    • setScale

      public void setScale(double scale)
      Set the scaling factor to apply to the output value from the source module.

      The get(double, double, double) method retrieves the output value from the source module, multiplies it with a scaling factor, adds a bias to it, then outputs the value.

      Parameters:
      scale - the scaling factor to apply

    • get

      public double get(double x, double y, double z)
      Description copied from class: NoiseModule
      Generates an output value given the coordinates of the specified input value.

      All source modules required by this module must have been connected with the NoiseModule.setSourceModule(int, NoiseModule) method. If these source modules are not connected, this method will throw a NoModuleException.

      To determine the number of source modules required by this noise module, call the NoiseModule.sourceModuleCount() method.

      Specified by:
      get in class NoiseModule
      Parameters:
      x - the x coordinate of the input value
      y - the y coordinate of the input value
      z - the z coordinate of the input value
      Returns:
      the output value