toolbars_footprint_editor.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2012 Wayne Stambaugh <[email protected]>
 * Copyright The 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 <https://www.gnu.org/licenses/>.
 */
 
#include <tool/actions.h>
#include <tool/action_menu.h>
#include <footprint_edit_frame.h>
#include <pcbnew_id.h>
#include <bitmaps.h>
#include <lset.h>
#include <tool/action_toolbar.h>
#include <tool/tool_manager.h>
#include <tool/ui/toolbar_context_menu_registry.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_selection_tool.h>
#include <pcb_layer_box_selector.h>
#include <wx/choice.h>
#include <wx/wupdlock.h>
#include <advanced_config.h>
#include <api/api_plugin_manager.h>
#include <api/api_utils.h>
#include <pgm_base.h>
#include <settings/common_settings.h>
#include <wx/log.h>
 
#include <toolbars_footprint_editor.h>
 
std::optional<TOOLBAR_CONFIGURATION> FOOTPRINT_EDIT_TOOLBAR_SETTINGS::DefaultToolbarConfig( TOOLBAR_LOC aToolbar )
{
    TOOLBAR_CONFIGURATION config;
 
    // clang-format off
    switch( aToolbar )
    {
    // No Aux toolbar
    case TOOLBAR_LOC::TOP_AUX:
        return std::nullopt;
 
    case TOOLBAR_LOC::LEFT:
        config.AppendAction( ACTIONS::toggleGrid )
              .WithContextMenu(
                      []( TOOL_MANAGER* aToolMgr )
                      {
                          PCB_SELECTION_TOOL* selTool = aToolMgr->GetTool<PCB_SELECTION_TOOL>();
                          auto                menu = std::make_unique<ACTION_MENU>( false, selTool );
                          menu->Add( ACTIONS::gridProperties );
                          menu->Add( ACTIONS::gridOrigin );
                          return menu;
                      } )
              .AppendAction( ACTIONS::toggleGridOverrides )
              .AppendAction( PCB_ACTIONS::togglePolarCoords )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Units" ) )
                            .AddAction( ACTIONS::millimetersUnits )
                            .AddAction( ACTIONS::inchesUnits )
                            .AddAction( ACTIONS::milsUnits ) )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Crosshair modes" ) )
                            .AddAction( ACTIONS::cursorSmallCrosshairs )
                            .AddAction( ACTIONS::cursorFullCrosshairs )
                            .AddAction( ACTIONS::cursor45Crosshairs ) );
 
        config.AppendSeparator()
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Line modes" ) )
                            .AddAction( PCB_ACTIONS::lineModeFree )
                            .AddAction( PCB_ACTIONS::lineMode90 )
                            .AddAction( PCB_ACTIONS::lineMode45 ) )
              .AppendAction( PCB_ACTIONS::toggleAutoConstraints );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::padDisplayMode )
              .AppendAction( PCB_ACTIONS::graphicsOutlines )
              .AppendAction( PCB_ACTIONS::textOutlines )
              .AppendAction( ACTIONS::highContrastMode );
 
        if( ADVANCED_CFG::GetCfg().m_DrawBoundingBoxes )
            config.AppendAction( ACTIONS::toggleBoundingBoxes );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::showLibraryTree )
              .AppendAction( PCB_ACTIONS::showLayersManager )
              .AppendAction( ACTIONS::showProperties );
        break;
 
    case TOOLBAR_LOC::RIGHT:
        config.AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Selection modes" ) )
              .AddAction( ACTIONS::selectSetRect )
              .AddAction( ACTIONS::selectSetLasso ) );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::placePad )
              .AppendAction( PCB_ACTIONS::drawRuleArea );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::drawLine )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Arc" ) )
                            .AddAction( PCB_ACTIONS::drawArcCenter )
                            .AddAction( PCB_ACTIONS::drawArcStartEndMid )
                            .AddAction( PCB_ACTIONS::drawArcStartEndCenter )
                            .AddAction( PCB_ACTIONS::drawArcTangent )
                            .AddAction( PCB_ACTIONS::drawArcStartDirEnd )
                            .AddAction( PCB_ACTIONS::drawEllipseArc )
                            .AddContextMenu(
                                    []( TOOL_MANAGER* aToolMgr )
                                    {
                                        PCB_SELECTION_TOOL* selTool = aToolMgr->GetTool<PCB_SELECTION_TOOL>();
                                        auto menu = std::make_unique<ACTION_MENU>( false, selTool );
                                        menu->Add( ACTIONS::pointEditorArcKeepCenter, ACTION_MENU::CHECK );
                                        menu->Add( ACTIONS::pointEditorArcKeepEndpoint, ACTION_MENU::CHECK );
                                        menu->Add( ACTIONS::pointEditorArcKeepRadius, ACTION_MENU::CHECK );
                                        return menu;
                                    } ) )
              .AppendAction( PCB_ACTIONS::drawRectangle )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Circle" ) )
                            .AddAction( PCB_ACTIONS::drawCircle )
                            .AddAction( PCB_ACTIONS::drawEllipse ) )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Constraints" ) )
                            .AddAction( PCB_ACTIONS::addConstraintCoincident )
                            .AddAction( PCB_ACTIONS::addConstraintPointOnLine )
                            .AddAction( PCB_ACTIONS::addConstraintMidpoint )
                            .AddAction( PCB_ACTIONS::addConstraintSymmetric )
                            .AddAction( PCB_ACTIONS::addConstraintFixedPosition )
                            .AddAction( PCB_ACTIONS::addConstraintParallel )
                            .AddAction( PCB_ACTIONS::addConstraintPerpendicular )
                            .AddAction( PCB_ACTIONS::addConstraintCollinear )
                            .AddAction( PCB_ACTIONS::addConstraintHorizontal )
                            .AddAction( PCB_ACTIONS::addConstraintVertical )
                            .AddAction( PCB_ACTIONS::addConstraintTangent )
                            .AddAction( PCB_ACTIONS::addConstraintEqualLength )
                            .AddAction( PCB_ACTIONS::addConstraintEqualRadius )
                            .AddAction( PCB_ACTIONS::addConstraintConcentric )
                            .AddAction( PCB_ACTIONS::addConstraintFixedLength )
                            .AddAction( PCB_ACTIONS::addConstraintFixedRadius )
                            .AddAction( PCB_ACTIONS::addConstraintArcAngle )
                            .AddAction( PCB_ACTIONS::addConstraintAngular ) )
              .AppendAction( PCB_ACTIONS::drawPolygon )
              .AppendAction( PCB_ACTIONS::drawBezier )
              .AppendAction( PCB_ACTIONS::placeReferenceImage )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Text objects" ) )
                            .AddAction( PCB_ACTIONS::placeText )
                            .AddAction( PCB_ACTIONS::drawTextBox ) )
              .AppendAction( PCB_ACTIONS::drawTable )
              .AppendGroup( TOOLBAR_GROUP_CONFIG( _( "Dimension objects" ) )
                            .AddAction( PCB_ACTIONS::drawOrthogonalDimension )
                            .AddAction( PCB_ACTIONS::drawAlignedDimension )
                            .AddAction( PCB_ACTIONS::drawCenterDimension )
                            .AddAction( PCB_ACTIONS::drawRadialDimension )
                            .AddAction( PCB_ACTIONS::drawLeader ) )
              .AppendAction( PCB_ACTIONS::placeBarcode )
              .AppendAction( ACTIONS::deleteTool );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::placePoint )
              .AppendAction( PCB_ACTIONS::setAnchor )
              .AppendAction( ACTIONS::gridSetOrigin )
              .AppendAction( ACTIONS::measureTool );
        break;
 
    case TOOLBAR_LOC::TOP_MAIN:
        config.AppendAction( PCB_ACTIONS::newFootprint )
              .AppendAction( PCB_ACTIONS::createFootprint )
              .AppendAction( ACTIONS::save );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::print );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::undo )
              .AppendAction( ACTIONS::redo );
 
        config.AppendSeparator()
              .AppendAction( ACTIONS::zoomRedraw )
              .AppendAction( ACTIONS::zoomInCenter )
              .AppendAction( ACTIONS::zoomOutCenter )
              .AppendAction( ACTIONS::zoomFitScreen )
              .AppendAction( ACTIONS::zoomTool );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::rotateCcw )
              .AppendAction( PCB_ACTIONS::rotateCw )
              .AppendAction( PCB_ACTIONS::mirrorV )
              .AppendAction( PCB_ACTIONS::mirrorH )
              .AppendAction( ACTIONS::group )
              .AppendAction( ACTIONS::ungroup );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::footprintProperties )
              .AppendAction( PCB_ACTIONS::padTable )
              .AppendAction( PCB_ACTIONS::defaultPadProperties )
              .AppendAction( ACTIONS::showDatasheet )
              .AppendAction( PCB_ACTIONS::checkFootprint );
 
        config.AppendSeparator()
              .AppendAction( PCB_ACTIONS::loadFpFromBoard )
              .AppendAction( PCB_ACTIONS::saveFpToBoard );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::gridSelect );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::zoomSelect );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::layerSelector );
 
        config.AppendSeparator()
              .AppendControl( ACTION_TOOLBAR_CONTROLS::ipcScripting );
        break;
    }
 
    // clang-format on
    return config;
}
 
 
void FOOTPRINT_EDIT_FRAME::ReCreateLayerBox( bool aForceResizeToolbar )
{
    if( !m_SelLayerBox )
        return;
 
    m_SelLayerBox->SetToolTip( _( "+/- to switch" ) );
    m_SelLayerBox->Resync();
 
    if( aForceResizeToolbar )
        UpdateToolbarControlSizes();
}
 
