com.flowpowered.noise.model

Class Cylinder

java.lang.Object

com.flowpowered.noise.model.Cylinder

public class Cylinder
extends Object

Model that defines the surface of a cylinder.

Constructor Summary

Constructors

Constructor and Description
Cylinder(Module mod)

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 angle, double height) Returns the output value from the noise module given the (angle, height) coordinates of the specified input value located on the surface of the cylinder.
void	setModule(Module mod) 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

Cylinder

public Cylinder(Module mod)

Parameters:

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

Returns:

A reference to the noise module.

setModule

public void setModule(Module mod)

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

Parameters:

mod - 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 angle,
                       double height)

Returns the output value from the noise module given the (angle, height) coordinates of the specified input value located on the surface of the cylinder.

Parameters:

angle - The angle around the cylinder's center, in degrees.

height - The height along the @a y axis.

Returns:

The output value from the noise module.