pcb_actions.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2016 CERN
 * Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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
 */
 
#ifndef __PCB_ACTIONS_H
#define __PCB_ACTIONS_H
 
#include <layer_ids.h>
#include <tool/tool_action.h>
#include <tool/actions.h>
 
enum class ZONE_MODE
{
 ADD, 
 CUTOUT, 
 SIMILAR, 
 GRAPHIC_POLYGON
};
 
 
class PCB_ACTIONS : public ACTIONS
{
public:
 static TOOL_ACTION* LayerIDToAction( PCB_LAYER_ID aLayerID );
 
 // Selection Tool
 static TOOL_ACTION selectionActivate;
 
 static TOOL_ACTION selectionCursor;
 
 static TOOL_ACTION selectionClear;
 
 static TOOL_ACTION selectItem;
 static TOOL_ACTION unselectItem;
 static TOOL_ACTION reselectItem;
 
 static TOOL_ACTION selectItems;
 static TOOL_ACTION unselectItems;
 
 static TOOL_ACTION syncSelection;
 
 static TOOL_ACTION syncSelectionWithNets;
 
 static TOOL_ACTION selectionMenu;
 
 static TOOL_ACTION selectConnection;
 
 static TOOL_ACTION unrouteSelected;
 
 static TOOL_ACTION selectNet;
 
 static TOOL_ACTION deselectNet;
 
 static TOOL_ACTION selectUnconnected;
 
 static TOOL_ACTION grabUnconnected;
 
 static TOOL_ACTION selectOnSheetFromEeschema;
 
 static TOOL_ACTION selectSameSheet;
 
 static TOOL_ACTION selectOnSchematic;
 
 static TOOL_ACTION filterSelection;
 
 static TOOL_ACTION move;
 
 static TOOL_ACTION moveIndividually;
 
 static TOOL_ACTION moveWithReference;
 
 static TOOL_ACTION copyWithReference;
 
 static TOOL_ACTION rotateCw;
 static TOOL_ACTION rotateCcw;
 
 static TOOL_ACTION flip;
 
 static TOOL_ACTION mirrorH;
 static TOOL_ACTION mirrorV;
 
 static TOOL_ACTION swap;
 
 static TOOL_ACTION packAndMoveFootprints;
 
 // Compound Action Tool actions, e.g. Move Individually
 static TOOL_ACTION skip;
 
 static TOOL_ACTION changeTrackWidth;
 
 static TOOL_ACTION filletTracks;
 
 static TOOL_ACTION filletLines;
 static TOOL_ACTION chamferLines;
 static TOOL_ACTION healShapes;
 static TOOL_ACTION extendLines;
 
 static TOOL_ACTION mergePolygons;
 static TOOL_ACTION subtractPolygons;
 static TOOL_ACTION intersectPolygons;
 
 static TOOL_ACTION properties;
 
 static TOOL_ACTION moveExact;
 
 static TOOL_ACTION duplicateIncrement;
 
 static TOOL_ACTION remove;
 static TOOL_ACTION deleteFull;
 
 static TOOL_ACTION selectLayerPair;
 
 static TOOL_ACTION breakTrack;
 
 static TOOL_ACTION drag45Degree;
 static TOOL_ACTION dragFreeAngle;
 
 // Drawing Tool Activations
 static TOOL_ACTION drawLine;
 static TOOL_ACTION drawPolygon;
 static TOOL_ACTION drawRectangle;
 static TOOL_ACTION drawCircle;
 static TOOL_ACTION drawArc;
 static TOOL_ACTION placeReferenceImage;
 static TOOL_ACTION placeText;
 static TOOL_ACTION drawTextBox;
 static TOOL_ACTION spacingIncrease;
 static TOOL_ACTION spacingDecrease;
 static TOOL_ACTION amplIncrease;
 static TOOL_ACTION amplDecrease;
 static TOOL_ACTION drawAlignedDimension;
 static TOOL_ACTION drawCenterDimension;
 static TOOL_ACTION drawRadialDimension;
 static TOOL_ACTION drawOrthogonalDimension;
 static TOOL_ACTION drawLeader;
 static TOOL_ACTION drawZone;
 static TOOL_ACTION drawVia;
 static TOOL_ACTION drawRuleArea;
 static TOOL_ACTION drawZoneCutout;
 static TOOL_ACTION drawSimilarZone;
 static TOOL_ACTION placeCharacteristics;
 static TOOL_ACTION placeStackup;
 static TOOL_ACTION placeFootprint;
 static TOOL_ACTION placeImportedGraphics;
 static TOOL_ACTION setAnchor;
 static TOOL_ACTION deleteLastPoint;
 static TOOL_ACTION closeOutline;
 
