kicad/pcbnew/dialogs/panel_display_options.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jean-pierre.charras at wanadoo.fr
 * Copyright (C) 1992-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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <pcb_edit_frame.h>
#include <pcb_display_options.h>
#include <pcbnew_settings.h>
#include <config_map.h>
#include <panel_display_options.h>
#include <pcb_view.h>
#include <pcb_painter.h>
#include <widgets/paged_dialog.h>
#include <widgets/gal_options_panel.h>
#include <wx/treebook.h>


static const UTIL::CFG_MAP<PCB_DISPLAY_OPTIONS::TRACE_CLEARANCE_DISPLAY_MODE_T> traceClearanceSelectMap =
{
    { PCB_DISPLAY_OPTIONS::SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING, 2 },     // Default
    { PCB_DISPLAY_OPTIONS::DO_NOT_SHOW_CLEARANCE,                       0 },
    { PCB_DISPLAY_OPTIONS::SHOW_TRACK_CLEARANCE_WHILE_ROUTING,          1 },
    { PCB_DISPLAY_OPTIONS::SHOW_WHILE_ROUTING_OR_DRAGGING,              3 },
    { PCB_DISPLAY_OPTIONS::SHOW_TRACK_CLEARANCE_WITH_VIA_ALWAYS,        4 },
};


PANEL_DISPLAY_OPTIONS::PANEL_DISPLAY_OPTIONS( PCB_BASE_FRAME* aFrame, PAGED_DIALOG* aParent ) :
    PANEL_DISPLAY_OPTIONS_BASE( aParent->GetTreebook() ),
    m_frame( aFrame )
{
    m_galOptsPanel = new GAL_OPTIONS_PANEL( this, m_frame );
    m_galOptionsSizer->Add( m_galOptsPanel, 1, wxEXPAND, 0 );

    m_optionsBook->SetSelection( dynamic_cast<PCB_EDIT_FRAME*>( m_frame ) ? 1 : 0 );
}


bool PANEL_DISPLAY_OPTIONS::TransferDataToWindow()
{
    PCB_EDIT_FRAME* pcbEdit = dynamic_cast<PCB_EDIT_FRAME*>( m_frame );

    if( pcbEdit )
    {
        const PCB_DISPLAY_OPTIONS& displ_opts = pcbEdit->GetDisplayOptions();

        m_OptDisplayTracksClearance->SetSelection( UTIL::GetConfigForVal(
                traceClearanceSelectMap, displ_opts.m_ShowTrackClearanceMode ) );

        m_OptDisplayPadClearence->SetValue( displ_opts.m_DisplayPadClearance );
        m_OptDisplayPadNumber->SetValue( displ_opts.m_DisplayPadNum );
        m_OptDisplayPadNoConn->SetValue( pcbEdit->IsElementVisible( LAYER_NO_CONNECTS ) );
        m_ShowNetNamesOption->SetSelection( displ_opts.m_DisplayNetNamesMode );

        m_live3Drefresh->SetValue( displ_opts.m_Live3DRefresh );

        CROSS_PROBING_SETTINGS& crossProbing = pcbEdit->GetPcbNewSettings()->m_CrossProbing;

        m_checkCrossProbeCenter->SetValue( crossProbing.center_on_items );
        m_checkCrossProbeZoom->SetValue( crossProbing.zoom_to_fit );
        m_checkCrossProbeAutoHighlight->SetValue( crossProbing.auto_highlight );
    }

    m_galOptsPanel->TransferDataToWindow();

    return true;
}


/*
 * Update variables with new options
 */
bool PANEL_DISPLAY_OPTIONS::TransferDataFromWindow()
{
    m_galOptsPanel->TransferDataFromWindow();

    // Apply changes to the GAL
    KIGFX::VIEW* view = m_frame->GetCanvas()->GetView();
    KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( view->GetPainter() );
    KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();

    PCB_EDIT_FRAME* pcbEdit = dynamic_cast<PCB_EDIT_FRAME*>( m_frame );

    if( pcbEdit )
    {
        PCB_DISPLAY_OPTIONS displ_opts = pcbEdit->GetDisplayOptions();

        displ_opts.m_ShowTrackClearanceMode = UTIL::GetValFromConfig(
                traceClearanceSelectMap, m_OptDisplayTracksClearance->GetSelection() );

        displ_opts.m_DisplayPadClearance = m_OptDisplayPadClearence->GetValue();
        displ_opts.m_DisplayPadNum = m_OptDisplayPadNumber->GetValue();

        pcbEdit->SetElementVisibility( LAYER_NO_CONNECTS, m_OptDisplayPadNoConn->GetValue() );

        displ_opts.m_DisplayNetNamesMode = m_ShowNetNamesOption->GetSelection();
        displ_opts.m_Live3DRefresh       = m_live3Drefresh->GetValue();

        pcbEdit->SetDisplayOptions( displ_opts );
        settings->LoadDisplayOptions( displ_opts, pcbEdit->ShowPageLimits() );
        pcbEdit->SetElementVisibility( LAYER_RATSNEST, displ_opts.m_ShowGlobalRatsnest );

        CROSS_PROBING_SETTINGS& crossProbing = pcbEdit->GetPcbNewSettings()->m_CrossProbing;

        crossProbing.center_on_items = m_checkCrossProbeCenter->GetValue();
        crossProbing.zoom_to_fit     = m_checkCrossProbeZoom->GetValue();
        crossProbing.auto_highlight  = m_checkCrossProbeAutoHighlight->GetValue();

        // Mark items with clearance display for repaint
        view->UpdateAllItemsConditionally( KIGFX::REPAINT,
                []( KIGFX::VIEW_ITEM* aItem ) -> bool
                {
                    if( EDA_ITEM* item = dynamic_cast<EDA_ITEM*>( aItem ) )
                    {
                        return( item->Type() == PCB_TRACE_T ||
                                item->Type() == PCB_ARC_T ||
                                item->Type() == PCB_VIA_T ||
                                item->Type() == PCB_PAD_T );
                    }

                    return false;
                } );
    }

    view->MarkTargetDirty( KIGFX::TARGET_NONCACHED );

    return true;
}