artofillusion.procedural
Class MarbleModule

java.lang.Object
  extended by artofillusion.procedural.Module
      extended by artofillusion.procedural.MarbleModule

public class MarbleModule
extends Module

This is a Module which generates a marble pattern.


Field Summary
 
Fields inherited from class artofillusion.procedural.Module
linkFrom, linkFromIndex
 
Constructor Summary
MarbleModule(java.awt.Point position)
           
 
Method Summary
 Module duplicate()
          Create a duplicate of this module.
 boolean edit(ProcedureEditor editor, Scene theScene)
          Allow the user to set the parameters.
 double getAmplitude()
          Get the amplitude.
 double getAverageValue(int which, double blur)
          Get the average value of the specified output port.
 int getOctaves()
          Get the number of octaves.
 double getSpacing()
          Get the spacing.
 double getValueError(int which, double blur)
          Get the uncertainty in the value of the specified output port.
 void getValueGradient(int which, Vec3 grad, double blur)
          Get the gradient of the value of the specified output port.
 void init(PointInfo p)
          This method initializes the module in preparation for evaluating the procedure at a new point.
 void readFromStream(java.io.DataInputStream in, Scene theScene)
          Read in the module's parameters from an input stream.
 void setAmplitude(double a)
          Set the amplitude.
 void setOctaves(int o)
          Set the number of octaves.
 void setSpacing(double s)
          Set the spacing.
 void writeToStream(java.io.DataOutputStream out, Scene theScene)
          Write out the module's parameters to an output stream.
 
Methods inherited from class artofillusion.procedural.Module
calcSize, checkFeedback, draw, getBounds, getClickedPort, getColor, getInputIndex, getInputPorts, getName, getOutputIndex, getOutputPorts, inputConnected, layout, setInput, setPosition
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarbleModule

public MarbleModule(java.awt.Point position)
Method Detail

getOctaves

public int getOctaves()
Get the number of octaves.


setOctaves

public void setOctaves(int o)
Set the number of octaves.


getAmplitude

public double getAmplitude()
Get the amplitude.


setAmplitude

public void setAmplitude(double a)
Set the amplitude.


getSpacing

public double getSpacing()
Get the spacing.


setSpacing

public void setSpacing(double s)
Set the spacing.


init

public void init(PointInfo p)
Description copied from class: Module
This method initializes the module in preparation for evaluating the procedure at a new point. The default implementation does nothing. Subclasses whose output depends on the point should override this method.

Overrides:
init in class Module

getAverageValue

public double getAverageValue(int which,
                              double blur)
Description copied from class: Module
Get the average value of the specified output port. If the specified output port does not have a value type of NUMBER, the result is undefined. Blur specifies the amount of smoothing to use. Subclasses which can return values should override this method.

Overrides:
getAverageValue in class Module

getValueError

public double getValueError(int which,
                            double blur)
Description copied from class: Module
Get the uncertainty in the value of the specified output port. If the specified output port does not have a value type of NUMBER, the result is undefined. Blur specifies the amount of smoothing to use. Subclasses which can return values should override this method.

Overrides:
getValueError in class Module

getValueGradient

public void getValueGradient(int which,
                             Vec3 grad,
                             double blur)
Description copied from class: Module
Get the gradient of the value of the specified output port. If the specified output port does not have a value type of NUMBER, the result is undefined. Blur specifies the amount of smoothing to use. Subclasses which can return values should override this method.

Overrides:
getValueGradient in class Module

edit

public boolean edit(ProcedureEditor editor,
                    Scene theScene)
Allow the user to set the parameters.

Overrides:
edit in class Module

duplicate

public Module duplicate()
Description copied from class: Module
Create a duplicate of this module. Subclasses with adjustable parameters should override this.

Overrides:
duplicate in class Module

writeToStream

public void writeToStream(java.io.DataOutputStream out,
                          Scene theScene)
                   throws java.io.IOException
Description copied from class: Module
Write out the module's parameters to an output stream. Subclasses with editable parameters should override this method.

Overrides:
writeToStream in class Module
Throws:
java.io.IOException

readFromStream

public void readFromStream(java.io.DataInputStream in,
                           Scene theScene)
                    throws java.io.IOException
Description copied from class: Module
Read in the module's parameters from an input stream. Subclasses with editable parameters should override this method.

Overrides:
readFromStream in class Module
Throws:
java.io.IOException


Copyright © 1999-2011 by Peter Eastman.