Class Cylinders


  • public class Cylinders
    extends Module
    Noise module that outputs concentric cylinders.

    This noise module outputs concentric cylinders centered on the origin. These cylinders are oriented along the y axis similar to the concentric rings of a tree. Each cylinder extends infinitely along the y axis.

    By default, the first cylinder has a radius of 1.0. Each subsequent cylinder has a radius that is 1.0 unit larger than the previous cylinder.

    The output value from this noise module is determined by the distance between the input value and the nearest cylinder surface. The input values that are located on a cylinder surface are given the output value 1.0 and the input values that are equidistant from two cylinder surfaces are given the output value -1.0.

    An application can change the frequency of the concentric cylinders. Increasing the frequency reduces the distances between cylinders. To specify the frequency, call the setFrequency(double) method.

    This noise module, modified with some low-frequency, low-power turbulence, is useful for generating wood-like textures.

    Source Modules
    This module does not require any source modules.
    • Field Detail

      • DEFAULT_CYLINDERS_FREQUENCY

        public static final double DEFAULT_CYLINDERS_FREQUENCY
        Default frequency value for the Cylinders noise module.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Cylinders

        public Cylinders()
    • Method Detail

      • getFrequency

        public double getFrequency()
        Get the frequency of the concentric cylinders.

        Increasing the frequency increases the density of the concentric cylinders, reducing the distances between them.

        Returns:
        the frequency of the concentric cylinders
      • setFrequency

        public void setFrequency​(double frequency)
        Set the frequency of the concentric cylinders.

        Increasing the frequency increases the density of the concentric cylinders, reducing the distances between them.

        Parameters:
        frequency - the frequency of the concentric cylinders
      • getValue

        public double getValue​(double x,
                               double y,
                               double z)
        Description copied from class: Module
        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 Module.setSourceModule(int, Module) 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 Module.getSourceModuleCount() method.

        Specified by:
        getValue in class Module
        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