Xj3D 2.0 VRML/X3D Code API

org.xj3d.ui.construct
Class Construct

java.lang.Object
  extended by org.xj3d.ui.construct.Construct
All Implemented Interfaces:
ConstructBuilder
Direct Known Subclasses:
OGLConstruct

public abstract class Construct
extends java.lang.Object
implements ConstructBuilder

The Construct is an abstract class that provides a flexible container and builder for instantiating and configuring the objects that provide the infrastructure of an X3D browser.
The Construct provides access to the management and rendering objects, but does not define a user interface. It is left to application specific sub-classes to provide a user interface.

Version:
$Revision: 1.3 $
Author:
Rex Melton

Field Summary
protected  int anisotropicDegree
          Value indicating the anisotropic degree setting to be configured.
protected  int antialiasSamples
          Value indicating the antialias samples setting to be configured.
protected  java.lang.String CONTENT_HANDLER_FACTORY
          Toolkit specific content handler factory class
protected  java.lang.String CONTENT_LOADER
          The external file loader class
protected  BrowserCore core
          The browser core
protected  DeviceFactory deviceFactory
          The device factory for pointing and keysensor devices associated with the rendering surface
protected  java.lang.String DIS_PROTOCOL_HANDLER
          The DIS protocol handler class
protected  boolean doubleBuffered
          Flag indicating that double buffering should be used.
protected  ErrorReporter errorReporter
          The error reporting mechanism
protected  java.lang.String EVENT_MODEL
          The event model manager class
protected  EventModelEvaluator eventModel
          THE event model manager
protected  java.lang.String HANIM_MANAGER
          The hanim manager class
protected  NodeManager hanimManager
          The manager for H-Anim handling
protected  boolean hardwareAccelerated
          Flag indicating that hardware acceleration should be used.
protected  java.lang.String LAYER_MANAGER_FACTORY
          The layer manager factory class
protected  boolean lightweightRenderer
          Flag indicating that the renderer component should be lightweight.
protected  ClassLoadUtilities loader
          Utilites for loading classes
protected  ContentLoadManager loadManager
          The manager for loading external content
protected  java.lang.String NETWORK_MANAGER
          The network manager class
protected  NetworkManager networkManager
          The manager for network handling
protected  java.lang.String PARTICLE_MANAGER
          The particle manager class
protected  NodeManager particleManager
          The manager for particle handling
protected  java.lang.String PHYSICS_MANAGER
          The physics manager class
protected  NodeManager physicsManager
          The manager for physics handling
protected  java.lang.String PICKING_MANAGER
          The picking manager class
protected  PickingManager pickingManager
          The manager for picking sensors
protected  int renderer
          Constant identifying the renderer
protected  java.lang.String renderer_id
          String identifying the renderer
protected  RouteManager routeManager
          The manager for route propogation
protected  java.lang.String ROUTER_FACTORY
          The router factory class
protected  java.lang.String ROUTER_MANAGER
          The route manager class
protected  SceneBuilderFactory sceneBuilderFactory
          The scene builder factory
protected  java.lang.String SCRIPT_LOADER
          The script loader class
protected  java.lang.String SCRIPT_MANAGER
          The script manager class
protected  ScriptLoader scriptLoader
          The script loader
protected  ScriptManager scriptManager
          The script manager
protected  java.lang.String SENSOR_MANAGER
          The sensor manager class
protected  SensorManager sensorManager
          The manager for input and sensor handling
protected  java.lang.String STATE_MANAGER
          The frame state manager class
protected  FrameStateManager stateManager
          The frame state manager
protected  boolean supportVRML
          Flag indicating that the browser instance should support VRML97.
protected  boolean supportX3D
          Flag indicating that the browser instance should support X3D.
protected  java.lang.String TIME_SENSOR_MANAGER
          The time sensor manager class
protected  TimeSensorManager timeSensorManager
          The manager for time sensor handling
protected  boolean useMipMaps
          Flag indicating that MipMaps should be generated.
protected  ViewpointManager viewpointManager
          The viewpoint manager
protected  java.lang.String VRML_JAVA_SCRIPT_ENGINE
          The VRML97 Java scripting engine class
protected  java.lang.String VRML_JAVASCRIPT_SCRIPT_ENGINE
          The VRML97 Javascript scripting engine class
protected  WorldLoaderManager worldLoader
          The manager of the world loaders
protected  java.lang.String X3D_ECMASCRIPT_SCRIPT_ENGINE
          The X3D Javascript scripting engine class
protected  java.lang.String X3D_JAVA_SCRIPT_ENGINE
          The X3D Java scripting engine class
 
Constructor Summary
protected Construct()
          Restricted Constructor
protected Construct(ErrorReporter reporter)
          Restricted Constructor
 
Method Summary
 void buildAll()
          Create a 'default' configuration instance.
protected abstract  void buildAudioRenderingDevice()
          Create the audio rendering device
protected abstract  void buildBrowserCore()
          Create the browser core
