org.web3d.j3d.browser
Class X3DBrowserJPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.web3d.j3d.browser.X3DBrowserJPanel

All Implemented Interfaces:

javax.accessibility.Accessible, BrowserComponent, BrowserCoreListener, java.awt.event.ComponentListener, java.util.EventListener, FileHandler, java.awt.image.ImageObserver, java.awt.event.KeyListener, java.awt.MenuContainer, java.lang.Runnable, java.io.Serializable, org.j3d.ui.navigation.ViewpointSelectionListener, java.awt.event.WindowListener, X3DComponent

public class X3DBrowserJPanel

extends javax.swing.JPanel

implements X3DComponent, BrowserComponent, org.j3d.ui.navigation.ViewpointSelectionListener, BrowserCoreListener, java.awt.event.ComponentListener, java.awt.event.WindowListener, FileHandler, java.lang.Runnable, java.awt.event.KeyListener

A swing panel that implements a single view browser using Java3D as the X3D renderer.

Version:

$Revision: 1.38 $

Author:

Justin Couch, Alan Hudson

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

X3DBrowserJPanel(boolean vrml97Only, boolean showDash, boolean dashTop, boolean showUrl, boolean urlTop, boolean urlReadOnly, boolean showConsole, boolean showOpenButton, boolean showReloadButton, boolean showStatusBar, boolean showFPS, java.lang.String contentDirectory, boolean antialiased, java.lang.String antialiasingQuality, java.lang.String primitiveQuality, java.lang.String textureQuality)
Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

X3DBrowserJPanel(boolean vrml97Only, boolean showDash, boolean dashTop, boolean showUrl, boolean urlTop, boolean urlReadOnly, boolean showConsole, boolean showOpenButton, boolean showReloadButton, boolean showStatusBar, boolean showFPS, java.lang.String contentDirectory, boolean antialiased, java.lang.String antialiasingQuality, java.lang.String primitiveQuality, java.lang.String textureQuality, java.util.Properties skinProperties)
Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

X3DBrowserJPanel(boolean showDash, boolean dashTop, boolean showUrl, boolean urlTop, boolean urlReadOnly, boolean showConsole, boolean showOpenButton, boolean showReloadButton, boolean showStatusBar, boolean showFPS, boolean antialiased, java.lang.String contentDirectory, java.lang.String antialiasingQuality, java.lang.String primitiveQuality, java.lang.String textureQuality)
Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Method Summary

void	browserDisposed() The browser has been disposed.
void	browserInitialized(VRMLScene scene) The browser has been initialised with new content.
void	browserShutdown() The browser has been shut down and the previous content is no longer valid.
void	componentHidden(java.awt.event.ComponentEvent evt) Invoked when the component has been made invisible.
void	componentMoved(java.awt.event.ComponentEvent evt) Invoked when the component's position changes.
void	componentResized(java.awt.event.ComponentEvent evt) Invoked when the component's size changes.
void	componentShown(java.awt.event.ComponentEvent evt) Invoked when the component has been made visible.
void	destroy() Called to instruct the component instance to destroy itself and any used resources.
ExternalBrowser	getBrowser() Get a browser reference from this component that represents the internals of this browser.
BrowserCore	getBrowserCore() Get the core browser implementation.
java.awt.Canvas	getCanvas() Get the AWT component holding this browser.
ErrorReporter	getErrorReporter() Fetch the error handler so that application code can post messages too.
java.lang.Object	getImplementation() Get a reference to the component implementation.
int	getRendererType() Get the renderer type.
VRMLScene	getScene() Get the scene object being rendered by this panel.
VRMLUniverse	getUniverse() Get the universe underlying this panel.
void	keyPressed(java.awt.event.KeyEvent e) Notification that a key is pressed.
void	keyReleased(java.awt.event.KeyEvent e) Notification that a key is released.
void	keyTyped(java.awt.event.KeyEvent e) Notification that a key is typed (press and release).
void	loadURL(InputSource src) Change the panels content to the provided URL.
void	loadURL(java.lang.String url) Change the panels content to the provided URL.
void	run() Thread to update frames per second and status bar.
void	setMinimumFrameInterval(int millis) Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer.
void	shutdown() Shutdown the component because it will no longer be needed.
void	start() Called to instruct the component instance to start rendering now.
void	stop() Called to instruct the component instance to stop and suspend its state.
int	supportedSpecificationVersion() Get the spec version that is supported.
void	urlLoadFailed(java.lang.String msg) The tried to load a URL and failed.
void	viewpointSelected(org.j3d.ui.navigation.ViewpointData vp) A new viewpoint has been selected and this is it.
void	windowActivated(java.awt.event.WindowEvent evt) Ignored
void	windowClosed(java.awt.event.WindowEvent evt) Ignored
void	windowClosing(java.awt.event.WindowEvent evt) Ignored
void	windowDeactivated(java.awt.event.WindowEvent evt) Ignored
void	windowDeiconified(java.awt.event.WindowEvent evt) Invoked when a window is changed from a minimized to a normal state.
void	windowIconified(java.awt.event.WindowEvent evt) Invoked when a window is changed from a normal state to minimzed.
void	windowOpened(java.awt.event.WindowEvent evt) Ignored

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, 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

