artofillusion.ui
Interface EditingWindow

All Known Implementing Classes:
CompoundImplicitEditorWindow, CSGEditorWindow, CurveEditorWindow, LayoutWindow, MeshEditorWindow, ObjectEditorWindow, Score, SkeletonShapeEditorWindow, SplineMeshEditorWindow, TriMeshEditorWindow, TubeEditorWindow, UVMappingWindow

public interface EditingWindow

EditingWindow represents a window used for editing an object or scene.


Method Summary
 boolean confirmClose()
          Confirm whether this window should be closed (possibly by displaying a message to the user), and then close it.
 ViewerCanvas[] getAllViews()
          Get all ViewerCanvases contained in this window.
 BFrame getFrame()
          Get the BFrame for this EditingWindow: either the EditingWindow itself if it is a BFrame, or its parent if it is a BDialog.
 Scene getScene()
          Get the Scene which is being edited in this window.
 ToolPalette getToolPalette()
          Get the ToolPalette for this window.
 ViewerCanvas getView()
          Get the ViewerCanvas in which editing is taking place.
 void setHelpText(java.lang.String text)
          Set the text to display at the bottom of the window.
 void setModified()
          Register that the scene or object contained in the window has been modified.
 void setTool(EditingTool tool)
          Set the currently selected EditingTool.
 void setUndoRecord(UndoRecord command)
          Set the current UndoRecord for this EditingWindow.
 void updateImage()
          Update the image displayed in this window.
 void updateMenus()
          Update which menus are enabled.
 

Method Detail

getToolPalette

ToolPalette getToolPalette()
Get the ToolPalette for this window.


setTool

void setTool(EditingTool tool)
Set the currently selected EditingTool.


setHelpText

void setHelpText(java.lang.String text)
Set the text to display at the bottom of the window.


getFrame

BFrame getFrame()
Get the BFrame for this EditingWindow: either the EditingWindow itself if it is a BFrame, or its parent if it is a BDialog.


updateImage

void updateImage()
Update the image displayed in this window.


updateMenus

void updateMenus()
Update which menus are enabled.


setUndoRecord

void setUndoRecord(UndoRecord command)
Set the current UndoRecord for this EditingWindow.


setModified

void setModified()
Register that the scene or object contained in the window has been modified.


getScene

Scene getScene()
Get the Scene which is being edited in this window. If it is not a window for editing a scene, this should return null.


getView

ViewerCanvas getView()
Get the ViewerCanvas in which editing is taking place. This may return null if there is no ViewerCanvas.


getAllViews

ViewerCanvas[] getAllViews()
Get all ViewerCanvases contained in this window. This may return null if there is no ViewerCanvas.


confirmClose

boolean confirmClose()
Confirm whether this window should be closed (possibly by displaying a message to the user), and then close it. If the closing is canceled, this should return false.



Copyright © 1999-2011 by Peter Eastman.