Class Settings

java.lang.Object

gaiasky.util.SettingsObject

gaiasky.util.Settings

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, Cloneable

public class Settings
extends SettingsObject

Holds the settings of Gaia Sky. This class is an almost 1-to-1 mapping to the Gaia Sky configuration file, config.yaml.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Settings.CamrecorderSettings
static class	Settings.ControlsSettings
static class	Settings.DataSettings	Holds configuration options related to the data files.
static enum	Settings.DefaultTimeZone
static enum	Settings.DistanceUnits
static enum	Settings.ElevationType
static class	Settings.FrameSettings
static enum	Settings.GraphicsQuality
static class	Settings.GraphicsSettings	Graphics settings of Gaia Sky.
static enum	Settings.GridStyle
static enum	Settings.ImageFormat
static enum	Settings.LensFlareType
static enum	Settings.LineMode
static enum	Settings.OriginType
static class	Settings.PerformanceSettings	Settings that relate to the performance of the application.
static enum	Settings.PointCloudMode
static class	Settings.PostprocessSettings
static class	Settings.ProgramSettings
static class	Settings.ProxySettings
static enum	Settings.ReprojectionMode
static class	Settings.RuntimeSettings
static class	Settings.SceneSettings	Settings of the scene, organized into camera, particle groups, star, proper motion, octree, renderer, crosshair, and initialization settings.
static enum	Settings.ScreenshotMode
static class	Settings.ScreenshotSettings
static class	Settings.SpacecraftSettings
static enum	Settings.StereoProfile
static enum	Settings.ToneMapping
static enum	Settings.UpscaleFilter
static class	Settings.VersionSettings	This object holds all the data pertaining to the software version.

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPLICATION_NAME
static String	APPLICATION_NAME_TITLE
static final String	APPLICATION_SHORT_NAME
static final String	ASSETS_LOC	Assets location for this instance of Gaia Sky.
static final String	AUTHOR_AFFILIATION
static final String	AUTHOR_AFFILIATION_PLAIN
static final String	AUTHOR_EMAIL
static final String	AUTHOR_NAME
static final String	AUTHOR_NAME_PLAIN
static final String	AUTHOR_WEBSITE_FULL
static final String	AUTHOR_WEBSITE_TEXT
Settings.CamrecorderSettings	camrecorder
int	configVersion	Version of the currently loaded configuration file.
Settings.ControlsSettings	controls
Settings.DataSettings	data
static final String	DOCUMENTATION
Settings.FrameSettings	frame
Settings.GraphicsSettings	graphics
static final String	HOMEPAGE
static final String	HOMEPAGE_DOWNLOADS
static final String	ICON_URL
boolean	initialized	Initialization flag.
static final String	INTERNET_CHECK_URL	URL used to check for internet connection.
static final String	LICENSE_URL	License file.
Settings.PerformanceSettings	performance
Settings.PostprocessSettings	postprocess
Settings.ProgramSettings	program
Settings.ProxySettings	proxy
static final String	REPO_ISSUES
static final String	REPOSITORY
Settings.RuntimeSettings	runtime
Settings.SceneSettings	scene
Settings.ScreenshotSettings	screenshot
static Settings	settings
static final String	SOCIAL_MEDIA_NAME
static final String	SOCIAL_MEDIA_URL
static final int	SOURCE_VERSION	Source version, used to enable or disable datasets.
Settings.SpacecraftSettings	spacecraft
Settings.VersionSettings	version

Fields inherited from class SettingsObject

parent

Constructor Summary

Constructors

Constructor	Description
Settings()

Method Summary

Modifier and Type	Method	Description
void	apply()
static String	assetsFileStr(String relativeAssetsLoc)
static Path	assetsPath(String relativeAssetsLoc)
Settings	clone()
void	dispose()
static String	getApplicationName(boolean vr)
static String	getApplicationTitle(boolean vr)
static String	getShortApplicationName()
static String	getSuperShortApplicationName()
void	initialize()	Called to initialize the settings object.
boolean	isEnabled()
void	setConfigVersion(int configVersion)	Sets the configuration version.
void	setEnabled(boolean enabled)
protected void	setParentRecursive(SettingsObject s)
static boolean	setSettingsReference(Settings s)	Set the static reference to Settings to the given object.
void	setupListeners()

Methods inherited from class SettingsObject

setParent

Methods inherited from class Object

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

Field Details

SOURCE_VERSION

public static final int SOURCE_VERSION

Source version, used to enable or disable datasets. This is usually tag where each number is allocated 2 digits. Version = major.minor.rev-seq -> 1.2.5 major=1; minor=2; rev=5; seq=0 Version = major * 1000000 + minor * 10000 + rev * 100 + seq So 1.2.5 -> 1020500 2.1.7 -> 2010700 3.5.3-1 -> 3050301 Leading zeroes are omitted to avoid octal literal interpretation.

