artofillusion.procedural
Class CommentModule

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

public class CommentModule
extends Module

This is a Module which displays a comment, but otherwise has no effect on the procedure.


Field Summary
 
Fields inherited from class artofillusion.procedural.Module
linkFrom, linkFromIndex
 
Constructor Summary
CommentModule(java.awt.Point position)
           
CommentModule(java.awt.Point position, java.lang.String text)
           
 
Method Summary
 void calcSize()
          Calculate the size on the screen of this module.
 Module duplicate()
          Create a duplicate of this module.
 boolean edit(ProcedureEditor editor, Scene theScene)
          Allow the user to edit the comment text.
 void readFromStream(java.io.DataInputStream in, Scene theScene)
          Read in the module's parameters from an input stream.
 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
checkFeedback, draw, getAverageValue, getBounds, getClickedPort, getColor, getInputIndex, getInputPorts, getName, getOutputIndex, getOutputPorts, getValueError, getValueGradient, init, inputConnected, layout, setInput, setPosition
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommentModule

public CommentModule(java.awt.Point position)

CommentModule

public CommentModule(java.awt.Point position,
                     java.lang.String text)
Method Detail

edit

public boolean edit(ProcedureEditor editor,
                    Scene theScene)
Allow the user to edit the comment text.

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

calcSize

public void calcSize()
Calculate the size on the screen of this module.

Overrides:
calcSize in class Module


Copyright © 1999-2011 by Peter Eastman.