sim.display3d
Class Display3D

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bysim.display3d.Display3D
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, Steppable

public class Display3D
extends javax.swing.JPanel
implements Steppable

Display3D holds, displays, and manipulates 3D Portrayal objects, allowing the user to scale them, rotate them, translate them, magnify them, change how often they're updated, take snapshots, and generate Quicktime movies. Display3D is Steppable, and each time it is stepped it updates and redisplays itself. Display3D also handles double-click events, routing them to the underlying portrayals as inspector requests.

Display3D's constructor takes a height and width, which is the height and width of the underlying display area (not including the button bar at-top). Display2D can be placed in a JFrame; indeed it provides a convenience function to sprout its own JFrame with the method createFrame(). You can put Display2D in your own JFrame if you like, but you should try to call Display2D.quit() when the frame is disposed.

The viewing area is by default set to roughly encapsulate a 2 by 2 by 2 cube centered at the origin. The user's eye is on the positive Z axis outside of the cube area and is looking down the negative Z axis.

Display3D can have both SimplePortrayal3Ds and FieldPortrayal3Ds attached. Once the Portrayals are attached, the you can transform them (rotate, scale, translate, etc.) all together as one scene via a Global Model Transform. Various Display3D functions are provided to manipulate this Transform (such as rotate(...)). Java3Ders in-the-know can also provide the actual Transform3D if they're feeling lucky.

Display3D provides the optional ability for the user to show axes and a backdrop. Axes are in the X, Y, and Z directions for one unit in length, and are added to the scene after the Global Model Transform has been applied. Thus if you've used the Global Model Transform to scale down your simulation into the space of a 2 by 2 by 2 cube centered at the origin, for example, the axes will just touch the edges of the cube. The backdrop is an optional feature that the programmer must add. You can provide either a spherical backdrop which rotates with the world (like a star field) or a flat backdrop which is always behind the environment and which fills the window exactly. Spherical backdrops can be wrapped with images (use a spherical projection) or -- for the daring Java3Ders -- Apperance objects. Flat backdrops can have images or flat colors.

Display3D and Java3D

Display3D uses Java3D to do its magic. Java3D is a sophisticated scene graph library, but we have done our best to hide this from you if you don't wish to know anything about how Java3D works. For those experienced in Java3D, we describe here the top-level scene graph used by the Display3D.

The Unverse is a SimpleUnverse called universe, the top BranchGraph is root, and the Canvas3D is a special subclass (CapturingCanvas3D) called canvas. A CapturingCanvas3D contains some additional machinery to make possible snapshots and movies. If you wish to add some scene graph material outside of Portrayal3Ds, and you don't want it to be transformed by the Global Model Transform, nor do you want it to be auto-spinnable, hanging it off of root is a good location. Note that even so, the user will be able to rotate, zoom, magnify, and translate the world with the mouse, and that includes this extra scene graph material.

Hanging off of root are two pairs of TransformGroups and RotationInterpolators responsible for auto-spinning the scene graph and a spherical backdrop (a Background object, if one exists), respectively. Auto-spinning happens in concert in these two TransformGroups, so the backdrop will always appear to be auto-spinning with the scene graph.

One of these TransformGroups (autoSpinTransformGroup) is public and holds the scene graph. The other TransformGroup is private. autoSpinTransformGroup is a good place to hang extra scene graph stuff you wish to add, if you don't want that stuff to be transformed along with the Portrayal3Ds, but you'd like it to be auto-spun along with the Portrayal3Ds.

Hanging off of autoSpinTransformGroup are two items: a private Switch which turns on and off the optional axes and backdrop; and globalModelTransformGroup, the TransformGroup responsible for transforming all of the Portrayals in the scene according to the global model transform. Additionally, globalModelTransformGroup is a good place to hang extra scene graph stuff you wish to add that you want to be transformed by the global model transform along with the rest of the Portrayal3Ds.

The globalModelTransformGroup in turn holds a private Switch which in turn holds the scene graph material supplied by each of the Portrayal3Ds in the scene. This Switch turns the Portrayals on and off according the layers menu choice the user makes on the button bar.

