com.partnersoft.preferences.model
Class VideoPreferences

java.lang.Object
  com.partnersoft.preferences.model.AbstractSubsystemPreferences
      com.partnersoft.preferences.model.VideoPreferences

All Implemented Interfaces:

Coggable, SubsystemPreferences

public class VideoPreferences
extends AbstractSubsystemPreferences

SubsystemPreferences for map control behavior.

Copyright 2010 Partner Software, Inc.

Version:

$Id$

Author:

Paul Reavis

Constructor Summary

VideoPreferences()

VideoPreferences(Cog state)

Method Summary

boolean	getFramerateShown() If true, a framerate display will appear in the bottom right of the map view.
boolean	getImageTilesShown() If true, lines are drawn at the boundaries of the underlying image tiles for background image sets such as aerial photos.
Java2dPreferences	getJava2dPreferences() Specific settings for Java2D rendering engine.
OpenglPreferences	getOpenglPreferences() Specific settings for OpenGL rendering engine.
RenderEngine	getRenderer() Map rendering engine to use.
boolean	getVectorTilesShown() If true, lines are drawn at the boundaries of the underlying vector tiles for published vector sets such as background maps.
boolean	isAnimated() If true, selection and indication animation is enabled.
boolean	isDirectDrawEnabled() If true, enables the Windows DirectDraw pipeline of Java2D throughout the platform.
boolean	isOpenglPipelineEnabled() If true, enables the OpenGL pipeline of Java2D throughout the platform.
void	setAnimated(boolean animated)
void	setDirectDrawEnabled(boolean directDrawEnabled)
void	setFramerateShown(boolean framerateShown)
void	setImageTilesShown(boolean imageTilesShown)
void	setJava2dPreferences(Java2dPreferences java2dPreferences)
void	setOpenglPipelineEnabled(boolean openglPipelineEnabled)
void	setOpenglPreferences(OpenglPreferences openglPreferences)
void	setRenderer(RenderEngine renderer)
void	setVectorTilesShown(boolean vectorTilesShown)
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class com.partnersoft.preferences.model.AbstractSubsystemPreferences

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoPreferences

public VideoPreferences()

VideoPreferences

public VideoPreferences(Cog state)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Overrides:

toCog in class AbstractSubsystemPreferences

Returns:

Cog representing the internal state of this object

getRenderer

public RenderEngine getRenderer()

Map rendering engine to use.

setRenderer

public void setRenderer(RenderEngine renderer)

isAnimated

public boolean isAnimated()

If true, selection and indication animation is enabled. Generally this is good from a user interface perspective, but it does use more CPU and therefore battery, and thus should probably be disabled on slow or battery-powered computers.

setAnimated

public void setAnimated(boolean animated)

isDirectDrawEnabled

public boolean isDirectDrawEnabled()

If true, enables the Windows DirectDraw pipeline of Java2D throughout the platform. This affects not just the map view but all Java user interface components. Generally this is a good thing but since it uses video hardware at a lower level has been known to cause blue screen crashes on rare machines. If you have weird video problems this may be a good thing to turn off.

If in doubt, leaving this off is safe.

setDirectDrawEnabled

public void setDirectDrawEnabled(boolean directDrawEnabled)

isOpenglPipelineEnabled

public boolean isOpenglPipelineEnabled()

If true, enables the OpenGL pipeline of Java2D throughout the platform. This affects not just the map view but all Java user interface components. It does not imply OpenGL rendering; you can use the Java2D rendering engine on top of the OpenGL pipeline - Java2D is then using OpenGL as its hardware rendering layer without affecting the way we use Java2D.

Like the useDirectDraw switch, this may cause instability on machines with poor video hardware or drivers. It may also interact strangely with Java2D, the Java2D rendering engine, or even the OpenGL rendering engine; the exact behaviors and effects on performance are highly machine dependent.

If in doubt, leaving this off is safe.

setOpenglPipelineEnabled

public void setOpenglPipelineEnabled(boolean openglPipelineEnabled)

getFramerateShown

public boolean getFramerateShown()

If true, a framerate display will appear in the bottom right of the map view. This displays the average framerate in frames/second over the last 1000 renders. The timings are based on the map rendering portion alone and may not match actual video hardware frames or other overheads. However, it's a decent way to determine the effects of changes to video settings or translator configuration, or roughly compare computer performance.

setFramerateShown

public void setFramerateShown(boolean framerateShown)

getImageTilesShown

public boolean getImageTilesShown()

If true, lines are drawn at the boundaries of the underlying image tiles for background image sets such as aerial photos. This is a debugging switch, useful when trying to troubleshoot or tune image sets.

setImageTilesShown

public void setImageTilesShown(boolean imageTilesShown)

getVectorTilesShown

public boolean getVectorTilesShown()

If true, lines are drawn at the boundaries of the underlying vector tiles for published vector sets such as background maps. This is a debugging switch, useful when trying to troubleshoot or tune legends, zooms, and levels-of-detail.

setVectorTilesShown

public void setVectorTilesShown(boolean vectorTilesShown)

getJava2dPreferences

public Java2dPreferences getJava2dPreferences()

Specific settings for Java2D rendering engine. These only apply if the renderer is JAVA2D.

setJava2dPreferences

public void setJava2dPreferences(Java2dPreferences java2dPreferences)

getOpenglPreferences

public OpenglPreferences getOpenglPreferences()

Specific settings for OpenGL rendering engine. These only apply if the renderer is OPENGL.

setOpenglPreferences

public void setOpenglPreferences(OpenglPreferences openglPreferences)