 static TOOL_ACTION incWidth;
 
 static TOOL_ACTION decWidth;
 
 static TOOL_ACTION arcPosture;
 
 static TOOL_ACTION magneticSnapActiveLayer;
 static TOOL_ACTION magneticSnapAllLayers;
 static TOOL_ACTION magneticSnapToggle;
 
 // Push and Shove Router Tool
 
 static TOOL_ACTION routeSingleTrack;
 
 static TOOL_ACTION routeDiffPair;
 
 static TOOL_ACTION tuneLength;
 static TOOL_ACTION tuneSkew;
 
 static TOOL_ACTION routerUndoLastSegment;
 
 static TOOL_ACTION routerContinueFromEnd;
 static TOOL_ACTION routerAttemptFinish;
 static TOOL_ACTION routerRouteSelected;
 static TOOL_ACTION routerRouteSelectedFromEnd;
 static TOOL_ACTION routerAutorouteSelected;
 
 static TOOL_ACTION routerSettingsDialog;
 static TOOL_ACTION routerDiffPairDialog;
 
 static TOOL_ACTION routerHighlightMode;
 static TOOL_ACTION routerShoveMode;
 static TOOL_ACTION routerWalkaroundMode;
 static TOOL_ACTION cycleRouterMode;
 
 static TOOL_ACTION routerInlineDrag;
 
 static TOOL_ACTION regenerateAllTuning;
 static TOOL_ACTION regenerateAll;
 static TOOL_ACTION regenerateSelected;
 static TOOL_ACTION regenerateItem;
 static TOOL_ACTION genStartEdit;
 static TOOL_ACTION genUpdateEdit;
 static TOOL_ACTION genPushEdit;
 static TOOL_ACTION genRevertEdit;
 static TOOL_ACTION genRemove;
 
 static TOOL_ACTION generatorsShowManager;
 
 // Point Editor
 static TOOL_ACTION pointEditorAddCorner;
 static TOOL_ACTION pointEditorRemoveCorner;
 
 static TOOL_ACTION pointEditorArcKeepCenter;
 static TOOL_ACTION pointEditorArcKeepEndpoint;
 
 static TOOL_ACTION pointEditorMoveCorner;
 static TOOL_ACTION pointEditorMoveMidpoint;
 
 
 // Group Tool
 static TOOL_ACTION groupProperties;
 static TOOL_ACTION pickNewGroupMember;
 
 
 // Placement Tool
 static TOOL_ACTION alignTop;
 static TOOL_ACTION alignBottom;
 static TOOL_ACTION alignLeft;
 static TOOL_ACTION alignRight;
 static TOOL_ACTION alignCenterX;
 static TOOL_ACTION alignCenterY;
 static TOOL_ACTION distributeHorizontally;
 static TOOL_ACTION distributeVertically;
 
 // Position Relative Tool
 static TOOL_ACTION positionRelative;
 
 static TOOL_ACTION selectpositionRelativeItem;
 
 // Display modes
 static TOOL_ACTION showRatsnest;
 static TOOL_ACTION ratsnestLineMode;
 static TOOL_ACTION netColorModeCycle;
 static TOOL_ACTION ratsnestModeCycle;
 static TOOL_ACTION trackDisplayMode;
 static TOOL_ACTION padDisplayMode;
 static TOOL_ACTION viaDisplayMode;
 static TOOL_ACTION zoneDisplayFilled;
 static TOOL_ACTION zoneDisplayOutline;
 static TOOL_ACTION zoneDisplayFractured;
 static TOOL_ACTION zoneDisplayTriangulated;
 static TOOL_ACTION zoneDisplayToggle;
 static TOOL_ACTION showPadNumbers;
 