X3DBrowserJPanel

public X3DBrowserJPanel(boolean showDash,
                        boolean dashTop,
                        boolean showUrl,
                        boolean urlTop,
                        boolean urlReadOnly,
                        boolean showConsole,
                        boolean showOpenButton,
                        boolean showReloadButton,
                        boolean showStatusBar,
                        boolean showFPS,
                        boolean antialiased,
                        java.lang.String contentDirectory,
                        java.lang.String antialiasingQuality,
                        java.lang.String primitiveQuality,
                        java.lang.String textureQuality)

Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Parameters:

showDash - true to show the navigation bar

dashTop - true to put the nav bar at the top

showUrl - true to show the URL location bar

urlTop - true to put the location bar at the top

urlReadOnly - true to make the location bar read only

showConsole - true if the console should be shown immediately

showOpenButton - true to put an open button with the URL location bar

showReloadButton - true to put a reload button with the URL location bar

showStatusBar - true to show a status bar

showFPS - true to show the current FPS

contentDirectory - initial directory to load content from. Must be a full path.

antialiased - true to turn on antialiasing

antialiasingQuality - low, medium, high, antialiasing must be turned on for this to matter.

primitiveQuality - low, medium, high.

textureQuality - low, medium, high.

X3DBrowserJPanel

public X3DBrowserJPanel(boolean vrml97Only,
                        boolean showDash,
                        boolean dashTop,
                        boolean showUrl,
                        boolean urlTop,
                        boolean urlReadOnly,
                        boolean showConsole,
                        boolean showOpenButton,
                        boolean showReloadButton,
                        boolean showStatusBar,
                        boolean showFPS,
                        java.lang.String contentDirectory,
                        boolean antialiased,
                        java.lang.String antialiasingQuality,
                        java.lang.String primitiveQuality,
                        java.lang.String textureQuality)

Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Parameters:

vrml97Only - true if this is to be restricted to VRML97 only

showDash - true to show the navigation bar

dashTop - true to put the nav bar at the top

showUrl - true to show the URL location bar

urlTop - true to put the location bar at the top

urlReadOnly - true to make the location bar read only

showConsole - true if the console should be shown immediately

showStatusBar - true to show a status bar

showFPS - true to show the current FPS

contentDirectory - initial directory to load content from. Must be a full path.

antialiased - true to turn on antialiasing

antialiasingQuality - low, medium, high, antialiasing must be turned on for this to matter.

primitiveQuality - low, medium, high.

textureQuality - low, medium, high.

X3DBrowserJPanel

public X3DBrowserJPanel(boolean vrml97Only,
                        boolean showDash,
                        boolean dashTop,
                        boolean showUrl,
                        boolean urlTop,
                        boolean urlReadOnly,
                        boolean showConsole,
                        boolean showOpenButton,
                        boolean showReloadButton,
                        boolean showStatusBar,
                        boolean showFPS,
                        java.lang.String contentDirectory,
                        boolean antialiased,
                        java.lang.String antialiasingQuality,
                        java.lang.String primitiveQuality,
                        java.lang.String textureQuality,
                        java.util.Properties skinProperties)

Create an instance of the panel configured to show or hide the controls and only shows VRML97 content.

Parameters:

vrml97Only - true if this is to be restricted to VRML97 only

showDash - true to show the navigation bar

dashTop - true to put the nav bar at the top

showUrl - true to show the URL location bar

urlTop - true to put the location bar at the top

urlReadOnly - true to make the location bar read only

showConsole - true if the console should be shown immediately

skinProperties - The properties object to configure appearance with

showStatusBar - true to show a status bar

showFPS - true to show the current FPS

contentDirectory - initial directory to load content from. Must be a full path.

antialiased - true to turn on antialiasing

antialiasingQuality - low, medium, high, antialiasing must be turned on for this to matter.

primitiveQuality - low, medium, high.

textureQuality - low, medium, high.

Method Detail

getBrowser

public ExternalBrowser getBrowser()

Get a browser reference from this component that represents the internals of this browser.

Specified by:

getBrowser in interface X3DComponent

Returns:

A reference to the browser object represented by this component.

getImplementation

public java.lang.Object getImplementation()

Description copied from interface: X3DComponent

Get a reference to the component implementation. For example, if this is an AWT component, it would return an instance of Component.

Specified by:

getImplementation in interface X3DComponent

See Also:

X3DComponent.getImplementation()

shutdown

public void shutdown()

Description copied from interface: X3DComponent

Shutdown the component because it will no longer be needed. If the component has already had this method called, it will silently ignore any further requests.

Specified by:

shutdown in interface X3DComponent

See Also:

X3DComponent.shutdown()

windowActivated

public void windowActivated(java.awt.event.WindowEvent evt)

Ignored

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent evt)

Ignored

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent evt)

Ignored

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent evt)

Ignored

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent evt)

