org.xith3d.utility.commandline
Class BasicApplicationArguments

java.lang.Object
  extended by org.xith3d.utility.commandline.BasicApplicationArguments

public class BasicApplicationArguments
extends java.lang.Object

An instance of this class can hold the basic application arguments for any Xith3D application.


Constructor Summary
BasicApplicationArguments()
           
BasicApplicationArguments(OpenGLLayer layer, DisplayMode displayMode, DisplayMode.FullscreenMode fullscreen, boolean vsync, FSAA fsaa, boolean mouseYInverted)
           
 
Method Summary
 CanvasConstructionInfo getCanvasConstructionInfo()
          Constructs and returns a CanvasConstructionInfo from the selected values.
 int getColorDepth()
          Returns the selected or the default color depth.
 float getConcreteMaxFPS()
          Returns the selected or default maximum frames per second (FPS).
 DisplayMode getDisplayMode()
          Returns the selected or the default DisplayMode.
 int getFrequency()
          Returns the selected or the default frequency.
 FSAA getFSAA()
          Returns the selected or the default FSAA.
 DisplayMode.FullscreenMode getFullscreenMode()
          Returns the selected or the default FullscreenMode.
 java.lang.Float getMaxFPS()
          Returns the selected or default maximum frames per second (FPS).
 boolean getMouseYInverted()
          Returns the selected or the default mouse-y-inverted flag.
 OpenGLLayer getOpenGLLayer()
          Returns the selected or the default OpenGLLayer.
 org.openmali.types.twodee.Sized2iRO getResolution()
          Returns the selected or the default resolution.
 int getResolutionHeight()
          Returns the selected or the default resolution height.
 int getResolutionWidth()
          Returns the selected or the default resolution width.
 boolean getVSync()
          Returns the selected or the default setting for vertical-sync.
 void setColorDepth(int bpp)
          Sets the selected color depth.
 void setFrequency(int freq)
          Sets the selected frequency.
 void setFSAA(FSAA fsaa)
          Sets the selected FSAA.
 void setFullscreenMode(DisplayMode.FullscreenMode fullscreenMode)
          Sets the selected FullscreenMode.
 void setMaxFPS(java.lang.Float maxFPS)
          Sets the selected maximum frames per second (FPS).
 void setMouseYInverted(boolean inverted)
          Sets the selected mouse-y-inverted flag.
 void setOpenGLLayer(OpenGLLayer oglLayer)
          Sets the selected OpenGLLayer.
 void setResolution(int resX, int resY)
          Sets the selected resolution.
 void setVSync(boolean vsync)
          Sets the selected setting for vertical-sync.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicApplicationArguments

public BasicApplicationArguments()

BasicApplicationArguments

public BasicApplicationArguments(OpenGLLayer layer,
                                 DisplayMode displayMode,
                                 DisplayMode.FullscreenMode fullscreen,
                                 boolean vsync,
                                 FSAA fsaa,
                                 boolean mouseYInverted)
Method Detail

setOpenGLLayer

public void setOpenGLLayer(OpenGLLayer oglLayer)
Sets the selected OpenGLLayer.

Parameters:
oglLayer -

getOpenGLLayer

public final OpenGLLayer getOpenGLLayer()
Returns the selected or the default OpenGLLayer.

Returns:
the OpenGLLayer.

setResolution

public void setResolution(int resX,
                          int resY)
Sets the selected resolution.

Parameters:
resX -
resY -

getResolution

public final org.openmali.types.twodee.Sized2iRO getResolution()
Returns the selected or the default resolution.

Returns:
the resolution.

getResolutionWidth

public final int getResolutionWidth()
Returns the selected or the default resolution width.

Returns:
the resolution width.

getResolutionHeight

public final int getResolutionHeight()
Returns the selected or the default resolution height.

Returns:
the resolution height.

setColorDepth

public void setColorDepth(int bpp)
Sets the selected color depth.

Parameters:
bpp -

getColorDepth

public final int getColorDepth()
Returns the selected or the default color depth.

Returns:
the color depth.

setFrequency

public void setFrequency(int freq)
Sets the selected frequency.

Parameters:
freq -

getFrequency

public final int getFrequency()
Returns the selected or the default frequency.

Returns:
the frequency.

getDisplayMode

public final DisplayMode getDisplayMode()
Returns the selected or the default DisplayMode.

Returns:
the DisplayMode.

setFullscreenMode

public void setFullscreenMode(DisplayMode.FullscreenMode fullscreenMode)
Sets the selected FullscreenMode.

Parameters:
fullscreenMode. -

getFullscreenMode

public final DisplayMode.FullscreenMode getFullscreenMode()
Returns the selected or the default FullscreenMode.

Returns:
the FullscreenMode.

setVSync

public void setVSync(boolean vsync)
Sets the selected setting for vertical-sync.

Parameters:
vsync. -

getVSync

public final boolean getVSync()
Returns the selected or the default setting for vertical-sync.

Returns:
the vertical-sync.

setFSAA

public void setFSAA(FSAA fsaa)
Sets the selected FSAA.

Parameters:
fsaa -

getFSAA

public final FSAA getFSAA()
Returns the selected or the default FSAA.

Returns:
the FSAA.

setMouseYInverted

public void setMouseYInverted(boolean inverted)
Sets the selected mouse-y-inverted flag.

Parameters:
inverted -

getMouseYInverted

public final boolean getMouseYInverted()
Returns the selected or the default mouse-y-inverted flag.

Returns:
the mouse-y-inverted flag.

setMaxFPS

public void setMaxFPS(java.lang.Float maxFPS)
Sets the selected maximum frames per second (FPS).

Parameters:
maxFPS - (null for no limit)

getMaxFPS

public final java.lang.Float getMaxFPS()
Returns the selected or default maximum frames per second (FPS).

Returns:
the maximum FPS or null if unlimited.

getConcreteMaxFPS

public final float getConcreteMaxFPS()
Returns the selected or default maximum frames per second (FPS).

Returns:
the maximum FPS or null if unlimited.

getCanvasConstructionInfo

public final CanvasConstructionInfo getCanvasConstructionInfo()
Constructs and returns a CanvasConstructionInfo from the selected values.

Returns:
a CanvasConstructionInfo.