Package org.xj3d.ui.awt.browser.ogl

Classes that are used to create or be a full browser panel embedded within an application using the OpenGL renderer.

See:
Description

Class Summary

AWTOGLConstruct	An abstract sub-class of OGLConstruct that provides AWT UI capabilities to the base Construct.
BrowserJPanel	Common Swing JPanel implementation of the browser component for use in either SAI or EAI, that wraps the functionality of a VRML browser into a convenient, easy to use form.
OffscreenOGLConstruct	An abstract sub-class of AWTOGLConstruct that provides offscreen rendering capabilities to the base Construct.
ThumbnailRecorder	A function module that performs an image capture of an X3D scene for the purpose of creating a thumbnail image.
TimeSensorSceneRecorder	A function module that performs a sequenced image capture of an embedded X3D world animation.
VRMLBrowserAWTPanel	A brower that uses the AWT panel and labels to draw render the UI with.
VRMLBrowserJPanel	Swing JPanel implementation that wraps the functionality of a VRML browser into a convenient, easy to use form for the EAI.
VRMLOGLBrowserFactoryImpl	An implementation of the EAI BrowserFactoryImpl interface that creates a browser that uses OpenGL for the renderer.
X3DBrowserAWTPanel	A brower that uses the AWT panel and labels to draw render the UI with.
X3DBrowserJPanel	Swing JPanel implementation that wraps the functionality of a X3D browser into a convenient, easy to use form for the SAI.
X3DNRBrowserFactoryImpl	Factory implementation for X3D SAI which will produce components using the Null renderer.
X3DOffscreenSurface	Swing JPanel implementation that wraps the functionality of a X3D browser into a convenient, easy to use form for the SAI.
X3DOGLBrowserFactoryImpl	Factory implementation for X3D SAI which will produce components using the OpenGL renderer.

Package org.xj3d.ui.awt.browser.ogl Description

Classes that are used to create or be a full browser panel embedded within an application using the OpenGL renderer.

The majority of these classes are used to support the EAI/SAI functionality so that a user can create and manipulate a full VRML/X3D browser as part of an application. The intention is that the programmer will never need to deal with all the other classes provided by Xj3D and just stick with the standards compliant EAI or SAI interface.

Creating a component using either of these interfaces starts with registering the appropriate factory implementation with the EAI/SAI. An end user should never have to do this, however as both standards define a way for each browser to nominate itself as the implementation of choice, through the use of Java properties files. To make sure you are using the right implementation, look for either vrml97.properties or x3d.properties in your CLASSPATH. Check that the entry is pointing to the appropriate class from this package. After that, all you need to do to use the SAI or EAI is to call the appropriate create method from the factory API. If you find yourself needing to call the setBrowserFactoryImpl() method then you are doing something wrong as this now restricts the code to a particular SAI/EAI implementation. This is wrong, and creates non-portable code.

These particular files are specific to the Aviatrix3D OpenGL based renderer.

Xj3D-Specific properties

When creating a new browser component, the following parameters are supported:

Xj3D_InterfaceType	awt|swing|swing-lightweight. Indication as to whether the UI should be AWT or SWING based. The SWING option may also use a purely lightweight renderer that does not suffer from the usual heavyweight rendering problems with menus etc. However, If you are not using the OpenGL 2D pipeline in Java 6, then you're likely to have significant performance loss.If not supplied the default is to use the heavyweight swing renderer.
Xj3D_NavbarShown	true|false. Show or hide the navigation bar on the screen. If not provided, the navigation bar will be shown.
Xj3D_NavbarPosition	top|bottom. If the navigation bar is shown, it should be placed at the desired location in the panel. If not provided, the navigation bar will be on the bottom.
Xj3D_LocationShown	true|false. Show or hide the panel that describes the current URL and allows the user to enter new URLs. If not provided, the location bar will be shown.
Xj3D_LocationPosition	top|bottom. If the URL bar is shown, it should be placed at the desired location in the panel. If not provided, the position will be at the top of the panel.
Xj3D_LocationReadOnly	true|false. If the URL bar is shown, you can make it read-only (ie not allow the user to change the URL). If not provided, the bar will be writable.
Xj3D_ShowConsole	true|false. Indication as to whether the component should automatically show the console on startup. Default is to hide.