 // Layer control
 static TOOL_ACTION layerTop;
 static TOOL_ACTION layerInner1;
 static TOOL_ACTION layerInner2;
 static TOOL_ACTION layerInner3;
 static TOOL_ACTION layerInner4;
 static TOOL_ACTION layerInner5;
 static TOOL_ACTION layerInner6;
 static TOOL_ACTION layerInner7;
 static TOOL_ACTION layerInner8;
 static TOOL_ACTION layerInner9;
 static TOOL_ACTION layerInner10;
 static TOOL_ACTION layerInner11;
 static TOOL_ACTION layerInner12;
 static TOOL_ACTION layerInner13;
 static TOOL_ACTION layerInner14;
 static TOOL_ACTION layerInner15;
 static TOOL_ACTION layerInner16;
 static TOOL_ACTION layerInner17;
 static TOOL_ACTION layerInner18;
 static TOOL_ACTION layerInner19;
 static TOOL_ACTION layerInner20;
 static TOOL_ACTION layerInner21;
 static TOOL_ACTION layerInner22;
 static TOOL_ACTION layerInner23;
 static TOOL_ACTION layerInner24;
 static TOOL_ACTION layerInner25;
 static TOOL_ACTION layerInner26;
 static TOOL_ACTION layerInner27;
 static TOOL_ACTION layerInner28;
 static TOOL_ACTION layerInner29;
 static TOOL_ACTION layerInner30;
 static TOOL_ACTION layerBottom;
 static TOOL_ACTION layerNext;
 static TOOL_ACTION layerPrev;
 static TOOL_ACTION layerAlphaInc;
 static TOOL_ACTION layerAlphaDec;
 static TOOL_ACTION layerToggle;
 
 // Group to link all actions that directly select layers
 static TOOL_ACTION_GROUP layerDirectSwitchActions();
 
 static TOOL_ACTION layerChanged; // notification
 
 static TOOL_ACTION flipBoard;
 
 // Track & via size control
 static TOOL_ACTION trackWidthInc;
 static TOOL_ACTION trackWidthDec;
 static TOOL_ACTION viaSizeInc;
 static TOOL_ACTION viaSizeDec;
 
 static TOOL_ACTION trackViaSizeChanged; // notification
 
 static TOOL_ACTION assignNetClass;
 
 // Zone actions
 static TOOL_ACTION zoneFill;
 static TOOL_ACTION zoneFillAll;
 static TOOL_ACTION zoneFillDirty;
 static TOOL_ACTION zoneUnfill;
 static TOOL_ACTION zoneUnfillAll;
 static TOOL_ACTION zoneMerge;
 
 static TOOL_ACTION zoneDuplicate;
 
 static TOOL_ACTION pluginsReload;
 static TOOL_ACTION pluginsShowFolder;
 
 // Global edit tool
 static TOOL_ACTION boardSetup;
 static TOOL_ACTION editTracksAndVias;
 static TOOL_ACTION editTextAndGraphics;
 static TOOL_ACTION editTeardrops;
 static TOOL_ACTION globalDeletions;
 static TOOL_ACTION cleanupTracksAndVias;
 static TOOL_ACTION cleanupGraphics;
 static TOOL_ACTION updateFootprint;
 static TOOL_ACTION updateFootprints;
 static TOOL_ACTION changeFootprint;
 static TOOL_ACTION changeFootprints;
 static TOOL_ACTION swapLayers;
 static TOOL_ACTION removeUnusedPads;
 
 static TOOL_ACTION importNetlist;
 
 static TOOL_ACTION importSpecctraSession;
 static TOOL_ACTION exportSpecctraDSN;
 
 static TOOL_ACTION generateGerbers;
 static TOOL_ACTION generateDrillFiles;
 static TOOL_ACTION generatePosFile;
 static TOOL_ACTION generateReportFile;
 static TOOL_ACTION generateIPC2581File;
 static TOOL_ACTION generateD356File;
 static TOOL_ACTION generateBOM;
 
 static TOOL_ACTION listNets;
 static TOOL_ACTION runDRC;
 
 static TOOL_ACTION editFpInFpEditor;
 static TOOL_ACTION editLibFpInFpEditor;
 
 static TOOL_ACTION showLayersManager;
 static TOOL_ACTION showPythonConsole;
 
 // Module editor tools
 
 static TOOL_ACTION showFootprintTree;
 static TOOL_ACTION hideFootprintTree;
 
 // We don't use ACTION::new here because we need to distinguish between New Library
 // and New Footprint.
 static TOOL_ACTION newFootprint;
 
 // Create a new footprint using the Footprint Wizard
 static TOOL_ACTION createFootprint;
 
 // We don't use ACTION::save here because we need to distinguish between saving to
 // the library and saving to the board (which have different tooltips and icons).
 static TOOL_ACTION saveToBoard;
 static TOOL_ACTION saveToLibrary;
 
