KiCad PCB EDA Suite
SCH_SCREEN Class Reference

#include <class_sch_screen.h>

Inheritance diagram for SCH_SCREEN:
BASE_SCREEN KIWAY_HOLDER EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 SCH_SCREEN (KIWAY *aKiway)
 Constructor. More...
 
 ~SCH_SCREEN ()
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const PAGE_INFOGetPageSettings () const
 
void SetPageSettings (const PAGE_INFO &aPageSettings)
 
void SetFileName (const wxString &aFileName)
 
const wxString & GetFileName () const
 
const wxPointGetAuxOrigin () const
 
void SetAuxOrigin (const wxPoint &aPosition)
 
const TITLE_BLOCKGetTitleBlock () const
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
 
void DecRefCount ()
 
void IncRefCount ()
 
int GetRefCount () const
 
SCH_ITEMGetDrawItems () const
 
void Append (SCH_ITEM *aItem)
 
void Append (SCH_SCREEN *aScreen)
 Copy the contents of aScreen into this SCH_SCREEN object. More...
 
void Append (DLIST< SCH_ITEM > &aList)
 Add aList of SCH_ITEM objects to the list for draw items for the sheet. More...
 
SCH_ITEMGetCurItem () const
 Return the currently selected SCH_ITEM, overriding BASE_SCREEN::GetCurItem(). More...
 
void SetCurItem (SCH_ITEM *aItem)
 Sets the currently selected object, m_CurrentItem. More...
 
void Clear ()
 Delete all draw items and clears the project settings. More...
 
void FreeDrawList ()
 Free all the items from the schematic associated with the screen. More...
 
SCH_ITEMGetItem (const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=NOT_USED) const
 Check aPosition within a distance of aAccuracy for items of type aFilter. More...
 
void Place (SCH_EDIT_FRAME *frame, wxDC *DC)
 
void UpdateSymbolLinks (bool aForce=false)
 Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawList. More...
 
void Draw (EDA_DRAW_PANEL *aCanvas, wxDC *aDC, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED)
 Draw all the items in the screen to aCanvas. More...
 
void Plot (PLOTTER *aPlotter)
 Plot all the schematic objects to aPlotter. More...
 
void Remove (SCH_ITEM *aItem)
 Remove aItem from the schematic associated with this screen. More...
 
void DeleteItem (SCH_ITEM *aItem)
 Removes aItem from the linked list and deletes the object. More...
 
bool CheckIfOnDrawList (SCH_ITEM *st)
 
bool SchematicCleanUp ()
 Perform routine schematic cleaning including breaking wire and buses and deleting identical objects superimposed on top of each other. More...
 
bool TestDanglingEnds ()
 Test all of the connectable objects in the schematic for unused connection points. More...
 
void ExtractWires (DLIST< SCH_ITEM > &aList, bool aCreateCopy)
 Extracts the old wires, junctions and buses. More...
 
void ReplaceWires (DLIST< SCH_ITEM > &aWireList)
 Replace all of the wires, buses, and junctions in the screen with aWireList. More...
 
void MarkConnections (SCH_LINE *aSegment)
 Add all wires and junctions connected to aSegment which are not connected any component pin to aItemList. More...
 
int GetConnection (const wxPoint &aPosition, PICKED_ITEMS_LIST &aList, bool aFullConnection)
 Adds all of the wires and junctions to aList that make up a connection to the object at aPosition. More...
 
bool BreakSegment (const wxPoint &aPoint)
 Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an intersection is found. More...
 
bool BreakSegmentsOnJunctions ()
 Tests all junctions and bus entries in the schematic for intersections with wires and buses and breaks any intersections into multiple segments. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_CONTAINER &aList, int aItemCount=-1) override
 Free the undo or redo list from aList element. More...
 
void ClearDrawingState ()
 Clear the state flags of all the items in the screen. More...
 
int CountConnectedItems (const wxPoint &aPos, bool aTestJunctions) const
 
bool IsJunctionNeeded (const wxPoint &aPosition)
 Test if a junction is required for the items at aPosition on the screen. More...
 
bool IsTerminalPoint (const wxPoint &aPosition, int aLayer)
 Test if aPosition is a connection point on aLayer. More...
 
