gal_options_panel.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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
 */


#include <wx/sizer.h>
#include <wx/checkbox.h>
#include <wx/choice.h>
#include <wx/radiobox.h>
#include <wx/spinctrl.h>
#include <wx/stattext.h>
#include <wx/statbox.h>

#include <ignore.h>
#include <widgets/gal_options_panel.h>
#include <eda_draw_frame.h>

#include <config_map.h>

/*
 * Spin control parameters
 */
static const double gridThicknessMin = 1.0;
static const double gridThicknessMax = 10.0;
static const double gridThicknessStep = 0.5;

static const double gridMinSpacingMin = 5;
static const double gridMinSpacingMax = 200;
static const double gridMinSpacingStep = 5;


static const UTIL::CFG_MAP<KIGFX::GRID_STYLE> gridStyleSelectMap =
{
 { KIGFX::GRID_STYLE::DOTS, 0 }, // Default
 { KIGFX::GRID_STYLE::LINES, 1 },
 { KIGFX::GRID_STYLE::SMALL_CROSS, 2 },
};


static const UTIL::CFG_MAP<KIGFX::GRID_SNAPPING> gridSnapConfigVals =
{
 { KIGFX::GRID_SNAPPING::ALWAYS, 0 },
 { KIGFX::GRID_SNAPPING::WITH_GRID, 1 },
 { KIGFX::GRID_SNAPPING::NEVER, 2 }
};


GAL_OPTIONS_PANEL::GAL_OPTIONS_PANEL( wxWindow* aParent, EDA_DRAW_FRAME* aDrawFrame ) :
 wxPanel( aParent, wxID_ANY ),
 m_drawFrame( aDrawFrame ),
 m_galOptions( aDrawFrame->GetGalDisplayOptions() )
{
 // the main sizer that holds "columns" of settings
 m_mainSizer = new wxBoxSizer( wxHORIZONTAL );
 SetSizer( m_mainSizer );

 // second-level sizers that are one "column" of settings each
 wxBoxSizer* sLeftSizer = new wxBoxSizer( wxVERTICAL );
 m_mainSizer->Add( sLeftSizer, 1, wxALL | wxEXPAND, 0 );

 /*
 * Rendering engine
 */
#ifndef __WXMAC__
 {
 wxString engineChoices[] = { _( "Accelerated graphics" ), _( "Fallback graphics" ) };
 m_renderingEngine = new wxRadioBox( this, wxID_ANY, _( "Rendering Engine" ),
 wxDefaultPosition, wxDefaultSize,
 sizeof( engineChoices ) / sizeof( wxString ),
 engineChoices, 1, wxRA_SPECIFY_COLS );
 m_renderingEngine->SetItemToolTip( 0, _( "Hardware-accelerated graphics (recommended)" ) );
 m_renderingEngine->SetItemToolTip( 1, _( "Software graphics (for computers which do not "
 "support KiCad's hardware acceleration "
 "requirements)" ) );

 sLeftSizer->Add( m_renderingEngine, 0, wxTOP | wxBOTTOM | wxRIGHT | wxEXPAND, 5 );
 }
#endif

 /*
 * Grid settings subpanel
 */
 {
 wxStaticBox* sGridOpts = new wxStaticBox( this, wxID_ANY, _( "Grid Options" ) );
 wxStaticBoxSizer* sGridSettings;
 sGridSettings = new wxStaticBoxSizer( sGridOpts, wxVERTICAL );

 wxString m_gridStyleChoices[] = {
 _( "Dots" ),
 _( "Lines" ),
 _( "Small crosses" )
 };

 int m_gridStyleNChoices = sizeof( m_gridStyleChoices ) / sizeof( wxString );
 m_gridStyle = new wxRadioBox( sGridSettings->GetStaticBox(), wxID_ANY, _( "Grid Style" ),
 wxDefaultPosition, wxDefaultSize, m_gridStyleNChoices,
 m_gridStyleChoices, 1, wxRA_SPECIFY_COLS );
 sGridSettings->Add( m_gridStyle, 0, wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND, 5 );

 wxFlexGridSizer* sGridSettingsGrid;
 sGridSettingsGrid = new wxFlexGridSizer( 0, 3, 0, 0 );
 sGridSettingsGrid->AddGrowableCol( 1 );
 sGridSettingsGrid->SetFlexibleDirection( wxBOTH );
 sGridSettingsGrid->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );

 l_gridLineWidth = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY,
 _( "Grid thickness:" ) );
 l_gridLineWidth->Wrap( -1 );
 sGridSettingsGrid->Add( l_gridLineWidth, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5 );

 m_gridLineWidth = new wxSpinCtrlDouble( sGridSettings->GetStaticBox(), wxID_ANY );
 m_gridLineWidth->SetRange( gridThicknessMin, gridThicknessMax );
 m_gridLineWidth->SetIncrement( gridThicknessStep );
 m_gridLineWidth->SetDigits( 1 );
 sGridSettingsGrid->Add( m_gridLineWidth, 0, wxEXPAND | wxTOP | wxBOTTOM, 5 );

 l_gridLineWidthUnits = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY,
 _( "px" ) );
 l_gridLineWidthUnits->Wrap( -1 );
 sGridSettingsGrid->Add( l_gridLineWidthUnits, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5 );

 l_gridMinSpacing = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY,
 _( "Min grid spacing:" ) );
 l_gridMinSpacing->Wrap( -1 );
 sGridSettingsGrid->Add( l_gridMinSpacing, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5 );

 m_gridMinSpacing = new wxSpinCtrlDouble( sGridSettings->GetStaticBox(), wxID_ANY);
 m_gridMinSpacing->SetRange( gridMinSpacingMin, gridMinSpacingMax );
 m_gridMinSpacing->SetIncrement( gridMinSpacingStep );
 m_gridMinSpacing->SetDigits( 0 );
 sGridSettingsGrid->Add( m_gridMinSpacing, 0, wxEXPAND | wxTOP | wxBOTTOM, 5 );

 l_gridMinSpacingUnits = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY,
 _( "px" ) );
 l_gridMinSpacingUnits->Wrap( -1 );
 sGridSettingsGrid->Add( l_gridMinSpacingUnits, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5 );

 l_gridSnapOptions = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY,
 _( "Snap to Grid:" ) );
 l_gridSnapOptions->Wrap( -1 );
 sGridSettingsGrid->Add( l_gridSnapOptions, 0, wxALIGN_CENTER_VERTICAL | wxALL, 5 );

 wxString gridSnapChoices[] = { _( "Always" ), _( "When grid shown" ), _( "Never" ) };
 int gridSnapNChoices = sizeof( gridSnapChoices ) / sizeof( wxString );
 m_gridSnapOptions = new wxChoice( sGridSettings->GetStaticBox(), wxID_ANY,
 wxDefaultPosition, wxDefaultSize, gridSnapNChoices,
 gridSnapChoices );
 m_gridSnapOptions->Select( 0 );
 sGridSettingsGrid->Add( m_gridSnapOptions, 0,
 wxALIGN_CENTER_VERTICAL | wxEXPAND | wxTOP | wxBOTTOM, 5 );

 l_gridSnapSpace = new wxStaticText( sGridSettings->GetStaticBox(), wxID_ANY, _( "px" ) );
 l_gridSnapSpace->Wrap( -1 );
 l_gridSnapSpace->Hide();
 sGridSettingsGrid->Add( l_gridSnapSpace, 0,
 wxALIGN_CENTER_VERTICAL | wxALL | wxRESERVE_SPACE_EVEN_IF_HIDDEN,
 5 );


 sGridSettings->Add( sGridSettingsGrid, 1, wxALL | wxEXPAND, 5 );

 sLeftSizer->Add( sGridSettings, 0, wxTOP | wxBOTTOM | wxRIGHT | wxEXPAND, 5 );
 }

 /*
 * Cursor settings subpanel
 */
 {
 wxStaticBox* sbCursorSettings = new wxStaticBox( this, wxID_ANY, _( "Cursor Options" ) );
 wxStaticBoxSizer* sCursorSettings = new wxStaticBoxSizer( sbCursorSettings, wxVERTICAL );

 sLeftSizer->Add( sCursorSettings, 1, wxTOP | wxRIGHT | wxEXPAND, 5 );

 wxString m_CursorShapeChoices[] = {
 _( "Small crosshair" ),
 _( "Full window crosshair" )
 };

 int m_CursorShapeNChoices = sizeof( m_CursorShapeChoices ) / sizeof( wxString );
 m_cursorShape = new wxRadioBox( this, wxID_ANY,
 _( "Cursor Shape" ), wxDefaultPosition, wxDefaultSize,
 m_CursorShapeNChoices, m_CursorShapeChoices, 1,
 wxRA_SPECIFY_COLS );

 m_cursorShape->SetSelection( 0 );
 m_cursorShape->SetToolTip( _( "Cursor shape for drawing, placement and movement tools" ) );
 sCursorSettings->Add( m_cursorShape, 0, wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND, 5 );

 m_forceCursorDisplay = new wxCheckBox( this, wxID_ANY, _( "Always show crosshairs" ) );
 sCursorSettings->Add( m_forceCursorDisplay, 0, wxALL | wxEXPAND, 5 );
 }
}


