KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Functions | Variables
edit_tool.cpp File Reference
#include <macros.h>
#include <advanced_config.h>
#include <clipboard.h>
#include <limits>
#include <kiplatform/ui.h>
#include <gal/graphics_abstraction_layer.h>
#include <board.h>
#include <board_design_settings.h>
#include <footprint.h>
#include <increment.h>
#include <pcb_shape.h>
#include <pcb_group.h>
#include <pcb_target.h>
#include <pcb_textbox.h>
#include <pcb_table.h>
#include <pcb_generator.h>
#include <pcb_edit_frame.h>
#include <drawing_sheet/ds_proxy_view_item.h>
#include <kiway.h>
#include <status_popup.h>
#include <tool/selection_conditions.h>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <tools/pcb_selection_tool.h>
#include <tools/edit_tool.h>
#include <tools/item_modification_routine.h>
#include <tools/pcb_picker_tool.h>
#include <tools/pcb_point_editor.h>
#include <tools/tool_event_utils.h>
#include <tools/pcb_grid_helper.h>
#include <tools/pad_tool.h>
#include <view/view_controls.h>
#include <connectivity/connectivity_algo.h>
#include <core/kicad_algo.h>
#include <fix_board_shape.h>
#include <bitmaps.h>
#include <functional>
#include "kicad_clipboard.h"
#include <wx/hyperlink.h>
#include <router/router_tool.h>
#include <dialog_get_footprint_by_name.h>
#include <dialogs/dialog_move_exact.h>
#include <dialogs/dialog_track_via_properties.h>
#include <dialogs/dialog_tablecell_properties.h>
#include <dialogs/dialog_table_properties.h>
#include <dialogs/dialog_multi_unit_entry.h>
#include <dialogs/dialog_unit_entry.h>
#include <pcb_reference_image.h>

Go to the source code of this file.

Functions

static std::shared_ptr< CONDITIONAL_MENU > makePositioningToolsMenu (TOOL_INTERACTIVE *aTool)
 
static std::shared_ptr< CONDITIONAL_MENU > makeShapeModificationMenu (TOOL_INTERACTIVE *aTool)
 
static FOOTPRINT * GetFootprintFromBoardByReference (PCB_BASE_FRAME &aFrame)
 
static std::optional< int > GetRadiusParams (PCB_BASE_EDIT_FRAME &aFrame, const wxString &aTitle, int &aPersitentRadius)
 Prompt the user for a radius and return it.
 
static std::optional< DOGBONE_CORNER_ROUTINE::PARAMETERS > GetDogboneParams (PCB_BASE_EDIT_FRAME &aFrame)
 
static std::optional< CHAMFER_PARAMS > GetChamferParams (PCB_BASE_EDIT_FRAME &aFrame)
 Prompt the user for chamfer parameters.
 
static void mirrorPad (PAD &aPad, const VECTOR2I &aMirrorPoint, FLIP_DIRECTION aFlipDirection)
 Mirror a pad in the H/V axis passing through a point.
 

Variables

static const std::vector< KICAD_T > padTypes = { PCB_PAD_T }
 
static const std::vector< KICAD_T > footprintTypes = { PCB_FOOTPRINT_T }
 
static const std::vector< KICAD_T > groupTypes = { PCB_GROUP_T }
 
static const std::vector< KICAD_T > trackTypes
 
static const std::vector< KICAD_T > baseConnectedTypes
 
static const std::vector< KICAD_T > connectedTypes
 
static const std::vector< KICAD_T > unroutableTypes
 

Function Documentation

◆ GetChamferParams()

static std::optional< CHAMFER_PARAMS > GetChamferParams ( PCB_BASE_EDIT_FRAME &  aFrame)
static

Prompt the user for chamfer parameters.

Parameters
aFrame
aErrorMsgfilled with an error message if the parameter is invalid somehow
Returns
std::optional<int> the chamfer parameters or std::nullopt if no valid fillet specified

Definition at line 1324 of file edit_tool.cpp.

References _, WX_UNIT_ENTRY_DIALOG::GetValue(), EDA_IU_SCALE::mmToIU(), pcbIUScale, and DIALOG_SHIM::ShowModal().

◆ GetDogboneParams()

static std::optional< DOGBONE_CORNER_ROUTINE::PARAMETERS > GetDogboneParams ( PCB_BASE_EDIT_FRAME &  aFrame)
static

Definition at line 1273 of file edit_tool.cpp.

References _, WX_MULTI_ENTRY_DIALOG::GetValues(), EDA_IU_SCALE::mmToIU(), pcbIUScale, and DIALOG_SHIM::ShowModal().

◆ GetFootprintFromBoardByReference()

static FOOTPRINT * GetFootprintFromBoardByReference ( PCB_BASE_FRAME &  aFrame)
static
Returns
a reference to the footprint found by its reference on the current board. The reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 421 of file edit_tool.cpp.

References BOARD::Footprints(), PCB_BASE_FRAME::GetBoard(), DIALOG_GET_FOOTPRINT_BY_NAME::GetValue(), and DIALOG_SHIM::ShowModal().

Referenced by EDIT_TOOL::GetAndPlace().

◆ GetRadiusParams()

static std::optional< int > GetRadiusParams ( PCB_BASE_EDIT_FRAME &  aFrame,
const wxString &  aTitle,
int &  aPersitentRadius 
)
static

Prompt the user for a radius and return it.

