artofillusion.procedural
Class OutputModule

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

public class OutputModule
extends Module


Field Summary
 
Fields inherited from class artofillusion.procedural.Module
linkFrom, linkFromIndex
 
Constructor Summary
OutputModule(java.lang.String name, java.lang.String defaultLabel, double defaultValue, RGBColor defaultColor, int type)
           
 
Method Summary
 void calcSize()
          Calculate the size on the screen of this module.
 double getAverageValue(int which, double blur)
          Get the average value of the specified output port.
 void getColor(int which, RGBColor color, double blur)
          Get the color 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 setWidth(int w)
           
 
Methods inherited from class artofillusion.procedural.Module
checkFeedback, draw, duplicate, edit, edit, getBounds, getClickedPort, getInputIndex, getInputPorts, getName, getOutputIndex, getOutputPorts, getValueError, init, inputConnected, layout, readFromStream, setInput, setPosition, writeToStream
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputModule

public OutputModule(java.lang.String name,
                    java.lang.String defaultLabel,
                    double defaultValue,
                    RGBColor defaultColor,
                    int type)
Method Detail

setWidth

public void setWidth(int w)

calcSize

public void calcSize()
Description copied from class: Module
Calculate the size on the screen of this module. The default implementation makes it large enough to display the name of the module.

Overrides:
calcSize 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

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

getColor

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

Overrides:
getColor in class Module


Copyright © 1999-2011 by Peter Eastman.