Rings
Version 0.3

threeD.run
Class Settings

java.lang.Object
  extended bythreeD.run.Settings

public abstract class Settings
extends java.lang.Object

The Settings class provides access to settings that change the way the RayTracer and its components run. This class also includes static fields providing information about this release of the RayTracer.


Field Summary
static java.lang.String aboutText
           
static JTextAreaPrintWriter cameraOut
          A JTextAreaPrintWriter object that should be used for debug output from the camera.
static java.text.DecimalFormat decimalFormat
          An instance of DecimalFormat that can be used to format decimal numbers.
static JTextAreaPrintWriter eventOut
          A JTextAreaPrintWriter object that should be used for debug output from the event system.
static java.text.DecimalFormat integerFormat
          An instance of DecimalFormat that can be used to format integer numbers.
static java.lang.String license
          String containing information on how to access the full software license.
static java.lang.String licenseInfo
          String containing license information for this software.
static java.lang.String localSplashImage
          String containing the local location of the splash screen image.
static boolean produceCameraOutput
          Setting to true enables camera debug output.
static boolean produceEventHandlerOutput
          Setting to true enables event system debug output.
static boolean produceOutput
          Setting to true enables debug output.
static boolean produceRayTracingEngineOutput
          Setting to true enables ray tracing engine debug output.
static boolean produceShaderOutput
          Setting to true enables shader debug output.
static boolean produceSurfaceOutput
          Setting to true enables surface debug output.
static JTextAreaPrintWriter rayEngineOut
          A JTextAreaPrintWriter object that should be used for debug output from the ray tracing engine.
static java.lang.String remoteSplashImage
          String containing the remote location of the splash screen image.
static java.lang.String resourcePath
          String containing the local directory where resources can be found.
static javax.swing.Icon sceneIcon
          Icon to use for top level of surface tree.
static java.lang.String sceneIconFile
          Path to file to load scene icon from.
static int screenHeight
          Integer values for the screen width and height.
static int screenWidth
          Integer values for the screen width and height.
static JTextAreaPrintWriter shaderOut
           
static JTextAreaPrintWriter surfaceOut
          A JTextAreaPrintWriter object that should be used for debug output from surfaces.
static java.awt.Color themePrimary1
          AWT Color representing the primary 1 color for the default theme.
static java.awt.Color themePrimary2
          AWT Color representing the primary 2 color for the default theme.
static java.awt.Color themePrimary3
          AWT Color representing the primary 3 color for the default theme.
static java.awt.Color themeSecondary1
          AWT Color representing the secondary 1 color for the default theme.
static java.awt.Color themeSecondary2
          AWT Color representing the secondary 2 color for the default theme.
static java.awt.Color themeSecondary3
          AWT Color representing the secondary 3 color for the default theme.
static boolean useRemoteResources
          Setting to true enables remote resource use.
static java.lang.String version
          String containing the version number of this software.
static java.lang.String websiteUrl
          String containing "http://j3d.sf.net/".
static java.lang.String writtenByInfo
          String containing "Written by Mike Murray".
 
Constructor Summary
Settings()
           
 
Method Summary
static java.util.Properties getProperties()
          Returns a Properties object that stores the current values of the static variables of the Settings class.
static void setProperties(java.util.Properties p)
          Sets the values of the static variables of the Settings class to those described by the specified Properties object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

version

public static final java.lang.String version
String containing the version number of this software.

See Also:
Constant Field Values

writtenByInfo

public static final java.lang.String writtenByInfo
String containing "Written by Mike Murray".

See Also:
Constant Field Values

websiteUrl

public static final java.lang.String websiteUrl
String containing "http://j3d.sf.net/".

See Also:
Constant Field Values

licenseInfo

public static final java.lang.String licenseInfo
String containing license information for this software.

See Also:
Constant Field Values

license

public static final java.lang.String license
String containing information on how to access the full software license.

See Also:
Constant Field Values

aboutText

public static final java.lang.String aboutText
See Also:
Constant Field Values

screenWidth

public static int screenWidth
Integer values for the screen width and height.


screenHeight

public static int screenHeight
Integer values for the screen width and height.


useRemoteResources

public static boolean useRemoteResources
Setting to true enables remote resource use.


resourcePath

public static java.lang.String resourcePath
String containing the local directory where resources can be found.


localSplashImage

public static java.lang.String localSplashImage
String containing the local location of the splash screen image.


remoteSplashImage

public static java.lang.String remoteSplashImage
String containing the remote location of the splash screen image.


produceOutput

public static boolean produceOutput
Setting to true enables debug output.


produceRayTracingEngineOutput

public static boolean produceRayTracingEngineOutput
Setting to true enables ray tracing engine debug output.


rayEngineOut

public static JTextAreaPrintWriter rayEngineOut
A JTextAreaPrintWriter object that should be used for debug output from the ray tracing engine.


produceShaderOutput

public static boolean produceShaderOutput
Setting to true enables shader debug output.


shaderOut

public static JTextAreaPrintWriter shaderOut

produceSurfaceOutput

public static boolean produceSurfaceOutput
Setting to true enables surface debug output.


surfaceOut

public static JTextAreaPrintWriter surfaceOut
A JTextAreaPrintWriter object that should be used for debug output from surfaces.


produceCameraOutput

public static boolean produceCameraOutput
Setting to true enables camera debug output.


cameraOut

public static JTextAreaPrintWriter cameraOut
A JTextAreaPrintWriter object that should be used for debug output from the camera.


produceEventHandlerOutput

public static boolean produceEventHandlerOutput
Setting to true enables event system debug output.


eventOut

public static JTextAreaPrintWriter eventOut
A JTextAreaPrintWriter object that should be used for debug output from the event system.


sceneIconFile

public static final java.lang.String sceneIconFile
Path to file to load scene icon from.


sceneIcon

public static javax.swing.Icon sceneIcon
Icon to use for top level of surface tree.


integerFormat

public static final java.text.DecimalFormat integerFormat
An instance of DecimalFormat that can be used to format integer numbers.


decimalFormat

public static final java.text.DecimalFormat decimalFormat
An instance of DecimalFormat that can be used to format decimal numbers.


themePrimary1

public static java.awt.Color themePrimary1
AWT Color representing the primary 1 color for the default theme.


themePrimary2

public static java.awt.Color themePrimary2
AWT Color representing the primary 2 color for the default theme.


themePrimary3

public static java.awt.Color themePrimary3
AWT Color representing the primary 3 color for the default theme.


themeSecondary1

public static java.awt.Color themeSecondary1
AWT Color representing the secondary 1 color for the default theme.


themeSecondary2

public static java.awt.Color themeSecondary2
AWT Color representing the secondary 2 color for the default theme.


themeSecondary3

public static java.awt.Color themeSecondary3
AWT Color representing the secondary 3 color for the default theme.

Constructor Detail

Settings

public Settings()
Method Detail

setProperties

public static void setProperties(java.util.Properties p)
Sets the values of the static variables of the Settings class to those described by the specified Properties object.


getProperties

public static java.util.Properties getProperties()
Returns a Properties object that stores the current values of the static variables of the Settings class.


Rings
Version 0.3

Copyright 2003-05 Mike Murray