artofillusion
Class ObjectEditorWindow

java.lang.Object
  extended by BFrame
      extended by artofillusion.ObjectEditorWindow
All Implemented Interfaces:
EditingWindow
Direct Known Subclasses:
CompoundImplicitEditorWindow, CSGEditorWindow, MeshEditorWindow

public abstract class ObjectEditorWindow
extends BFrame
implements EditingWindow

The ObjectEditorWindow class represents a window for editing an object. This is an abstract class, with subclasses for various types of objects.


Constructor Summary
ObjectEditorWindow(EditingWindow parent, java.lang.String title, ObjectInfo obj)
           
 
Method Summary
 boolean confirmClose()
          Confirm whether this window should be closed (possibly by displaying a message to the user), and then close it.
 void dispose()
          This is overridden to notify all plugins when the window is closed.
 ViewerCanvas[] getAllViews()
          Get all ViewerCanvases 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.
 ToolPalette getToolPalette()
          Get the ToolPalette for this window.
 ViewerCanvas getView()
          Get the currently selected ViewerCanvas for this window.
 void redoCommand()
          Redo the last action that was undone.
 void setCurrentView(ViewerCanvas view)
          Set which ViewerCanvas has focus.
 void setGridCommand()
          Set the grid options for the current window.
 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 setTemplateCommand()
          Allow the user to set the template image.
 void setTool(EditingTool tool)
          Set the currently selected EditingTool.
 void setUndoRecord(UndoRecord command)
          Set the current UndoRecord for this EditingWindow.
 void setVisible(boolean visible)
          This is overridden to notify all plugins when the window is shown for the first time.
 void showAxesCommand()
          Toggle whether the coordinate axes are shown.
 void showTemplateCommand()
          Toggle whether the template is shown.
 void toggleViewsCommand()
          Toggle whether there are one or four views shown.
 void undoCommand()
          Undo the most recent action.
 void updateImage()
          Update the image displayed in this window.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface artofillusion.ui.EditingWindow
getScene, updateMenus
 

Constructor Detail

ObjectEditorWindow

public ObjectEditorWindow(EditingWindow parent,
                          java.lang.String title,
                          ObjectInfo obj)
Method Detail

setTool

public void setTool(EditingTool tool)
Description copied from interface: EditingWindow
Set the currently selected EditingTool.

Specified by:
setTool in interface EditingWindow

confirmClose

public boolean confirmClose()
Description copied from interface: EditingWindow
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.

Specified by:
confirmClose in interface EditingWindow

setHelpText

public void setHelpText(java.lang.String text)
Description copied from interface: EditingWindow
Set the text to display at the bottom of the window.

Specified by:
setHelpText in interface EditingWindow

getFrame

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

Specified by:
getFrame in interface EditingWindow

updateImage

public void updateImage()
Description copied from interface: EditingWindow
Update the image displayed in this window.

Specified by:
updateImage in interface EditingWindow

setUndoRecord

public void setUndoRecord(UndoRecord command)
Description copied from interface: EditingWindow
Set the current UndoRecord for this EditingWindow.

Specified by:
setUndoRecord in interface EditingWindow

setModified

public void setModified()
Description copied from interface: EditingWindow
Register that the scene or object contained in the window has been modified.

Specified by:
setModified in interface EditingWindow

getView

public ViewerCanvas getView()
Get the currently selected ViewerCanvas for this window.

Specified by:
getView in interface EditingWindow

setCurrentView

public void setCurrentView(ViewerCanvas view)
Set which ViewerCanvas has focus.

Parameters:
view - the ViewerCanvas which should become the currently focused view. If this is not one of the views belonging to this window, this method does nothing.

getToolPalette

public ToolPalette getToolPalette()
Get the ToolPalette for this window.

Specified by:
getToolPalette in interface EditingWindow

getAllViews

public ViewerCanvas[] getAllViews()
Get all ViewerCanvases in this window.

Specified by:
getAllViews in interface EditingWindow

showAxesCommand

public void showAxesCommand()
Toggle whether the coordinate axes are shown.


showTemplateCommand

public void showTemplateCommand()
Toggle whether the template is shown.


toggleViewsCommand

public void toggleViewsCommand()
Toggle whether there are one or four views shown.


setTemplateCommand

public void setTemplateCommand()
Allow the user to set the template image.


setGridCommand

public void setGridCommand()
Set the grid options for the current window.


undoCommand

public void undoCommand()
Undo the most recent action.


redoCommand

public void redoCommand()
Redo the last action that was undone.


setVisible

public void setVisible(boolean visible)
This is overridden to notify all plugins when the window is shown for the first time.


dispose

public void dispose()
This is overridden to notify all plugins when the window is closed.



Copyright © 1999-2011 by Peter Eastman.