artofillusion.procedural
Interface ProcedureOwner

All Known Implementing Classes:
CustomDistortionTrack, ProceduralMaterial3D, ProceduralPositionTrack, ProceduralRotationTrack, ProceduralTexture2D, ProceduralTexture3D

public interface ProcedureOwner

This interface defines an object which "owns" a procedure, and helps define the user interface for editing it.


Method Summary
 void acceptEdits(ProcedureEditor editor)
          This is called when the user clicks OK in the procedure editor.
 boolean allowParameters()
          Determine whether the procedure may contain Parameter modules.
 boolean allowViewAngle()
          Determine whether the procedure may contain View Angle modules.
 boolean canEditName()
          Determine whether the procedure may be renamed.
 void disposePreview(java.lang.Object preview)
          Dispose of the preview object when the editor is closed.
 void editProperties(ProcedureEditor editor)
          Display the Properties dialog.
 java.lang.String getName()
          Get the name of the procedure.
 java.lang.Object getPreview(ProcedureEditor editor)
          Create an object which displays a preview of the procedure.
 java.lang.String getWindowTitle()
          Get the title of the procedure's editing window.
 void setName(java.lang.String name)
          Set the name of the procedure.
 void updatePreview(java.lang.Object preview)
          Update the display of the preview.
 

Method Detail

getWindowTitle

java.lang.String getWindowTitle()
Get the title of the procedure's editing window.


getPreview

java.lang.Object getPreview(ProcedureEditor editor)
Create an object which displays a preview of the procedure.


updatePreview

void updatePreview(java.lang.Object preview)
Update the display of the preview.


disposePreview

void disposePreview(java.lang.Object preview)
Dispose of the preview object when the editor is closed.


allowParameters

boolean allowParameters()
Determine whether the procedure may contain Parameter modules.


allowViewAngle

boolean allowViewAngle()
Determine whether the procedure may contain View Angle modules.


canEditName

boolean canEditName()
Determine whether the procedure may be renamed.


getName

java.lang.String getName()
Get the name of the procedure.


setName

void setName(java.lang.String name)
Set the name of the procedure.


acceptEdits

void acceptEdits(ProcedureEditor editor)
This is called when the user clicks OK in the procedure editor.


editProperties

void editProperties(ProcedureEditor editor)
Display the Properties dialog.



Copyright © 1999-2011 by Peter Eastman.