EditorSettings Class Reference

Settings for the editor. More...

#include <EditorSettings.hpp>

Inheritance diagram for EditorSettings:

Public Member Functions
void	Save () final
	Save the settings to an INI file. More...
Public Member Functions inherited from Settings
bool	GetBool (const std::string &settingName)
	Get a bool setting. More...
void	SetBool (const std::string &settingName, bool value)
	Set a bool setting. More...
long	GetLong (const std::string &settingName)
	Get a long setting. More...
void	SetLong (const std::string &settingName, long value)
	Set a long setting. More...
double	GetDouble (const std::string &settingName)
	Get a double setting. More...
void	SetDouble (const std::string &settingName, double value)
	Set a double setting. More...
std::string	GetString (const std::string &settingName)
	Get a string setting. More...
void	SetString (const std::string &settingName, const std::string &value)
	Set a string setting. More...

Static Public Member Functions
static EditorSettings &	GetInstance ()
	Get the instance of the class. More...

Additional Inherited Members
Protected Member Functions inherited from Settings
void	AddBoolSetting (const std::string &settingName, const std::string &section, const std::string &key, bool defaultValue)
	Add a bool setting. More...
void	AddLongSetting (const std::string &settingName, const std::string &section, const std::string &key, long defaultValue)
	Add a long setting. More...
void	AddDoubleSetting (const std::string &settingName, const std::string &section, const std::string &key, double defaultValue)
	Add a double setting. More...
void	AddStringSetting (const std::string &settingName, const std::string &section, const std::string &key, const std::string &defaultValue)
	Add a string setting. More...
Protected Attributes inherited from Settings
CSimpleIni	ini
	Ini file. More...

Detailed Description

Settings for the editor.

Available settings:

Name	Description	Type	Default Value
Logging	Output a log file.	bool	false
Width	Width of the editor window.	long	800
Height	Height of the editor window.	long	600
Theme	Visual theme to use.	string	Default
API	Which graphics API to use.	string	OpenGL
Sound Source Icons	Show sound source icons.	bool	true
Light Source Icons	Show light source icons.	bool	true
Camera Icons	Show camera icons.	bool	true
Physics Volumes	Show physics volumes.	bool	true
Lighting	Light the scene.	bool	true
Light Volumes	Show light culling volumes.	bool	false

Text Editor | Path to text editor for scripts. | string | Grid Settings | Whether to show grid settings. | bool | false Grid Size | Size of the grid. | long | 100 Grid Line Width | Width of the lines in the grid. | long | 3 Grid Snap | Snap to grid when moving. | bool | false Grid Snap Size | Size to snap to. | long | 100

Member Function Documentation

GetInstance()

EditorSettings & EditorSettings::GetInstance ( )

static

Get the instance of the class.

Returns

The EditorSettings instance

Save()

void EditorSettings::Save ( )

finalvirtual

Save the settings to an INI file.

Implements Settings.

---

The documentation for this class was generated from the following files:

• src/Editor/Util/EditorSettings.hpp
• src/Editor/Util/EditorSettings.cpp