Rings
Version 0.3

threeD.ui.panels
Class RenderPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bythreeD.ui.panels.RenderPanel
All Implemented Interfaces:
javax.accessibility.Accessible, EventGenerator, EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class RenderPanel
extends javax.swing.JPanel
implements EventListener, EventGenerator

A RenderPanel object allows display of scene previews and rendered images of the Scene object it uses.

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
 
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
RenderPanel(Scene scene)
          Constructs a new RenderPanel object that can be used to render the specified Scene object.
 
Method Summary
 void clearRenderedImage()
          Removes any stored image data from this RenderPanel object and repaints the panel.
 void eventFired(Event event)
          Method called when an event has been fired.
 EventHandler getEventHandler()
          Returns the EventHandler object used by this RenderPanel object.
 int getImageHeight()
          Returns the height, in pixels, of the image that will be rendered by this RenderPanel object.
 int getImageWidth()
          Returns the width, in pixels, of the image that will be rendered by this RenderPanel object.
 double getProjectionHeight()
           
 double getProjectionWidth()
           
 RGB[][] getRenderedImageData()
          Return the image rendered by this RenderPanel as an array of RGB objects.
 boolean getShowProgressWindow()
          Returns true if rendering progress will be displayed in a new window.
 int getSupersampleHeight()
          Returns the supersampling height of the image that will be rendered by this RenderPanel object.
 int getSupersampleWidth()
          Returns the supersampling width of the image that will be rendered by this RenderPanel object.
 void paint(java.awt.Graphics g)
          Method called when painting this RenderPanel.
 void render()
          Renders the Scene object stored by this RenderPanel object and draws the output image on the panel.
 void setEventHandler(EventHandler handler)
          Sets the EventHandler object used by this RenderPanel object.
 void setImageHeight(int height)
          Sets the height, in pixels, of the image that will be rendered by this RenderPanel object.
 void setImageWidth(int width)
          Sets the width, in pixels, of the image that will be rendered by this RenderPanel object.
 void setShowProgressWindow(boolean show)
          When set to true, rendering progress will be displayed in a new window.
 void setSupersampleHeight(int height)
          Sets the supersampling height of the image that will be rendered by this RenderPanel object.
 void setSupersampleWidth(int width)
          Sets the supersampling width of the image that will be rendered by this RenderPanel object.
 
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, paintBorder, paintChildren, paintComponent, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RenderPanel

public RenderPanel(Scene scene)
Constructs a new RenderPanel object that can be used to render the specified Scene object.

Method Detail

render

public void render()
Renders the Scene object stored by this RenderPanel object and draws the output image on the panel.


clearRenderedImage

public void clearRenderedImage()
Removes any stored image data from this RenderPanel object and repaints the panel.


eventFired

public void eventFired(Event event)
Method called when an event has been fired.

Specified by:
eventFired in interface EventListener

setImageWidth

public void setImageWidth(int width)
Sets the width, in pixels, of the image that will be rendered by this RenderPanel object.


setImageHeight

public void setImageHeight(int height)
Sets the height, in pixels, of the image that will be rendered by this RenderPanel object.


setSupersampleWidth

public void setSupersampleWidth(int width)
Sets the supersampling width of the image that will be rendered by this RenderPanel object.


setSupersampleHeight

public void setSupersampleHeight(int height)
Sets the supersampling height of the image that will be rendered by this RenderPanel object.


getProjectionWidth

public double getProjectionWidth()
Returns:
The projection width of the Camera object stored by this RenderPanel object.

getProjectionHeight

public double getProjectionHeight()
Returns:
The projection height of the Camera object stored by this RenderPanel object.

setShowProgressWindow

public void setShowProgressWindow(boolean show)
When set to true, rendering progress will be displayed in a new window. Otherwise, the progress will be displayed within this RenderPanel's window.


getImageWidth

public int getImageWidth()
Returns the width, in pixels, of the image that will be rendered by this RenderPanel object.


getImageHeight

public int getImageHeight()
Returns the height, in pixels, of the image that will be rendered by this RenderPanel object.


getSupersampleWidth

public int getSupersampleWidth()
Returns the supersampling width of the image that will be rendered by this RenderPanel object.


getSupersampleHeight

public int getSupersampleHeight()
Returns the supersampling height of the image that will be rendered by this RenderPanel object.


getShowProgressWindow

public boolean getShowProgressWindow()
Returns true if rendering progress will be displayed in a new window. Otherwise, false is returned and the progress will be displayed within this RenderPanel's window.


getRenderedImageData

public RGB[][] getRenderedImageData()
Return the image rendered by this RenderPanel as an array of RGB objects.


setEventHandler

public void setEventHandler(EventHandler handler)
Sets the EventHandler object used by this RenderPanel object. Setting this to null will deactivae event reporting.

Specified by:
setEventHandler in interface EventGenerator

getEventHandler

public EventHandler getEventHandler()
Returns the EventHandler object used by this RenderPanel object.

Specified by:
getEventHandler in interface EventGenerator

paint

public void paint(java.awt.Graphics g)
Method called when painting this RenderPanel.


Rings
Version 0.3

Copyright 2003-05 Mike Murray