protected abstract  void buildGraphicsRenderingDevice()
          Create the graphics rendering device
 void buildManagers()
          Create the x3d managers
 void buildNetworkCapabilities()
          Set up the networking properties and objects needed to run the browser.
 void buildRenderingCapabilities()
          Create the rendering capabilities
 void buildRenderingDevices()
          Create the rendering devices
protected abstract  void buildSceneBuilderFactory()
          Create the scene builder factory
 void buildScriptEngines()
          Create the x3d scripting engines
 BrowserCore getBrowserCore()
          Return the browser core.
 ContentLoadManager getContentLoadManager()
          Return the content load manager.
 ErrorReporter getErrorReporter()
          Return the error reporter.
 EventModelEvaluator getEventModelEvaluator()
          Return the event model evaluator.
 FrameStateManager getFrameStateManager()
          Return the frame state manager.
abstract  java.lang.Object getGraphicsObject()
          Return the rendering surface
 RouteManager getRouteManager()
          Return the route manager.
 ScriptLoader getScriptLoader()
          Return the script loader.
 ScriptManager getScriptManager()
          Return the script manager.
 SensorManager getSensorManager()
          Return the sensor manager.
 TimeSensorManager getTimeSensorManager()
          Return the time sensor manager.
 ViewpointManager getViewpointManager()
          Return the viewpoint manager.
 WorldLoaderManager getWorldLoaderManager()
          Return the world loader manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.xj3d.ui.construct.ConstructBuilder
buildInterfaceDevices, buildRenderer
 

Field Detail

DIS_PROTOCOL_HANDLER

protected java.lang.String DIS_PROTOCOL_HANDLER
The DIS protocol handler class


NETWORK_MANAGER

protected java.lang.String NETWORK_MANAGER
The network manager class


HANIM_MANAGER

protected java.lang.String HANIM_MANAGER
The hanim manager class


PHYSICS_MANAGER

protected java.lang.String PHYSICS_MANAGER
The physics manager class


PARTICLE_MANAGER

protected java.lang.String PARTICLE_MANAGER
The particle manager class


SCRIPT_LOADER

protected java.lang.String SCRIPT_LOADER
The script loader class


SCRIPT_MANAGER

protected java.lang.String SCRIPT_MANAGER
The script manager class


CONTENT_LOADER

protected java.lang.String CONTENT_LOADER
The external file loader class


ROUTER_FACTORY

protected java.lang.String ROUTER_FACTORY
The router factory class


ROUTER_MANAGER

protected java.lang.String ROUTER_MANAGER
The route manager class


STATE_MANAGER

protected java.lang.String STATE_MANAGER
The frame state manager class


PICKING_MANAGER

protected java.lang.String PICKING_MANAGER
The picking manager class


SENSOR_MANAGER

protected java.lang.String SENSOR_MANAGER
The sensor manager class


EVENT_MODEL

protected java.lang.String EVENT_MODEL
The event model manager class


TIME_SENSOR_MANAGER

protected java.lang.String TIME_SENSOR_MANAGER
The time sensor manager class


VRML_JAVA_SCRIPT_ENGINE

protected java.lang.String VRML_JAVA_SCRIPT_ENGINE
The VRML97 Java scripting engine class


VRML_JAVASCRIPT_SCRIPT_ENGINE

protected java.lang.String VRML_JAVASCRIPT_SCRIPT_ENGINE
The VRML97 Javascript scripting engine class


X3D_JAVA_SCRIPT_ENGINE

protected java.lang.String X3D_JAVA_SCRIPT_ENGINE
The X3D Java scripting engine class


X3D_ECMASCRIPT_SCRIPT_ENGINE

protected java.lang.String X3D_ECMASCRIPT_SCRIPT_ENGINE
The X3D Javascript scripting engine class


LAYER_MANAGER_FACTORY

protected java.lang.String LAYER_MANAGER_FACTORY
The layer manager factory class


CONTENT_HANDLER_FACTORY

protected java.lang.String CONTENT_HANDLER_FACTORY
Toolkit specific content handler factory class


renderer

protected int renderer
Constant identifying the renderer


renderer_id

protected java.lang.String renderer_id
String identifying the renderer


supportVRML

protected boolean supportVRML
Flag indicating that the browser instance should support VRML97. Default value is true.


supportX3D

protected boolean supportX3D
Flag indicating that the browser instance should support X3D. Default value is true.


lightweightRenderer

protected boolean lightweightRenderer
Flag indicating that the renderer component should be lightweight. Default value is false.


useMipMaps

protected boolean useMipMaps
Flag indicating that MipMaps should be generated. Default value is true.


doubleBuffered

protected boolean doubleBuffered
Flag indicating that double buffering should be used. Default value is true.


hardwareAccelerated

protected boolean hardwareAccelerated
Flag indicating that hardware acceleration should be used. Default value is true.


anisotropicDegree

protected int anisotropicDegree
Value indicating the anisotropic degree setting to be configured. Default value is 0, which disables anisotropic filtering.


