com.sudoplay.joise.module

Class Module

java.lang.Object

com.sudoplay.joise.module.Module

Direct Known Subclasses:

ModuleBlend, ModuleCellular, ModuleCombiner, ModuleGradient, ModuleMagnitude, ModuleOverlaps, ModuleSelect, ModuleSphere, SeededModule, SourcedModule

public abstract class Module
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_SEED

Constructor Summary

Constructors

Constructor and Description
Module()
Module(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
abstract Module	buildFromPropertyMap(com.sudoplay.joise.ModulePropertyMap props, com.sudoplay.joise.ModuleInstanceMap map)
abstract double	get(double x, double y)
abstract double	get(double x, double y, double z)
abstract double	get(double x, double y, double z, double w)
abstract double	get(double x, double y, double z, double w, double u, double v)
java.lang.String	getId()
com.sudoplay.joise.ModuleMap	getModuleMap()
void	setId(java.lang.String id) Sets the globally unique string id for this module
abstract void	setSeed(java.lang.String seedName, long seed)
abstract void	writeToMap(com.sudoplay.joise.ModuleMap map)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEED

public static final long DEFAULT_SEED

See Also:

Constant Field Values

Constructor Detail

Module

public Module()

Module

public Module(java.lang.String id)

Method Detail

get

public abstract double get(double x,
                           double y)

get

public abstract double get(double x,
                           double y,
                           double z)

get

public abstract double get(double x,
                           double y,
                           double z,
                           double w)

get

public abstract double get(double x,
                           double y,
                           double z,
                           double w,
                           double u,
                           double v)

getId

public java.lang.String getId()

Returns:

the globally unique string id for this module

setId

public void setId(java.lang.String id)

Sets the globally unique string id for this module

getModuleMap

public com.sudoplay.joise.ModuleMap getModuleMap()

Returns:

a new ModuleMap of the module chain using this module as the entry point

setSeed

public abstract void setSeed(java.lang.String seedName,
                             long seed)

writeToMap

public abstract void writeToMap(com.sudoplay.joise.ModuleMap map)

buildFromPropertyMap

public abstract Module buildFromPropertyMap(com.sudoplay.joise.ModulePropertyMap props,
                                            com.sudoplay.joise.ModuleInstanceMap map)