The right place to add scene graph material, or make other changes to the Java3D environment, is in the sceneGraphCreated() hook. This function is called for your benefit after the Display3D has created its scene graph material but just before the renderer has been started -- thus the graph is not yet online and is still modifiable.

If you add extra scene graph material to the Display3D outside of a Portrayal3D context, you should set it to be unpickable, or otherwise you will get errors when the user tries to select it from the scene (Display3D uses geometry-based picking for its object selection). The easiest way for you to do this to a given node is to call the utility function sim.display3d.SimpleDisplay3D.clearPickableFlags(node)

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 javax.media.j3d.TransformGroup autoSpinTransformGroup
          The TransformGroup which used to spin the underlying model.
 CapturingCanvas3D canvas
          The Java3D canvas holding the universe.
static Display3D foo
           
 javax.media.j3d.TransformGroup globalModelTransformGroup
          The TransformGroup which holds the switch holding the portrayal's scene graph models.
 MovieMaker movieMaker
          The MovieMaker
 javax.media.j3d.BranchGroup root
          The root scene graph node in the Java3D universe.
 com.sun.j3d.utils.universe.SimpleUniverse universe
          The Java3D universe.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
Display3D(double width, double height, GUIState simulation, long interval)
          Creates a Display3D with the provided width and height for its portrayal region, attached to the provided simulation, and displaying itself with the given interval (which must be > 0).
 
Method Summary
 void attach(Portrayal3D portrayal, java.lang.String name)
          Attaches a portrayal to the Display3D, along with the provided human-readable name for the portrayal.
 void clearBackdrop()
          Clears any backdrop presently being used in the scene
 javax.swing.JFrame createFrame()
          Creates a frame holding the Display3D.
 void createSceneGraph()
          Recreates the entire scene graph, including the universe, root, and canvas3d.
 java.util.ArrayList detatchAll()
          Detatches all portrayals from the Display3D.
static java.lang.String ensureFileEndsWith(java.lang.String filename, java.lang.String ending)
          Utility method.
 void ensureRepaintHeader()
          Force-repaints the header by running the repaint through an invokeLater(), which seems to be more stable than just calling header.repaint() directly.
protected  void finalize()
          Quits the Display3D.
 long getInterval()
          Gets how many ticks are skipped before the display updates itself.
 double getScale()
          Returns the value of the scale (magnification).
 javax.media.j3d.Transform3D getTransform()
          Sets the Display3D's global model transform.
 void paintComponent(java.awt.Graphics g)
          Updates the scene graph
 void quit()
          Quits the Display3D.
 void reset()
          Resets the Display3D so it reschedules itself.
 void resetTransform()
          Resets the global model transform to its default value (identity).
 void rotateX(double degrees)
          Modifies the global model transform by rotating along the current X axis the provided number of degrees.
 void rotateY(double degrees)
          Modifies the global model transform by rotating along the current Y axis the provided number of degrees.
 void rotateZ(double degrees)
          Modifies the global model transform by rotating along the current Z axis the provided number of degrees.
 void scale(double value)
          Modifies the global model transform by uniformly scaling it in all directions by the provided amount.
 void scale(double sx, double sy, double sz)
          Modifies the internal transform by scaling it in a nonuniform fashion.