LIB_PINGetPin (const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
 Test the screen for a component pin item at aPosition. More...
 
SCH_SHEETGetSheet (const wxString &aName)
 Returns a sheet object pointer that is named aName. More...
 
SCH_SHEET_PINGetSheetLabel (const wxPoint &aPosition)
 Test the screen if aPosition is a sheet label object. More...
 
void ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
 Clear the annotation for the components in aSheetPath on the screen. More...
 
void GetHierarchicalItems (EDA_ITEMS &aItems)
 Add all schematic sheet and component objects in the screen to aItems. More...
 
int GetNode (const wxPoint &aPosition, EDA_ITEMS &aList)
 Return all the items at aPosition that form a node. More...
 
SCH_LINEGetWireOrBus (const wxPoint &aPosition)
 Return a wire or bus item located at aPosition. More...
 
SCH_LINEGetLine (const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 Return a line item located at aPosition. More...
 
SCH_LINEGetWire (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 
SCH_LINEGetBus (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 
SCH_TEXTGetLabel (const wxPoint &aPosition, int aAccuracy=0)
 Return a label item located at aPosition. More...
 
bool SetComponentFootprint (SCH_SHEET_PATH *aSheetPath, const wxString &aReference, const wxString &aFootPrint, bool aSetVisible)
 Search this screen for a symbol with aReference and set the footprint field to aFootPrint if found. More...
 
void SelectBlockItems ()
 Create a list of items found when a block command is initiated. More...
 
int UpdatePickList ()
 Add all the items in the screen within the block selection rectangle to the pick list. More...
 
void SetCurItem (EDA_ITEM *aItem)
 Function SetCurItem sets the currently selected object, m_CurrentItem. More...
 
void InitDataPoints (const wxSize &aPageSizeInternalUnits)
 
virtual int MilsToIuScalar ()
 Function MilsToIuScalar returns the scalar required to convert mils to internal units. More...
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
int GetUndoCommandCount () const
 
int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
void SetMaxUndoItems (int aMax)
 
void SetModify ()
 
void ClrModify ()
 
void SetSave ()
 
void ClrSave ()
 
bool IsModify () const
 
bool IsSave () const
 
double GetZoom () const
 Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device unit", or "world units per device unit". More...
 
bool SetZoom (double iu_per_du)
 Function SetZoom adjusts the current zoom factor. More...
 
bool SetNextZoom ()
 
bool SetPreviousZoom ()
 
bool SetFirstZoom ()
 
bool SetLastZoom ()
 
double GetMaxAllowedZoom () const
 Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last entry in m_ZoomList. More...
 
double GetMinAllowedZoom () const
 Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the first entry in m_ZoomList. More...
 
void SetScalingFactor (double iu_per_du)
 Function SetScalingFactor sets the scaling factor of "internal unit per device unit". More...
 
double GetScalingFactor () const
 Function GetScalingFactor returns the inverse of the current scale used to draw items on screen. More...
 
int GetGridCmdId () const
 Return the command ID of the currently selected grid. More...
 
const wxRealPoint & GetGridSize () const
 Return the grid size of the currently selected grid. More...
 
const GRID_TYPEGetGrid () const
 Return the grid object of the currently selected grid. More...
 
GRID_TYPEGetGrid (size_t aIndex)
 Function GetGrid() Returns the grid object at aIndex. More...
 
int SetGrid (const wxRealPoint &size)
 set the current grid size m_Grid. More...
 
int SetGrid (int aCommandId)
 Function SetGrid sets the grid size from command ID (not an index in grid list, but a wxID). More...
 
void SetGridList (GRIDS &sizelist)
 
void AddGrid (const GRID_TYPE &grid)
 
void AddGrid (const wxRealPoint &size, int id)
 
void AddGrid (const wxRealPoint &size, EDA_UNITS_T aUnit, int id)
 
bool GridExists (int aCommandId)
 Function GridExists tests for grid command ID (not an index in grid list, but a wxID) exists in grid list. More...
 
size_t GetGridCount () const
 Function GetGridCount(). More...
 
const GRIDSGetGrids () const
 Function GetGrids(). More...
 
int BuildGridsChoiceList (wxArrayString &aGridsList, bool aMmFirst) const
 Function BuildGridsChoiceList(). More...
 
bool IsBlockActive () const
 
void ClearBlockCommand ()
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (time_t aNewTimeStamp)
 
time_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition) const
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual const EDA_RECT GetBoundingBox () const
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual wxString GetSelectMenuText () const
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

wxPoint m_DrawOrg
 offsets for drawing the circuit on the screen More...
 
wxPoint m_O_Curseur
 Relative Screen cursor coordinate (on grid) in user units. More...
 
int m_ScrollPixelsPerUnitX
 Pixels per scroll unit in the horizontal direction. More...
 
int m_ScrollPixelsPerUnitY
 Pixels per scroll unit in the vertical direction. More...
 
wxSize m_ScrollbarNumber
 Current virtual draw area size in scroll units. More...
 
wxPoint m_ScrollbarPos
 Current scroll bar position in scroll units. More...
 
wxPoint m_StartVisu
 Coordinates in drawing units of the current view position (upper left corner of device) More...
 
bool m_Center
 Center on screen. More...
 
bool m_FirstRedraw
 
UNDO_REDO_CONTAINER m_UndoList
 Objects list for the undo command (old data) More...
 
UNDO_REDO_CONTAINER m_RedoList
 Objects list for the redo command (old data) More...
 
BLOCK_SELECTOR m_BlockLocate
 Block description for block commands. More...
 
int m_ScreenNumber
 
int m_NumberOfScreens
 
std::vector< double > m_ZoomList
 standard zoom (i.e. scale) coefficients. More...
 
bool m_IsPrinting
 

Static Public Attributes

static wxString m_PageLayoutDescrFileName
 the name of the page layout descr file, or emty to used the default pagelayout More...
 

Protected Member Functions

bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
time_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void addConnectedItemsToBlock (const wxPoint &aPosition)
 Add items connected at aPosition to the block pick list. More...
 

Private Attributes

wxString m_fileName
 File used to load the screen. More...
 
int m_refCount
 Number of sheets referencing this screen. More...
 
PAGE_INFO m_paper
 The size of the paper to print or plot on. More...
 
TITLE_BLOCK m_titles
 
wxPoint m_aux_origin
 Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA. More...
 
DLIST< SCH_ITEMm_drawList
 Object list for the screen. More...
 
int m_modification_sync
 inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll(). More...
 

Detailed Description

Definition at line 66 of file class_sch_screen.h.

Constructor & Destructor Documentation

SCH_SCREEN::SCH_SCREEN ( KIWAY aKiway)

Constructor.

Definition at line 93 of file sch_screen.cpp.

References BASE_SCREEN::AddGrid(), DIM, BASE_SCREEN::InitDataPoints(), BASE_SCREEN::m_Center, m_modification_sync, m_paper, m_refCount, BASE_SCREEN::m_ZoomList, SchematicZoomList, BASE_SCREEN::SetGrid(), and BASE_SCREEN::SetZoom().

93  :
95  KIWAY_HOLDER( aKiway ),
96  m_paper( wxT( "A4" ) )
97 {
99 
100  SetZoom( 32 );
101 
102  for( unsigned i = 0; i < DIM( SchematicZoomList ); i++ )
103  m_ZoomList.push_back( SchematicZoomList[i] );
104 
105  for( unsigned i = 0; i < DIM( SchematicGridList ); i++ )
107 
108  SetGrid( wxRealPoint( 50, 50 ) ); // Default grid size.
109  m_refCount = 0;
110 
111  // Suitable for schematic only. For libedit and viewlib, must be set to true
112  m_Center = false;
113 
114  InitDataPoints( m_paper.GetSizeIU() );
115 }
#define DIM(x)
of elements in an array
Definition: macros.h:98
static double SchematicZoomList[]
Definition: sch_screen.cpp:64
int m_refCount
Number of sheets referencing this screen.
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
static GRID_TYPE SchematicGridList[]
Definition: sch_screen.cpp:82
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:69
PAGE_INFO m_paper
The size of the paper to print or plot on.
bool m_Center
Center on screen.
KIWAY_HOLDER(KIWAY *aKiway)
Definition: kiway_player.h:51
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
void AddGrid(const GRID_TYPE &grid)
BASE_SCREEN(KICAD_T aType=SCREEN_T)
Definition: base_screen.cpp:42
int SetGrid(const wxRealPoint &size)
set the current grid size m_Grid.
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
SCH_SCREEN::~SCH_SCREEN ( )

Definition at line 118 of file sch_screen.cpp.

References BASE_SCREEN::ClearUndoRedoList(), and FreeDrawList().

119 {
121  FreeDrawList();
122 }
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:164

Member Function Documentation

void SCH_SCREEN::addConnectedItemsToBlock ( const wxPoint aPosition)
private

Add items connected at aPosition to the block pick list.

This method tests all connectable unselected items in the screen that are connected to aPosition and adds them to the block selection pick list. This is used when a block drag is being performed to ensure connections to items in the block are not lost.

Parameters
aPosition= The connection point to test.

Definition at line 796 of file sch_screen.cpp.

References DLIST< T >::begin(), EDA_ITEM::ClearFlags(), ENDPOINT, SCH_LINE::GetEndPoint(), EDA_ITEM::GetFlags(), BLOCK_SELECTOR::GetItems(), SCH_LINE::GetStartPoint(), SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnected(), EDA_ITEM::IsSelected(), BASE_SCREEN::m_BlockLocate, m_drawList, SCH_ITEM::Next(), PICKED_ITEMS_LIST::PushItem(), SCH_LINE_T, SELECTED, ITEM_PICKER::SetFlags(), EDA_ITEM::SetFlags(), ITEM_PICKER::SetItem(), SKIP_STRUCT, STARTPOINT, and EDA_ITEM::Type().

Referenced by SelectBlockItems().

797 {
798  SCH_ITEM* item;
799  ITEM_PICKER picker;
800 
801  for( item = m_drawList.begin(); item; item = item->Next() )
802  {
803  bool addinlist = true;
804  picker.SetItem( item );
805 
806  if( !item->IsConnectable() || !item->IsConnected( position )
807  || (item->GetFlags() & SKIP_STRUCT) )
808  continue;
809 
810  if( item->IsSelected() && item->Type() != SCH_LINE_T )
811  continue;
812 
813  // A line having 2 ends, it can be tested twice: one time per end
814  if( item->Type() == SCH_LINE_T )
815  {
816  if( ! item->IsSelected() ) // First time this line is tested
817  item->SetFlags( SELECTED | STARTPOINT | ENDPOINT );
818  else // second time (or more) this line is tested
819  addinlist = false;
820 
821  SCH_LINE* line = (SCH_LINE*) item;
822 
823  if( line->GetStartPoint() == position )
824  item->ClearFlags( STARTPOINT );
825  else if( line->GetEndPoint() == position )
826  item->ClearFlags( ENDPOINT );
827  }
828  else
829  item->SetFlags( SELECTED );
830 
831  if( addinlist )
832  {
833  picker.SetFlags( item->GetFlags() );
834  m_BlockLocate.GetItems().PushItem( picker );
835  }
836  }
837 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:269
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:138
bool IsSelected() const
Definition: base_struct.h:235
T * begin() const
Definition: dlist.h:218
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
wxPoint GetEndPoint() const
Definition: sch_line.h:80
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
virtual bool IsConnectable() const
Function IsConnectable returns true if the schematic item can connect to another schematic item...
void SetFlags(STATUS_FLAGS aFlags)
void SetItem(EDA_ITEM *aItem)
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
#define ENDPOINT
Definition: base_struct.h:133
PICKED_ITEMS_LIST & GetItems()
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
#define STARTPOINT
Definition: base_struct.h:132
void BASE_SCREEN::AddGrid ( const GRID_TYPE grid)
inherited

Definition at line 280 of file base_screen.cpp.

References ID_POPUP_GRID_USER, GRID_TYPE::m_CmdId, BASE_SCREEN::m_grids, and GRID_TYPE::m_Size.

Referenced by BASE_SCREEN::AddGrid(), GBR_SCREEN::GBR_SCREEN(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), and DIALOG_SET_GRID::TransferDataFromWindow().

281 {
282  for( unsigned i = 0; i < m_grids.size(); i++ )
283  {
284  if( m_grids[i].m_Size == grid.m_Size && grid.m_CmdId != ID_POPUP_GRID_USER )
285  {
286  wxLogDebug( wxT( "Discarding duplicate grid size( %g, %g )." ),
287  grid.m_Size.x, grid.m_Size.y );
288  return;
289  }
290 
291  if( m_grids[i].m_CmdId == grid.m_CmdId )
292  {
293  wxLogDebug( wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
294  wxT( "size( %g, %g )." ),
295  grid.m_CmdId, m_grids[i].m_Size.x,
296  m_grids[i].m_Size.y, grid.m_Size.x, grid.m_Size.y );
297  m_grids[i].m_Size = grid.m_Size;
298  return;
299  }
300  }
301 
302  m_grids.push_back( grid );
303 }
wxRealPoint m_Size
ID_POPUP_GRID_USER
Definition: draw_frame.cpp:108
GRIDS m_grids
List of valid grid sizes.
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
int  id 
)
inherited

Definition at line 306 of file base_screen.cpp.

References BASE_SCREEN::AddGrid(), GRID_TYPE::m_CmdId, and GRID_TYPE::m_Size.

307 {
308  GRID_TYPE grid;
309 
310  grid.m_Size = size;
311  grid.m_CmdId = id;
312  AddGrid( grid );
313 }
wxRealPoint m_Size
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
EDA_UNITS_T  aUnit,
int  id 
)
inherited

Definition at line 316 of file base_screen.cpp.

References BASE_SCREEN::AddGrid(), From_User_Unit(), GRID_TYPE::m_CmdId, and GRID_TYPE::m_Size.

317 {
318  wxRealPoint new_size;
319  GRID_TYPE new_grid;
320 
321  new_size.x = From_User_Unit( aUnit, size.x );
322  new_size.y = From_User_Unit( aUnit, size.y );
323  new_grid.m_CmdId = id;
324  new_grid.m_Size = new_size;
325 
326  AddGrid( new_grid );
327 }
double From_User_Unit(EDA_UNITS_T aUnit, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg"...
Definition: base_units.cpp:274
wxRealPoint m_Size
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
void SCH_SCREEN::Append ( SCH_SCREEN aScreen)

Copy the contents of aScreen into this SCH_SCREEN object.

Warning
The contents of Screen cannot contain any duplicate sheet names or any hierarchy recursion issues or bad things will happen.
Parameters
aScreenis the screen to append to this one.
Returns
false if there are any duplicate sheet names or any hierarchy recursion issues the calling this method or KiCad will crash.

Definition at line 139 of file sch_screen.cpp.

References DLIST< T >::Append(), m_drawList, and DHEAD::SetOwnership().

140 {
141  wxCHECK_RET( aScreen, "Invalid screen object." );
142 
143  // No need to decend the hierarchy. Once the top level screen is copied, all of it's
144  // children are copied as well.
145  m_drawList.Append( aScreen->m_drawList );
146 
147  // This screen owns the objects now. This prevents the object from being delete when
148  // aSheet is deleted.
149  aScreen->m_drawList.SetOwnership( false );
150 }
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
void SetOwnership(bool Iown)
Function SetOwnership controls whether the list owns the objects and is responsible for deleteing the...
Definition: dlist.h:119
void SCH_SCREEN::Append ( DLIST< SCH_ITEM > &  aList)
inline

Add aList of SCH_ITEM objects to the list for draw items for the sheet.

Parameters
aListA reference to a DLIST containing the SCH_ITEM to add to the sheet.

Definition at line 161 of file class_sch_screen.h.

References DLIST< T >::Append(), and m_modification_sync.

162  {
163  m_drawList.Append( aList );
165  }
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

References EDA_ITEM::Pback.

Referenced by DHEAD::insert(), and DHEAD::remove().

221 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:179
bool SCH_SCREEN::BreakSegment ( const wxPoint aPoint)

Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an intersection is found.

Parameters
aPointTest this point for an intersection.
Returns
True if any wires or buses were broken.

Definition at line 897 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_LINE::HitTest(), DLIST< T >::Insert(), SCH_LINE::IsEndPoint(), LAYER_NOTES, m_drawList, SCH_LINE::Next(), SCH_ITEM::Next(), SCH_LINE, SCH_LINE_T, SCH_LINE::SetEndPoint(), and SCH_LINE::SetStartPoint().

Referenced by BreakSegmentsOnJunctions(), and SCH_EDIT_FRAME::Process_Special_Functions().

898 {
899  SCH_LINE* segment;
900  SCH_LINE* newSegment;
901  bool brokenSegments = false;
902 
903  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
904  {
905  if( (item->Type() != SCH_LINE_T) || (item->GetLayer() == LAYER_NOTES) )
906  continue;
907 
908  segment = (SCH_LINE*) item;
909 
910  if( !segment->HitTest( aPoint, 0 ) || segment->IsEndPoint( aPoint ) )
911  continue;
912 
913  // Break the segment at aPoint and create a new segment.
914  newSegment = new SCH_LINE( *segment );
915  newSegment->SetStartPoint( aPoint );
916  segment->SetEndPoint( aPoint );
917  m_drawList.Insert( newSegment, segment->Next() );
918  item = newSegment;
919  brokenSegments = true;
920  }
921 
922  return brokenSegments;
923 }
T * begin() const
Definition: dlist.h:218
SCH_LINE * Next() const
Definition: sch_line.h:61
SCH_LINEPenStyle
Definition: sch_line.cpp:45
SCH_ITEM * Next() const
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:82
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item...
Definition: sch_line.cpp:641
void SetStartPoint(const wxPoint &aPosition)
Definition: sch_line.h:78
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:69
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void Insert(T *aNewElement, T *aElementAfterMe)
Function Insert puts aNewElement just in front of aElementAfterMe in the list sequence.
Definition: dlist.h:200
bool SCH_SCREEN::BreakSegmentsOnJunctions ( )

Tests all junctions and bus entries in the schematic for intersections with wires and buses and breaks any intersections into multiple segments.

Returns
True if any wires or buses were broken.

Definition at line 926 of file sch_screen.cpp.

References DLIST< T >::begin(), BreakSegment(), SCH_JUNCTION::GetPosition(), SCH_BUS_ENTRY_BASE::GetPosition(), m_drawList, SCH_BUS_ENTRY_BASE::m_End(), SCH_ITEM::Next(), and SCH_JUNCTION_T.

Referenced by GetConnection(), and SCH_EDIT_FRAME::HandleBlockEnd().

927 {
928  bool brokenSegments = false;
929 
930  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
931  {
932  if( item->Type() == SCH_JUNCTION_T )
933  {
934  SCH_JUNCTION* junction = ( SCH_JUNCTION* ) item;
935 
936  if( BreakSegment( junction->GetPosition() ) )
937  brokenSegments = true;
938  }
939  else
940  {
941  SCH_BUS_ENTRY_BASE* busEntry = dynamic_cast<SCH_BUS_ENTRY_BASE*>( item );
942  if( busEntry )
943  {
944  if( BreakSegment( busEntry->GetPosition() )
945  || BreakSegment( busEntry->m_End() ) )
946  brokenSegments = true;
947  }
948  }
949  }
950 
951  return brokenSegments;
952 }
bool BreakSegment(const wxPoint &aPoint)
Checks every wire and bus for a intersection at aPoint and break into two segments at aPoint if an in...
Definition: sch_screen.cpp:897
T * begin() const
Definition: dlist.h:218
wxPoint m_End() const
SCH_ITEM * Next() const
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:41
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:88
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
wxPoint GetPosition() const override
Function GetPosition.
int BASE_SCREEN::BuildGridsChoiceList ( wxArrayString &  aGridsList,
bool  aMmFirst 
) const
inherited

Function BuildGridsChoiceList().

Build the human readable list of grid list, for menus or combo boxes the list shows the grid size both in mils or mm.

Parameters
aGridsList= a wxArrayString to populate
aMmFirst= true to have mm first and mils after false to have mils first and mm after
Returns
the index of the curr grid in list, if found or -1

Definition at line 173 of file base_screen.cpp.

References BASE_SCREEN::GetGridCount(), BASE_SCREEN::GetGridSize(), ID_POPUP_GRID_USER, INCHES, GRID_TYPE::m_CmdId, BASE_SCREEN::m_grids, GRID_TYPE::m_Size, MILLIMETRES, and To_User_Unit().

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), GRID_MENU::GRID_MENU(), and PCB_BASE_FRAME::updateGridSelectBox().

174 {
175  wxString msg;
176  wxRealPoint curr_grid_size = GetGridSize();
177  int idx = -1;
178  int idx_usergrid = -1;
179 
180  for( size_t i = 0; i < GetGridCount(); i++ )
181  {
182  const GRID_TYPE& grid = m_grids[i];
183  double gridValueMils = To_User_Unit( INCHES, grid.m_Size.x ) * 1000;
184  double gridValue_mm = To_User_Unit( MILLIMETRES, grid.m_Size.x );
185 
186  if( grid.m_CmdId == ID_POPUP_GRID_USER )
187  {
188  msg = _( "Custom User Grid" );
189  idx_usergrid = i;
190  }
191  else
192  {
193  if( aMmFirst )
194  msg.Printf( _( "Grid: %.4f mm (%.2f mils)" ),
195  gridValue_mm, gridValueMils );
196  else
197  msg.Printf( _( "Grid: %.2f mils (%.4f mm)" ),
198  gridValueMils, gridValue_mm );
199  }
200 
201  aGridsList.Add( msg );
202 
203  if( curr_grid_size == grid.m_Size )
204  idx = i;
205  }
206 
207  if( idx < 0 )
208  idx = idx_usergrid;
209 
210  return idx;
211 }
size_t GetGridCount() const
Function GetGridCount().
Definition: common.h:144
wxRealPoint m_Size
ID_POPUP_GRID_USER
Definition: draw_frame.cpp:108
GRIDS m_grids
List of valid grid sizes.
Class GRID_TYPE is for grid arrays.
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
double To_User_Unit(EDA_UNITS_T aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:91
bool SCH_SCREEN::CheckIfOnDrawList ( SCH_ITEM st)

Definition at line 199 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, and SCH_ITEM::Next().

Referenced by SCH_EDIT_FRAME::addCurrentItemToList().

200 {
201  SCH_ITEM* itemList = m_drawList.begin();
202 
203  while( itemList )
204  {
205  if( itemList == aItem )
206  return true;
207 
208  itemList = itemList->Next();
209  }
210 
211  return false;
212 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::Clear ( )

Delete all draw items and clears the project settings.

Definition at line 153 of file sch_screen.cpp.

References TITLE_BLOCK::Clear(), FreeDrawList(), BASE_SCREEN::m_NumberOfScreens, BASE_SCREEN::m_ScreenNumber, and m_titles.

Referenced by SCH_EDIT_FRAME::OnCloseWindow().

154 {
155  FreeDrawList();
156 
157  // Clear the project settings
159 
160  m_titles.Clear();
161 }
TITLE_BLOCK m_titles
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:164
void SCH_SCREEN::ClearAnnotation ( SCH_SHEET_PATH aSheetPath)

Clear the annotation for the components in aSheetPath on the screen.

Parameters
aSheetPathThe sheet path of the component annotation to clear. If NULL then the entire hierarchy is cleared.

Definition at line 688 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_COMPONENT::ClearAnnotation(), EDA_ITEM::ClearFlags(), m_drawList, SCH_ITEM::Next(), and SCH_COMPONENT_T.

Referenced by SCH_EDIT_FRAME::DeleteAnnotation().

689 {
690  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
691  {
692  if( item->Type() == SCH_COMPONENT_T )
693  {
694  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
695 
696  component->ClearAnnotation( aSheetPath );
697 
698  // Clear the modified component flag set by component->ClearAnnotation
699  // because we do not use it here and we should not leave this flag set,
700  // when an edition is finished:
701  component->ClearFlags();
702  }
703  }
704 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath)
Clear exiting component annotation.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void BASE_SCREEN::ClearBlockCommand ( )
inlineinherited
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 247 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

247 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void SCH_SCREEN::ClearDrawingState ( )

Clear the state flags of all the items in the screen.

Definition at line 570 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, and SCH_ITEM::Next().

Referenced by AbortCreateNewLine(), GetConnection(), SCH_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::PasteListOfItems(), and SelectBlockItems().

571 {
572  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
573  item->ClearFlags();
574 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 268 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_PART::DeleteSelectedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_EAGLE_PLUGIN::loadSheet(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), LIB_PIN::Save(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

268 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 246 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

246 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void EDA_ITEM::ClearSelected ( )
inlineinherited
void SCH_SCREEN::ClearUndoORRedoList ( UNDO_REDO_CONTAINER aList,
int  aItemCount = -1 
)
overridevirtual

Free the undo or redo list from aList element.

  • Wrappers are deleted.
  • data pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)
Parameters
aList= the UNDO_REDO_CONTAINER to clear
aItemCount= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Implements BASE_SCREEN.

Definition at line 555 of file sch_screen.cpp.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

556 {
557  if( aItemCount == 0 )
558  return;
559 
560  for( auto& command : aList.m_CommandsList )
561  {
562  command->ClearListAndDeleteItems();
563  delete command;
564  }
565 
566  aList.m_CommandsList.clear();
567 }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
void BASE_SCREEN::ClearUndoRedoList ( )
virtualinherited

Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 407 of file base_screen.cpp.

References BASE_SCREEN::ClearUndoORRedoList(), BASE_SCREEN::m_RedoList, and BASE_SCREEN::m_UndoList.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), LIB_EDIT_FRAME::emptyScreen(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), PL_EDITOR_FRAME::OnNewPageLayout(), GBR_SCREEN::~GBR_SCREEN(), PCB_SCREEN::~PCB_SCREEN(), PL_EDITOR_SCREEN::~PL_EDITOR_SCREEN(), and ~SCH_SCREEN().

408 {
411 }
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, TEXTE_PCB, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, LIB_CIRCLE, SCH_MARKER, PCB_TARGET, LIB_BEZIER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 125 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), CopyMarkedItems(), LIB_PART::CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), BOARD::Duplicate(), DuplicateStruct(), ExtractWires(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

126 {
127  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
128  wxT( ". Bad programmer!" ) );
129 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void BASE_SCREEN::ClrSave ( )
inlineinherited

Definition at line 327 of file class_base_screen.h.

Referenced by SCH_EDIT_FRAME::SaveEEFile(), and PCB_EDIT_FRAME::SavePcbFile().

327 { m_FlagSave = false; }
bool m_FlagSave
Indicates automatic file save.
int SCH_SCREEN::CountConnectedItems ( const wxPoint aPos,
bool  aTestJunctions 
) const

Definition at line 670 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_ITEM::IsConnected(), m_drawList, SCH_ITEM::Next(), SCH_JUNCTION_T, and EDA_ITEM::Type().

Referenced by GetConnection().

671 {
672  SCH_ITEM* item;
673  int count = 0;
674 
675  for( item = m_drawList.begin(); item; item = item->Next() )
676  {
677  if( item->Type() == SCH_JUNCTION_T && !aTestJunctions )
678  continue;
679 
680  if( item->IsConnected( aPos ) )
681  count++;
682  }
683 
684  return count;
685 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::DecRefCount ( )

Definition at line 131 of file sch_screen.cpp.

References m_refCount.

Referenced by SCH_SHEET::SetScreen(), and SCH_SHEET::~SCH_SHEET().

132 {
133  wxCHECK_RET( m_refCount != 0,
134  wxT( "Screen reference count already zero. Bad programmer!" ) );
135  m_refCount--;
136 }
int m_refCount
Number of sheets referencing this screen.
void SCH_SCREEN::DeleteItem ( SCH_ITEM aItem)

Removes aItem from the linked list and deletes the object.

If aItem is a schematic sheet label, it is removed from the screen associated with the sheet that contains the label to be deleted.

Parameters
aItemThe schematic object to be deleted from the screen.

Definition at line 176 of file sch_screen.cpp.

References SCH_SHEET_PIN::GetParent(), m_drawList, DLIST< T >::Remove(), SCH_SHEET::RemovePin(), SCH_SHEET_PIN_T, BASE_SCREEN::SetModify(), and EDA_ITEM::Type().

Referenced by SCH_SCREENS::DeleteAllMarkers(), and SchematicCleanUp().

177 {
178  wxCHECK_RET( aItem, wxT( "Cannot delete invalid item from screen." ) );
179 
180  SetModify();
181 
182  if( aItem->Type() == SCH_SHEET_PIN_T )
183  {
184  // This structure is attached to a sheet, get the parent sheet object.
185  SCH_SHEET_PIN* sheetPin = (SCH_SHEET_PIN*) aItem;
186  SCH_SHEET* sheet = sheetPin->GetParent();
187  wxCHECK_RET( sheet,
188  wxT( "Sheet label parent not properly set, bad programmer!" ) );
189  sheet->RemovePin( sheetPin );
190  return;
191  }
192  else
193  {
194  delete m_drawList.Remove( aItem );
195  }
196 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
Definition: sch_sheet.h:159
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
void RemovePin(SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
Definition: sch_sheet.cpp:186
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:61
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
void SCH_SCREEN::Draw ( EDA_DRAW_PANEL aCanvas,
wxDC *  aDC,
GR_DRAWMODE  aDrawMode,
COLOR4D  aColor = COLOR4D::UNSPECIFIED 
)

Draw all the items in the screen to aCanvas.

Note
This function is useful only for schematic. The library editor and library viewer do not use a draw list and therefore draws nothing.
Parameters
aCanvasThe canvas item to draw on.
aDCThe device context to draw on.
aDrawModeThe drawing mode.
aColorThe drawing color.

Definition at line 513 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, SCH_ITEM::Next(), SCH_JUNCTION_T, and UpdateSymbolLinks().

Referenced by SCH_PRINTOUT::DrawPage(), and SCH_EDIT_FRAME::RedrawActiveWindow().

514 {
515  /* note: SCH_SCREEN::Draw is useful only for schematic.
516  * library editor and library viewer do not use m_drawList, and therefore
517  * their SCH_SCREEN::Draw() draws nothing
518  */
519  std::vector< SCH_ITEM* > junctions;
520 
521  // Ensure links are up to date, even if a library was reloaded for some reason:
523 
524  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
525  {
526  if( item->IsMoving() || item->IsResized() )
527  continue;
528 
529  if( item->Type() == SCH_JUNCTION_T )
530  junctions.push_back( item );
531  else
532  // uncomment line below when there is a virtual EDA_ITEM::GetBoundingBox()
533  // if( panel->GetClipBox().Intersects( item->GetBoundingBox() ) )
534  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ), aDrawMode, aColor );
535  }
536 
537  for( auto item : junctions )
538  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ), aDrawMode, aColor );
539 }
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:487
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::ExtractWires ( DLIST< SCH_ITEM > &  aList,
bool  aCreateCopy 
)

Extracts the old wires, junctions and buses.

If aCreateCopy is true, replace extracted items with a copy of the original. Old items are to be put in undo list and the new ones can be modified by clean up safely. If an abort draw segment command is made, the old wires must be put back into m_drawList, and the copies must be deleted. This is because previously stored undo commands can handle pointers on wires or buses, and we do not delete wires or buses, we must put them in undo list. Because cleanup deletes and/or modify bus and wires, it is easier is to put all the existing wires in undo list and use a new copy of wires for cleanup.

Definition at line 253 of file sch_screen.cpp.

References DLIST< T >::Append(), DLIST< T >::begin(), EDA_ITEM::Clone(), DLIST< T >::Insert(), m_drawList, SCH_ITEM::Next(), DLIST< T >::Remove(), SCH_JUNCTION_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::EndSegment(), SCH_EDIT_FRAME::Process_Special_Functions(), and SCH_EDIT_FRAME::PutDataInPreviousState().

254 {
255  SCH_ITEM* item;
256  SCH_ITEM* next_item;
257 
258  for( item = m_drawList.begin(); item; item = next_item )
259  {
260  next_item = item->Next();
261 
262  switch( item->Type() )
263  {
264  case SCH_JUNCTION_T:
265  case SCH_LINE_T:
266  m_drawList.Remove( item );
267  aList.Append( item );
268 
269  if( aCreateCopy )
270  m_drawList.Insert( (SCH_ITEM*) item->Clone(), next_item );
271 
272  break;
273 
274  default:
275  break;
276  }
277  }
278 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void Insert(T *aNewElement, T *aElementAfterMe)
Function Insert puts aNewElement just in front of aElementAfterMe in the list sequence.
Definition: dlist.h:200
void SCH_SCREEN::FreeDrawList ( )

Free all the items from the schematic associated with the screen.

This does not delete any sub hierarchies.

Definition at line 164 of file sch_screen.cpp.

References DHEAD::DeleteAll(), and m_drawList.

Referenced by Clear(), and ~SCH_SCREEN().

165 {
167 }
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:41
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const
inline

Definition at line 120 of file class_sch_screen.h.

References m_aux_origin.

Referenced by SCH_BASE_FRAME::GetAuxOrigin().

120 { return m_aux_origin; }
wxPoint m_aux_origin
Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA.
const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const
virtualinherited

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented in BOARD, D_PAD, SCH_SHEET, LIB_PART, SCH_HIERLABEL, SCH_COMPONENT, SCH_GLOBALLABEL, LIB_ITEM, SCH_LABEL, GERBER_DRAW_ITEM, DIMENSION, DRAWSEGMENT, LIB_FIELD, ZONE_CONTAINER, MODULE, TEXTE_MODULE, SCH_TEXT, TEXTE_PCB, LIB_PIN, TRACK, MARKER_PCB, SCH_LINE, GBR_LAYOUT, LIB_ARC, SCH_FIELD, LIB_TEXT, SCH_BITMAP, PCB_TARGET, SCH_BUS_ENTRY_BASE, LIB_POLYLINE, LIB_BEZIER, LIB_RECTANGLE, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 112 of file base_struct.cpp.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_FRAME::AppendBoardFile(), compareX(), compareY(), SCH_EDIT_FRAME::DeleteItem(), SELECTION_TOOL::findCallback(), getAnchorPoint(), LIB_ITEM::GetBoundingBox(), getRect(), SCH_EAGLE_PLUGIN::loadSheet(), and EDA_ITEM::ViewBBox().

113 {
114 #if defined(DEBUG)
115  printf( "Missing GetBoundingBox()\n" );
116  Show( 0, std::cout ); // tell me which classes still need GetBoundingBox support
117 #endif
118 
119  // return a zero-sized box per default. derived classes should override
120  // this
121  return EDA_RECT( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
122 }
Class EDA_RECT handles the component boundary box.
SCH_LINE* SCH_SCREEN::GetBus ( const wxPoint aPosition,
int  aAccuracy = 0,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)
inline

Definition at line 470 of file class_sch_screen.h.

References GetLine(), and LAYER_BUS.

Referenced by IsTerminalPoint().

472  {
473  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
474  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:989
virtual wxString SCH_SCREEN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from BASE_SCREEN.

Definition at line 108 of file class_sch_screen.h.

109  {
110  return wxT( "SCH_SCREEN" );
111  }
int SCH_SCREEN::GetConnection ( const wxPoint aPosition,
PICKED_ITEMS_LIST aList,
bool  aFullConnection 
)

Adds all of the wires and junctions to aList that make up a connection to the object at aPosition.

Parameters
aPositionThe position of the first connection object in drawing units.
aListThe pick list to add the connect item to.
aFullConnectionIf true all the objects that make up this connection are add to aList. Otherwise, only the objects up to the first node are added.
Returns
The number of items added to aList.

Definition at line 1090 of file sch_screen.cpp.

References DLIST< T >::begin(), BreakSegmentsOnJunctions(), CANDIDATE, ClearDrawingState(), EDA_ITEM::ClearFlags(), CountConnectedItems(), PICKED_ITEMS_LIST::GetCount(), SCH_LINE::GetEndPoint(), EDA_ITEM::GetFlags(), GetNode(), SCH_JUNCTION::GetPosition(), SCH_LINE::GetStartPoint(), GetWireOrBus(), SCH_LINE::IsEndPoint(), m_drawList, MarkConnections(), SCH_ITEM::Next(), EDA_ITEM::Next(), PICKED_ITEMS_LIST::PushItem(), SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SELECTEDNODE, EDA_ITEM::SetFlags(), SKIP_STRUCT, STRUCT_DELETED, EDA_ITEM::Type(), and UR_DELETED.

Referenced by SCH_EDIT_FRAME::DeleteConnection().

1092 {
1093  SCH_ITEM* item;
1094  EDA_ITEM* tmp;
1095  EDA_ITEMS list;
1096 
1097  // Clear flags member for all items.
1100 
1101  if( GetNode( aPosition, list ) == 0 )
1102  return 0;
1103 
1104  for( size_t i = 0; i < list.size(); i++ )
1105  {
1106  item = (SCH_ITEM*) list[ i ];
1108 
1109  /* Put this structure in the picked list: */
1110  ITEM_PICKER picker( item, UR_DELETED );
1111  aList.PushItem( picker );
1112  }
1113 
1114  // Mark all wires, junctions, .. connected to the item(s) found.
1115  if( aFullConnection )
1116  {
1117  SCH_LINE* segment;
1118 
1119  for( item = m_drawList.begin(); item; item = item->Next() )
1120  {
1121  if( !(item->GetFlags() & SELECTEDNODE) )
1122  continue;
1123 
1124  if( item->Type() != SCH_LINE_T )
1125  continue;
1126 
1127  MarkConnections( (SCH_LINE*) item );
1128  }
1129 
1130  // Search all attached wires (i.e wire with one new dangling end )
1131  for( item = m_drawList.begin(); item; item = item->Next() )
1132  {
1133  bool noconnect = false;
1134 
1135  if( item->GetFlags() & STRUCT_DELETED )
1136  continue; // Already seen
1137 
1138  if( !(item->GetFlags() & CANDIDATE) )
1139  continue; // not a candidate
1140 
1141  if( item->Type() != SCH_LINE_T )
1142  continue;
1143 
1144  item->SetFlags( SKIP_STRUCT );
1145 
1146  segment = (SCH_LINE*) item;
1147 
1148  /* If the wire start point is connected to a wire that was already found
1149  * and now is not connected, add the wire to the list. */
1150  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1151  {
1152  // Ensure tmp is a previously deleted segment:
1153  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1154  continue;
1155 
1156  if( tmp->Type() != SCH_LINE_T )
1157  continue;
1158 
1159  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1160 
1161  // Test for segment connected to the previously deleted segment:
1162  if( testSegment->IsEndPoint( segment->GetStartPoint() ) )
1163  break;
1164  }
1165 
1166  // when tmp != NULL, segment is a new candidate:
1167  // put it in deleted list if
1168  // the start point is not connected to an other item (like pin)
1169  if( tmp && !CountConnectedItems( segment->GetStartPoint(), true ) )
1170  noconnect = true;
1171 
1172  /* If the wire end point is connected to a wire that has already been found
1173  * and now is not connected, add the wire to the list. */
1174  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1175  {
1176  // Ensure tmp is a previously deleted segment:
1177  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1178  continue;
1179 
1180  if( tmp->Type() != SCH_LINE_T )
1181  continue;
1182 
1183  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1184 
1185  // Test for segment connected to the previously deleted segment:
1186  if( testSegment->IsEndPoint( segment->GetEndPoint() ) )
1187  break;
1188  }
1189 
1190  // when tmp != NULL, segment is a new candidate:
1191  // put it in deleted list if
1192  // the end point is not connected to an other item (like pin)
1193  if( tmp && !CountConnectedItems( segment->GetEndPoint(), true ) )
1194  noconnect = true;
1195 
1196  item->ClearFlags( SKIP_STRUCT );
1197 
1198  if( noconnect )
1199  {
1200  item->SetFlags( STRUCT_DELETED );
1201 
1202  ITEM_PICKER picker( item, UR_DELETED );
1203  aList.PushItem( picker );
1204 
1205  item = m_drawList.begin();
1206  }
1207  }
1208 
1209  // Get redundant junctions (junctions which connect < 3 end wires
1210  // and no pin)
1211  for( item = m_drawList.begin(); item; item = item->Next() )
1212  {
1213  if( item->GetFlags() & STRUCT_DELETED )
1214  continue;
1215 
1216  if( !(item->GetFlags() & CANDIDATE) )
1217  continue;
1218 
1219  if( item->Type() != SCH_JUNCTION_T )
1220  continue;
1221 
1222  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
1223 
1224  if( CountConnectedItems( junction->GetPosition(), false ) <= 2 )
1225  {
1226  item->SetFlags( STRUCT_DELETED );
1227 
1228  ITEM_PICKER picker( item, UR_DELETED );
1229  aList.PushItem( picker );
1230  }
1231  }
1232 
1233  for( item = m_drawList.begin(); item; item = item->Next() )
1234  {
1235  if( item->GetFlags() & STRUCT_DELETED )
1236  continue;
1237 
1238  if( item->Type() != SCH_LABEL_T )
1239  continue;
1240 
1241  tmp = GetWireOrBus( ( (SCH_TEXT*) item )->GetPosition() );
1242 
1243  if( tmp && tmp->GetFlags() & STRUCT_DELETED )
1244  {
1245  item->SetFlags( STRUCT_DELETED );
1246 
1247  ITEM_PICKER picker( item, UR_DELETED );
1248  aList.PushItem( picker );
1249  }
1250  }
1251  }
1252 
1254 
1255  return aList.GetCount();
1256 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
int CountConnectedItems(const wxPoint &aPos, bool aTestJunctions) const
Definition: sch_screen.cpp:670
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:269
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:138
#define SELECTEDNODE
flag indicating that the structure has already selected
Definition: base_struct.h:135
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:80
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
EDA_ITEM * Next() const
Definition: base_struct.h:220
bool BreakSegmentsOnJunctions()
Tests all junctions and bus entries in the schematic for intersections with wires and buses and break...
Definition: sch_screen.cpp:926
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:137
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:88
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:544
void MarkConnections(SCH_LINE *aSegment)
Add all wires and junctions connected to aSegment which are not connected any component pin to aItemL...
Definition: sch_screen.cpp:307
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:136
int GetNode(const wxPoint &aPosition, EDA_ITEMS &aList)
Return all the items at aPosition that form a node.
Definition: sch_screen.cpp:955
unsigned GetCount() const
Function GetCount.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:69
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
SCH_LINE * GetWireOrBus(const wxPoint &aPosition)
Return a wire or bus item located at aPosition.
Definition: sch_screen.cpp:974
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:570
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 269 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), LIB_EDIT_FRAME::LoadOneSymbol(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

269 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
const GRID_TYPE& BASE_SCREEN::GetGrid ( ) const
inlineinherited

Return the grid object of the currently selected grid.

Returns
GRID_TYPE - The currently selected grid.

Definition at line 417 of file class_base_screen.h.

References BASE_SCREEN::m_Grid.

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), GRID_MENU::GRID_MENU(), PCB_BASE_FRAME::OnUpdateSelectGrid(), and PCB_BASE_FRAME::updateGridSelectBox().

417 { return m_Grid; }
GRID_TYPE m_Grid
Current grid selection.
GRID_TYPE & BASE_SCREEN::GetGrid ( size_t  aIndex)
inherited

Function GetGrid() Returns the grid object at aIndex.

Parameters
aIndex- The grid list index.
Returns
- The grid object at aIndex or the current grid if the grid list is empty.

Definition at line 330 of file base_screen.cpp.

References BASE_SCREEN::m_Grid, and BASE_SCREEN::m_grids.

331 {
332  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
333  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
334 
335  return m_grids[ aIndex ];
336 }
GRID_TYPE m_Grid
Current grid selection.
GRIDS m_grids
List of valid grid sizes.
int BASE_SCREEN::GetGridCmdId ( ) const
inlineinherited

Return the command ID of the currently selected grid.

Returns
int - Currently selected grid command ID.

Definition at line 403 of file class_base_screen.h.

References GRID_TYPE::m_CmdId.

Referenced by PCB_BASE_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::SetNextGrid(), EDA_DRAW_FRAME::SetPrevGrid(), DIALOG_SET_GRID::TransferDataFromWindow(), and GRID_MENU::update().

403 { return m_Grid.m_CmdId; }
GRID_TYPE m_Grid
Current grid selection.
size_t BASE_SCREEN::GetGridCount ( ) const
inlineinherited

Function GetGridCount().

Return the size of the grid list.

Returns
- The size of the grid list.

Definition at line 457 of file class_base_screen.h.

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), BASE_SCREEN::BuildGridsChoiceList(), PCB_BASE_FRAME::OnUpdateSelectGrid(), and PCB_BASE_FRAME::updateGridSelectBox().

457 { return m_grids.size(); }
GRIDS m_grids
List of valid grid sizes.
const GRIDS& BASE_SCREEN::GetGrids ( ) const
inlineinherited

Function GetGrids().

Returns the current list of grids.

Definition at line 472 of file class_base_screen.h.

References BASE_SCREEN::m_grids.

Referenced by LIB_EDIT_FRAME::OnPreferencesOptions(), SCH_EDIT_FRAME::OnPreferencesOptions(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), and EDA_DRAW_FRAME::SetPresetGrid().

473  {
474  return m_grids;
475  }
GRIDS m_grids
List of valid grid sizes.
const wxRealPoint& BASE_SCREEN::GetGridSize ( ) const
inlineinherited
void SCH_SCREEN::GetHierarchicalItems ( EDA_ITEMS aItems)

Add all schematic sheet and component objects in the screen to aItems.

Parameters
aItemsHierarchical item list to fill.

Definition at line 707 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, SCH_ITEM::Next(), SCH_COMPONENT_T, SCH_SHEET_T, and EDA_ITEM::Type().

708 {
709  SCH_ITEM* item = m_drawList.begin();
710 
711  while( item )
712  {
713  if( ( item->Type() == SCH_SHEET_T ) || ( item->Type() == SCH_COMPONENT_T ) )
714  aItems.push_back( item );
715 
716  item = item->Next();
717  }
718 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_ITEM * SCH_SCREEN::GetItem ( const wxPoint aPosition,
int  aAccuracy = 0,
KICAD_T  aType = NOT_USED 
) const

Check aPosition within a distance of aAccuracy for items of type aFilter.

Parameters
aPositionPosition in drawing units.
aAccuracyThe maximum distance within Position to check for an item.
aTypeThe type of item to find or NOT_USED to find any item type.
Returns
The item found that meets the search criteria or NULL if none found.

Definition at line 215 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_COMPONENT::GetField(), SCH_COMPONENT::GetFieldCount(), SCH_SHEET::GetPin(), SCH_FIELD::HitTest(), m_drawList, SCH_ITEM::Next(), NOT_USED, REFERENCE, SCH_COMPONENT_T, SCH_FIELD_T, SCH_SHEET_PIN_T, and SCH_SHEET_T.

Referenced by IsJunctionNeeded(), IsTerminalPoint(), and SCH_EDIT_FRAME::OnLeftClick().

216 {
217  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
218  {
219  if( item->HitTest( aPosition, aAccuracy ) && (aType == NOT_USED) )
220  return item;
221 
222  if( (aType == SCH_FIELD_T) && (item->Type() == SCH_COMPONENT_T) )
223  {
224  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
225 
226  for( int i = REFERENCE; i < component->GetFieldCount(); i++ )
227  {
228  SCH_FIELD* field = component->GetField( i );
229 
230  if( field->HitTest( aPosition, aAccuracy ) )
231  return (SCH_ITEM*) field;
232  }
233  }
234  else if( (aType == SCH_SHEET_PIN_T) && (item->Type() == SCH_SHEET_T) )
235  {
236  SCH_SHEET* sheet = (SCH_SHEET*)item;
237 
238  SCH_SHEET_PIN* label = sheet->GetPin( aPosition );
239 
240  if( label )
241  return (SCH_ITEM*) label;
242  }
243  else if( (item->Type() == aType) && item->HitTest( aPosition, aAccuracy ) )
244  {
245  return item;
246  }
247  }
248 
249  return NULL;
250 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:370
the 3d code uses this value
Definition: typeinfo.h:80
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
Field Reference of part, i.e. "IC21".
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item...
Definition: sch_field.cpp:451
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:61
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
int GetFieldCount() const
Return the number of fields in this symbol.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_TEXT * SCH_SCREEN::GetLabel ( const wxPoint aPosition,
int  aAccuracy = 0 
)

Return a label item located at aPosition.

Parameters
aPositionThe wxPoint to test for label items.
aAccuracyAmount to inflate the item hit test bounding box.
Returns
The SCH_TEXT* of the label item found at aPosition or NULL if item not found.

Definition at line 1023 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, SCH_ITEM::Next(), SCH_GLOBAL_LABEL_T, SCH_HIERARCHICAL_LABEL_T, and SCH_LABEL_T.

Referenced by IsTerminalPoint().

1024 {
1025  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1026  {
1027  switch( item->Type() )
1028  {
1029  case SCH_LABEL_T:
1030  case SCH_GLOBAL_LABEL_T:
1032  if( item->HitTest( aPosition, aAccuracy ) )
1033  return (SCH_TEXT*) item;
1034 
1035  default:
1036  ;
1037  }
1038  }
1039 
1040  return NULL;
1041 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_LINE * SCH_SCREEN::GetLine ( const wxPoint aPosition,
int  aAccuracy = 0,
int  aLayer = LAYER_NOTES,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)

Return a line item located at aPosition.

Parameters
aPositionThe wxPoint to test for a line item.
aAccuracyAmount to inflate the item hit test bounding box.
aLayerThe layer the line is drawn upon.
aSearchTypeAdditional line test criteria.
Returns
The SCH_LINE* of the wire item found at aPosition or NULL if item not found.

Definition at line 989 of file sch_screen.cpp.

References DLIST< T >::begin(), END_POINTS_ONLY_T, ENTIRE_LENGTH_T, EXCLUDE_END_POINTS_T, m_drawList, SCH_ITEM::Next(), and SCH_LINE_T.

Referenced by GetBus(), GetWire(), and IsTerminalPoint().

991 {
992  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
993  {
994  if( item->Type() != SCH_LINE_T )
995  continue;
996 
997  if( item->GetLayer() != aLayer )
998  continue;
999 
1000  if( !item->HitTest( aPosition, aAccuracy ) )
1001  continue;
1002 
1003  switch( aSearchType )
1004  {
1005  case ENTIRE_LENGTH_T:
1006  return (SCH_LINE*) item;
1007 
1008  case EXCLUDE_END_POINTS_T:
1009  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
1010  return (SCH_LINE*) item;
1011  break;
1012 
1013  case END_POINTS_ONLY_T:
1014  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
1015  return (SCH_LINE*) item;
1016  }
1017  }
1018 
1019  return NULL;
1020 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
double BASE_SCREEN::GetMaxAllowedZoom ( ) const
inlineinherited

Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last entry in m_ZoomList.

Definition at line 361 of file class_base_screen.h.

Referenced by BASE_SCREEN::SetLastZoom(), BASE_SCREEN::SetScalingFactor(), and BASE_SCREEN::SetZoom().

361 { return m_ZoomList.size() ? *m_ZoomList.rbegin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
int BASE_SCREEN::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 311 of file class_base_screen.h.

References BASE_SCREEN::m_UndoRedoCountMax.

311 { return m_UndoRedoCountMax; }
int m_UndoRedoCountMax
undo/Redo command Max depth
BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, LIB_ARC, SCH_LINE, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, SCH_BUS_ENTRY_BASE, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 282 of file base_struct.cpp.

References dummy_xpm.

Referenced by FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

283 {
284  return dummy_xpm;
285 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
double BASE_SCREEN::GetMinAllowedZoom ( ) const
inlineinherited

Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the first entry in m_ZoomList.

Definition at line 368 of file class_base_screen.h.

Referenced by BASE_SCREEN::SetFirstZoom(), BASE_SCREEN::SetScalingFactor(), and BASE_SCREEN::SetZoom().

368 { return m_ZoomList.size() ? *m_ZoomList.begin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
virtual void EDA_ITEM::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
inlinevirtualinherited

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented in BOARD, D_PAD, MODULE, SCH_SHEET, SCH_COMPONENT, LIB_ITEM, GERBER_DRAW_ITEM, NETINFO_ITEM, TRACK, DIMENSION, SCH_TEXT, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, ZONE_CONTAINER, EDGE_MODULE, MARKER_PCB, LIB_ARC, LIB_BEZIER, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 291 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), and PCB_BASE_FRAME::UpdateMsgPanel().

292  {
293  }
int SCH_SCREEN::GetNode ( const wxPoint aPosition,
EDA_ITEMS aList 
)

Return all the items at aPosition that form a node.

Parameters
aPositionThe wxPoint to test for node items.
aListA EDA_ITEMS container to place the items found.
Returns
The number of node items found at aPosition.

Definition at line 955 of file sch_screen.cpp.

References DLIST< T >::begin(), LAYER_BUS, LAYER_WIRE, m_drawList, SCH_ITEM::Next(), SCH_JUNCTION_T, and SCH_LINE_T.

Referenced by GetConnection().

956 {
957  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
958  {
959  if( item->Type() == SCH_LINE_T && item->HitTest( aPosition )
960  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
961  {
962  aList.push_back( item );
963  }
964  else if( item->Type() == SCH_JUNCTION_T && item->HitTest( aPosition ) )
965  {
966  aList.push_back( item );
967  }
968  }
969 
970  return (int) aList.size();
971 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
LIB_PIN * SCH_SCREEN::GetPin ( const wxPoint aPosition,
SCH_COMPONENT **  aComponent = NULL,
bool  aEndPointOnly = false 
) const

Test the screen for a component pin item at aPosition.

Parameters
aPositionPosition to test.
aComponentThe component if a pin was found, otherwise NULL.
aEndPointOnlySet to true to test if aPosition is the connection point of the pin.
Returns
The pin item if found, otherwise NULL.

Definition at line 577 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_COMPONENT::GetConvert(), LIB_ITEM::GetConvert(), SCH_COMPONENT::GetDrawItem(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_COMPONENT::GetUnit(), LIB_ITEM::GetUnit(), LIB_PIN_T, m_drawList, SCH_ITEM::Next(), SCH_COMPONENT_T, and EDA_ITEM::Type().

Referenced by IsJunctionNeeded(), IsTerminalPoint(), and MarkConnections().

579 {
580  SCH_ITEM* item;
581  SCH_COMPONENT* component = NULL;
582  LIB_PIN* pin = NULL;
583 
584  for( item = m_drawList.begin(); item; item = item->Next() )
585  {
586  if( item->Type() != SCH_COMPONENT_T )
587  continue;
588 
589  component = (SCH_COMPONENT*) item;
590 
591  if( aEndPointOnly )
592  {
593  pin = NULL;
594 
595  auto part = component->GetPartRef().lock();
596 
597  if( !part )
598  continue;
599 
600  for( pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
601  {
602  // Skip items not used for this part.
603  if( component->GetUnit() && pin->GetUnit() &&
604  ( pin->GetUnit() != component->GetUnit() ) )
605  continue;
606 
607  if( component->GetConvert() && pin->GetConvert() &&
608  ( pin->GetConvert() != component->GetConvert() ) )
609  continue;
610 
611  if(component->GetPinPhysicalPosition( pin ) == aPosition )
612  break;
613  }
614  if( pin )
615  break;
616  }
617  else
618  {
619  pin = (LIB_PIN*) component->GetDrawItem( aPosition, LIB_PIN_T );
620 
621  if( pin )
622  break;
623  }
624  }
625 
626  if( pin && aComponent )
627  *aComponent = component;
628 
629  return pin;
630 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
PART_REF & GetPartRef()
int GetUnit() const
T * begin() const
Definition: dlist.h:218
LIB_ITEM * GetDrawItem(const wxPoint &aPosition, KICAD_T aType=TYPE_NOT_INIT)
Return the component library item at aPosition that is part of this component.
SCH_ITEM * Next() const
int GetConvert() const
wxPoint GetPinPhysicalPosition(LIB_PIN *Pin)
int GetUnit() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
int GetConvert() const
int BASE_SCREEN::GetRedoCommandCount ( ) const
inlineinherited

Definition at line 306 of file class_base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by BASE_SCREEN::PushCommandToRedoList().

307  {
308  return m_RedoList.m_CommandsList.size();
309  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
int SCH_SCREEN::GetRefCount ( ) const
inline

Definition at line 131 of file class_sch_screen.h.

References m_refCount.

Referenced by SCH_SHEET::GetScreenCount(), SCH_SHEET::SetScreen(), and SCH_SHEET::~SCH_SHEET().

131 { return m_refCount; }
int m_refCount
Number of sheets referencing this screen.
double BASE_SCREEN::GetScalingFactor ( ) const
inherited

Function GetScalingFactor returns the inverse of the current scale used to draw items on screen.

This function somehow got designed to be the inverse of SetScalingFactor().

device coordinates = user coordinates * GetScalingFactor()

Definition at line 92 of file base_screen.cpp.

References BASE_SCREEN::GetZoom(), and scale.

Referenced by EDA_DRAW_FRAME::AdjustScrollBars(), EDA_DRAW_PANEL::DoPrepareDC(), BASE_SCREEN::getCrossHairScreenPosition(), EDA_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnPan(), EDA_DRAW_PANEL::OnScroll(), and EDA_DRAW_PANEL::SetClipBox().

93 {
94  double scale = 1.0 / GetZoom();
95  return scale;
96 }
double GetZoom() const
Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device ...
const int scale
wxString EDA_ITEM::GetSelectMenuText ( ) const
virtualinherited

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented in D_PAD, ZONE_CONTAINER, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_LINE, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 175 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

176 {
177  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
178  GetClass() );
179 
180  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
181 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
SCH_SHEET * SCH_SCREEN::GetSheet ( const wxString &  aName)

Returns a sheet object pointer that is named aName.

Note
The screen hierarchy is not descend.
Parameters
aNameis the case insensitive name of the sheet.
Returns
A pointer to the SCH_SHEET object found or NULL.

Definition at line 633 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_SHEET::GetName(), m_drawList, SCH_ITEM::Next(), and SCH_SHEET_T.

Referenced by SCH_EDIT_FRAME::AppendSchematic().

634 {
635  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
636  {
637  if( item->Type() != SCH_SHEET_T )
638  continue;
639 
640  SCH_SHEET* sheet = (SCH_SHEET*) item;
641 
642  if( aName.CmpNoCase( sheet->GetName() ) == 0 )
643  return sheet;
644  }
645 
646  return NULL;
647 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
wxString GetName() const
Definition: sch_sheet.h:267
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_SHEET_PIN * SCH_SCREEN::GetSheetLabel ( const wxPoint aPosition)

Test the screen if aPosition is a sheet label object.

Parameters
aPositionThe position to test.
Returns
The sheet label object if found otherwise NULL.

Definition at line 650 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_SHEET::GetPin(), m_drawList, SCH_ITEM::Next(), and SCH_SHEET_T.

Referenced by IsTerminalPoint().

651 {
652  SCH_SHEET_PIN* sheetPin = NULL;
653 
654  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
655  {
656  if( item->Type() != SCH_SHEET_T )
657  continue;
658 
659  SCH_SHEET* sheet = (SCH_SHEET*) item;
660  sheetPin = sheet->GetPin( aPosition );
661 
662  if( sheetPin )
663  break;
664  }
665 
666  return sheetPin;
667 }
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:370
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:61
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 264 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

264 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:175
const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const
inline
int BASE_SCREEN::GetUndoCommandCount ( ) const
inlineinherited

Definition at line 301 of file class_base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by BASE_SCREEN::PushCommandToUndoList().

302  {
303  return m_UndoList.m_CommandsList.size();
304  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
SCH_LINE* SCH_SCREEN::GetWire ( const wxPoint aPosition,
int  aAccuracy = 0,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)
inline

Definition at line 464 of file class_sch_screen.h.

References GetLine(), and LAYER_WIRE.

Referenced by SCH_EDIT_FRAME::addJunctionMenuEntries(), IsJunctionNeeded(), and IsTerminalPoint().

466  {
467  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
468  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:989
SCH_LINE * SCH_SCREEN::GetWireOrBus ( const wxPoint aPosition)

Return a wire or bus item located at aPosition.

Parameters
aPositionThe wxPoint to test for node items.
Returns
The SCH_LINE* of the wire or bus item found at aPosition or NULL if item not found.

Definition at line 974 of file sch_screen.cpp.

References DLIST< T >::begin(), LAYER_BUS, LAYER_WIRE, m_drawList, SCH_ITEM::Next(), and SCH_LINE_T.

Referenced by SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForWire(), and GetConnection().

975 {
976  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
977  {
978  if( (item->Type() == SCH_LINE_T) && item->HitTest( aPosition )
979  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
980  {
981  return (SCH_LINE*) item;
982  }
983  }
984 
985  return NULL;
986 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
double BASE_SCREEN::GetZoom ( ) const
inlineinherited

Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device unit", or "world units per device unit".

A device unit is typically a pixel.

Definition at line 340 of file class_base_screen.h.

References BASE_SCREEN::m_Zoom.

Referenced by EDA_DRAW_FRAME::AddMenuZoomAndGrid(), PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), BASE_SCREEN::GetScalingFactor(), EDA_DRAW_PANEL::GetZoom(), EDA_DRAW_FRAME::GetZoom(), DIALOG_ERC::OnLeftClickMarkersList(), PCB_BASE_FRAME::OnUpdateSelectZoom(), and ZOOM_MENU::update().

340 { return m_Zoom; }
double m_Zoom
Current zoom coefficient.
bool BASE_SCREEN::GridExists ( int  aCommandId)
inherited

Function GridExists tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.

Parameters
aCommandId= the wxWidgets command ID
Returns
true if the grid exists in grid list.

Definition at line 339 of file base_screen.cpp.

References BASE_SCREEN::m_grids.

Referenced by EDA_DRAW_FRAME::SetNextGrid(), EDA_DRAW_FRAME::SetPresetGrid(), and EDA_DRAW_FRAME::SetPrevGrid().

340 {
341  // tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.
342  for( unsigned i = 0; i < m_grids.size(); i++ )
343  {
344  if( m_grids[i].m_CmdId == aCommandId )
345  return true;
346  }
347 
348  return false;
349 }
GRIDS m_grids
List of valid grid sizes.
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented in D_PAD, MODULE, VIA, SCH_ITEM, BOARD_ITEM, ZONE_CONTAINER, GERBER_DRAW_ITEM, LIB_ITEM, TRACK, DIMENSION, TEXTE_MODULE, DRAWSEGMENT, LIB_FIELD, LIB_PIN, MARKER_PCB, LIB_ARC, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, LIB_BEZIER, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 302 of file base_struct.h.

Referenced by LIB_ITEM::HitTest(), BOARD_ITEM::HitTest(), GERBER_COLLECTOR::Inspect(), and SCH_COLLECTOR::Inspect().

303  {
304  return false; // derived classes should override this function
305  }
void SCH_SCREEN::IncRefCount ( )

Definition at line 125 of file sch_screen.cpp.

References m_refCount.

Referenced by SCH_SHEET::SCH_SHEET(), and SCH_SHEET::SetScreen().

126 {
127  m_refCount++;
128 }
int m_refCount
Number of sheets referencing this screen.
void BASE_SCREEN::InitDataPoints ( const wxSize &  aPageSizeInternalUnits)
inherited

Definition at line 69 of file base_screen.cpp.

References BASE_SCREEN::m_Center, BASE_SCREEN::m_crossHairPosition, BASE_SCREEN::m_DrawOrg, BASE_SCREEN::m_O_Curseur, wxPoint::x, and wxPoint::y.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::LoadSettings(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), PL_EDITOR_FRAME::SetPageSettings(), GERBVIEW_FRAME::SetPageSettings(), and PCB_BASE_FRAME::SetPageSettings().

70 {
71  if( m_Center )
72  {
75 
76  m_DrawOrg.x = -aPageSizeIU.x / 2;
77  m_DrawOrg.y = -aPageSizeIU.y / 2;
78  }
79  else
80  {
81  m_crossHairPosition.x = aPageSizeIU.x / 2;
82  m_crossHairPosition.y = aPageSizeIU.y / 2;
83 
84  m_DrawOrg.x = 0;
85  m_DrawOrg.y = 0;
86  }
87 
88  m_O_Curseur.x = m_O_Curseur.y = 0;
89 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
wxPoint m_O_Curseur
Relative Screen cursor coordinate (on grid) in user units.
bool m_Center
Center on screen.
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
bool BASE_SCREEN::IsBlockActive ( ) const
inlineinherited

Definition at line 499 of file class_base_screen.h.

References BLOCK_SELECTOR::IsIdle().

Referenced by EDA_DRAW_FRAME::CopyToClipboard(), DrawPageOnClipboard(), SCH_EDIT_FRAME::OnCancelCurrentCommand(), EDA_DRAW_PANEL::OnMouseEvent(), LIB_EDIT_FRAME::OnRightClick(), and SCH_EDIT_FRAME::OnRightClick().

499 { return !m_BlockLocate.IsIdle(); }
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
bool IsIdle() const
Function IsIdle returns true if there is currently no block operation in progress.
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 238 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

238 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

References HIGHLIGHTED.

237 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool SCH_SCREEN::IsJunctionNeeded ( const wxPoint aPosition)

Test if a junction is required for the items at aPosition on the screen.

A junction is required at aPosition if the following criteria are satisfied:

  • one wire midpoint, one or more wire endpoints and no junction.
  • three or more wire endpoints and no junction.
  • two wire midpoints and no junction
  • one wire midpoint, a component pin, and no junction.
  • three wire endpoints, a component pin, and no junction.
Parameters
aPositionThe position to test.
Returns
True if a junction is required at aPosition.

Definition at line 349 of file sch_screen.cpp.

References END_POINTS_ONLY_T, EXCLUDE_END_POINTS_T, GetItem(), GetPin(), GetWire(), and SCH_JUNCTION_T.

Referenced by SCH_EDIT_FRAME::EndSegment().

350 {
351  if( GetItem( aPosition, 0, SCH_JUNCTION_T ) )
352  return false;
353 
354  if( GetWire( aPosition, 0, EXCLUDE_END_POINTS_T ) )
355  {
356  if( GetWire( aPosition, 0, END_POINTS_ONLY_T ) )
357  return true;
358 
359  if( GetPin( aPosition, NULL, true ) )
360  return true;
361  }
362 
363  return false;
364 }
SCH_LINE * GetWire(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=NOT_USED) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:215
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:577
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

231 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:123
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
bool BASE_SCREEN::IsModify ( ) const
inlineinherited

Definition at line 328 of file class_base_screen.h.

References BASE_SCREEN::m_FlagModified.

Referenced by PCB_EDIT_FRAME::ExportSpecctraFile(), PL_EDITOR_FRAME::Files_io(), and PL_EDITOR_FRAME::OnFileHistory().

328 { return m_FlagModified; }
bool m_FlagModified
Indicates current drawing has been modified.
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 230 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

230 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 458 of file base_struct.h.

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

458 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 236 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

236 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
bool BASE_SCREEN::IsSave ( ) const
inlineinherited

Definition at line 329 of file class_base_screen.h.

References BASE_SCREEN::m_FlagSave.

329 { return m_FlagSave; }
bool m_FlagSave
Indicates automatic file save.
bool EDA_ITEM::IsSelected ( ) const
inlineinherited
bool SCH_SCREEN::IsTerminalPoint ( const wxPoint aPosition,
int  aLayer 
)

Test if aPosition is a connection point on aLayer.

Parameters
aPositionPosition to test.
aLayerThe layer type to test against. Valid layer types are LAYER_NOTES, LAYER_BUS, and LAYER_WIRE.
Returns
True if Position is a connection point on aLayer.

Definition at line 367 of file sch_screen.cpp.

References GetBus(), GetDefaultLineThickness(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheetLabel(), EDA_TEXT::GetText(), GetWire(), IsBusLabel(), SCH_ITEM::IsConnected(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, max, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_JUNCTION_T, SCH_LABEL_T, and EDA_ITEM::Type().

368 {
369  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
370  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
371 
372  SCH_SHEET_PIN* label;
373  SCH_TEXT* text;
374 
375  switch( aLayer )
376  {
377  case LAYER_BUS:
378 
379  if( GetBus( aPosition ) )
380  return true;
381 
382  label = GetSheetLabel( aPosition );
383 
384  if( label && IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
385  return true;
386 
387  text = GetLabel( aPosition );
388 
389  if( text && IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
390  && (text->Type() != SCH_LABEL_T) )
391  return true;
392 
393  break;
394 
395  case LAYER_NOTES:
396 
397  if( GetLine( aPosition ) )
398  return true;
399 
400  break;
401 
402  case LAYER_WIRE:
404  return true;
405 
406  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
407  return true;
408 
409  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
410  return true;
411 
412  if( GetPin( aPosition, NULL, true ) )
413  return true;
414 
415  if( GetWire( aPosition ) )
416  return true;
417 
418  text = GetLabel( aPosition );
419 
420  if( text && text->IsConnected( aPosition ) && !IsBusLabel( text->GetText() ) )
421  return true;
422 
423  label = GetSheetLabel( aPosition );
424 
425  if( label && label->IsConnected( aPosition ) && !IsBusLabel( label->GetText() ) )
426  return true;
427 
428  break;
429 
430  default:
431  break;
432  }
433 
434  return false;
435 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
bool IsBusLabel(const wxString &aLabel)
Function IsBusLabel test if aLabel has a bus notation.
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i...
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:989
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
SCH_SHEET_PIN * GetSheetLabel(const wxPoint &aPosition)
Test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:650
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:61
SCH_LINE * GetWire(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
SCH_TEXT * GetLabel(const wxPoint &aPosition, int aAccuracy=0)
Return a label item located at aPosition.
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=NOT_USED) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:215
#define max(a, b)
Definition: auxiliary.h:86
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:577
SCH_LINE * GetBus(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

234 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 132 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:178
KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
void SCH_SCREEN::MarkConnections ( SCH_LINE aSegment)

Add all wires and junctions connected to aSegment which are not connected any component pin to aItemList.

Parameters
aSegmentThe segment to test for connections.

Definition at line 307 of file sch_screen.cpp.

References DLIST< T >::begin(), CANDIDATE, SCH_LINE::GetEndPoint(), GetPin(), SCH_JUNCTION::GetPosition(), SCH_LINE::GetStartPoint(), SCH_LINE::IsEndPoint(), m_drawList, SCH_ITEM::Next(), SCH_JUNCTION_T, SCH_LINE_T, EDA_ITEM::SetFlags(), and EDA_ITEM::Type().

Referenced by GetConnection().

308 {
309  wxCHECK_RET( (aSegment) && (aSegment->Type() == SCH_LINE_T),
310  wxT( "Invalid object pointer." ) );
311 
312  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
313  {
314  if( item->GetFlags() & CANDIDATE )
315  continue;
316 
317  if( item->Type() == SCH_JUNCTION_T )
318  {
319  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
320 
321  if( aSegment->IsEndPoint( junction->GetPosition() ) )
322  item->SetFlags( CANDIDATE );
323 
324  continue;
325  }
326 
327  if( item->Type() != SCH_LINE_T )
328  continue;
329 
330  SCH_LINE* segment = (SCH_LINE*) item;
331 
332  if( aSegment->IsEndPoint( segment->GetStartPoint() )
333  && !GetPin( segment->GetStartPoint(), NULL, true ) )
334  {
335  item->SetFlags( CANDIDATE );
336  MarkConnections( segment );
337  }
338 
339  if( aSegment->IsEndPoint( segment->GetEndPoint() )
340  && !GetPin( segment->GetEndPoint(), NULL, true ) )
341  {
342  item->SetFlags( CANDIDATE );
343  MarkConnections( segment );
344  }
345  }
346 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:80
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:137
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:88
void MarkConnections(SCH_LINE *aSegment)
Add all wires and junctions connected to aSegment which are not connected any component pin to aItemL...
Definition: sch_screen.cpp:307
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:69
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:577
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 414 of file base_struct.h.

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), and SCH_SHEET::Matches().

415  {
416  return false;
417  }
bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 184 of file base_struct.cpp.

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:458
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
virtual int BASE_SCREEN::MilsToIuScalar ( )
inlinevirtualinherited

Function MilsToIuScalar returns the scalar required to convert mils to internal units.

Note
This is a temporary hack until the derived objects SCH_SCREEN and PCB_SCREEN no longer need to be derived from BASE_SCREEN. I does allow removal of the obsolete GetInternalUnits function.

Reimplemented in PCB_SCREEN, GBR_SCREEN, and PL_EDITOR_SCREEN.

Definition at line 245 of file class_base_screen.h.

Referenced by DrawPageOnClipboard(), and DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample().

245 { return 1; }
bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 241 of file base_struct.cpp.

References Format(), GetChars(), and EDA_ITEM::GetClass().

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void SCH_SCREEN::Place ( SCH_EDIT_FRAME frame,
wxDC *  DC 
)
inline

Definition at line 204 of file class_sch_screen.h.

204 { };
void SCH_SCREEN::Plot ( PLOTTER aPlotter)

Plot all the schematic objects to aPlotter.

Note
This function is useful only for schematic. The library editor and library viewer do not use a draw list and therefore plots nothing.
Parameters
aPlotterThe plotter object to plot to.

Definition at line 542 of file sch_screen.cpp.

References DLIST< T >::begin(), m_drawList, SCH_ITEM::Next(), PLOTTER::SetCurrentLineWidth(), and UpdateSymbolLinks().

Referenced by DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

543 {
544  // Ensure links are up to date, even if a library was reloaded for some reason:
546 
547  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
548  {
549  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
550  item->Plot( aPlotter );
551  }
552 }
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:487
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
PICKED_ITEMS_LIST * BASE_SCREEN::PopCommandFromRedoList ( )
virtualinherited

PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 448 of file base_screen.cpp.

References BASE_SCREEN::m_RedoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), and SCH_EDIT_FRAME::GetSchematicFromRedoList().

449 {
450  return m_RedoList.PopCommand( );
451 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
PICKED_ITEMS_LIST * BASE_SCREEN::PopCommandFromUndoList ( )
virtualinherited

PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted.

Definition at line 442 of file base_screen.cpp.

References BASE_SCREEN::m_UndoList, and UNDO_REDO_CONTAINER::PopCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_EDIT_FRAME::GetSchematicFromUndoList(), and PL_EDITOR_FRAME::RemoveLastCommandInUndoList().

443 {
444  return m_UndoList.PopCommand( );
445 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::AddAliasOfPart(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_BOARD_EDITOR::DIALOG_MODULE_BOARD_EDITOR(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:144
void BASE_SCREEN::PushCommandToRedoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList)

Definition at line 428 of file base_screen.cpp.

References BASE_SCREEN::ClearUndoORRedoList(), BASE_SCREEN::GetRedoCommandCount(), BASE_SCREEN::m_RedoList, BASE_SCREEN::m_UndoRedoCountMax, and UNDO_REDO_CONTAINER::PushCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), and SCH_EDIT_FRAME::GetSchematicFromUndoList().

429 {
430  m_RedoList.PushCommand( aNewitem );
431 
432  // Delete the extra items, if count max reached
433  if( m_UndoRedoCountMax > 0 )
434  {
435  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
436  if( extraitems > 0 )
437  ClearUndoORRedoList( m_RedoList, extraitems );
438  }
439 }
int m_UndoRedoCountMax
undo/Redo command Max depth
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
int GetRedoCommandCount() const
void BASE_SCREEN::PushCommandToUndoList ( PICKED_ITEMS_LIST aItem)
virtualinherited

Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList)

Definition at line 414 of file base_screen.cpp.

References BASE_SCREEN::ClearUndoORRedoList(), BASE_SCREEN::GetUndoCommandCount(), BASE_SCREEN::m_UndoList, BASE_SCREEN::m_UndoRedoCountMax, and UNDO_REDO_CONTAINER::PushCommand().

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), SCH_EDIT_FRAME::GetSchematicFromRedoList(), PL_EDITOR_FRAME::SaveCopyInUndoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

415 {
416  m_UndoList.PushCommand( aNewitem );
417 
418  // Delete the extra items, if count max reached
419  if( m_UndoRedoCountMax > 0 )
420  {
421  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
422  if( extraitems > 0 )
423  ClearUndoORRedoList( m_UndoList, extraitems );
424  }
425 }
int m_UndoRedoCountMax
undo/Redo command Max depth
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
int GetUndoCommandCount() const
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
void SCH_SCREEN::Remove ( SCH_ITEM aItem)

Remove aItem from the schematic associated with this screen.

Note
The removed item is not deleted. It is only unlinked from the item list.
Parameters
aItemItem to be removed from schematic.

Definition at line 170 of file sch_screen.cpp.

References m_drawList, and DLIST< T >::Remove().

Referenced by SCH_EDIT_FRAME::DeleteCurrentSegment(), SCH_EDIT_FRAME::DeleteItem(), DeleteItemsInList(), ExitSheet(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::PutDataInPreviousState(), and ReplaceWires().

171 {
172  m_drawList.Remove( aItem );
173 }
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 211 of file base_struct.cpp.

References GetChars(), EDA_ITEM::GetClass(), and EDA_ITEM::IsReplaceable().

Referenced by SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:458
const wxString traceFindReplace
Flag to enable find and replace debug tracing.
Definition: base_struct.cpp:58
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 446 of file base_struct.h.

446 { return false; }
void SCH_SCREEN::ReplaceWires ( DLIST< SCH_ITEM > &  aWireList)

Replace all of the wires, buses, and junctions in the screen with aWireList.

Parameters
aWireListList of wires to replace the existing wires with.

Definition at line 281 of file sch_screen.cpp.

References DLIST< T >::Append(), DLIST< T >::begin(), m_drawList, SCH_ITEM::Next(), Remove(), SCH_JUNCTION_T, SCH_LINE_T, and EDA_ITEM::Type().

282 {
283  SCH_ITEM* item;
284  SCH_ITEM* next_item;
285 
286  for( item = m_drawList.begin(); item; item = next_item )
287  {
288  next_item = item->Next();
289 
290  switch( item->Type() )
291  {
292  case SCH_JUNCTION_T:
293  case SCH_LINE_T:
294  Remove( item );
295  delete item;
296  break;
297 
298  default:
299  break;
300  }
301  }
302 
303  m_drawList.Append( aWireList );
304 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
T * begin() const
Definition: dlist.h:218
void Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:170
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
bool SCH_SCREEN::SchematicCleanUp ( )

Perform routine schematic cleaning including breaking wire and buses and deleting identical objects superimposed on top of each other.

Returns
True if any schematic clean up was performed.

Definition at line 438 of file sch_screen.cpp.

References DLIST< T >::begin(), DeleteItem(), m_drawList, SCH_LINE::MergeOverlap(), SCH_ITEM::Next(), SCH_JUNCTION_T, SCH_LINE_T, EDA_ITEM::SetFlags(), and TestDanglingEnds().

Referenced by SCH_EDIT_FRAME::AddNoConnect(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_FRAME::EndSegment(), and SCH_EDIT_FRAME::rescueProject().

439 {
440  bool modified = false;
441 
442  for( SCH_ITEM* item = m_drawList.begin() ; item; item = item->Next() )
443  {
444  if( ( item->Type() != SCH_LINE_T ) && ( item->Type() != SCH_JUNCTION_T ) )
445  continue;
446 
447  bool restart;
448 
449  for( SCH_ITEM* testItem = item->Next(); testItem; testItem = restart ? m_drawList.begin() : testItem->Next() )
450  {
451  restart = false;
452 
453  if( ( item->Type() == SCH_LINE_T ) && ( testItem->Type() == SCH_LINE_T ) )
454  {
455  SCH_LINE* line = (SCH_LINE*) item;
456 
457  if( line->MergeOverlap( (SCH_LINE*) testItem ) )
458  {
459  // Keep the current flags, because the deleted segment can be flagged.
460  item->SetFlags( testItem->GetFlags() );
461  DeleteItem( testItem );
462  restart = true;
463  modified = true;
464  }
465  }
466  else if ( ( ( item->Type() == SCH_JUNCTION_T )
467  && ( testItem->Type() == SCH_JUNCTION_T ) ) && ( testItem != item ) )
468  {
469  if ( testItem->HitTest( item->GetPosition() ) )
470  {
471  // Keep the current flags, because the deleted segment can be flagged.
472  item->SetFlags( testItem->GetFlags() );
473  DeleteItem( testItem );
474  restart = true;
475  modified = true;
476  }
477  }
478  }
479  }
480 
482 
483  return modified;
484 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
bool MergeOverlap(SCH_LINE *aLine)
Check line against aLine to see if it overlaps and merge if it does.
Definition: sch_line.cpp:355
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
void DeleteItem(SCH_ITEM *aItem)
Removes aItem from the linked list and deletes the object.
Definition: sch_screen.cpp:176
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
Definition: sch_screen.cpp:876
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::SelectBlockItems ( )

Create a list of items found when a block command is initiated.

The items selected depend on the block command. If the drag block command is issued, then any items connected to items in the block are also selected.

Definition at line 721 of file sch_screen.cpp.

References addConnectedItemsToBlock(), ClearDrawingState(), PICKED_ITEMS_LIST::GetCount(), EDA_ITEM::GetFlags(), BLOCK_SELECTOR::GetItems(), PICKED_ITEMS_LIST::GetPickedItem(), EDA_RECT::Inflate(), IS_DRAGGED, SCH_ITEM::IsConnectable(), BLOCK_SELECTOR::IsDragging(), EDA_ITEM::IsSelected(), SCH_ITEM::IsSelectStateChanged(), BASE_SCREEN::m_BlockLocate, SCH_COMPONENT_T, SCH_LINE_T, SELECTED, EDA_ITEM::SetFlags(), PICKED_ITEMS_LIST::SetPickerFlags(), SKIP_STRUCT, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::HandleBlockEnd().

722 {
723  auto addConnections = [ this ]( SCH_ITEM* item ) -> void
724  {
725  std::vector< wxPoint > connections;
726  item->GetConnectionPoints( connections );
727  for( auto conn : connections )
728  addConnectedItemsToBlock( conn );
729  };
730 
731  PICKED_ITEMS_LIST* pickedlist = &m_BlockLocate.GetItems();
732 
733  if( pickedlist->GetCount() == 0 )
734  return;
735 
737 
738  for( unsigned ii = 0; ii < pickedlist->GetCount(); ii++ )
739  {
740  SCH_ITEM* item = (SCH_ITEM*) pickedlist->GetPickedItem( ii );
741  item->SetFlags( SELECTED );
742  }
743 
744  if( !m_BlockLocate.IsDragging() )
745  return;
746 
747  // Select all the items in the screen connected to the items in the block.
748  // be sure end lines that are on the block limits are seen inside this block
749  m_BlockLocate.Inflate( 1 );
750  unsigned last_select_id = pickedlist->GetCount();
751 
752  for( unsigned ii = 0; ii < last_select_id; ii++ )
753  {
754  SCH_ITEM* item = (SCH_ITEM*)pickedlist->GetPickedItem( ii );
755  item->SetFlags( IS_DRAGGED );
756 
757  if( item->Type() == SCH_LINE_T )
758  {
760 
761  if( !item->IsSelected() )
762  { // This is a special case:
763  // this selected wire has no ends in block.
764  // But it was selected (because it intersects the selecting area),
765  // so we must keep it selected and select items connected to it
766  // Note: an other option could be: remove it from drag list
767  item->SetFlags( SELECTED | SKIP_STRUCT );
768  addConnections( item );
769  }
770 
771  pickedlist->SetPickerFlags( item->GetFlags(), ii );
772  }
773  else if( item->IsConnectable() )
774  {
775  addConnections( item );
776  }
777  }
778 
779  // Select the items that are connected to a component that was added
780  // to our selection list in the last step.
781  for( unsigned ii = last_select_id; ii < pickedlist->GetCount(); ii++ )
782  {
783  SCH_ITEM* item = (SCH_ITEM*)pickedlist->GetPickedItem( ii );
784 
785  if( item->Type() == SCH_COMPONENT_T )
786  {
787  item->SetFlags( IS_DRAGGED );
788  addConnections( item );
789  }
790  }
791 
792  m_BlockLocate.Inflate( -1 );
793 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:269
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:138
bool IsSelected() const
Definition: base_struct.h:235
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:129
#define SELECTED
Definition: base_struct.h:134
void addConnectedItemsToBlock(const wxPoint &aPosition)
Add items connected at aPosition to the block pick list.
Definition: sch_screen.cpp:796
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
virtual bool IsConnectable() const
Function IsConnectable returns true if the schematic item can connect to another schematic item...
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
bool SetPickerFlags(STATUS_FLAGS aFlags, unsigned aIdx)
Function SetPickerFlags set the flags of the picker (usually to the picked item m_Flags value) ...
unsigned GetCount() const
Function GetCount.
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Function GetPickedItem.
virtual bool IsSelectStateChanged(const wxRect &aRect)
Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed...
bool IsDragging() const
Function IsDragging returns true if the current block command is a drag operation.
PICKED_ITEMS_LIST & GetItems()
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:570
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
void SCH_SCREEN::SetAuxOrigin ( const wxPoint aPosition)
inline

Definition at line 121 of file class_sch_screen.h.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

121 { m_aux_origin = aPosition; }
wxPoint m_aux_origin
Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA.
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 226 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

226 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:179
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 243 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

243 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
bool SCH_SCREEN::SetComponentFootprint ( SCH_SHEET_PATH aSheetPath,
const wxString &  aReference,
const wxString &  aFootPrint,
bool  aSetVisible 
)

Search this screen for a symbol with aReference and set the footprint field to aFootPrint if found.

Parameters
aSheetPathThe sheet path used to look up the reference designator.
aReferenceThe reference designator of the component.
aFootPrintThe value to set the footprint field.
aSetVisibleThe value to set the field visibility flag.
Returns
True if aReference was found otherwise false.

Definition at line 1044 of file sch_screen.cpp.

References DLIST< T >::begin(), FOOTPRINT, SCH_COMPONENT::GetField(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetRef(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), m_drawList, SCH_ITEM::Next(), EDA_TEXT::Offset(), SCH_COMPONENT_T, EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVisible(), and VALUE.

Referenced by SCH_SHEET_PATH::SetComponentFootprint().

1046 {
1047  SCH_COMPONENT* component;
1048  bool found = false;
1049 
1050  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1051  {
1052  if( item->Type() != SCH_COMPONENT_T )
1053  continue;
1054 
1055  component = (SCH_COMPONENT*) item;
1056 
1057  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
1058  {
1059  // Found: Init Footprint Field
1060 
1061  /* Give a reasonable value to the field position and
1062  * orientation, if the text is empty at position 0, because
1063  * it is probably not yet initialized
1064  */
1065  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
1066  if( fpfield->GetText().IsEmpty()
1067  && ( fpfield->GetTextPos() == component->GetPosition() ) )
1068  {
1069  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
1070  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
1071  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
1072 
1073  if( fpfield->GetTextAngle() == 0.0 )
1074  fpfield->Offset( wxPoint( 0, 100 ) );
1075  else
1076  fpfield->Offset( wxPoint( 100, 0 ) );
1077  }
1078 
1079  fpfield->SetText( aFootPrint );
1080  fpfield->SetVisible( aSetVisible );
1081 
1082  found = true;
1083  }
1084  }
1085 
1086  return found;
1087 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:156
Class SCH_FIELD instances are attached to a component and provide a place for the component's value...
Definition: sch_field.h:56
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:229
const wxPoint & GetTextPos() const
Definition: eda_text.h:224
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:223
void SetVisible(bool aVisible)
Definition: eda_text.h:175
T * begin() const
Definition: dlist.h:218
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:214
SCH_ITEM * Next() const
Field Name Module PCB, i.e. "16DIP300".
double GetTextAngle() const
Definition: eda_text.h:164
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
wxPoint GetPosition() const override
Function GetPosition.
const wxSize & GetTextSize() const
Definition: eda_text.h:215
#define VALUE
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual void SetText(const wxString &aText)
Definition: eda_text.h:141
void SCH_SCREEN::SetCurItem ( SCH_ITEM aItem)
inline

Sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from SCH_ITEM

Definition at line 179 of file class_sch_screen.h.

References BASE_SCREEN::SetCurItem().

Referenced by AbortCreateNewLine(), abortMoveBitmap(), abortMoveItem(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::DeleteCurrentSegment(), SCH_EDIT_FRAME::DeleteItemAtCrossHair(), SCH_EDIT_FRAME::EditSheetPin(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), LIB_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::LocateItem(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnEditItem(), SCH_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnOrient(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OrientComponent(), SCH_FIELD::Place(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::Process_Special_Functions(), and UpdatePickList().

179 { BASE_SCREEN::SetCurItem( (EDA_ITEM*) aItem ); }
void SetCurItem(EDA_ITEM *aItem)
Function SetCurItem sets the currently selected object, m_CurrentItem.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
void BASE_SCREEN::SetCurItem ( EDA_ITEM aItem)
inlineinherited

Function SetCurItem sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from EDA_ITEM

Definition at line 231 of file class_base_screen.h.

Referenced by Abort_Move_ModuleOutline(), AbortBlockCurrentCommand(), AbortMoveTextModule(), BASE_SCREEN::BASE_SCREEN(), GERBVIEW_FRAME::OnLeftClick(), GERBVIEW_FRAME::OnRightClick(), PL_EDITOR_SCREEN::SetCurItem(), PCB_SCREEN::SetCurItem(), GERBVIEW_FRAME::SetCurItem(), and SetCurItem().

231 { m_CurrentItem = aItem; }
EDA_ITEM * m_CurrentItem
Currently selected object.
void SCH_SCREEN::SetFileName ( const wxString &  aFileName)
inline
bool BASE_SCREEN::SetFirstZoom ( )
inherited

Definition at line 108 of file base_screen.cpp.

References BASE_SCREEN::GetMinAllowedZoom(), and BASE_SCREEN::SetZoom().

109 {
110  return SetZoom( GetMinAllowedZoom() );
111 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 267 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), addConnectedItemsToBlock(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_PART::CopySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::EditDimension(), LIB_PIN::EnableEditMode(), PCB_EDIT_FRAME::FlipTextePcb(), GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), PCB_BASE_FRAME::LoadModuleFromLibrary(), MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SchematicCleanUp(), SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

267 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 279 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

279 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:186
int BASE_SCREEN::SetGrid ( const wxRealPoint &  size)
inherited

set the current grid size m_Grid.

The size must be existing in grid list (in m_grids) If not, the near existing grid size is used

Parameters
size= the size of the new grid
Returns
the grid id offset (id from ID_POPUP_GRID_LEVEL_1000 ) of the currently selected grid.

Definition at line 223 of file base_screen.cpp.

References ID_POPUP_GRID_LEVEL_1000, BASE_SCREEN::m_Grid, BASE_SCREEN::m_grids, and GRID_TYPE::m_Size.

Referenced by SCH_EDIT_FRAME::AppendSchematic(), SCH_EDIT_FRAME::DisplayCurrentSheet(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::ImportFile(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), LIB_EDIT_FRAME::OnPreferencesOptions(), SCH_EDIT_FRAME::OnPreferencesOptions(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), EDA_DRAW_FRAME::SetPresetGrid(), and DIALOG_SET_GRID::TransferDataFromWindow().

224 {
225  wxASSERT( !m_grids.empty() );
226 
227  GRID_TYPE nearest_grid = m_grids[0];
228  int gridIdx = 0;
229 
230  for( unsigned i = 0; i < m_grids.size(); i++ )
231  {
232  if( m_grids[i].m_Size == size )
233  {
234  m_Grid = m_grids[i];
235  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
236  }
237 
238  // keep track of the nearest larger grid size, if the exact size is not found
239  if ( size.x < m_grids[i].m_Size.x )
240  {
241  gridIdx = m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
242  nearest_grid = m_grids[i];
243  }
244  }
245 
246  m_Grid = nearest_grid;
247 
248  wxLogWarning( wxT( "Grid size( %f, %f ) not in grid list, falling back " ) \
249  wxT( "to grid size( %f, %f )." ),
250  size.x, size.y, m_Grid.m_Size.x, m_Grid.m_Size.y );
251 
252  return gridIdx;
253 }
GRID_TYPE m_Grid
Current grid selection.
wxRealPoint m_Size
GRIDS m_grids
List of valid grid sizes.
Class GRID_TYPE is for grid arrays.
int BASE_SCREEN::SetGrid ( int  aCommandId)
inherited

Function SetGrid sets the grid size from command ID (not an index in grid list, but a wxID).

Parameters
aCommandId= the wxWidgets command ID
Returns
the grid id offset (id from ID_POPUP_GRID_LEVEL_1000 ) of the currently selected grid.

Definition at line 256 of file base_screen.cpp.

References ID_POPUP_GRID_LEVEL_1000, BASE_SCREEN::m_Grid, BASE_SCREEN::m_grids, and GRID_TYPE::m_Size.

257 {
258  wxASSERT( !m_grids.empty() );
259 
260  for( unsigned i = 0; i < m_grids.size(); i++ )
261  {
262  if( m_grids[i].m_CmdId == aCommandId )
263  {
264  m_Grid = m_grids[i];
265  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
266  }
267  }
268 
269  m_Grid = m_grids[0];
270 
271  wxLogWarning( wxT( "Grid ID %d not in grid list, falling back to " ) \
272  wxT( "grid size( %g, %g )." ), aCommandId,
273  m_Grid.m_Size.x, m_Grid.m_Size.y );
274 
275  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
276 }
GRID_TYPE m_Grid
Current grid selection.
wxRealPoint m_Size
GRIDS m_grids
List of valid grid sizes.
void BASE_SCREEN::SetGridList ( GRIDS sizelist)
inherited

Definition at line 214 of file base_screen.cpp.

References BASE_SCREEN::m_grids.

215 {
216  if( !m_grids.empty() )
217  m_grids.clear();
218 
219  m_grids = gridlist;
220 }
GRIDS m_grids
List of valid grid sizes.
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 242 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

242 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_player.h:85
const char * name
bool BASE_SCREEN::SetLastZoom ( )
inherited

Definition at line 114 of file base_screen.cpp.

References BASE_SCREEN::GetMaxAllowedZoom(), and BASE_SCREEN::SetZoom().

115 {
116  return SetZoom( GetMaxAllowedZoom() );
117 }
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 228 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), DHEAD::remove(), and SwapItemData().

228 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:180
void BASE_SCREEN::SetMaxUndoItems ( int  aMax)
inlineinherited

Definition at line 313 of file class_base_screen.h.

References ABS_MAX_UNDO_ITEMS, and DEFAULT_MAX_UNDO_ITEMS.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::EditSheet(), and LIB_EDIT_FRAME::LIB_EDIT_FRAME().

314  {
315  if( aMax >= 0 && aMax < ABS_MAX_UNDO_ITEMS )
316  m_UndoRedoCountMax = aMax;
317  else
318  {
319  wxFAIL_MSG( "Maximum undo items not within limits" );
321  }
322  }
int m_UndoRedoCountMax
undo/Redo command Max depth
#define DEFAULT_MAX_UNDO_ITEMS
Definition: draw_frame.h:46
#define ABS_MAX_UNDO_ITEMS
Definition: draw_frame.h:47
void EDA_ITEM::SetModified ( )
inherited
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 225 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), DHEAD::remove(), and SwapItemData().

225 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:178
bool BASE_SCREEN::SetNextZoom ( )
inherited

Definition at line 139 of file base_screen.cpp.

References BASE_SCREEN::m_Zoom, BASE_SCREEN::m_ZoomList, and BASE_SCREEN::SetZoom().

Referenced by EDA_DRAW_FRAME::OnZoom(), and EDA_DRAW_FRAME::SetNextZoom().

140 {
141  for( unsigned i=0; i < m_ZoomList.size(); ++i )
142  {
143  if( m_Zoom < m_ZoomList[i] )
144  {
145  SetZoom( m_ZoomList[i] );
146  return true;
147  }
148  }
149 
150  return false;
151 }
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double m_Zoom
Current zoom coefficient.
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
void SCH_SCREEN::SetPageSettings ( const PAGE_INFO aPageSettings)
inline

Definition at line 114 of file class_sch_screen.h.

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), and SCH_BASE_FRAME::SetPageSettings().

114 { m_paper = aPageSettings; }
PAGE_INFO m_paper
The size of the paper to print or plot on.
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 227 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_MODULE_BOARD_EDITOR::OnEditReference(), DIALOG_MODULE_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

227 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:182
bool BASE_SCREEN::SetPreviousZoom ( )
inherited

Definition at line 154 of file base_screen.cpp.

References BASE_SCREEN::m_Zoom, BASE_SCREEN::m_ZoomList, and BASE_SCREEN::SetZoom().

Referenced by EDA_DRAW_FRAME::OnZoom(), and EDA_DRAW_FRAME::SetPrevZoom().

155 {
156  for( unsigned i = m_ZoomList.size(); i != 0; --i )
157  {
158  if( m_Zoom > m_ZoomList[i - 1] )
159  {
160  SetZoom( m_ZoomList[i - 1] );
161  return true;
162  }
163  }
164 
165  return false;
166 }
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double m_Zoom
Current zoom coefficient.
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
void BASE_SCREEN::SetSave ( )
inlineinherited

Definition at line 326 of file class_base_screen.h.

Referenced by PCB_BASE_FRAME::OnModify().

326 { m_FlagSave = true; }
bool m_FlagSave
Indicates automatic file save.
void BASE_SCREEN::SetScalingFactor ( double  iu_per_du)
inherited

Function SetScalingFactor sets the scaling factor of "internal unit per device unit".

If the output device is a screen, then "device units" are pixels. The "logical unit" is wx terminology, and corresponds to KiCad's "Internal Unit (IU)".

This scaling factor is "internal units per device unit". This function is the same thing currently as SetZoom(), but clamps the argument within a legal range.

Parameters
iu_per_duis the current scale used to draw items onto the device context wxDC.

Definition at line 99 of file base_screen.cpp.

References Clamp(), BASE_SCREEN::GetMaxAllowedZoom(), BASE_SCREEN::GetMinAllowedZoom(), and BASE_SCREEN::SetZoom().

Referenced by EDA_DRAW_FRAME::Window_Zoom(), and EDA_DRAW_FRAME::Zoom_Automatique().

100 {
101  // Limit zoom to max and min allowed values:
102  double zoom = Clamp( GetMinAllowedZoom(), aScale, GetMaxAllowedZoom() );
103 
104  SetZoom( zoom );
105 }
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: macros.h:127
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 241 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::pasteClipboard(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::selectVisually().

241 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( time_t  aNewTimeStamp)
inlineinherited

Definition at line 217 of file base_struct.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DIALOG_MODULE_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), PCB_BASE_FRAME::LoadModuleFromLibrary(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), SCH_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), and TestDuplicateSheetNames().

217 { m_TimeStamp = aNewTimeStamp; }
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:183
void SCH_SCREEN::SetTitleBlock ( const TITLE_BLOCK aTitleBlock)
inline
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 240 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

240 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:267
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
bool BASE_SCREEN::SetZoom ( double  iu_per_du)
inherited

Function SetZoom adjusts the current zoom factor.

Parameters
iu_per_duis the number of internal units (world units) per device units (pixels typically).

Definition at line 120 of file base_screen.cpp.

References BASE_SCREEN::GetMaxAllowedZoom(), BASE_SCREEN::GetMinAllowedZoom(), and BASE_SCREEN::m_Zoom.

Referenced by PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), SCH_EDIT_FRAME::FindComponentAndItem(), GBR_SCREEN::GBR_SCREEN(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_EDIT_FRAME::OnFindDrcMarker(), EDA_DRAW_FRAME::OnSelectZoom(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), BASE_SCREEN::SetFirstZoom(), BASE_SCREEN::SetLastZoom(), BASE_SCREEN::SetNextZoom(), EDA_DRAW_FRAME::SetPresetZoom(), BASE_SCREEN::SetPreviousZoom(), BASE_SCREEN::SetScalingFactor(), and EDA_DRAW_PANEL::SetZoom().

121 {
122  if( iu_per_du == m_Zoom )
123  return false;
124 
125  //wxLogDebug( "Zoom:%.16g 1/Zoom:%.16g", iu_per_du, 1/iu_per_du );
126 
127  if( iu_per_du < GetMinAllowedZoom() )
128  return false;
129 
130  if( iu_per_du > GetMaxAllowedZoom() )
131  return false;
132 
133  m_Zoom = iu_per_du;
134 
135  return true;
136 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
double m_Zoom
Current zoom coefficient.
static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 477 of file base_struct.h.

Referenced by PART_LIB::GetEntryTypePowerNames().

477 { return *aLeft < *aRight; }
bool SCH_SCREEN::TestDanglingEnds ( )

Test all of the connectable objects in the schematic for unused connection points.

Returns
True if any connection state changes were made.

Definition at line 876 of file sch_screen.cpp.

References DLIST< T >::begin(), SCH_ITEM::GetEndPoints(), SCH_ITEM::IsDanglingStateChanged(), m_drawList, and SCH_ITEM::Next().

Referenced by SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::DeleteItemAtCrossHair(), SCH_EDIT_FRAME::GetSchematicFromRedoList(), SCH_EDIT_FRAME::GetSchematicFromUndoList(), SCH_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::ImportFile(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::RepeatDrawItem(), SchematicCleanUp(), and SCH_EDIT_FRAME::SetBusEntryShape().

877 {
878  SCH_ITEM* item;
879  std::vector< DANGLING_END_ITEM > endPoints;
880  bool hasStateChanged = false;
881 
882  for( item = m_drawList.begin(); item; item = item->Next() )
883  item->GetEndPoints( endPoints );
884 
885  for( item = m_drawList.begin(); item; item = item->Next() )
886  {
887  if( item->IsDanglingStateChanged( endPoints ) )
888  {
889  hasStateChanged = true;
890  }
891  }
892 
893  return hasStateChanged;
894 }
virtual void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList)
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points...
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
virtual bool IsDanglingStateChanged(std::vector< DANGLING_END_ITEM > &aItemList)
Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state...
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 212 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), HIERARCHY_NAVIG_DLG::BuildTree(), calcArea(), calcMaxArea(), DIALOG_EXCHANGE_MODULE::changeAllFootprints(), DIALOG_EXCHANGE_MODULE::changeSameFootprints(), SCH_SCREENS::ChangeSymbolLibNickname(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), CountConnectedItems(), SCH_SHEET::CountSheets(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), DeleteItem(), LIB_EDIT_FRAME::deleteItem(), deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteItemsInList(), DeleteNullTrackSegments(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), ExtractWires(), DRC::fillMarker(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), POINT_EDITOR::finishItem(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), NETLIST_OBJECT::GetComponentParent(), GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsDraggableJunction(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), LIB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), ReplaceWires(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), CN_CONNECTIVITY_ALGO::searchConnections(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_NO_CONNECT::SwapData(), SCH_JUNCTION::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), ZONE_CONTAINER::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), TraceSegmentPcb(), TRACK::TransformShapeWithClearanceToPolygon(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

213  {
214  return m_StructType;
215  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:174
int SCH_SCREEN::UpdatePickList ( )

Add all the items in the screen within the block selection rectangle to the pick list.

Returns
The number of items in the pick list.

Definition at line 840 of file sch_screen.cpp.

References DLIST< T >::begin(), BLOCK_SELECTOR::GetCount(), BLOCK_SELECTOR::GetItem(), EDA_RECT::GetOrigin(), EDA_RECT::GetSize(), BASE_SCREEN::m_BlockLocate, m_drawList, SCH_ITEM::Next(), EDA_RECT::Normalize(), BLOCK_SELECTOR::PushItem(), SetCurItem(), ITEM_PICKER::SetItem(), EDA_RECT::SetOrigin(), and EDA_RECT::SetSize().

Referenced by SCH_EDIT_FRAME::HandleBlockEnd().

841 {
842  ITEM_PICKER picker;
843  EDA_RECT area;
844  unsigned count;
845 
847  area.SetSize( m_BlockLocate.GetSize() );
848  area.Normalize();
849 
850  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
851  {
852  // An item is picked if its bounding box intersects the reference area.
853  if( item->HitTest( area ) )
854  {
855  picker.SetItem( item );
856  m_BlockLocate.PushItem( picker );
857  }
858  }
859 
860  // if the block is composed of one item,
861  // select it as the current item
862  count = m_BlockLocate.GetCount();
863  if( count == 1 )
864  {
866  }
867  else
868  {
869  SetCurItem( NULL );
870  }
871 
872  return count;
873 }
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
void SetOrigin(const wxPoint &pos)
T * begin() const
Definition: dlist.h:218
EDA_ITEM * GetItem(unsigned aIndex)
SCH_ITEM * Next() const
const wxPoint & GetOrigin() const
void SetItem(EDA_ITEM *aItem)
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
void Normalize()
Function Normalize ensures that the height ant width are positive.
void SetSize(const wxSize &size)
void SetCurItem(SCH_ITEM *aItem)
Sets the currently selected object, m_CurrentItem.
Class EDA_RECT handles the component boundary box.
const wxSize & GetSize() const
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
unsigned GetCount() const
void PushItem(ITEM_PICKER &aItem)
Function PushItem adds aItem to the list of items.
void SCH_SCREEN::UpdateSymbolLinks ( bool  aForce = false)

Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawList.

It must be called from:

  • Draw function
  • when loading a schematic file
  • before creating a netlist (in case a library is modified)
  • whenever a symbol library is modified
Parameters
aForcetrue forces a refresh even if the library modification has hasn't changed.

Definition at line 487 of file sch_screen.cpp.

References SCH_TYPE_COLLECTOR::Collect(), SCH_COLLECTOR::ComponentsOnly, DHEAD::GetCount(), GetDrawItems(), SYMBOL_LIB_TABLE::GetModifyHash(), m_drawList, m_modification_sync, KIWAY_HOLDER::Prj(), and SCH_COMPONENT::ResolveAll().

Referenced by Draw(), and Plot().

488 {
489  // Initialize or reinitialize the pointer to the LIB_PART for each component
490  // found in m_drawList, but only if needed (change in lib or schematic)
491  // therefore the calculation time is usually very low.
492 
493  if( m_drawList.GetCount() )
494  {
495  SYMBOL_LIB_TABLE* libs =