Package org.xj3d.sai

Class BrowserConfig

java.lang.Object

org.xj3d.sai.BrowserConfig

public class BrowserConfig
extends Object

Utility class to load, qualify and store SAI and EAI browser configuration parameters, including the properties defining the browser 'skin'. Used by the various BrowserFactoryImpl's as a common parameter loader.

Version:

$Revision: 1.2 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
boolean	antialiased	Antialiasing enabled.
String	antialiasingQuality	Antialiasing quality.
Properties	browserSkin	Properties object defining appearance of browser panel.
String	contentDirectory	Initial directory to use for locating content.
String	cullingMode	Culling Mode.
boolean	dashTop	Placement of the navigation bar if visible.
boolean	disableAudio	Should audio be disabled.
boolean	forceLighting	Should we force objects with no appearance to have a material for lighting
BrowserInterfaceTypes	interfaceType	The type of GUI interface that should be created
int	preferredHeight	The preferred height of the window.
int	preferredWidth	The preferred width of the window.
String	primitiveQuality	Primitive geometry quality.
Map<String,Object>	resourceMap	Map object containing default resources referred to by the skinProperties.
boolean	showConsole	Should the console be visible.
boolean	showDash	Should the navigation bar be visible.
boolean	showFPS	Should StatusBar have a frames-per-second display.
boolean	showOpenButton	Should the open button, on the location bar, be visible.
boolean	showReloadButton	Should the reload button, on the location bar, be visible.
boolean	showStatusBar	Should StatusBar be shown.
boolean	showUrl	Should the location bar be visible.
String	textureQuality	Texture quality.
boolean	urlReadOnly	Should the location bar be read only.
boolean	urlTop	Placement of the location bar if visible.
boolean	vrml97Only	Should the browser be restricted to VRML97 only.

Constructor Summary

Constructors

Constructor	Description
BrowserConfig()	Create a BrowserConfig instance initialized with defaults.
BrowserConfig(String[] params)	Create a BrowserConfig instance initialized with defaults which will be overridden by any parameters passed in the argument array.
BrowserConfig(Map<String,Object> params)	Create a BrowserConfig instance initialized with defaults which will be overridden by any parameters passed in the argument Map.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

vrml97Only

public boolean vrml97Only

Should the browser be restricted to VRML97 only. Default false.

interfaceType

public BrowserInterfaceTypes interfaceType

The type of GUI interface that should be created

showDash

public boolean showDash

Should the navigation bar be visible. Default true.

dashTop

public boolean dashTop

Placement of the navigation bar if visible. Default false.

showUrl

public boolean showUrl

Should the location bar be visible. Default true.

urlTop

public boolean urlTop

Placement of the location bar if visible. Default true.

urlReadOnly

public boolean urlReadOnly

Should the location bar be read only. Default false.

showConsole

public boolean showConsole

Should the console be visible. Default false.

showOpenButton

public boolean showOpenButton

Should the open button, on the location bar, be visible. Default false.

showReloadButton

public boolean showReloadButton

Should the reload button, on the location bar, be visible. Default false.

showStatusBar

public boolean showStatusBar

Should StatusBar be shown. Default false.

showFPS

public boolean showFPS

Should StatusBar have a frames-per-second display. Default false.

contentDirectory

public String contentDirectory

Initial directory to use for locating content. Defaults to System.getProperty("user.dir")

antialiased

public boolean antialiased

Antialiasing enabled. Default false.

antialiasingQuality

public String antialiasingQuality

Antialiasing quality. "low"|"medium"|"high". Default "low".

primitiveQuality

public String primitiveQuality

Primitive geometry quality. "low"|"medium"|"high". Default "medium".

textureQuality

public String textureQuality

Texture quality. "low"|"medium"|"high". Default "medium".

browserSkin

public Properties browserSkin

Properties object defining appearance of browser panel. Defaults to an empty Properties object.

resourceMap

public Map<String,Object> resourceMap

Map object containing default resources referred to by the skinProperties. Default null.

cullingMode

public String cullingMode

Culling Mode. "none"|"frustum". Default "frustum".

forceLighting

public boolean forceLighting

Should we force objects with no appearance to have a material for lighting

preferredWidth

public int preferredWidth

The preferred width of the window.

preferredHeight

public int preferredHeight

The preferred height of the window.

disableAudio

public boolean disableAudio

Should audio be disabled. Default false.

Constructor Details

BrowserConfig

public BrowserConfig()

Create a BrowserConfig instance initialized with defaults.

BrowserConfig

public BrowserConfig(String[] params)

Create a BrowserConfig instance initialized with defaults which will be overridden by any parameters passed in the argument array.

Parameters:

params - Parameters to control the look and feel.

Throws:

IllegalArgumentException - if a parameter in the argument Map is invalid.

BrowserConfig

public BrowserConfig(Map<String,Object> params)

Create a BrowserConfig instance initialized with defaults which will be overridden by any parameters passed in the argument Map.

Parameters:

params - Parameters to control the look and feel.

Throws:

IllegalArgumentException - if a parameter in the argument Map is invalid.