protected  void sceneGraphCreated()
          A hook for people who want to modify the scene graph just after it's been created (when the user pressed the start button usually; or if the user dynamicallly attaches or detaches portrayals) but before the canvas has started rendering.
 void setBackdrop(javax.media.j3d.Appearance appearance)
          Sets a general appearance for a spherical backdrop.
 void setBackdrop(java.awt.Color color)
          Sets the color for a flat backdrop.
 void setBackdrop(java.awt.Image image, boolean spherical)
          Sets the image for a backdrop (spherical or flat)
 void setInterval(long i)
          Sets how many ticks are skipped before the display updates itself.
 void setScale(double val)
          Changes the value of the scale (magnification).
 void setTransform(javax.media.j3d.Transform3D transform)
          Returns a copy of the current global model transform.
 void startMovie()
          Starts a Quicktime movie on the given Display3D.
 void step(SimState state)
          Steps the Display3D in the GUIState schedule.
 void stopMovie()
          Stops a Quicktime movie and cleans up, flushing the remaining frames out to disk.
 void takeSnapshot()
          Takes a snapshot of the Display3D's currently displayed simulation.
 void transform(javax.media.j3d.Transform3D transform)
          Changes the global model transform of the FieldPortrayal3D by appending to it the provided transform operation.
 void translate(double dx, double dy, double dz)
          Modifies the global model transform by translating in the provided x, y, and z amounts.
 void updateSceneGraph(boolean waitForRenderer)
          Updates the scene graph to reflect changes in the simulation.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

canvas

public CapturingCanvas3D canvas
The Java3D canvas holding the universe. A good time to fool around with this is in the sceneGraphCreated() hook.


universe

public com.sun.j3d.utils.universe.SimpleUniverse universe
The Java3D universe. Created (and recreated) by createSceneGraph. A good time to fool around with this is in the sceneGraphCreated() hook.


root

public javax.media.j3d.BranchGroup root
The root scene graph node in the Java3D universe. Created (and recreated) by createSceneGraph. This is a good place to hang things you don't want auto-rotated nor transformed by the Display3D. Hang things off of here in the sceneGraphCreated() hook.


movieMaker

public MovieMaker movieMaker
The MovieMaker


foo

public static Display3D foo

globalModelTransformGroup

public javax.media.j3d.TransformGroup globalModelTransformGroup
The TransformGroup which holds the switch holding the portrayal's scene graph models. A good time to fool around with this is in the sceneGraphCreated() hook. This is a good place to hang stuff which you want to get rotated AND transformed along with the scene graph.


autoSpinTransformGroup

public javax.media.j3d.TransformGroup autoSpinTransformGroup
The TransformGroup which used to spin the underlying model. This is a good place to hang stuff which you want to get rotated along with the models in the scene graph, but DON'T want transformed along with the scene graph.

Constructor Detail

Display3D

public Display3D(double width,
                 double height,
                 GUIState simulation,
                 long interval)
Creates a Display3D with the provided width and height for its portrayal region, attached to the provided simulation, and displaying itself with the given interval (which must be > 0).

Method Detail

setInterval

public void setInterval(long i)
Sets how many ticks are skipped before the display updates itself.


getInterval

public long getInterval()
Gets how many ticks are skipped before the display updates itself.


createFrame

public javax.swing.JFrame createFrame()
Creates a frame holding the Display3D. This is the best method to create the frame, rather than making a frame and putting the Display3D in it. If you prefer the latter, then you need to handle one thing: when the frame is disposed, you need to call quit() on the Display3D.


ensureRepaintHeader

public void ensureRepaintHeader()
Force-repaints the header by running the repaint through an invokeLater(), which seems to be more stable than just calling header.repaint() directly. This fixes a bug in MacOS X 1.3.1 which doesn't redraw the header when we resize the window.


reset

public void reset()
Resets the Display3D so it reschedules itself. This is useful when reusing the Display3D.


attach

public void attach(Portrayal3D portrayal,
                   java.lang.String name)
Attaches a portrayal to the Display3D, along with the provided human-readable name for the portrayal. The portrayal will be transformed, along with similar attached portrayals, according to the Display3D's internal transform.


detatchAll

public java.util.ArrayList detatchAll()
Detatches all portrayals from the Display3D.


clearBackdrop

public void clearBackdrop()
Clears any backdrop presently being used in the scene


setBackdrop

public void setBackdrop(javax.media.j3d.Appearance appearance)
Sets a general appearance for a spherical backdrop.


setBackdrop

public void setBackdrop(java.awt.Color color)
Sets the color for a flat backdrop.


setBackdrop

public void setBackdrop(java.awt.Image image,
                        boolean spherical)
Sets the image for a backdrop (spherical or flat)


getTransform

