edit_tool.cpp File Reference

#include <macros.h>
#include <advanced_config.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 <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 <array_creator.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 <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_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 std::optional< int >	GetFilletParams (PCB_BASE_EDIT_FRAME &aFrame)
	Prompt the user for the fillet radius and return it.
static std::optional< CHAMFER_PARAMS >	GetChamferParams (PCB_BASE_EDIT_FRAME &aFrame)
	Prompt the user for chamfer parameters.
static VECTOR2I	mirrorPointX (const VECTOR2I &aPoint, const VECTOR2I &aMirrorPoint)
	Mirror a point about the vertical axis passing through another point.
static VECTOR2I	mirrorPointY (const VECTOR2I &aPoint, const VECTOR2I &aMirrorPoint)
	Mirror a point about the vertical axis passing through another point.
static void	mirrorPadX (PAD &aPad, const VECTOR2I &aMirrorPoint)
	Mirror a pad in the vertical axis passing through a point (mirror left to right).
static void	mirrorPadY (PAD &aPad, const VECTOR2I &aMirrorPoint)
	Mirror a pad in the vertical axis passing through a point (mirror left to right).

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
aErrorMsg	filled 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 1217 of file edit_tool.cpp.

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

GetFilletParams()

static std::optional< int > GetFilletParams ( PCB_BASE_EDIT_FRAME &  aFrame )

static

Prompt the user for the fillet radius and return it.

Parameters

aFrame
aErrorMsg	filled with an error message if the parameter is invalid somehow

Returns

std::optional<int> the fillet radius or std::nullopt if no valid fillet specified

Definition at line 1193 of file edit_tool.cpp.

References _, and WX_UNIT_ENTRY_DIALOG::GetValue().

makePositioningToolsMenu()

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

static

Definition at line 120 of file edit_tool.cpp.

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

Referenced by EDIT_TOOL::Init().

makeShapeModificationMenu()

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

static

Definition at line 142 of file edit_tool.cpp.

References _, PCB_ACTIONS::chamferLines, SELECTION_CONDITIONS::Count(), 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().

mirrorPadX()

static void mirrorPadX ( PAD &  aPad, const VECTOR2I &  aMirrorPoint  )

static

Mirror a pad in the vertical axis passing through a point (mirror left to right).

Definition at line 1980 of file edit_tool.cpp.

References CUSTOM, PAD::FlipPrimitives(), PAD::GetDelta(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPosition(), PAD::GetShape(), mirrorPointX(), PAD::SetDelta(), PAD::SetOffset(), PAD::SetOrientation(), PAD::SetPosition(), and VECTOR2< T >::x.

Referenced by EDIT_TOOL::Mirror().

mirrorPadY()

static void mirrorPadY ( PAD &  aPad, const VECTOR2I &  aMirrorPoint  )

static

Mirror a pad in the vertical axis passing through a point (mirror left to right).

Definition at line 2003 of file edit_tool.cpp.

References CUSTOM, PAD::FlipPrimitives(), PAD::GetDelta(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPosition(), PAD::GetShape(), mirrorPointY(), PAD::SetDelta(), PAD::SetOffset(), PAD::SetOrientation(), PAD::SetPosition(), and VECTOR2< T >::y.

Referenced by EDIT_TOOL::Mirror().

mirrorPointX()

static VECTOR2I mirrorPointX ( const VECTOR2I &  aPoint, const VECTOR2I &  aMirrorPoint  )

static

Mirror a point about the vertical axis passing through another point.

Definition at line 1950 of file edit_tool.cpp.

References VECTOR2< T >::x.

Referenced by mirrorPadX().

mirrorPointY()

static VECTOR2I mirrorPointY ( const VECTOR2I &  aPoint, const VECTOR2I &  aMirrorPoint  )

static

Mirror a point about the vertical axis passing through another point.

Definition at line 1965 of file edit_tool.cpp.

References VECTOR2< T >::y.

Referenced by mirrorPadY().

Variable Documentation

baseConnectedTypes

const std::vector<KICAD_T> baseConnectedTypes

static

Initial value:

= { PCB_PAD_T,
 PCB_VIA_T,
 PCB_TRACE_T,
 PCB_ARC_T }

Definition at line 86 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 }

Definition at line 91 of file edit_tool.cpp.

footprintTypes

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

static

Definition at line 78 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 80 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 76 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 82 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 }

Definition at line 97 of file edit_tool.cpp.

Referenced by EDIT_TOOL::Init().