antialiasSamples

protected int antialiasSamples
Value indicating the antialias samples setting to be configured. Default value is 0, which disables antialiasing.


deviceFactory

protected DeviceFactory deviceFactory
The device factory for pointing and keysensor devices associated with the rendering surface


core

protected BrowserCore core
The browser core


scriptManager

protected ScriptManager scriptManager
The script manager


scriptLoader

protected ScriptLoader scriptLoader
The script loader


stateManager

protected FrameStateManager stateManager
The frame state manager


loadManager

protected ContentLoadManager loadManager
The manager for loading external content


networkManager

protected NetworkManager networkManager
The manager for network handling


hanimManager

protected NodeManager hanimManager
The manager for H-Anim handling


physicsManager

protected NodeManager physicsManager
The manager for physics handling


particleManager

protected NodeManager particleManager
The manager for particle handling


routeManager

protected RouteManager routeManager
The manager for route propogation


sensorManager

protected SensorManager sensorManager
The manager for input and sensor handling


timeSensorManager

protected TimeSensorManager timeSensorManager
The manager for time sensor handling


pickingManager

protected PickingManager pickingManager
The manager for picking sensors


eventModel

protected EventModelEvaluator eventModel
THE event model manager


worldLoader

protected WorldLoaderManager worldLoader
The manager of the world loaders


viewpointManager

protected ViewpointManager viewpointManager
The viewpoint manager


sceneBuilderFactory

protected SceneBuilderFactory sceneBuilderFactory
The scene builder factory


errorReporter

protected ErrorReporter errorReporter
The error reporting mechanism


loader

protected ClassLoadUtilities loader
Utilites for loading classes

Constructor Detail

Construct

protected Construct()
Restricted Constructor


Construct

protected Construct(ErrorReporter reporter)
Restricted Constructor

Parameters:
reporter - The error reporter
Method Detail

getGraphicsObject

public abstract java.lang.Object getGraphicsObject()
Return the rendering surface

Returns:
The rendering surface

buildAll

public void buildAll()
Create a 'default' configuration instance.

Specified by:
buildAll in interface ConstructBuilder

buildRenderingCapabilities

public void buildRenderingCapabilities()
Create the rendering capabilities

Specified by:
buildRenderingCapabilities in interface ConstructBuilder

buildRenderingDevices

public void buildRenderingDevices()
Create the rendering devices

Specified by:
buildRenderingDevices in interface ConstructBuilder

buildGraphicsRenderingDevice

protected abstract void buildGraphicsRenderingDevice()
Create the graphics rendering device


buildAudioRenderingDevice

protected abstract void buildAudioRenderingDevice()
Create the audio rendering device


buildManagers

public void buildManagers()
Create the x3d managers

Specified by:
buildManagers in interface ConstructBuilder
Throws:
InvalidConfigurationException - If a required class class cannot be loaded.

buildBrowserCore

protected abstract void buildBrowserCore()
Create the browser core


buildSceneBuilderFactory

protected abstract void buildSceneBuilderFactory()
Create the scene builder factory


buildScriptEngines

public void buildScriptEngines()
Create the x3d scripting engines

Specified by:
buildScriptEngines in interface ConstructBuilder
Throws:
InvalidConfigurationException - If a required class class cannot be loaded.

buildNetworkCapabilities

public void buildNetworkCapabilities()
Set up the networking properties and objects needed to run the browser.

Specified by:
buildNetworkCapabilities in interface ConstructBuilder
Throws:
InvalidConfigurationException - If a required class class cannot be loaded.

getErrorReporter

public ErrorReporter getErrorReporter()
Return the error reporter.

Returns:
The error reporter.

getScriptManager

public ScriptManager getScriptManager()
Return the script manager.

Returns:
The script manager.

getScriptLoader

public ScriptLoader getScriptLoader()
Return the script loader.

Returns:
The script loader.

getViewpointManager

public ViewpointManager getViewpointManager()
Return the viewpoint manager.

Returns:
The viewpoint manager.

getContentLoadManager

public ContentLoadManager getContentLoadManager()
Return the content load manager.

Returns:
The content load manager.

getRouteManager

public RouteManager getRouteManager()
Return the route manager.

Returns:
The route manager.

getSensorManager

public SensorManager getSensorManager()
Return the sensor manager.

Returns:
The sensor manager.

getTimeSensorManager

public TimeSensorManager getTimeSensorManager()
Return the time sensor manager.

Returns:
The time sensor manager.

getWorldLoaderManager

public WorldLoaderManager getWorldLoaderManager()
Return the world loader manager.

Returns:
The world loader manager.

getFrameStateManager

public FrameStateManager getFrameStateManager()
Return the frame state manager.

Returns:
The frame state manager.

getEventModelEvaluator

public EventModelEvaluator getEventModelEvaluator()
Return the event model evaluator.

Returns:
The event model evaluator.

getBrowserCore

public BrowserCore getBrowserCore()
Return the browser core.

Returns:
the browser core.

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium