KiCad PCB EDA Suite
edit_tool.cpp File Reference
#include <limits>
#include <class_board.h>
#include <class_module.h>
#include <class_edge_mod.h>
#include <class_zone.h>
#include <collectors.h>
#include <pcb_edit_frame.h>
#include <kiway.h>
#include <footprint_edit_frame.h>
#include <array_creator.h>
#include <pcbnew_id.h>
#include <status_popup.h>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <tools/selection_tool.h>
#include <tools/edit_tool.h>
#include <tools/pcbnew_picker_tool.h>
#include <tools/tool_event_utils.h>
#include <tools/grid_helper.h>
#include <view/view_controls.h>
#include <connectivity/connectivity_data.h>
#include <confirm.h>
#include <bitmaps.h>
#include <cassert>
#include <functional>
#include "kicad_clipboard.h"
#include <router/router_tool.h>
#include <dialogs/dialog_move_exact.h>
#include <dialogs/dialog_track_via_properties.h>
#include <preview_items/ruler_item.h>
#include <board_commit.h>

Go to the source code of this file.

Functions

void EditToolSelectionFilter (GENERAL_COLLECTOR &aCollector, int aFlags)
 
static wxPoint mirrorPointX (const wxPoint &aPoint, const wxPoint &aMirrorPoint)
 
static void mirrorPadX (D_PAD &aPad, const wxPoint &aMirrorPoint)
 Mirror a pad in the vertical axis passing through a point. More...
 

Function Documentation

◆ EditToolSelectionFilter()

void EditToolSelectionFilter ( GENERAL_COLLECTOR aCollector,
int  aFlags 
)

Definition at line 61 of file edit_tool.cpp.

62 {
63  // Iterate from the back so we don't have to worry about removals.
64  for( int i = aCollector.GetCount() - 1; i >= 0; --i )
65  {
66  BOARD_ITEM* item = aCollector[ i ];
67 
68  if( ( aFlags & EXCLUDE_LOCKED ) && item->IsLocked() )
69  {
70  aCollector.Remove( item );
71  }
72  else if( item->Type() == PCB_PAD_T )
73  {
74  MODULE* mod = static_cast<MODULE*>( item->GetParent() );
75 
76  // case 1: handle locking
77  if( ( aFlags & EXCLUDE_LOCKED ) && mod && mod->IsLocked() )
78  {
79  aCollector.Remove( item );
80  }
81  else if( ( aFlags & EXCLUDE_LOCKED_PADS ) && mod && mod->PadsLocked() )
82  {
83  // Pad locking is considerably "softer" than item locking
84  aCollector.Remove( item );
85 
86  if( !mod->IsLocked() && !aCollector.HasItem( mod ) )
87  aCollector.Append( mod );
88  }
89 
90  // case 2: selection contains both the module and its pads - remove the pads
91  if( mod && aCollector.HasItem( mod ) )
92  aCollector.Remove( item );
93  }
94  else if( ( aFlags & EXCLUDE_TRANSIENTS ) && item->Type() == PCB_MARKER_T )
95  {
96  aCollector.Remove( item );
97  }
98  }
99 }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
void Remove(int aIndex)
Function Remove removes the item at aIndex (first position is 0);.
Definition: collector.h:142
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
Definition: collector.h:132
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:113
bool HasItem(const EDA_ITEM *aItem) const
Function HasItem tests if aItem has already been collected.
Definition: collector.h:196
#define EXCLUDE_TRANSIENTS
Definition: edit_tool.h:55
virtual bool IsLocked() const
Function IsLocked.
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:97
size_t i
Definition: json11.cpp:597
#define EXCLUDE_LOCKED
Function EditToolSelectionFilter.
Definition: edit_tool.h:53
#define EXCLUDE_LOCKED_PADS
Definition: edit_tool.h:54
BOARD_ITEM_CONTAINER * GetParent() const
#define mod(a, n)
Definition: greymap.cpp:24
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References COLLECTOR::Append(), EXCLUDE_LOCKED, EXCLUDE_LOCKED_PADS, EXCLUDE_TRANSIENTS, COLLECTOR::GetCount(), BOARD_ITEM::GetParent(), COLLECTOR::HasItem(), i, BOARD_ITEM::IsLocked(), mod, PCB_MARKER_T, PCB_PAD_T, COLLECTOR::Remove(), and EDA_ITEM::Type().

Referenced by EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::Duplicate(), EDIT_TOOL::Flip(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), EDIT_TOOL::Mirror(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Properties(), EDIT_TOOL::Remove(), EDIT_TOOL::Rotate(), and POSITION_RELATIVE_TOOL::SelectPositionRelativeItem().

◆ mirrorPadX()

static void mirrorPadX ( D_PAD aPad,
const wxPoint &  aMirrorPoint 
)
static

Mirror a pad in the vertical axis passing through a point.

Definition at line 655 of file edit_tool.cpp.

656 {
657  wxPoint tmpPt = mirrorPointX( aPad.GetPosition(), aMirrorPoint );
658 
659  if( aPad.GetShape() == PAD_SHAPE_CUSTOM )
660  aPad.MirrorXPrimitives( tmpPt.x );
661 
662  aPad.SetPosition( tmpPt );
663 
664  aPad.SetX0( aPad.GetPosition().x );
665 
666  tmpPt = aPad.GetOffset();
667  tmpPt.x = -tmpPt.x;
668  aPad.SetOffset( tmpPt );
669 
670  auto tmpz = aPad.GetDelta();
671  tmpz.x = -tmpz.x;
672  aPad.SetDelta( tmpz );
673 
674  aPad.SetOrientation( -aPad.GetOrientation() );
675 }
void SetPosition(const wxPoint &aPos) override
Definition: class_pad.h:224
const wxPoint & GetOffset() const
Definition: class_pad.h:293
const wxSize & GetDelta() const
Definition: class_pad.h:287
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees,...
Definition: class_pad.h:406
static wxPoint mirrorPointX(const wxPoint &aPoint, const wxPoint &aMirrorPoint)
Definition: edit_tool.cpp:640
void SetOrientation(double aAngle)
Function SetOrientation sets the rotation angle of the pad.
Definition: class_pad.cpp:430
void SetX0(int x)
Definition: class_pad.h:281
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:221
const wxPoint GetPosition() const override
Definition: class_pad.h:225
void SetOffset(const wxPoint &aOffset)
Definition: class_pad.h:292
void MirrorXPrimitives(int aX)
Mirror the primitives about a coordinate.
Definition: class_pad.cpp:504
void SetDelta(const wxSize &aSize)
Definition: class_pad.h:286

References D_PAD::GetDelta(), D_PAD::GetOffset(), D_PAD::GetOrientation(), D_PAD::GetPosition(), D_PAD::GetShape(), mirrorPointX(), D_PAD::MirrorXPrimitives(), PAD_SHAPE_CUSTOM, D_PAD::SetDelta(), D_PAD::SetOffset(), D_PAD::SetOrientation(), D_PAD::SetPosition(), and D_PAD::SetX0().

Referenced by EDIT_TOOL::Mirror().

◆ mirrorPointX()

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

Mirror a point about the vertical axis passing through another point

Definition at line 640 of file edit_tool.cpp.

641 {
642  wxPoint mirrored = aPoint;
643 
644  mirrored.x -= aMirrorPoint.x;
645  mirrored.x = -mirrored.x;
646  mirrored.x += aMirrorPoint.x;
647 
648  return mirrored;
649 }

Referenced by mirrorPadX().