Parameters
aFrame
aTitlethe title of the dialog
aPersitentRadiusthe last used radius
Returns
std::optional<int> the radius or std::nullopt if no valid radius specified

Definition at line 1258 of file edit_tool.cpp.

References _, WX_UNIT_ENTRY_DIALOG::GetValue(), and DIALOG_SHIM::ShowModal().

◆ makePositioningToolsMenu()

static std::shared_ptr< CONDITIONAL_MENU > makePositioningToolsMenu ( TOOL_INTERACTIVE *  aTool)
static

Definition at line 123 of file edit_tool.cpp.

References _, PCB_ACTIONS::copyWithReference, PCB_ACTIONS::moveExact, PCB_ACTIONS::moveWithReference, SELECTION_CONDITIONS::NotEmpty(), PCB_ACTIONS::positionRelative, PCB_ACTIONS::positionRelativeInteractively, and special_tools.

Referenced by EDIT_TOOL::Init().

◆ makeShapeModificationMenu()

static std::shared_ptr< CONDITIONAL_MENU > makeShapeModificationMenu ( TOOL_INTERACTIVE *  aTool)
static

Definition at line 146 of file edit_tool.cpp.

References _, PCB_ACTIONS::chamferLines, SELECTION_CONDITIONS::Count(), PCB_ACTIONS::dogboneCorners, PCB_ACTIONS::extendLines, PCB_ACTIONS::filletLines, TOOL_BASE::GetManager(), TOOL_MANAGER::GetTool(), PCB_POINT_EDITOR::HasCorner(), PCB_POINT_EDITOR::HasMidpoint(), SELECTION_CONDITIONS::HasTypes(), PCB_ACTIONS::healShapes, PCB_ACTIONS::intersectPolygons, PCB_ACTIONS::mergePolygons, SELECTION_CONDITIONS::MoreThan(), SELECTION_CONDITIONS::OnlyTypes(), PCB_SHAPE_LOCATE_ARC_T, PCB_SHAPE_LOCATE_BEZIER_T, PCB_SHAPE_LOCATE_POLY_T, PCB_SHAPE_LOCATE_RECT_T, PCB_SHAPE_LOCATE_SEGMENT_T, PCB_ZONE_T, PCB_ACTIONS::pointEditorMoveCorner, PCB_ACTIONS::pointEditorMoveMidpoint, PCB_ACTIONS::simplifyPolygons, and PCB_ACTIONS::subtractPolygons.

Referenced by EDIT_TOOL::Init().

◆ mirrorPad()

static void mirrorPad ( PAD &  aPad,
const VECTOR2I &  aMirrorPoint,
FLIP_DIRECTION  aFlipDirection 
)
static

Mirror a pad in the H/V axis passing through a point.

Definition at line 2074 of file edit_tool.cpp.

References PADSTACK::ALL_LAYERS, CUSTOM, PAD::FlipPrimitives(), PAD::GetDelta(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPosition(), PAD::GetShape(), MIRROR(), PAD::SetDelta(), PAD::SetOffset(), PAD::SetOrientation(), and PAD::SetPosition().

Referenced by EDIT_TOOL::Mirror().

Variable Documentation

◆ baseConnectedTypes

const std::vector<KICAD_T> baseConnectedTypes
static
Initial value:
= { PCB_PAD_T,
PCB_VIA_T,
PCB_TRACE_T,
PCB_ARC_T }
PCB_VIA_T
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
PCB_PAD_T
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
PCB_ARC_T
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
PCB_TRACE_T
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96

Definition at line 89 of file edit_tool.cpp.

Referenced by EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), and BOARD::GetTrackLength().

◆ connectedTypes

const std::vector<KICAD_T> connectedTypes
static
Initial value:
= { PCB_TRACE_T,
PCB_ARC_T,
PCB_VIA_T,
PCB_PAD_T,
PCB_ZONE_T }
PCB_ZONE_T
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:107

Definition at line 94 of file edit_tool.cpp.

◆ footprintTypes

const std::vector<KICAD_T> footprintTypes = { PCB_FOOTPRINT_T }
static

Definition at line 81 of file edit_tool.cpp.

Referenced by EDIT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ groupTypes

const std::vector<KICAD_T> groupTypes = { PCB_GROUP_T }
static

Definition at line 83 of file edit_tool.cpp.

Referenced by EDIT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ padTypes

const std::vector<KICAD_T> padTypes = { PCB_PAD_T }
static

Definition at line 79 of file edit_tool.cpp.

Referenced by CONVERT_TOOL::Init(), EDIT_TOOL::Init(), and PAD_TOOL::Init().

◆ trackTypes

const std::vector<KICAD_T> trackTypes
static
Initial value:
= { PCB_TRACE_T,
PCB_ARC_T,
PCB_VIA_T }

Definition at line 85 of file edit_tool.cpp.

Referenced by CONVERT_TOOL::Init(), EDIT_TOOL::Init(), and PCB_EDIT_FRAME::setupUIConditions().

◆ unroutableTypes

const std::vector<KICAD_T> unroutableTypes
static
Initial value:
= { PCB_TRACE_T,
PCB_ARC_T,
PCB_VIA_T,
PCB_PAD_T,
PCB_FOOTPRINT_T }
PCB_FOOTPRINT_T
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86

Definition at line 100 of file edit_tool.cpp.

Referenced by EDIT_TOOL::Init().