artofillusion.procedural
Class ProcedureEditor

java.lang.Object
  extended by CustomWidget
      extended by artofillusion.procedural.ProcedureEditor

public class ProcedureEditor
extends CustomWidget

This is the editor for editing procedures. It subclasses CustomWidget, but you should never add it to any Container. Instead, it will automatically create a BFrame and add itself to that.


Constructor Summary
ProcedureEditor(Procedure proc, ProcedureOwner owner, Scene scene)
           
 
Method Summary
 void addModule(Module mod)
          Add a module to the procedure.
 EditingWindow getEditingWindow()
          Get the editing window which owns the scene the procedure is part of.
 ProcedureOwner getOwner()
          Get the editor's owner.
 BFrame getParentFrame()
          Get the editor's parent Frame.
 java.awt.Dimension getPreferredSize()
           
 java.awt.Rectangle getRectangle(java.awt.Point p1, java.awt.Point p2)
          Utility function to create a Rectangle from two Points.
 Scene getScene()
          Get the scene the procedure is part of.
 void saveState(boolean redo)
          Record the current state of the procedure, so that it can be undone.
 void setEditingWindow(EditingWindow window)
          Set the editing window which owns the scene the procedure is part of.
 void updatePreview()
          Update the preview.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcedureEditor

public ProcedureEditor(Procedure proc,
                       ProcedureOwner owner,
                       Scene scene)
Method Detail

getParentFrame

public BFrame getParentFrame()
Get the editor's parent Frame.


getOwner

public ProcedureOwner getOwner()
Get the editor's owner.


getScene

public Scene getScene()
Get the scene the procedure is part of.


setEditingWindow

public void setEditingWindow(EditingWindow window)
Set the editing window which owns the scene the procedure is part of.


getEditingWindow

public EditingWindow getEditingWindow()
Get the editing window which owns the scene the procedure is part of.


getPreferredSize

public java.awt.Dimension getPreferredSize()

addModule

public void addModule(Module mod)
Add a module to the procedure.


saveState

public void saveState(boolean redo)
Record the current state of the procedure, so that it can be undone.


updatePreview

public void updatePreview()
Update the preview.


getRectangle

public java.awt.Rectangle getRectangle(java.awt.Point p1,
                                       java.awt.Point p2)
Utility function to create a Rectangle from two Points.



Copyright © 1999-2011 by Peter Eastman.