org.web3d.browser
Class X3DBrowserFactoryImpl

java.lang.Object
  org.web3d.browser.X3DBrowserFactoryImpl

All Implemented Interfaces:

BrowserFactoryImpl

public class X3DBrowserFactoryImpl

extends java.lang.Object

implements BrowserFactoryImpl

An implementation of the SAI BrowserFactoryImpl interface that creates a browser that delegates to the OpenGL and Java3D specific browser factories.

This browser factory delegates to the other known browser factories based on a hard coded search sequence and an optional user supplied renderer hint.

Version:

$Revision: 1.3 $

Author:

Brad Vender

Constructor Summary

X3DBrowserFactoryImpl()

Method Summary

X3DComponent	createComponent(java.util.Map params) Create a VRML browser that can be used as an AWT component.
ExternalBrowser	getBrowser(java.applet.Applet applet) Get a browser from the given java applet reference as a base in the current HTML page.
ExternalBrowser	getBrowser(java.applet.Applet applet, java.lang.String frameName, int index) Get a browser from the given java applet reference one some named page and at some embbed location.
ExternalBrowser	getBrowser(java.net.InetAddress address, int port) Get a reference to a browser that is located on a remote machine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

X3DBrowserFactoryImpl

public X3DBrowserFactoryImpl()

Method Detail

createComponent

public X3DComponent createComponent(java.util.Map params)
                             throws NotSupportedException

Create a VRML browser that can be used as an AWT component. The component returned is guaranteed to be an instance of X3DComponent.

Specified by:

createComponent in interface BrowserFactoryImpl

Parameters:

params - Parameters to control the look and feel.

Returns:

The component browser initialised to be empty.

Throws:

NotSupportedException - The implementation does not support this type of VRML browser.

See Also:

X3DComponent

getBrowser

public ExternalBrowser getBrowser(java.applet.Applet applet)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  ConnectionException

Get a browser from the given java applet reference as a base in the current HTML page. Used when attempting to access a browser on the current page as this applet and is the first browser on the page. Generically, the same as calling getBrowser(applet, "", 0);

Specified by:

getBrowser in interface BrowserFactoryImpl

Parameters:

applet - The applet reference to use

Returns:

A reference to the Browser implementation

Throws:

NotSupportedException - The implementation does not support this type of VRML browser

NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.

ConnectionException - An error occurred during the connecting process

getBrowser

public ExternalBrowser getBrowser(java.applet.Applet applet,
                                  java.lang.String frameName,
                                  int index)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  ConnectionException

Get a browser from the given java applet reference one some named page and at some embbed location. Used when attempting to access a browser on another HTML page within a multi-framed environment, or if there are a number of VRML browser instances located on the same page.

If the frame name is a zero length string or null then it is assumed to be located on the same HTML page as the applet. The index is the number of the embbed VRML browser starting from the top of the page. If there are other non-VRML plugins embedded in the page these are not taken into account in calculating the embed index.

Specified by:

getBrowser in interface BrowserFactoryImpl

Parameters:

applet - The applet reference to use

frameName - The name of the frame to look into for the browser

index - The embed index of the VRML browser in the page

Returns:

A reference to the Browser implementation

Throws:

NotSupportedException - The implementation does not support this type of VRML browser.

NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.

ConnectionException - An error occurred during the connecting process

getBrowser

public ExternalBrowser getBrowser(java.net.InetAddress address,
                                  int port)
                           throws NotSupportedException,
                                  NoSuchBrowserException,
                                  java.net.UnknownHostException,
                                  ConnectionException

Get a reference to a browser that is located on a remote machine. This a server application to send scene updates to a number of client browsers located on remote machines. If there are a number of browsers running on a remote machine, they can be differentiated by the port number they are listening on.

There is no default port number for VRML browsers.

Specified by:

getBrowser in interface BrowserFactoryImpl

Parameters:

address - The address of the machine to connect to

port - The port number on that machine to connect to.

Returns:

A reference to the Browser implementation

Throws:

NotSupportedException - The implementation does not support this type of VRML browser.

NoSuchBrowserException - Could not locate a VRML browser on the same page as the applet.

java.net.UnknownHostException - Could not find the machine named in the address.

ConnectionException - An error occurred during the connecting process