Invoked when a window is changed from a minimized to a normal state.

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

evt - The window event.

windowIconified

public void windowIconified(java.awt.event.WindowEvent evt)

Invoked when a window is changed from a normal state to minimzed.

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

evt - The window event.

windowOpened

public void windowOpened(java.awt.event.WindowEvent evt)

Ignored

Specified by:

windowOpened in interface java.awt.event.WindowListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Notification that a key is pressed.

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

e - The event that caused this method to be called

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Notification that a key is released.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

e - The event that caused this method to be called

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Notification that a key is typed (press and release).

Specified by:

keyTyped in interface java.awt.event.KeyListener

Parameters:

e - The event that caused this method to be called

componentHidden

public void componentHidden(java.awt.event.ComponentEvent evt)

Invoked when the component has been made invisible.

Specified by:

componentHidden in interface java.awt.event.ComponentListener

Parameters:

evt - The event

componentMoved

public void componentMoved(java.awt.event.ComponentEvent evt)

Invoked when the component's position changes.

Specified by:

componentMoved in interface java.awt.event.ComponentListener

Parameters:

evt - The event

componentResized

public void componentResized(java.awt.event.ComponentEvent evt)

Invoked when the component's size changes.

Specified by:

componentResized in interface java.awt.event.ComponentListener

Parameters:

evt - The event

componentShown

public void componentShown(java.awt.event.ComponentEvent evt)

Invoked when the component has been made visible.

Specified by:

componentShown in interface java.awt.event.ComponentListener

Parameters:

evt - The event

supportedSpecificationVersion

public int supportedSpecificationVersion()

Get the spec version that is supported.

Specified by:

supportedSpecificationVersion in interface BrowserComponent

Returns:

a number representing the spec major version

getCanvas

public java.awt.Canvas getCanvas()

Get the AWT component holding this browser.

Specified by:

getCanvas in interface BrowserComponent

Returns:

The component

getRendererType

public int getRendererType()

Get the renderer type.

Specified by:

getRendererType in interface BrowserComponent

Returns:

The BrowserCore type

getBrowserCore

public BrowserCore getBrowserCore()

Get the core browser implementation.

Specified by:

getBrowserCore in interface BrowserComponent

Returns:

the BrowserCore

getErrorReporter

public ErrorReporter getErrorReporter()

Fetch the error handler so that application code can post messages too.

Specified by:

getErrorReporter in interface BrowserComponent

Returns:

The current error handler instance

setMinimumFrameInterval

public void setMinimumFrameInterval(int millis)

Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer. By default it will use all of them.

Specified by:

setMinimumFrameInterval in interface BrowserComponent

Parameters:

millis - The minimum time in milleseconds.

start

public void start()

Called to instruct the component instance to start rendering now.

Specified by:

start in interface BrowserComponent

stop

public void stop()

Called to instruct the component instance to stop and suspend its state. The renderer should stop at this point.

Specified by:

stop in interface BrowserComponent

destroy

public void destroy()

Called to instruct the component instance to destroy itself and any used resources. It will not be used again.

Specified by:

destroy in interface BrowserComponent

viewpointSelected

public void viewpointSelected(org.j3d.ui.navigation.ViewpointData vp)

A new viewpoint has been selected and this is it. Move to this viewpoint location according to the requested means.

Specified by:

viewpointSelected in interface org.j3d.ui.navigation.ViewpointSelectionListener

Parameters:

vp - The new viewpoint to use

browserInitialized

public void browserInitialized(VRMLScene scene)

The browser has been initialised with new content. The content given is found in the accompanying scene and description.

Specified by:

browserInitialized in interface BrowserCoreListener

Parameters:

scene - The scene of the new content

urlLoadFailed

public void urlLoadFailed(java.lang.String msg)

The tried to load a URL and failed. It is typically because none of the URLs resolved to anything valid or there were network failures.

Specified by:

urlLoadFailed in interface BrowserCoreListener

Parameters:

msg - An error message to go with the failure

browserShutdown

public void browserShutdown()

The browser has been shut down and the previous content is no longer valid.

Specified by:

browserShutdown in interface BrowserCoreListener

browserDisposed

public void browserDisposed()

The browser has been disposed.

Specified by:

browserDisposed in interface BrowserCoreListener

loadURL

public void loadURL(java.lang.String url)
             throws java.io.IOException

Change the panels content to the provided URL.

Specified by:

loadURL in interface FileHandler

Parameters:

url - The URL to load.

Throws:

java.io.IOException - On a failed load or badly formatted URL

loadURL

public void loadURL(InputSource src)
             throws java.io.IOException

Change the panels content to the provided URL.

Parameters:

src - The source representation to load

Throws:

java.io.IOException - On a failed load or badly formatted URL

run

public void run()

Thread to update frames per second and status bar.

Specified by:

run in interface java.lang.Runnable

getScene

public VRMLScene getScene()

Get the scene object being rendered by this panel.

Returns:

The current scene.

getUniverse

public VRMLUniverse getUniverse()

Get the universe underlying this panel.

Returns:

The universe.