com.flowpowered.noise.model

Class Plane

java.lang.Object

com.flowpowered.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 ( @a x,

Constructor Summary

Constructors

Constructor and Description
Plane(Module module) Constructor

Method Summary

Modifier and Type	Method and Description
Module	getModule() Returns the noise module that is used to generate the output values.
double	getValue(double x, double z) Returns the output value from the noise module given the ( @a x, @a z ) coordinates of the specified input value located on the surface of the plane.
void	setModule(Module 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 Detail

Plane

public Plane(Module module)

Constructor

Parameters:

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

Method Detail

getModule

public Module getModule()

Returns the noise module that is used to generate the output values.

setModule

public void setModule(Module module)

Sets the noise module that is used to generate the output values.

Parameters:

module - 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.

getValue

public double getValue(double x,
                       double z)

Returns the output value from the noise module given the ( @a x, @a z ) coordinates of the specified input value located on the surface of the plane.

Parameters:

x - The @a x coordinate of the input value.

z - The @a z coordinate of the input value.

Returns:

The output value from the noise module.