void FOOTPRINT_EDIT_FRAME::configureToolbars()
{
    PCB_BASE_EDIT_FRAME::configureToolbars();
 
    // IPC/Scripting plugin control
    // TODO (ISM): Clean this up to make IPC actions just normal tool actions to get rid of this
    // entire control
    auto pluginControlFactory =
            [this]( ACTION_TOOLBAR* aToolbar )
            {
                bool haveApiPlugins = Pgm().GetCommonSettings()->m_Api.enable_server
                                        && !Pgm().GetPluginManager().GetActionsForScope( PluginActionScope() ).empty();
 
                if( haveApiPlugins )
                {
                    aToolbar->AddScaledSeparator( aToolbar->GetParent() );
                    AddApiPluginTools( aToolbar );
                }
            };
 
    RegisterCustomToolbarControlFactory( ACTION_TOOLBAR_CONTROLS::ipcScripting, pluginControlFactory );
}
 
 
void FOOTPRINT_EDIT_FRAME::onPluginAvailabilityChanged( wxCommandEvent& aEvt )
{
    wxLogTrace( traceApi, "Footprint editor frame: EDA_EVT_PLUGIN_AVAILABILITY_CHANGED" );
    RecreateToolbars();
    ReCreateMenuBar();
    aEvt.Skip();
}