Package org.web3d.vrml.scripting.external.neteai

Class NetworkBrowserClient

java.lang.Object

org.web3d.vrml.scripting.external.neteai.NetworkBrowserClient

All Implemented Interfaces:

NetworkStartupListener, Browser

public class NetworkBrowserClient
extends Object
implements Browser, NetworkStartupListener

NetworkBrowserClient communicates over the network to a NetworkBrowserServer.

Method Summary

Modifier and Type	Method	Description
void	addBrowserListener(BrowserListener l)	* @see vrml.eai.Browser#addBrowserListener(vrml.eai.event.BrowserListener)
void	addRoute(Node fromNode, String eventOut, Node toNode, String eventIn)	* @see vrml.eai.Browser#addRoute(vrml.eai.Node, java.lang.String, vrml.eai.Node, java.lang.String)
void	beginUpdate()	* @see vrml.eai.Browser#beginUpdate()
Node[]	createVrmlFromString(String vrmlString)	* @see vrml.eai.Browser#createVrmlFromString(java.lang.String)
void	createVrmlFromURL(String[] url, Node node, String eventIn)	* @see vrml.eai.Browser#createVrmlFromURL(java.lang.String[], vrml.eai.Node, java.lang.String)
void	deleteRoute(Node fromNode, String eventOut, Node toNode, String eventIn)	* @see vrml.eai.Browser#deleteRoute(vrml.eai.Node, java.lang.String, vrml.eai.Node, java.lang.String)
void	dispose()	* @see vrml.eai.Browser#dispose()
void	endUpdate()	* @see vrml.eai.Browser#endUpdate()
float	getCurrentFrameRate()	* @see vrml.eai.Browser#getCurrentFrameRate()
float	getCurrentSpeed()	* @see vrml.eai.Browser#getCurrentSpeed()
String	getName()	* @see vrml.eai.Browser#getName()
Node	getNode(String name)	* @see vrml.eai.Browser#getNode(java.lang.String)
String	getVersion()	* @see vrml.eai.Browser#getVersion()
String	getWorldURL()	* @see vrml.eai.Browser#getWorldURL()
void	loadURL(String[] url, String[] parameter)	* @see vrml.eai.Browser#loadURL(java.lang.String[], java.lang.String[])
void	notifyNetworkInitializationComplete()	* @see org.web3d.vrml.scripting.external.neteai.NetworkStartupListener#notifyNetworkInitializationComplete()
void	removeBrowserListener(BrowserListener l)	* @see vrml.eai.Browser#removeBrowserListener(vrml.eai.event.BrowserListener)
void	replaceWorld(Node[] nodes)	* @see vrml.eai.Browser#replaceWorld(vrml.eai.Node[])
void	setDescription(String desc)	* @see vrml.eai.Browser#setDescription(java.lang.String)

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()
               throws InvalidBrowserException

* @see vrml.eai.Browser#getName()

Specified by:

getName in interface Browser

Returns:

The name of the browser or null if not supported

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

getVersion

public String getVersion()
                  throws InvalidBrowserException

* @see vrml.eai.Browser#getVersion()

Specified by:

getVersion in interface Browser

Returns:

The version of the browser or null if not supported

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

getCurrentSpeed

public float getCurrentSpeed()
                      throws InvalidBrowserException

* @see vrml.eai.Browser#getCurrentSpeed()

Specified by:

getCurrentSpeed in interface Browser

Returns:

The velocity in m/s or 0.0 if not supported

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

getCurrentFrameRate

public float getCurrentFrameRate()
                          throws InvalidBrowserException

* @see vrml.eai.Browser#getCurrentFrameRate()

Specified by:

getCurrentFrameRate in interface Browser

Returns:

The current frame rate or 0.0 if not supported

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

getWorldURL

public String getWorldURL()
                   throws InvalidBrowserException,
URLUnavailableException

* @see vrml.eai.Browser#getWorldURL()

Specified by:

getWorldURL in interface Browser

Returns:

A string of the URL or null if not supported.

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

URLUnavailableException - The URL is not available because a world has not been loaded

See Also:

• Browser.loadURL(java.lang.String[], java.lang.String[])
• Browser.replaceWorld(vrml.eai.Node[])

replaceWorld

public void replaceWorld(Node[] nodes)
                  throws IllegalArgumentException,
InvalidBrowserException

* @see vrml.eai.Browser#replaceWorld(vrml.eai.Node[])

Specified by:

replaceWorld in interface Browser

Parameters:

nodes - The list of nodes to use as the new root of the world

Throws:

IllegalArgumentException - if the nodes are not valid VRML nodes

InvalidBrowserException - The dispose method has been called on this browser reference.

loadURL

public void loadURL(String[] url,
 String[] parameter)
             throws InvalidBrowserException,
InvalidURLException

* @see vrml.eai.Browser#loadURL(java.lang.String[], java.lang.String[])

Specified by:

loadURL in interface Browser

Parameters:

url - The list of URLs in decreasing order of preference as defined in the VRML97 specification.