public javax.media.j3d.Transform3D getTransform()
Sets the Display3D's global model transform. This is a user-modifiable transform which should be used primarily to adjust the location all of the models together.


setTransform

public void setTransform(javax.media.j3d.Transform3D transform)
Returns a copy of the current global model transform.


transform

public void transform(javax.media.j3d.Transform3D transform)
Changes the global model transform of the FieldPortrayal3D by appending to it the provided transform operation.


resetTransform

public void resetTransform()
Resets the global model transform to its default value (identity).


rotateX

public void rotateX(double degrees)
Modifies the global model transform by rotating along the current X axis the provided number of degrees.


rotateY

public void rotateY(double degrees)
Modifies the global model transform by rotating along the current Y axis the provided number of degrees.


rotateZ

public void rotateZ(double degrees)
Modifies the global model transform by rotating along the current Z axis the provided number of degrees.


translate

public void translate(double dx,
                      double dy,
                      double dz)
Modifies the global model transform by translating in the provided x, y, and z amounts.


scale

public void scale(double value)
Modifies the global model transform by uniformly scaling it in all directions by the provided amount. Has nothing to do with the setScale(...) and getScale(...) methods.


scale

public void scale(double sx,
                  double sy,
                  double sz)
Modifies the internal transform by scaling it in a nonuniform fashion. Note that this is less efficient than a uniform scale. Has nothing to do with the setScale(...) and getScale(...) methods.


createSceneGraph

public void createSceneGraph()
Recreates the entire scene graph, including the universe, root, and canvas3d. This is an expensive procedure and generally should only be called when starting a simulation (in GUIState's start() or load() methods). Just before the renderer is started and the scene goes online, the hook sceneGraphCreated() is called in case you'd like to add anything to the scene graph.


sceneGraphCreated

protected void sceneGraphCreated()
A hook for people who want to modify the scene graph just after it's been created (when the user pressed the start button usually; or if the user dynamicallly attaches or detaches portrayals) but before the canvas has started rendering. Override this as you see fit. The default does nothing at all.


setScale

public void setScale(double val)
Changes the value of the scale (magnification). Usually done by the user through changing the value of the Scale text field. This has nothing to do with the scale() method.


getScale

public double getScale()
Returns the value of the scale (magnification). This has nothing to do with the scale() method.


paintComponent

public void paintComponent(java.awt.Graphics g)
Updates the scene graph


step

public void step(SimState state)
Steps the Display3D in the GUIState schedule. Every interval ticks, this results in updating the scen graph.

Specified by:
step in interface Steppable

updateSceneGraph

public void updateSceneGraph(boolean waitForRenderer)
Updates the scene graph to reflect changes in the simulation. If waitForRenderer is true, we block until the renderer has finished producing the scene on-screen.


ensureFileEndsWith

public static java.lang.String ensureFileEndsWith(java.lang.String filename,
                                                  java.lang.String ending)
Utility method. Returns a filename guaranteed to end with the given ending.


takeSnapshot

public void takeSnapshot()
Takes a snapshot of the Display3D's currently displayed simulation. Ought only be done from the main event loop.


startMovie

public void startMovie()
Starts a Quicktime movie on the given Display3D. The size of the movie frame will be the size of the display at the time this method is called. This method ought to be called from the main event loop. Most of the default movie formats provided will result in a giagantic movie, which you can re-encode using something smarter (like the Animation or Sorenson codecs) to put to a reasonable size. On the Mac, Quicktime Pro will do this quite elegantly.


stopMovie

public void stopMovie()
Stops a Quicktime movie and cleans up, flushing the remaining frames out to disk. This method ought to be called from the main event loop.


quit

public void quit()
Quits the Display3D. Called by the Display3D's frame if the Display3D made the frame itself. Also called by finalize(). Otherwise you should call this method before destroying the Display3D.


finalize

protected void finalize()
                 throws java.lang.Throwable
Quits the Display3D. Okay, so finalize is evil and we're not supposed to rely on it. We're not. But it's an additional cargo-cult programming measure just in case.

Throws:
java.lang.Throwable