org.web3d.browser
Interface BrowserComponent

All Known Implementing Classes:

VRMLBrowserAWTPanel, VRMLBrowserAWTPanel, VRMLBrowserJPanel, VRMLBrowserJPanel, X3DBrowserAWTPanel, X3DBrowserAWTPanel, X3DBrowserJPanel, X3DBrowserJPanel

public interface BrowserComponent

Abstraction of a specific rendering component that can be placed on screen regardless of renderer type.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Method Summary

void	destroy() Called to instruct the component instance to destroy itself and any used resources.
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.
int	getRendererType() Get the renderer type.
void	setMinimumFrameInterval(int millis) Set the minimum frame interval time to limit the CPU resources taken up by the 3D renderer.
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.

Method Detail

supportedSpecificationVersion

public int supportedSpecificationVersion()

Get the spec version that is supported.

Returns:

a number representing the spec major version

getCanvas

public java.awt.Canvas getCanvas()

Get the AWT component holding this browser.

Returns:

The component

getRendererType

public int getRendererType()

Get the renderer type.

Returns:

The BrowserCore type

getBrowserCore

public BrowserCore getBrowserCore()

Get the core browser implementation.

Returns:

the BrowserCore

getErrorReporter

public ErrorReporter getErrorReporter()

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

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.

Parameters:

millis - The minimum time in milleseconds.

start

public void start()

Called to instruct the component instance to start rendering now.

stop

public void stop()

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

destroy

public void destroy()

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