parameter - The list of parameters to accompany the load call as defined in the Anchor node specification of VRML97

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

InvalidURLException - All of the URLs passed to this method are bogus and cannot be translated to usable values

setDescription

public void setDescription(String desc)
                    throws InvalidBrowserException

* @see vrml.eai.Browser#setDescription(java.lang.String)

Specified by:

setDescription in interface Browser

Parameters:

desc - The description string to set.

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

createVrmlFromString

public Node[] createVrmlFromString(String vrmlString)
                            throws InvalidBrowserException,
InvalidVrmlException

* @see vrml.eai.Browser#createVrmlFromString(java.lang.String)

Specified by:

createVrmlFromString in interface Browser

Parameters:

vrmlString - The string containing VRML string syntax

Returns:

A list of the top level nodes in VRML representation as defined in the parameter

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

InvalidVrmlException - If the string does not contain legal VRML syntax or no node instantiations

createVrmlFromURL

public void createVrmlFromURL(String[] url,
 Node node,
 String eventIn)
                       throws InvalidBrowserException,
InvalidNodeException,
InvalidURLException

* @see vrml.eai.Browser#createVrmlFromURL(java.lang.String[], vrml.eai.Node, java.lang.String)

Specified by:

createVrmlFromURL in interface Browser

Parameters:

url - The list of URLs in decreasing order of preference as defined in the VRML97 specification.

node - The destination node for the VRML code to be sent to.

eventIn - The name of the MFNode eventIn to send the nodes to.

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

InvalidNodeException - The nominated destination node has been disposed of

InvalidURLException - All of the URLs passed to this method are bogus and cannot be translated to usable values

getNode

public Node getNode(String name)
             throws InvalidNodeException,
InvalidBrowserException,
URLUnavailableException

* @see vrml.eai.Browser#getNode(java.lang.String)

Specified by:

getNode in interface Browser

Parameters:

name - The name of the DEF node to retrieve

Returns:

A reference to that node

Throws:

InvalidNodeException - The named node does not exist or is not accessible.

InvalidBrowserException - The dispose method has been called on this browser reference.

URLUnavailableException - The URL is not available because a world has not been loaded

addRoute

public void addRoute(Node fromNode,
 String eventOut,
 Node toNode,
 String eventIn)
              throws InvalidBrowserException,
InvalidEventOutException,
InvalidEventInException,
InvalidNodeException

* @see vrml.eai.Browser#addRoute(vrml.eai.Node, java.lang.String, vrml.eai.Node, java.lang.String)

Specified by:

addRoute in interface Browser

Parameters:

fromNode - The source node for the route

eventOut - The eventOut source of the route

toNode - The destination node of the route

eventIn - The eventIn destination of the route

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

InvalidEventOutException - if the named eventOut does not exist

InvalidEventInException - if the named eventIn does not exist.

InvalidNodeException - The nominated destination or source node has been disposed of

deleteRoute

public void deleteRoute(Node fromNode,
 String eventOut,
 Node toNode,
 String eventIn)
                 throws InvalidBrowserException,
InvalidEventOutException,
InvalidEventInException,
InvalidNodeException

* @see vrml.eai.Browser#deleteRoute(vrml.eai.Node, java.lang.String, vrml.eai.Node, java.lang.String)

Specified by:

deleteRoute in interface Browser

Parameters:

fromNode - The source node for the route

eventOut - The eventOut source of the route

toNode - The destination node of the route

eventIn - The eventIn destination of the route

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

InvalidEventOutException - if the named eventOut does not exist

InvalidEventInException - if the named eventIn does not exist.

InvalidNodeException - The nominated destination or source node has been disposed of

beginUpdate

public void beginUpdate()
                 throws InvalidBrowserException

* @see vrml.eai.Browser#beginUpdate()

Specified by:

beginUpdate in interface Browser

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

endUpdate

public void endUpdate()
               throws InvalidBrowserException

* @see vrml.eai.Browser#endUpdate()

Specified by:

endUpdate in interface Browser

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

addBrowserListener

public void addBrowserListener(BrowserListener l)
                        throws InvalidBrowserException

* @see vrml.eai.Browser#addBrowserListener(vrml.eai.event.BrowserListener)

Specified by:

addBrowserListener in interface Browser

Parameters:

l - The listener to add.

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

removeBrowserListener

public void removeBrowserListener(BrowserListener l)
                           throws InvalidBrowserException

* @see vrml.eai.Browser#removeBrowserListener(vrml.eai.event.BrowserListener)

Specified by:

removeBrowserListener in interface Browser

Parameters:

l - The listener to remove

Throws:

InvalidBrowserException - The dispose method has been called on this browser reference.

dispose

public void dispose()

* @see vrml.eai.Browser#dispose()

Specified by:

dispose in interface Browser

notifyNetworkInitializationComplete

public void notifyNetworkInitializationComplete()

* @see org.web3d.vrml.scripting.external.neteai.NetworkStartupListener#notifyNetworkInitializationComplete()

Specified by:

notifyNetworkInitializationComplete in interface NetworkStartupListener