See Also:

• Constant Field Values

ASSETS_LOC

public static final String ASSETS_LOC

Assets location for this instance of Gaia Sky. macOS needs fully qualified paths when run as an app (GaiaSky.app), that's why we use the File.getAbsolutePath() call.

APPLICATION_SHORT_NAME

public static final String APPLICATION_SHORT_NAME

See Also:

• Constant Field Values

HOMEPAGE

public static final String HOMEPAGE

See Also:

• Constant Field Values

HOMEPAGE_DOWNLOADS

public static final String HOMEPAGE_DOWNLOADS

See Also:

• Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION

See Also:

• Constant Field Values

REPOSITORY

public static final String REPOSITORY

See Also:

• Constant Field Values

SOCIAL_MEDIA_NAME

public static final String SOCIAL_MEDIA_NAME

See Also:

• Constant Field Values

SOCIAL_MEDIA_URL

public static final String SOCIAL_MEDIA_URL

See Also:

• Constant Field Values

ICON_URL

public static final String ICON_URL

REPO_ISSUES

public static final String REPO_ISSUES

See Also:

• Constant Field Values

AUTHOR_NAME

public static final String AUTHOR_NAME

See Also:

• Constant Field Values

AUTHOR_NAME_PLAIN

public static final String AUTHOR_NAME_PLAIN

See Also:

• Constant Field Values

AUTHOR_EMAIL

public static final String AUTHOR_EMAIL

See Also:

• Constant Field Values

AUTHOR_AFFILIATION

public static final String AUTHOR_AFFILIATION

See Also:

• Constant Field Values

AUTHOR_AFFILIATION_PLAIN

public static final String AUTHOR_AFFILIATION_PLAIN

See Also:

• Constant Field Values

AUTHOR_WEBSITE_TEXT

public static final String AUTHOR_WEBSITE_TEXT

See Also:

• Constant Field Values

AUTHOR_WEBSITE_FULL

public static final String AUTHOR_WEBSITE_FULL

See Also:

• Constant Field Values

LICENSE_URL

public static final String LICENSE_URL

License file.

See Also:

• Constant Field Values

INTERNET_CHECK_URL

public static final String INTERNET_CHECK_URL

URL used to check for internet connection.

See Also:

• Constant Field Values

APPLICATION_NAME

public static String APPLICATION_NAME

APPLICATION_NAME_TITLE

public static String APPLICATION_NAME_TITLE

settings

public static Settings settings

configVersion

public int configVersion

Version of the currently loaded configuration file.

initialized

public boolean initialized

Initialization flag.

version

public Settings.VersionSettings version

data

public Settings.DataSettings data

performance

public Settings.PerformanceSettings performance

graphics

public Settings.GraphicsSettings graphics

scene

public Settings.SceneSettings scene

program

public Settings.ProgramSettings program

controls

public Settings.ControlsSettings controls

frame

public Settings.FrameSettings frame

screenshot

public Settings.ScreenshotSettings screenshot

camrecorder

public Settings.CamrecorderSettings camrecorder

postprocess

public Settings.PostprocessSettings postprocess

spacecraft

public Settings.SpacecraftSettings spacecraft

proxy

public Settings.ProxySettings proxy

runtime

public Settings.RuntimeSettings runtime

Constructor Details

Settings

public Settings()

Method Details

setSettingsReference

public static boolean setSettingsReference(Settings s)

Set the static reference to Settings to the given object. This method deactivates and disposes the old settings object, and activates the new one.

Parameters:

s - The settings object.

Returns:

True if the given object is not null, false otherwise.

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

Overrides:

isEnabled in class SettingsObject

initialize

public void initialize()

Called to initialize the settings object. This mainly initializes the internal references.

assetsPath

public static Path assetsPath(String relativeAssetsLoc)

assetsFileStr

public static String assetsFileStr(String relativeAssetsLoc)

getApplicationTitle

public static String getApplicationTitle(boolean vr)

getShortApplicationName

public static String getShortApplicationName()

getSuperShortApplicationName

public static String getSuperShortApplicationName()

getApplicationName

public static String getApplicationName(boolean vr)

clone

public Settings clone()

Overrides:

clone in class SettingsObject

setParentRecursive

protected void setParentRecursive(SettingsObject s)

Specified by:

setParentRecursive in class SettingsObject

setupListeners

public void setupListeners()

Specified by:

setupListeners in class SettingsObject

dispose

public void dispose()

apply

public void apply()

setConfigVersion

public void setConfigVersion(int configVersion)

Sets the configuration version. Adapts to the new min.maj.rev-seq format automagically.

Parameters:

configVersion - The configuration version.