org.web3d.browser
Interface BrowserComponent

All Known Implementing Classes:

BrowserComposite, BrowserJPanel, BrowserView, VRMLBrowserAWTPanel, VRMLBrowserJPanel, X3DBrowserAWTPanel, X3DBrowserComposite, X3DBrowserJPanel

public interface BrowserComponent

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

Version:

$Revision: 1.4 $

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.lang.Object	getCanvas() Get the UI toolkit specific 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, boolean userSet) 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

int supportedSpecificationVersion()

Get the spec version that is supported.

Returns:

a number representing the spec major version

getCanvas

java.lang.Object getCanvas()

Get the UI toolkit specific component holding this browser.

Returns:

The component

getRendererType

int getRendererType()

Get the renderer type.

Returns:

The BrowserCore type

getBrowserCore

BrowserCore getBrowserCore()

Get the core browser implementation.

Returns:

the BrowserCore

getErrorReporter

ErrorReporter getErrorReporter()

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

Returns:

The current error handler instance

setMinimumFrameInterval

void setMinimumFrameInterval(int millis,
                             boolean userSet)

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. The second parameter is used to control whether this is a user-set hard minimum or something set by the browser internals. User set values are always treated as the minimum unless the browser internals set a value that is a slower framerate than the user set. If the browser then sets a faster framerate than the user set value, the user value is used instead.

Parameters:

millis - The minimum time in milleseconds.

userSet - true if this is an end-user set minimum

start

void start()

Called to instruct the component instance to start rendering now.

stop

void stop()

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

destroy

void destroy()

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