bool GAL_OPTIONS_PANEL::TransferDataToWindow()
{
#ifndef __WXMAC__
 if( m_drawFrame->GetCanvas()->GetBackend() == EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL )
 m_renderingEngine->SetSelection( 0 );
 else
 m_renderingEngine->SetSelection( 1 );
#else
 ignore_unused( m_drawFrame );
#endif

 m_gridSnapOptions->SetSelection( UTIL::GetConfigForVal( gridSnapConfigVals,
 m_galOptions.m_gridSnapping ) );

 m_gridStyle->SetSelection( UTIL::GetConfigForVal( gridStyleSelectMap,
 m_galOptions.m_gridStyle ) );

 m_gridLineWidth->SetValue( m_galOptions.m_gridLineWidth );

 m_gridMinSpacing->SetValue( m_galOptions.m_gridMinSpacing );

 m_cursorShape->SetSelection( m_galOptions.m_fullscreenCursor );

 m_forceCursorDisplay->SetValue( m_galOptions.m_forceDisplayCursor );

 return true;
}


bool GAL_OPTIONS_PANEL::TransferDataFromWindow()
{
 m_galOptions.m_gridSnapping = UTIL::GetValFromConfig( gridSnapConfigVals,
 m_gridSnapOptions->GetSelection() );

 m_galOptions.m_gridStyle = UTIL::GetValFromConfig( gridStyleSelectMap,
 m_gridStyle->GetSelection() );

 m_galOptions.m_gridLineWidth = m_gridLineWidth->GetValue();

 m_galOptions.m_gridMinSpacing = m_gridMinSpacing->GetValue();

 m_galOptions.m_fullscreenCursor = m_cursorShape->GetSelection();

 m_galOptions.m_forceDisplayCursor = m_forceCursorDisplay->GetValue();

#ifndef __WXMAC__
 EDA_DRAW_PANEL_GAL::GAL_TYPE wantedType = m_renderingEngine->GetSelection() == 0 ?
 EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL :
 EDA_DRAW_PANEL_GAL::GAL_TYPE_CAIRO;
 EDA_DRAW_PANEL_GAL::GAL_TYPE currentType = m_drawFrame->GetCanvas()->GetBackend();

 if( wantedType != currentType )
 m_drawFrame->GetCanvas()->SwitchBackend( wantedType );
#endif

 return true;
}