haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/common/gal/gal_display_options.cpp

105 lines
3.5 KiB
C++
Raw Normal View History

final touch-ups (license information, includes)
2016-12-23 16:06:33 +00:00
/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
* Copyright (C) 2016-2017 Kicad Developers, see change_log.txt for contributors.
final touch-ups (license information, includes)
2016-12-23 16:06:33 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
#include <gal/gal_display_options.h>
#include <wx/config.h>
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
#include <config_map.h>
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
using namespace KIGFX;
Give all GAL canvases access to a GAL_DISPLAY_OPTIONS structure instance Also loads the gal options when loading a canvas, as the canvas otherwise might not register the initial settings.
2017-02-13 11:43:28 +00:00
/*
* Config option strings
*/
static const wxString GalGLAntialiasingKeyword( "OpenGLAntialiasingMode" );
Move Grid style to Graphics Options dialog This puts the graphical/display options with the other similar options in that dialog, rather than with the dimension options found in the Set Grid dialog, which is in the Dimensions menu. Also place the option itself in the GAL Display Options structure, so it can be updated using the observer mechanism there. The setter for the style in the GAL interface is removed, as the public interface for setting this option is now to modify the GAL_DISPLAY_OPTIONS structure and notify the GAL when done.
2017-02-13 11:53:58 +00:00
static const wxString GalGridStyleConfig( "GridStyle" );
Add grid line thickness control to Display Options Dialog This adds a user-settable control for the grid line thickness on GAL canvases to the display options dialog. The thickness settings now comes in, along with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface. Fixes: lp:1662482 * https://bugs.launchpad.net/kicad/+bug/1662482
2017-02-14 15:31:21 +00:00
static const wxString GalGridLineWidthConfig( "GridLineWidth" );
Add user control for grid minimum spacing in GAL This allows the user to set a thicker grid line without causing the grid lines to become over dense, or just make the grid denser according to preference. The term "density" is modified to "minimum grid spacing", which is the pixel spacing between adjacent grid lines. The spacing settings now comes in along, with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface.
2017-02-13 03:47:50 +00:00
static const wxString GalGridMaxDensityConfig( "GridMaxDensity" );
Give all GAL canvases access to a GAL_DISPLAY_OPTIONS structure instance Also loads the gal options when loading a canvas, as the canvas otherwise might not register the initial settings.
2017-02-13 11:43:28 +00:00
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
static const UTIL::CFG_MAP<KIGFX::OPENGL_ANTIALIASING_MODE> aaModeConfigVals =
{
{ KIGFX::OPENGL_ANTIALIASING_MODE::NONE, 0 },
{ KIGFX::OPENGL_ANTIALIASING_MODE::SUBSAMPLE_HIGH, 1 },
{ KIGFX::OPENGL_ANTIALIASING_MODE::SUBSAMPLE_ULTRA, 2 },
{ KIGFX::OPENGL_ANTIALIASING_MODE::SUPERSAMPLING_X2, 3 },
{ KIGFX::OPENGL_ANTIALIASING_MODE::SUPERSAMPLING_X4, 4 },
};
static const UTIL::CFG_MAP<KIGFX::GRID_STYLE> gridStyleConfigVals =
{
{ KIGFX::GRID_STYLE::DOTS, 0 },
{ KIGFX::GRID_STYLE::LINES, 1 },
};
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
GAL_DISPLAY_OPTIONS::GAL_DISPLAY_OPTIONS()
Move Grid style to Graphics Options dialog This puts the graphical/display options with the other similar options in that dialog, rather than with the dimension options found in the Set Grid dialog, which is in the Dimensions menu. Also place the option itself in the GAL Display Options structure, so it can be updated using the observer mechanism there. The setter for the style in the GAL interface is removed, as the public interface for setting this option is now to modify the GAL_DISPLAY_OPTIONS structure and notify the GAL when done.
2017-02-13 11:53:58 +00:00
: gl_antialiasing_mode( OPENGL_ANTIALIASING_MODE::NONE ),
Make KIGFX::GRID_STYLE an enum class This provides stronger typing to these values.
2017-02-16 02:50:34 +00:00
m_gridStyle( GRID_STYLE::DOTS )
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
{}
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
void GAL_DISPLAY_OPTIONS::ReadConfig( wxConfigBase* aCfg, wxString aBaseName )
{
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
long readLong; // Temp value buffer
aCfg->Read( aBaseName + GalGLAntialiasingKeyword, &readLong,
Give all GAL canvases access to a GAL_DISPLAY_OPTIONS structure instance Also loads the gal options when loading a canvas, as the canvas otherwise might not register the initial settings.
2017-02-13 11:43:28 +00:00
static_cast<long>( KIGFX::OPENGL_ANTIALIASING_MODE::NONE ) );
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
gl_antialiasing_mode = UTIL::GetValFromConfig( aaModeConfigVals, readLong );
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
aCfg->Read( aBaseName + GalGridStyleConfig, &readLong,
Make KIGFX::GRID_STYLE an enum class This provides stronger typing to these values.
2017-02-16 02:50:34 +00:00
static_cast<long>( KIGFX::GRID_STYLE::DOTS ) );
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
m_gridStyle = UTIL::GetValFromConfig( gridStyleConfigVals, readLong );
Move Grid style to Graphics Options dialog This puts the graphical/display options with the other similar options in that dialog, rather than with the dimension options found in the Set Grid dialog, which is in the Dimensions menu. Also place the option itself in the GAL Display Options structure, so it can be updated using the observer mechanism there. The setter for the style in the GAL interface is removed, as the public interface for setting this option is now to modify the GAL_DISPLAY_OPTIONS structure and notify the GAL when done.
2017-02-13 11:53:58 +00:00
Add grid line thickness control to Display Options Dialog This adds a user-settable control for the grid line thickness on GAL canvases to the display options dialog. The thickness settings now comes in, along with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface. Fixes: lp:1662482 * https://bugs.launchpad.net/kicad/+bug/1662482
2017-02-14 15:31:21 +00:00
aCfg->Read( aBaseName + GalGridLineWidthConfig,
&m_gridLineWidth, 0.5 );
Add user control for grid minimum spacing in GAL This allows the user to set a thicker grid line without causing the grid lines to become over dense, or just make the grid denser according to preference. The term "density" is modified to "minimum grid spacing", which is the pixel spacing between adjacent grid lines. The spacing settings now comes in along, with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface.
2017-02-13 03:47:50 +00:00
aCfg->Read( aBaseName + GalGridMaxDensityConfig,
&m_gridMinSpacing, 10 );
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
NotifyChanged();
}
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
void GAL_DISPLAY_OPTIONS::WriteConfig( wxConfigBase* aCfg, wxString aBaseName )
{
aCfg->Write( aBaseName + GalGLAntialiasingKeyword,
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
UTIL::GetConfigForVal( aaModeConfigVals, gl_antialiasing_mode ) );
Move Grid style to Graphics Options dialog This puts the graphical/display options with the other similar options in that dialog, rather than with the dimension options found in the Set Grid dialog, which is in the Dimensions menu. Also place the option itself in the GAL Display Options structure, so it can be updated using the observer mechanism there. The setter for the style in the GAL interface is removed, as the public interface for setting this option is now to modify the GAL_DISPLAY_OPTIONS structure and notify the GAL when done.
2017-02-13 11:53:58 +00:00
aCfg->Write( aBaseName + GalGridStyleConfig,
Sanitise incoming GAL config options using mapping tables When reading config options from files, it's important to make sure the value makes sense - the incoming data could be anything, and may have incompatible values or be otherwise unreliable. This introduces a simple way to define and use "mapping tables" which can map between a "native" value, probably an enum (but not necessarily) and some external value, for example the value written to file. This provides a decoupling between the two values, as well as sanitising inputs and outputs. This is important, as over time, if there isn't a decoupled interface, changing options result in corrupt configs, or a proliferation of obsolete enum values kept for compatibility.
2017-02-16 02:40:35 +00:00
UTIL::GetConfigForVal( gridStyleConfigVals, m_gridStyle ) );
Add grid line thickness control to Display Options Dialog This adds a user-settable control for the grid line thickness on GAL canvases to the display options dialog. The thickness settings now comes in, along with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface. Fixes: lp:1662482 * https://bugs.launchpad.net/kicad/+bug/1662482
2017-02-14 15:31:21 +00:00
aCfg->Write( aBaseName + GalGridLineWidthConfig,
m_gridLineWidth );
Add user control for grid minimum spacing in GAL This allows the user to set a thicker grid line without causing the grid lines to become over dense, or just make the grid denser according to preference. The term "density" is modified to "minimum grid spacing", which is the pixel spacing between adjacent grid lines. The spacing settings now comes in along, with other GAL display settings, as part of GAL_DISPLAY_OPTIONS observer functionality. To this end, the setter in GAL interface is removed, as an external user should be setting this parameter via the GAL_DISPLAY_OPTIONS interface.
2017-02-13 03:47:50 +00:00
aCfg->Write( aBaseName + GalGridMaxDensityConfig,
m_gridMinSpacing );
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
}
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
OpenGL antialising code clean up & formatting
2017-01-11 15:19:58 +00:00
void GAL_DISPLAY_OPTIONS::NotifyChanged()
{
Notify( &GAL_DISPLAY_OPTIONS_OBSERVER::OnGalDisplayOptionsChanged, *this );
Add UI control to set up gal opengl antialiasing and load/store the settings
2016-12-23 15:21:00 +00:00
}