 static TOOL_ACTION editFootprint;
 static TOOL_ACTION duplicateFootprint;
 static TOOL_ACTION renameFootprint;
 static TOOL_ACTION deleteFootprint;
 static TOOL_ACTION cutFootprint;
 static TOOL_ACTION copyFootprint;
 static TOOL_ACTION pasteFootprint;
 static TOOL_ACTION importFootprint;
 static TOOL_ACTION exportFootprint;
 
 static TOOL_ACTION footprintProperties;
 static TOOL_ACTION defaultPadProperties;
 
 static TOOL_ACTION checkFootprint;
 
 static TOOL_ACTION placePad;
 
 static TOOL_ACTION explodePad;
 static TOOL_ACTION recombinePad;
 
 static TOOL_ACTION enumeratePads;
 
 static TOOL_ACTION createArray;
 
 static TOOL_ACTION graphicsOutlines;
 
 static TOOL_ACTION textOutlines;
 
 // Pad tools
 
 static TOOL_ACTION copyPadSettings;
 
 static TOOL_ACTION applyPadSettings;
 
 static TOOL_ACTION pushPadSettings;
 
 // Microwave tools
 static TOOL_ACTION microwaveCreateGap;
 
 static TOOL_ACTION microwaveCreateStub;
 
 static TOOL_ACTION microwaveCreateStubArc;
 
 static TOOL_ACTION microwaveCreateFunctionShape;
 
 static TOOL_ACTION microwaveCreateLine;
 
 // Constrained drawing
 static TOOL_ACTION toggleHV45Mode;
 
 // Locking
 static TOOL_ACTION toggleLock;
 static TOOL_ACTION lock;
 static TOOL_ACTION unlock;
 
 // Grouping
 static TOOL_ACTION group;
 static TOOL_ACTION ungroup;
 static TOOL_ACTION removeFromGroup;
 static TOOL_ACTION groupEnter;
 static TOOL_ACTION groupLeave;
 
 // Miscellaneous
 static TOOL_ACTION selectionTool;
 static TOOL_ACTION pickerTool;
 static TOOL_ACTION measureTool;
 static TOOL_ACTION drillOrigin;
 static TOOL_ACTION drillResetOrigin;
 static TOOL_ACTION placeFileOrigin;
 static TOOL_ACTION appendBoard;
 static TOOL_ACTION showEeschema;
 static TOOL_ACTION boardStatistics;
 static TOOL_ACTION boardReannotate;
 static TOOL_ACTION repairBoard;
 static TOOL_ACTION repairFootprint;
 static TOOL_ACTION inspectClearance;
 static TOOL_ACTION inspectConstraints;
 static TOOL_ACTION diffFootprint;
 static TOOL_ACTION showFootprintAssociations;
 
 // Appearance controls
 static TOOL_ACTION clearHighlight; // Turns off highlight and resets previous highlight
 static TOOL_ACTION highlightNet; // Highlights a net by code (cross-probe highlight)
 static TOOL_ACTION toggleLastNetHighlight; // Toggles between current and previous highlight
 static TOOL_ACTION toggleNetHighlight; // Toggles between highlight off and highlight on
 static TOOL_ACTION highlightNetSelection; // Turns on highlight and takes net from selection
 static TOOL_ACTION highlightItem; // Select component via cross-probe
 
 // Ratsnest
 static TOOL_ACTION hideNetInRatsnest;
 static TOOL_ACTION showNetInRatsnest;
 static TOOL_ACTION localRatsnestTool;
 static TOOL_ACTION hideLocalRatsnest;
 static TOOL_ACTION updateLocalRatsnest;
 
 static TOOL_ACTION find;
 
 static TOOL_ACTION getAndPlace;
 
 static TOOL_ACTION autoplaceOffboardComponents;
 static TOOL_ACTION autoplaceSelectedComponents;
 
 // convert tool
 static TOOL_ACTION convertToPoly;
 static TOOL_ACTION convertToZone;
 static TOOL_ACTION convertToKeepout;
 static TOOL_ACTION convertToLines;
 static TOOL_ACTION convertToArc;
 static TOOL_ACTION convertToTracks;
 
 static TOOL_ACTION ddAppendBoard;
 static TOOL_ACTION ddImportFootprint;
 
 
};
 
class PCB_EVENTS
{
public:
 const static TOOL_EVENT SnappingModeChangedByKeyEvent;
};
 
#endif