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
 Function GetDrawItems(). More...
 
void Append (SCH_ITEM *aItem)
 
void Append (DLIST< SCH_ITEM > &aList)
 Function Append adds aList of SCH_ITEM objects to the list for draw items for the sheet. More...
 
SCH_ITEMGetCurItem () const
 Function GetCurItem returns the currently selected SCH_ITEM, overriding BASE_SCREEN::GetCurItem(). More...
 
void SetCurItem (SCH_ITEM *aItem)
 Function SetCurItem sets the currently selected object, m_CurrentItem. More...
 
void Clear ()
 Function Clear deletes 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
 Function GetItem checks aPosition within a distance of aAccuracy for items of type aFilter. More...
 
void Place (SCH_EDIT_FRAME *frame, wxDC *DC)
 
void CheckComponentsToPartsLinks ()
 Function CheckComponentsToPartsLink initializes or reinitializes 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)
 Function Draw draws all the items in the screen to aCanvas. More...
 
void Plot (PLOTTER *aPlotter)
 Function Plot plots all the schematic objects to aPlotter. More...
 
void Remove (SCH_ITEM *aItem)
 Function Remove removes aItem from the schematic associated with this screen. More...
 
void DeleteItem (SCH_ITEM *aItem)
 Function DeleteItem removes aItem from the linked list and deletes the object. More...
 
bool CheckIfOnDrawList (SCH_ITEM *st)
 
bool SchematicCleanUp ()
 Function SchematicCleanUp performs routine schematic cleaning including breaking wire and buses and deleting identical objects superimposed on top of each other. More...
 
bool TestDanglingEnds ()
 Function TestDanglingEnds tests all of the connectible objects in the schematic for unused connection points. More...
 
void ExtractWires (DLIST< SCH_ITEM > &aList, bool aCreateCopy)
 Function ExtractWires extracts the old wires, junctions and buses. More...
 
void ReplaceWires (DLIST< SCH_ITEM > &aWireList)
 Function ReplaceWires replaces all of the wires, buses, and junctions in the screen with aWireList. More...
 
void MarkConnections (SCH_LINE *aSegment)
 Function MarkConnections 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)
 Functions GetConnection 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)
 Function BreakSegment 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 ()
 Function 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
 Function ClearUndoORRedoList free the undo or redo list from List element Wrappers are deleted. More...
 
bool Save (FILE *aFile) const
 Function Save writes the data structures for this object out to aFile in "*.sch" format. 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)
 Function IsJunctionNeeded tests if a junction is required for the items at aPosition on the screen. More...
 
bool IsTerminalPoint (const wxPoint &aPosition, int aLayer)
 Function IsTerminalPoint tests if aPosition is a connection point on aLayer. More...
 
LIB_PINGetPin (const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
 Function GetPin test the screen for a component pin item at aPosition. More...
 
SCH_SHEETGetSheet (const wxString &aName)
 Function GetSheet returns a sheet object pointer that is named aName. More...
 
SCH_SHEET_PINGetSheetLabel (const wxPoint &aPosition)
 Function GetSheetLabel test the screen if aPosition is a sheet label object. More...
 
void ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
 Function ClearAnnotation clears the annotation for the components in aSheetPath on the screen. More...
 
void GetHierarchicalItems (EDA_ITEMS &aItems)
 Function GetHierarchicalItems adds all schematic sheet and component object in the screen to aItems. More...
 
int GetNode (const wxPoint &aPosition, EDA_ITEMS &aList)
 Function GetNode returns all the items at aPosition that form a node. More...
 
SCH_LINEGetWireOrBus (const wxPoint &aPosition)
 Function GetWireOrBus returns 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)
 Function GetLine returns 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)
 Function GetLabel returns a label item located at aPosition. More...
 
bool SetComponentFootprint (SCH_SHEET_PATH *aSheetPath, const wxString &aReference, const wxString &aFootPrint, bool aSetVisible)
 Function SetFootprintField searches screen for a component with aReference and set the footprint field to aFootPrint if found. More...
 
void SelectBlockItems ()
 Function SelectBlockItems creates a list of items found when a block command is initiated. More...
 
int UpdatePickList ()
 Function UpdatePickList adds 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 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)
 Function addConnectedItemsToBlock 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 auxilliary 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 95 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().

95  :
97  KIWAY_HOLDER( aKiway ),
98  m_paper( wxT( "A4" ) )
99 {
101 
102  SetZoom( 32 );
103 
104  for( unsigned i = 0; i < DIM( SchematicZoomList ); i++ )
105  m_ZoomList.push_back( SchematicZoomList[i] );
106 
107  for( unsigned i = 0; i < DIM( SchematicGridList ); i++ )
109 
110  SetGrid( wxRealPoint( 50, 50 ) ); // Default grid size.
111  m_refCount = 0;
112 
113  // Suitable for schematic only. For libedit and viewlib, must be set to true
114  m_Center = false;
115 
116  InitDataPoints( m_paper.GetSizeIU() );
117 }
#define DIM(x)
of elements in an array
Definition: macros.h:98
static double SchematicZoomList[]
Definition: sch_screen.cpp:63
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:84
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 120 of file sch_screen.cpp.

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

121 {
123  FreeDrawList();
124 }
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:152

Member Function Documentation

void SCH_SCREEN::addConnectedItemsToBlock ( const wxPoint aPosition)
private

Function addConnectedItemsToBlock add items connected at aPosition to the block pick list.

This method tests all connectible 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 835 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().

836 {
837  SCH_ITEM* item;
838  ITEM_PICKER picker;
839  bool addinlist = true;
840 
841  for( item = m_drawList.begin(); item; item = item->Next() )
842  {
843  picker.SetItem( item );
844 
845  if( !item->IsConnectable() || !item->IsConnected( position )
846  || (item->GetFlags() & SKIP_STRUCT) )
847  continue;
848 
849  if( item->IsSelected() && item->Type() != SCH_LINE_T )
850  continue;
851 
852  // A line having 2 ends, it can be tested twice: one time per end
853  if( item->Type() == SCH_LINE_T )
854  {
855  if( ! item->IsSelected() ) // First time this line is tested
856  item->SetFlags( SELECTED | STARTPOINT | ENDPOINT );
857  else // second time (or more) this line is tested
858  addinlist = false;
859 
860  SCH_LINE* line = (SCH_LINE*) item;
861 
862  if( line->GetStartPoint() == position )
863  item->ClearFlags( STARTPOINT );
864  else if( line->GetEndPoint() == position )
865  item->ClearFlags( ENDPOINT );
866  }
867  else
868  item->SetFlags( SELECTED );
869 
870  if( addinlist )
871  {
872  picker.SetFlags( item->GetFlags() );
873  m_BlockLocate.GetItems().PushItem( picker );
874  }
875  }
876 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:255
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:124
bool IsSelected() const
Definition: base_struct.h:221
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:75
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:71
#define SELECTED
Definition: base_struct.h:120
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
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.
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
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:119
PICKED_ITEMS_LIST & GetItems()
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
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:118
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:105
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:273
wxRealPoint m_Size
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
void SCH_SCREEN::Append ( SCH_ITEM aItem)
inline
void SCH_SCREEN::Append ( DLIST< SCH_ITEM > &  aList)
inline

Function Append adds 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 152 of file class_sch_screen.h.

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

153  {
154  m_drawList.Append( aList );
156  }
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 207 of file base_struct.h.

References EDA_ITEM::Pback.

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

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

Function BreakSegment 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 936 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_T, SCH_LINE::SetEndPoint(), and SCH_LINE::SetStartPoint().

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

937 {
938  SCH_LINE* segment;
939  SCH_LINE* newSegment;
940  bool brokenSegments = false;
941 
942  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
943  {
944  if( (item->Type() != SCH_LINE_T) || (item->GetLayer() == LAYER_NOTES) )
945  continue;
946 
947  segment = (SCH_LINE*) item;
948 
949  if( !segment->HitTest( aPoint, 0 ) || segment->IsEndPoint( aPoint ) )
950  continue;
951 
952  // Break the segment at aPoint and create a new segment.
953  newSegment = new SCH_LINE( *segment );
954  newSegment->SetStartPoint( aPoint );
955  segment->SetEndPoint( aPoint );
956  m_drawList.Insert( newSegment, segment->Next() );
957  item = newSegment;
958  brokenSegments = true;
959  }
960 
961  return brokenSegments;
962 }
T * begin() const
Definition: dlist.h:218
SCH_LINE * Next() const
Definition: sch_line.h:56
SCH_ITEM * Next() const
void SetEndPoint(const wxPoint &aPosition)
Definition: sch_line.h:77
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:548
void SetStartPoint(const wxPoint &aPosition)
Definition: sch_line.h:73
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:64
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
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 ( )

Function 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 965 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().

966 {
967  bool brokenSegments = false;
968 
969  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
970  {
971  if( item->Type() == SCH_JUNCTION_T )
972  {
973  SCH_JUNCTION* junction = ( SCH_JUNCTION* ) item;
974 
975  if( BreakSegment( junction->GetPosition() ) )
976  brokenSegments = true;
977  }
978  else
979  {
980  SCH_BUS_ENTRY_BASE* busEntry = dynamic_cast<SCH_BUS_ENTRY_BASE*>( item );
981  if( busEntry )
982  {
983  if( BreakSegment( busEntry->GetPosition() )
984  || BreakSegment( busEntry->m_End() ) )
985  brokenSegments = true;
986  }
987  }
988  }
989 
990  return brokenSegments;
991 }
bool BreakSegment(const wxPoint &aPoint)
Function BreakSegment checks every wire and bus for a intersection at aPoint and break into two segme...
Definition: sch_screen.cpp:936
T * begin() const
Definition: dlist.h:218
wxPoint m_End() const
SCH_ITEM * Next() const
Class SCH_BUS_ENTRY_BASE.
Definition: sch_bus_entry.h:43
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:92
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:145
wxRealPoint m_Size
ID_POPUP_GRID_USER
Definition: draw_frame.cpp:105
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:90
void SCH_SCREEN::CheckComponentsToPartsLinks ( )

Function CheckComponentsToPartsLink initializes or reinitializes 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)

Definition at line 532 of file sch_screen.cpp.

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

Referenced by Draw(), SCH_EDIT_FRAME::LoadOneEEFile(), and Plot().

533 {
534  // Initialize or reinitialize the pointer to the LIB_PART for each component
535  // found in m_drawList, but only if needed (change in lib or schematic)
536  // therefore the calculation time is usually very low.
537 
538  if( m_drawList.GetCount() )
539  {
540  PART_LIBS* libs = Prj().SchLibs();
541  int mod_hash = libs->GetModifyHash();
542 
543  // Must we resolve?
544  if( m_modification_sync != mod_hash )
545  {
547 
549 
550  SCH_COMPONENT::ResolveAll( c, libs );
551 
552  m_modification_sync = mod_hash; // note the last mod_hash
553  }
554  }
555 }
Class TYPE_COLLECTOR merely gathers up all SCH_ITEMs of a given set of KICAD_T type(s).
int GetModifyHash()
Return the modification hash for all libraries.
static const KICAD_T ComponentsOnly[]
A scan list for schematic component items only.
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
static void ResolveAll(const SCH_COLLECTOR &aComponents, PART_LIBS *aLibs)
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class PART_LIBS is a collection of PART_LIBs.
SCH_ITEM * GetDrawItems() const
Function GetDrawItems().
void Collect(SCH_ITEM *aBoard, const KICAD_T aScanList[])
Function Collect scans a BOARD_ITEM using this class's Inspector method, which does the collection...
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
bool SCH_SCREEN::CheckIfOnDrawList ( SCH_ITEM st)

Definition at line 187 of file sch_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::addCurrentItemToList().

188 {
189  SCH_ITEM* itemList = m_drawList.begin();
190 
191  while( itemList )
192  {
193  if( itemList == aItem )
194  return true;
195 
196  itemList = itemList->Next();
197  }
198 
199  return false;
200 }
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 ( )

Function Clear deletes all draw items and clears the project settings.

Definition at line 141 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().

142 {
143  FreeDrawList();
144 
145  // Clear the project settings
147 
148  m_titles.Clear();
149 }
TITLE_BLOCK m_titles
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:152
void SCH_SCREEN::ClearAnnotation ( SCH_SHEET_PATH aSheetPath)

Function ClearAnnotation clears 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 739 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().

740 {
741  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
742  {
743  if( item->Type() == SCH_COMPONENT_T )
744  {
745  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
746 
747  component->ClearAnnotation( aSheetPath );
748 
749  // Clear the modified component flag set by component->ClearAnnotation
750  // because we do not use it here and we should not leave this flag set,
751  // when an edition is finished:
752  component->ClearFlags();
753  }
754  }
755 }
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:254
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 233 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

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

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

Definition at line 621 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().

622 {
623  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
624  item->ClearFlags();
625 }
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 254 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(), SCH_EDIT_FRAME::AppendOneEEProject(), 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(), LIB_PART::CopySelectedItems(), 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_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), 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(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), 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().

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

Definition at line 232 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

232 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void EDA_ITEM::ClearSelected ( )
inlineinherited

Definition at line 231 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), SELECTION_TOOL::unselectVisually(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

231 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:120
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void SCH_SCREEN::ClearUndoORRedoList ( UNDO_REDO_CONTAINER aList,
int  aItemCount = -1 
)
overridevirtual

Function ClearUndoORRedoList free the undo or redo list from List 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 597 of file sch_screen.cpp.

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), and UNDO_REDO_CONTAINER::m_CommandsList.

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

598 {
599  if( aItemCount == 0 )
600  return;
601 
602  unsigned icnt = aList.m_CommandsList.size();
603 
604  if( aItemCount > 0 )
605  icnt = aItemCount;
606 
607  for( unsigned ii = 0; ii < icnt; ii++ )
608  {
609  if( aList.m_CommandsList.size() == 0 )
610  break;
611 
612  PICKED_ITEMS_LIST* curr_cmd = aList.m_CommandsList[0];
613  aList.m_CommandsList.erase( aList.m_CommandsList.begin() );
614 
615  curr_cmd->ClearListAndDeleteItems();
616  delete curr_cmd; // Delete command
617  }
618 }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void ClearListAndDeleteItems()
Function ClearListAndDeleteItems deletes the list of pickers, AND the data pointed by m_PickedItem or...
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::CreateNewLibraryPart(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::OnImportPart(), 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 ZONE_CONTAINER, SCH_COMPONENT, SCH_SHEET, MODULE, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, SCH_TEXT, TEXTE_MODULE, SCH_SHEET_PIN, SCH_FIELD, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_LINE, SCH_BITMAP, TEXTE_PCB, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, SCH_MARKER, LIB_CIRCLE, 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(), BOARD::Duplicate(), DuplicateStruct(), ExtractWires(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), 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 721 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().

722 {
723  SCH_ITEM* item;
724  int count = 0;
725 
726  for( item = m_drawList.begin(); item; item = item->Next() )
727  {
728  if( item->Type() == SCH_JUNCTION_T && !aTestJunctions )
729  continue;
730 
731  if( item->IsConnected( aPos ) )
732  count++;
733  }
734 
735  return count;
736 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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 133 of file sch_screen.cpp.

References m_refCount.

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

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

Function DeleteItem removes aItem from the linked list and deletes the object.

If aItem is 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 164 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().

165 {
166  wxCHECK_RET( aItem, wxT( "Cannot delete invalid item from screen." ) );
167 
168  SetModify();
169 
170  if( aItem->Type() == SCH_SHEET_PIN_T )
171  {
172  // This structure is attached to a sheet, get the parent sheet object.
173  SCH_SHEET_PIN* sheetPin = (SCH_SHEET_PIN*) aItem;
174  SCH_SHEET* sheet = sheetPin->GetParent();
175  wxCHECK_RET( sheet,
176  wxT( "Sheet label parent not properly set, bad programmer!" ) );
177  sheet->RemovePin( sheetPin );
178  return;
179  }
180  else
181  {
182  delete m_drawList.Remove( aItem );
183  }
184 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
Definition: sch_sheet.h:161
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:370
Class SCH_SHEET_PIN defines a sheet pin (label) used in sheets to create hierarchical schematics...
Definition: sch_sheet.h:62
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
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 
)

Function Draw draws all the items in the screen to aCanvas.

note: this function is useful only for schematic. 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 558 of file sch_screen.cpp.

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

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

559 {
560  /* note: SCH_SCREEN::Draw is useful only for schematic.
561  * library editor and library viewer do not use m_drawList, and therefore
562  * their SCH_SCREEN::Draw() draws nothing
563  */
564 
565  // Ensure links are up to date, even if a library was reloaded for some reason:
567 
568  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
569  {
570  if( item->IsMoving() || item->IsResized() )
571  continue;
572 
573  // uncomment line below when there is a virtual EDA_ITEM::GetBoundingBox()
574  // if( panel->GetClipBox().Intersects( item->GetBoundingBox() ) )
575  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ), aDrawMode, aColor );
576  }
577 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
void CheckComponentsToPartsLinks()
Function CheckComponentsToPartsLink initializes or reinitializes the weak reference to the LIB_PART f...
Definition: sch_screen.cpp:532
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 
)

Function ExtractWires 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 segmat 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 241 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().

242 {
243  SCH_ITEM* item;
244  SCH_ITEM* next_item;
245 
246  for( item = m_drawList.begin(); item; item = next_item )
247  {
248  next_item = item->Next();
249 
250  switch( item->Type() )
251  {
252  case SCH_JUNCTION_T:
253  case SCH_LINE_T:
254  m_drawList.Remove( item );
255  aList.Append( item );
256 
257  if( aCreateCopy )
258  m_drawList.Insert( (SCH_ITEM*) item->Clone(), next_item );
259 
260  break;
261 
262  default:
263  break;
264  }
265  }
266 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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 152 of file sch_screen.cpp.

References DHEAD::DeleteAll(), and m_drawList.

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

153 {
155 }
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 121 of file class_sch_screen.h.

References m_aux_origin.

Referenced by SCH_BASE_FRAME::GetAuxOrigin().

121 { return m_aux_origin; }
wxPoint m_aux_origin
Origin of the auxilliary 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, DIMENSION, GERBER_DRAW_ITEM, DRAWSEGMENT, LIB_FIELD, ZONE_CONTAINER, SCH_TEXT, TEXTE_MODULE, TEXTE_PCB, LIB_PIN, TRACK, MODULE, MARKER_PCB, LIB_ARC, SCH_FIELD, PCB_TARGET, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, LIB_POLYLINE, LIB_BEZIER, SCH_LINE, 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(), SELECTION::GetBoundingBox(), LIB_ITEM::GetBoundingBox(), getRect(), SELECTION::ViewBBox(), 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 477 of file class_sch_screen.h.

References GetLine(), and LAYER_BUS.

Referenced by IsTerminalPoint().

479  {
480  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
481  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Function GetLine returns a line item located at aPosition.
virtual wxString SCH_SCREEN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from BASE_SCREEN.

Definition at line 109 of file class_sch_screen.h.

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

Functions GetConnection 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 1129 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().

1131 {
1132  SCH_ITEM* item;
1133  EDA_ITEM* tmp;
1134  EDA_ITEMS list;
1135 
1136  // Clear flags member for all items.
1139 
1140  if( GetNode( aPosition, list ) == 0 )
1141  return 0;
1142 
1143  for( size_t i = 0; i < list.size(); i++ )
1144  {
1145  item = (SCH_ITEM*) list[ i ];
1147 
1148  /* Put this structure in the picked list: */
1149  ITEM_PICKER picker( item, UR_DELETED );
1150  aList.PushItem( picker );
1151  }
1152 
1153  // Mark all wires, junctions, .. connected to the item(s) found.
1154  if( aFullConnection )
1155  {
1156  SCH_LINE* segment;
1157 
1158  for( item = m_drawList.begin(); item; item = item->Next() )
1159  {
1160  if( !(item->GetFlags() & SELECTEDNODE) )
1161  continue;
1162 
1163  if( item->Type() != SCH_LINE_T )
1164  continue;
1165 
1166  MarkConnections( (SCH_LINE*) item );
1167  }
1168 
1169  // Search all attached wires (i.e wire with one new dangling end )
1170  for( item = m_drawList.begin(); item; item = item->Next() )
1171  {
1172  bool noconnect = false;
1173 
1174  if( item->GetFlags() & STRUCT_DELETED )
1175  continue; // Already seen
1176 
1177  if( !(item->GetFlags() & CANDIDATE) )
1178  continue; // not a candidate
1179 
1180  if( item->Type() != SCH_LINE_T )
1181  continue;
1182 
1183  item->SetFlags( SKIP_STRUCT );
1184 
1185  segment = (SCH_LINE*) item;
1186 
1187  /* If the wire start point is connected to a wire that was already found
1188  * and now is not connected, add the wire to the list. */
1189  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1190  {
1191  // Ensure tmp is a previously deleted segment:
1192  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1193  continue;
1194 
1195  if( tmp->Type() != SCH_LINE_T )
1196  continue;
1197 
1198  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1199 
1200  // Test for segment connected to the previously deleted segment:
1201  if( testSegment->IsEndPoint( segment->GetStartPoint() ) )
1202  break;
1203  }
1204 
1205  // when tmp != NULL, segment is a new candidate:
1206  // put it in deleted list if
1207  // the start point is not connected to an other item (like pin)
1208  if( tmp && !CountConnectedItems( segment->GetStartPoint(), true ) )
1209  noconnect = true;
1210 
1211  /* If the wire end point is connected to a wire that has already been found
1212  * and now is not connected, add the wire to the list. */
1213  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1214  {
1215  // Ensure tmp is a previously deleted segment:
1216  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1217  continue;
1218 
1219  if( tmp->Type() != SCH_LINE_T )
1220  continue;
1221 
1222  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1223 
1224  // Test for segment connected to the previously deleted segment:
1225  if( testSegment->IsEndPoint( segment->GetEndPoint() ) )
1226  break;
1227  }
1228 
1229  // when tmp != NULL, segment is a new candidate:
1230  // put it in deleted list if
1231  // the end point is not connected to an other item (like pin)
1232  if( tmp && !CountConnectedItems( segment->GetEndPoint(), true ) )
1233  noconnect = true;
1234 
1235  item->ClearFlags( SKIP_STRUCT );
1236 
1237  if( noconnect )
1238  {
1239  item->SetFlags( STRUCT_DELETED );
1240 
1241  ITEM_PICKER picker( item, UR_DELETED );
1242  aList.PushItem( picker );
1243 
1244  item = m_drawList.begin();
1245  }
1246  }
1247 
1248  // Get redundant junctions (junctions which connect < 3 end wires
1249  // and no pin)
1250  for( item = m_drawList.begin(); item; item = item->Next() )
1251  {
1252  if( item->GetFlags() & STRUCT_DELETED )
1253  continue;
1254 
1255  if( !(item->GetFlags() & CANDIDATE) )
1256  continue;
1257 
1258  if( item->Type() != SCH_JUNCTION_T )
1259  continue;
1260 
1261  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
1262 
1263  if( CountConnectedItems( junction->GetPosition(), false ) <= 2 )
1264  {
1265  item->SetFlags( STRUCT_DELETED );
1266 
1267  ITEM_PICKER picker( item, UR_DELETED );
1268  aList.PushItem( picker );
1269  }
1270  }
1271 
1272  for( item = m_drawList.begin(); item; item = item->Next() )
1273  {
1274  if( item->GetFlags() & STRUCT_DELETED )
1275  continue;
1276 
1277  if( item->Type() != SCH_LABEL_T )
1278  continue;
1279 
1280  tmp = GetWireOrBus( ( (SCH_TEXT*) item )->GetPosition() );
1281 
1282  if( tmp && tmp->GetFlags() & STRUCT_DELETED )
1283  {
1284  item->SetFlags( STRUCT_DELETED );
1285 
1286  ITEM_PICKER picker( item, UR_DELETED );
1287  aList.PushItem( picker );
1288  }
1289  }
1290  }
1291 
1293 
1294  return aList.GetCount();
1295 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
int CountConnectedItems(const wxPoint &aPos, bool aTestJunctions) const
Definition: sch_screen.cpp:721
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:255
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:124
#define SELECTEDNODE
flag indicating that the structure has already selected
Definition: base_struct.h:121
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:75
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
EDA_ITEM * Next() const
Definition: base_struct.h:206
bool BreakSegmentsOnJunctions()
Function BreakSegmentsOnJunctions tests all junctions and bus entries in the schematic for intersecti...
Definition: sch_screen.cpp:965
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:123
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:71
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:92
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:530
void MarkConnections(SCH_LINE *aSegment)
Function MarkConnections add all wires and junctions connected to aSegment which are not connected an...
Definition: sch_screen.cpp:295
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:122
int GetNode(const wxPoint &aPosition, EDA_ITEMS &aList)
Function GetNode returns all the items at aPosition that form a node.
Definition: sch_screen.cpp:994
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:64
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
SCH_LINE * GetWireOrBus(const wxPoint &aPosition)
Function GetWireOrBus returns a wire or bus item located at aPosition.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:621
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 255 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(), 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(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), 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().

255 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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)

Function GetHierarchicalItems adds all schematic sheet and component object in the screen to aItems.

Parameters
aItemsHierarchical item list to fill.

Definition at line 758 of file sch_screen.cpp.

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

759 {
760  SCH_ITEM* item = m_drawList.begin();
761 
762  while( item )
763  {
764  if( ( item->Type() == SCH_SHEET_T ) || ( item->Type() == SCH_COMPONENT_T ) )
765  aItems.push_back( item );
766 
767  item = item->Next();
768  }
769 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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

Function GetItem checks 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 203 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().

204 {
205  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
206  {
207  if( item->HitTest( aPosition, aAccuracy ) && (aType == NOT_USED) )
208  return item;
209 
210  if( (aType == SCH_FIELD_T) && (item->Type() == SCH_COMPONENT_T) )
211  {
212  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
213 
214  for( int i = REFERENCE; i < component->GetFieldCount(); i++ )
215  {
216  SCH_FIELD* field = component->GetField( i );
217 
218  if( field->HitTest( aPosition, aAccuracy ) )
219  return (SCH_ITEM*) field;
220  }
221  }
222  else if( (aType == SCH_SHEET_PIN_T) && (item->Type() == SCH_SHEET_T) )
223  {
224  SCH_SHEET* sheet = (SCH_SHEET*)item;
225 
226  SCH_SHEET_PIN* label = sheet->GetPin( aPosition );
227 
228  if( label )
229  return (SCH_ITEM*) label;
230  }
231  else if( (item->Type() == aType) && item->HitTest( aPosition, aAccuracy ) )
232  {
233  return item;
234  }
235  }
236 
237  return NULL;
238 }
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:528
the 3d code uses this value
Definition: typeinfo.h:92
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:499
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
Class SCH_SHEET_PIN defines a sheet pin (label) used in sheets to create hierarchical schematics...
Definition: sch_sheet.h:62
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
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 
)

Function GetLabel returns 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 1062 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().

1063 {
1064  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1065  {
1066  switch( item->Type() )
1067  {
1068  case SCH_LABEL_T:
1069  case SCH_GLOBAL_LABEL_T:
1071  if( item->HitTest( aPosition, aAccuracy ) )
1072  return (SCH_TEXT*) item;
1073 
1074  default:
1075  ;
1076  }
1077  }
1078 
1079  return NULL;
1080 }
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 
)

Function GetLine returns 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 1028 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().

1030 {
1031  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1032  {
1033  if( item->Type() != SCH_LINE_T )
1034  continue;
1035 
1036  if( item->GetLayer() != aLayer )
1037  continue;
1038 
1039  if( !item->HitTest( aPosition, aAccuracy ) )
1040  continue;
1041 
1042  switch( aSearchType )
1043  {
1044  case ENTIRE_LENGTH_T:
1045  return (SCH_LINE*) item;
1046 
1047  case EXCLUDE_END_POINTS_T:
1048  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
1049  return (SCH_LINE*) item;
1050  break;
1051 
1052  case END_POINTS_ONLY_T:
1053  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
1054  return (SCH_LINE*) item;
1055  }
1056  }
1057 
1058  return NULL;
1059 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
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 ZONE_CONTAINER, SCH_COMPONENT, SCH_SHEET, MODULE, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, LIB_ARC, TEXTE_PCB, SCH_BITMAP, LIB_TEXT, SCH_LINE, EDGE_MODULE, LIB_POLYLINE, SCH_BUS_ENTRY_BASE, MARKER_PCB, 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, NETINFO_ITEM, GERBER_DRAW_ITEM, SCH_TEXT, TRACK, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, ZONE_CONTAINER, EDGE_MODULE, LIB_ARC, MARKER_PCB, LIB_BEZIER, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 277 of file base_struct.h.

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

278  {
279  }
int SCH_SCREEN::GetNode ( const wxPoint aPosition,
EDA_ITEMS aList 
)

Function GetNode returns 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 994 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().

995 {
996  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
997  {
998  if( item->Type() == SCH_LINE_T && item->HitTest( aPosition )
999  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
1000  {
1001  aList.push_back( item );
1002  }
1003  else if( item->Type() == SCH_JUNCTION_T && item->HitTest( aPosition ) )
1004  {
1005  aList.push_back( item );
1006  }
1007  }
1008 
1009  return (int) aList.size();
1010 }
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

Function GetPin 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 628 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().

630 {
631  SCH_ITEM* item;
632  SCH_COMPONENT* component = NULL;
633  LIB_PIN* pin = NULL;
634 
635  for( item = m_drawList.begin(); item; item = item->Next() )
636  {
637  if( item->Type() != SCH_COMPONENT_T )
638  continue;
639 
640  component = (SCH_COMPONENT*) item;
641 
642  if( aEndPointOnly )
643  {
644  pin = NULL;
645 
646  auto part = component->GetPartRef().lock();
647 
648  if( !part )
649  continue;
650 
651  for( pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
652  {
653  // Skip items not used for this part.
654  if( component->GetUnit() && pin->GetUnit() &&
655  ( pin->GetUnit() != component->GetUnit() ) )
656  continue;
657 
658  if( component->GetConvert() && pin->GetConvert() &&
659  ( pin->GetConvert() != component->GetConvert() ) )
660  continue;
661 
662  if(component->GetPinPhysicalPosition( pin ) == aPosition )
663  break;
664  }
665  if( pin )
666  break;
667  }
668  else
669  {
670  pin = (LIB_PIN*) component->GetDrawItem( aPosition, LIB_PIN_T );
671 
672  if( pin )
673  break;
674  }
675  }
676 
677  if( pin && aComponent )
678  *aComponent = component;
679 
680  return pin;
681 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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 132 of file class_sch_screen.h.

References m_refCount.

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

132 { 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 ZONE_CONTAINER, SCH_COMPONENT, SCH_SHEET, MODULE, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, LIB_FIELD, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, SCH_BITMAP, LIB_TEXT, SCH_LINE, 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 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)

Function GetSheet returns a sheet object pointer that is named aName.

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

Definition at line 684 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::AppendOneEEProject().

685 {
686  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
687  {
688  if( item->Type() != SCH_SHEET_T )
689  continue;
690 
691  SCH_SHEET* sheet = (SCH_SHEET*) item;
692 
693  if( aName.CmpNoCase( sheet->GetName() ) == 0 )
694  return sheet;
695  }
696 
697  return NULL;
698 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
wxString GetName() const
Definition: sch_sheet.h:274
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)

Function GetSheetLabel 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 701 of file sch_screen.cpp.

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

Referenced by IsTerminalPoint().

702 {
703  SCH_SHEET_PIN* sheetPin = NULL;
704 
705  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
706  {
707  if( item->Type() != SCH_SHEET_T )
708  continue;
709 
710  SCH_SHEET* sheet = (SCH_SHEET*) item;
711  sheetPin = sheet->GetPin( aPosition );
712 
713  if( sheetPin )
714  break;
715  }
716 
717  return sheetPin;
718 }
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:528
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
Class SCH_SHEET_PIN defines a sheet pin (label) used in sheets to create hierarchical schematics...
Definition: sch_sheet.h:62
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
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 250 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

250 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:161
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 471 of file class_sch_screen.h.

References GetLine(), and LAYER_WIRE.

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

473  {
474  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
475  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Function GetLine returns a line item located at aPosition.
SCH_LINE * SCH_SCREEN::GetWireOrBus ( const wxPoint aPosition)

Function GetWireOrBus returns 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 1013 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().

1014 {
1015  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1016  {
1017  if( (item->Type() == SCH_LINE_T) && item->HitTest( aPosition )
1018  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
1019  {
1020  return (SCH_LINE*) item;
1021  }
1022  }
1023 
1024  return NULL;
1025 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
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, VIA, MODULE, SCH_ITEM, BOARD_ITEM, ZONE_CONTAINER, LIB_ITEM, GERBER_DRAW_ITEM, TRACK, DIMENSION, TEXTE_MODULE, DRAWSEGMENT, LIB_FIELD, LIB_PIN, LIB_ARC, MARKER_PCB, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, LIB_BEZIER, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 288 of file base_struct.h.

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

289  {
290  return false; // derived classes should override this function
291  }
void SCH_SCREEN::IncRefCount ( )

Definition at line 127 of file sch_screen.cpp.

References m_refCount.

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

128 {
129  m_refCount++;
130 }
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(), GERBVIEW_FRAME::SetPageSettings(), PL_EDITOR_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 224 of file base_struct.h.

References BRIGHTENED.

Referenced by SELECTION_TOOL::disambiguationMenu().

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

Definition at line 223 of file base_struct.h.

References HIGHLIGHTED.

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

Function IsJunctionNeeded tests 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 337 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().

338 {
339  if( GetItem( aPosition, 0, SCH_JUNCTION_T ) )
340  return false;
341 
342  if( GetWire( aPosition, 0, EXCLUDE_END_POINTS_T ) )
343  {
344  if( GetWire( aPosition, 0, END_POINTS_ONLY_T ) )
345  return true;
346 
347  if( GetPin( aPosition, NULL, true ) )
348  return true;
349  }
350 
351  return false;
352 }
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
Function GetItem checks aPosition within a distance of aAccuracy for items of type aFilter...
Definition: sch_screen.cpp:203
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Function GetPin test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:628
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 217 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

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

Definition at line 216 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(), 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().

216 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 444 of file base_struct.h.

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

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

Definition at line 222 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

222 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:114
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 SCH_SCREEN::IsTerminalPoint ( const wxPoint aPosition,
int  aLayer 
)

Function IsTerminalPoint tests 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 355 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().

356 {
357  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
358  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
359 
360  SCH_SHEET_PIN* label;
361  SCH_TEXT* text;
362 
363  switch( aLayer )
364  {
365  case LAYER_BUS:
366 
367  if( GetBus( aPosition ) )
368  return true;
369 
370  label = GetSheetLabel( aPosition );
371 
372  if( label && IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
373  return true;
374 
375  text = GetLabel( aPosition );
376 
377  if( text && IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
378  && (text->Type() != SCH_LABEL_T) )
379  return true;
380 
381  break;
382 
383  case LAYER_NOTES:
384 
385  if( GetLine( aPosition ) )
386  return true;
387 
388  break;
389 
390  case LAYER_WIRE:
392  return true;
393 
394  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
395  return true;
396 
397  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
398  return true;
399 
400  if( GetPin( aPosition, NULL, true ) )
401  return true;
402 
403  if( GetWire( aPosition ) )
404  return true;
405 
406  text = GetLabel( aPosition );
407 
408  if( text && text->IsConnected( aPosition ) && !IsBusLabel( text->GetText() ) )
409  return true;
410 
411  label = GetSheetLabel( aPosition );
412 
413  if( label && label->IsConnected( aPosition ) && !IsBusLabel( label->GetText() ) )
414  return true;
415 
416  break;
417 
418  default:
419  break;
420  }
421 
422  return false;
423 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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)
Function GetLine returns a line item located at aPosition.
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)
Function GetSheetLabel test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:701
Class SCH_SHEET_PIN defines a sheet pin (label) used in sheets to create hierarchical schematics...
Definition: sch_sheet.h:62
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)
Function GetLabel returns a label item located at aPosition.
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=NOT_USED) const
Function GetItem checks aPosition within a distance of aAccuracy for items of type aFilter...
Definition: sch_screen.cpp:203
#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
Function GetPin test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:628
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 220 of file base_struct.h.

References IS_WIRE_IMAGE.

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

220 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:117
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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(), 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:151
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
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::AppendOneEEProject(), 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(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), 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::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(), 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)

Function MarkConnections 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 295 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().

296 {
297  wxCHECK_RET( (aSegment) && (aSegment->Type() == SCH_LINE_T),
298  wxT( "Invalid object pointer." ) );
299 
300  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
301  {
302  if( item->GetFlags() & CANDIDATE )
303  continue;
304 
305  if( item->Type() == SCH_JUNCTION_T )
306  {
307  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
308 
309  if( aSegment->IsEndPoint( junction->GetPosition() ) )
310  item->SetFlags( CANDIDATE );
311 
312  continue;
313  }
314 
315  if( item->Type() != SCH_LINE_T )
316  continue;
317 
318  SCH_LINE* segment = (SCH_LINE*) item;
319 
320  if( aSegment->IsEndPoint( segment->GetStartPoint() )
321  && !GetPin( segment->GetStartPoint(), NULL, true ) )
322  {
323  item->SetFlags( CANDIDATE );
324  MarkConnections( segment );
325  }
326 
327  if( aSegment->IsEndPoint( segment->GetEndPoint() )
328  && !GetPin( segment->GetEndPoint(), NULL, true ) )
329  {
330  item->SetFlags( CANDIDATE );
331  MarkConnections( segment );
332  }
333  }
334 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:75
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:123
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:71
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:92
void MarkConnections(SCH_LINE *aSegment)
Function MarkConnections add all wires and junctions connected to aSegment which are not connected an...
Definition: sch_screen.cpp:295
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:64
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Function GetPin test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:628
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_SHEET, SCH_COMPONENT, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 400 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().

401  {
402  return false;
403  }
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:444
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 196 of file class_sch_screen.h.

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

Function Plot plots all the schematic objects to aPlotter.

note: this function is useful only for schematic. 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 584 of file sch_screen.cpp.

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

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().

585 {
586  // Ensure links are up to date, even if a library was reloaded for some reason:
588 
589  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
590  {
591  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
592  item->Plot( aPlotter );
593  }
594 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
void CheckComponentsToPartsLinks()
Function CheckComponentsToPartsLink initializes or reinitializes the weak reference to the LIB_PART f...
Definition: sch_screen.cpp:532
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 SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), SCH_EDIT_FRAME::backAnnotateFootprints(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), SCH_EDIT_FRAME::CheckAnnotate(), CheckComponentsToPartsLinks(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::CreateArchiveLibrary(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG(), 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_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), LIB_VIEW_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::ExportToGenCAD(), 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(), LIB_EDIT_FRAME::GetCurPart(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_EDIT_FRAME::InstallConfigFrame(), SCH_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), DIALOG_BOM_EDITOR::LoadComponents(), CVPCB_MAINFRAME::LoadFootprintFiles(), SCH_EDIT_FRAME::LoadOneEEFile(), LIB_EDIT_FRAME::LoadOneLibraryPart(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertLibClick(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertPath(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), LIB_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), 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_SPICE_MODEL::onSelectIcLib(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OnSelectUnit(), DIALOG_SPICE_MODEL::onSemiSelectLib(), 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(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), 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::RescueProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), Save(), LIB_EDIT_FRAME::SaveActiveLibrary(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_ERC::TestErc(), DIALOG_SPICE_MODEL::updateFromFile(), SIM_PLOT_FRAME::updateNetlistExporter(), 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)

Function Remove removes 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 158 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().

159 {
160  m_drawList.Remove( aItem );
161 }
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:444
const wxString traceFindReplace(wxT("KicadFindReplace"))
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 432 of file base_struct.h.

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

Function ReplaceWires replaces 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 269 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().

270 {
271  SCH_ITEM* item;
272  SCH_ITEM* next_item;
273 
274  for( item = m_drawList.begin(); item; item = next_item )
275  {
276  next_item = item->Next();
277 
278  switch( item->Type() )
279  {
280  case SCH_JUNCTION_T:
281  case SCH_LINE_T:
282  Remove( item );
283  delete item;
284  break;
285 
286  default:
287  break;
288  }
289  }
290 
291  m_drawList.Append( aWireList );
292 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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)
Function Remove removes aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:158
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::Save ( FILE *  aFile) const

Function Save writes the data structures for this object out to aFile in "*.sch" format.

Parameters
aFileThe FILE to write to.
Returns
bool - true if success writing else false.

Definition at line 475 of file sch_screen.cpp.

References DLIST< T >::begin(), EESCHEMA_FILE_STAMP, EESCHEMA_VERSION, EscapedUTF8(), TITLE_BLOCK::GetComment1(), TITLE_BLOCK::GetComment2(), TITLE_BLOCK::GetComment3(), TITLE_BLOCK::GetComment4(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), PAGE_INFO::GetHeightMils(), TITLE_BLOCK::GetRevision(), TITLE_BLOCK::GetTitle(), GetTitleBlock(), PAGE_INFO::GetType(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), m_drawList, BASE_SCREEN::m_NumberOfScreens, m_paper, BASE_SCREEN::m_ScreenNumber, SCH_ITEM::Next(), KIWAY_HOLDER::Prj(), SCH_LAYER_ID_COUNT, SCHEMATIC_HEAD_STRING, and TO_UTF8.

476 {
477  // Creates header
478  if( fprintf( aFile, "%s %s %d\n", EESCHEMA_FILE_STAMP,
480  return false;
481 
482  for( const PART_LIB& lib : *Prj().SchLibs() )
483  {
484  if( fprintf( aFile, "LIBS:%s\n", TO_UTF8( lib.GetName() ) ) < 0 )
485  return false;
486  }
487 
488  // This section is not used, but written for file compatibility
489  if( fprintf( aFile, "EELAYER %d %d\n", SCH_LAYER_ID_COUNT, 0 ) < 0
490  || fprintf( aFile, "EELAYER END\n" ) < 0 )
491  return false;
492 
493  /* Write page info, ScreenNumber and NumberOfScreen; not very meaningful for
494  * SheetNumber and Sheet Count in a complex hierarchy, but useful in
495  * simple hierarchy and flat hierarchy. Used also to search the root
496  * sheet ( ScreenNumber = 1 ) within the files
497  */
498  const TITLE_BLOCK& tb = GetTitleBlock();
499 
500  if( fprintf( aFile, "$Descr %s %d %d%s\n", TO_UTF8( m_paper.GetType() ),
504  " portrait" : ""
505  ) < 0
506  || fprintf( aFile, "encoding utf-8\n") < 0
507  || fprintf( aFile, "Sheet %d %d\n", m_ScreenNumber, m_NumberOfScreens ) < 0
508  || fprintf( aFile, "Title %s\n", EscapedUTF8( tb.GetTitle() ).c_str() ) < 0
509  || fprintf( aFile, "Date %s\n", EscapedUTF8( tb.GetDate() ).c_str() ) < 0
510  || fprintf( aFile, "Rev %s\n", EscapedUTF8( tb.GetRevision() ).c_str() ) < 0
511  || fprintf( aFile, "Comp %s\n", EscapedUTF8( tb.GetCompany() ).c_str() ) < 0
512  || fprintf( aFile, "Comment1 %s\n", EscapedUTF8( tb.GetComment1() ).c_str() ) < 0
513  || fprintf( aFile, "Comment2 %s\n", EscapedUTF8( tb.GetComment2() ).c_str() ) < 0
514  || fprintf( aFile, "Comment3 %s\n", EscapedUTF8( tb.GetComment3() ).c_str() ) < 0
515  || fprintf( aFile, "Comment4 %s\n", EscapedUTF8( tb.GetComment4() ).c_str() ) < 0
516  || fprintf( aFile, "$EndDescr\n" ) < 0 )
517  return false;
518 
519  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
520  {
521  if( !item->Save( aFile ) )
522  return false;
523  }
524 
525  if( fprintf( aFile, "$EndSCHEMATC\n" ) < 0 )
526  return false;
527 
528  return true;
529 }
const wxString & GetCompany() const
const wxString & GetComment4() const
T * begin() const
Definition: dlist.h:218
const wxString & GetDate() const
#define SCH_LAYER_ID_COUNT
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout, or editing view.
SCH_ITEM * Next() const
#define SCHEMATIC_HEAD_STRING
Definition: general.h:41
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const wxString & GetTitle() const
std::string EscapedUTF8(const wxString &aString)
Function EscapedUTF8 returns an 8 bit UTF8 string given aString in unicode form.
Definition: string.cpp:137
#define EESCHEMA_VERSION
Definition: general.h:40
bool IsPortrait() const
PAGE_INFO m_paper
The size of the paper to print or plot on.
const wxString & GetRevision() const
const wxString & GetComment3() const
int GetWidthMils() const
const TITLE_BLOCK & GetTitleBlock() const
const wxString & GetComment2() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
bool IsCustom() const
Function IsCustom returns true if the type is Custom.
const wxString & GetComment1() const
#define EESCHEMA_FILE_STAMP
Definition: sch_screen.cpp:58
const wxString & GetType() const
Class PART_LIB is used to load, save, search, and otherwise manipulate part library files...
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
int GetHeightMils() const
bool SCH_SCREEN::SchematicCleanUp ( )

Function SchematicCleanUp performs 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 426 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().

427 {
428  bool modified = false;
429 
430  for( SCH_ITEM* item = m_drawList.begin() ; item; item = item->Next() )
431  {
432  if( ( item->Type() != SCH_LINE_T ) && ( item->Type() != SCH_JUNCTION_T ) )
433  continue;
434 
435  bool restart;
436 
437  for( SCH_ITEM* testItem = item->Next(); testItem; testItem = restart ? m_drawList.begin() : testItem->Next() )
438  {
439  restart = false;
440 
441  if( ( item->Type() == SCH_LINE_T ) && ( testItem->Type() == SCH_LINE_T ) )
442  {
443  SCH_LINE* line = (SCH_LINE*) item;
444 
445  if( line->MergeOverlap( (SCH_LINE*) testItem ) )
446  {
447  // Keep the current flags, because the deleted segment can be flagged.
448  item->SetFlags( testItem->GetFlags() );
449  DeleteItem( testItem );
450  restart = true;
451  modified = true;
452  }
453  }
454  else if ( ( ( item->Type() == SCH_JUNCTION_T )
455  && ( testItem->Type() == SCH_JUNCTION_T ) ) && ( testItem != item ) )
456  {
457  if ( testItem->HitTest( item->GetPosition() ) )
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  }
467  }
468 
470 
471  return modified;
472 }
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:274
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
void DeleteItem(SCH_ITEM *aItem)
Function DeleteItem removes aItem from the linked list and deletes the object.
Definition: sch_screen.cpp:164
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Class SCH_LINE is a segment description base class to describe items which have 2 end points (track...
Definition: sch_line.h:42
bool TestDanglingEnds()
Function TestDanglingEnds tests all of the connectible objects in the schematic for unused connection...
Definition: sch_screen.cpp:915
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::SelectBlockItems ( )

Function SelectBlockItems creates 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, than any items connected to items in the block are also selected.

Definition at line 772 of file sch_screen.cpp.

References addConnectedItemsToBlock(), ClearDrawingState(), SCH_ITEM::GetConnectionPoints(), 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_LINE_T, SELECTED, EDA_ITEM::SetFlags(), PICKED_ITEMS_LIST::SetPickerFlags(), SKIP_STRUCT, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::HandleBlockEnd().

773 {
774  PICKED_ITEMS_LIST* pickedlist = &m_BlockLocate.GetItems();
775 
776  if( pickedlist->GetCount() == 0 )
777  return;
778 
780 
781  for( unsigned ii = 0; ii < pickedlist->GetCount(); ii++ )
782  {
783  SCH_ITEM* item = (SCH_ITEM*) pickedlist->GetPickedItem( ii );
784  item->SetFlags( SELECTED );
785  }
786 
787  if( !m_BlockLocate.IsDragging() )
788  return;
789 
790  // Select all the items in the screen connected to the items in the block.
791  // be sure end lines that are on the block limits are seen inside this block
792  m_BlockLocate.Inflate( 1 );
793  unsigned last_select_id = pickedlist->GetCount();
794 
795  for( unsigned ii = 0; ii < last_select_id; ii++ )
796  {
797  SCH_ITEM* item = (SCH_ITEM*)pickedlist->GetPickedItem( ii );
798  item->SetFlags( IS_DRAGGED );
799 
800  if( item->Type() == SCH_LINE_T )
801  {
803 
804  if( !item->IsSelected() )
805  { // This is a special case:
806  // this selected wire has no ends in block.
807  // But it was selected (because it intersects the selecting area),
808  // so we must keep it selected and select items connected to it
809  // Note: an other option could be: remove it from drag list
810  item->SetFlags( SELECTED | SKIP_STRUCT );
811  std::vector< wxPoint > connections;
812  item->GetConnectionPoints( connections );
813 
814  for( size_t i = 0; i < connections.size(); i++ )
815  addConnectedItemsToBlock( connections[i] );
816  }
817 
818  pickedlist->SetPickerFlags( item->GetFlags(), ii );
819  }
820  else if( item->IsConnectable() )
821  {
822  std::vector< wxPoint > connections;
823 
824  item->GetConnectionPoints( connections );
825 
826  for( size_t jj = 0; jj < connections.size(); jj++ )
827  addConnectedItemsToBlock( connections[jj] );
828  }
829  }
830 
831  m_BlockLocate.Inflate( -1 );
832 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:255
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:124
bool IsSelected() const
Definition: base_struct.h:221
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:115
#define SELECTED
Definition: base_struct.h:120
void addConnectedItemsToBlock(const wxPoint &aPosition)
Function addConnectedItemsToBlock add items connected at aPosition to the block pick list...
Definition: sch_screen.cpp:835
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
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.
virtual void GetConnectionPoints(std::vector< wxPoint > &aPoints) const
Function GetConnectionPoints add all the connection points for this item to aPoints.
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:621
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 122 of file class_sch_screen.h.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

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

Definition at line 212 of file base_struct.h.

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

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

Definition at line 229 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

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

Function SetFootprintField searches screen for a component 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 1083 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().

1085 {
1086  SCH_COMPONENT* component;
1087  bool found = false;
1088 
1089  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1090  {
1091  if( item->Type() != SCH_COMPONENT_T )
1092  continue;
1093 
1094  component = (SCH_COMPONENT*) item;
1095 
1096  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
1097  {
1098  // Found: Init Footprint Field
1099 
1100  /* Give a reasonable value to the field position and
1101  * orientation, if the text is empty at position 0, because
1102  * it is probably not yet initialized
1103  */
1104  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
1105  if( fpfield->GetText().IsEmpty()
1106  && ( fpfield->GetTextPos() == component->GetPosition() ) )
1107  {
1108  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
1109  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
1110  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
1111 
1112  if( fpfield->GetTextAngle() == 0.0 )
1113  fpfield->Offset( wxPoint( 0, 100 ) );
1114  else
1115  fpfield->Offset( wxPoint( 100, 0 ) );
1116  }
1117 
1118  fpfield->SetText( aFootPrint );
1119  fpfield->SetVisible( aSetVisible );
1120 
1121  found = true;
1122  }
1123  }
1124 
1125  return found;
1126 }
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.
Field Value of part, i.e. "3.3K".
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
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

Function SetCurItem sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from SCH_ITEM

Definition at line 170 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::LoadOneEEFile(), 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().

170 { 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:151
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 253 of file base_struct.h.

Referenced by 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_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_SHEET::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(), LIB_PIN::SetNumber(), 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().

253 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 265 of file base_struct.h.

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

265 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:172
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::AppendOneEEProject(), SCH_EDIT_FRAME::DisplayCurrentSheet(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::GERBVIEW_FRAME(), LIB_EDIT_FRAME::LIB_EDIT_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 228 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

228 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
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 214 of file base_struct.h.

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

214 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:166
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::AppendOneEEProject(), SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::EditSheet(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), and SCH_EDIT_FRAME::LoadOneEEFile().

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:45
#define ABS_MAX_UNDO_ITEMS
Definition: draw_frame.h:46
void EDA_ITEM::SetModified ( )
inherited
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 211 of file base_struct.h.

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

211 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
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 115 of file class_sch_screen.h.

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

115 { 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 213 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(), SCH_SHEET::Load(), 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(), MODULE_EDITOR_TOOLS::PasteItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), 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(), BOARD_ITEM::SwapData(), SCH_SHEET::SwapData(), and SCH_COMPONENT::SwapData().

213 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:168
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 227 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::selectVisually().

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

Definition at line 203 of file base_struct.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendOneEEProject(), 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(), SCH_SHEET::Load(), 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(), BOARD_ITEM::SwapData(), and TestDuplicateSheetNames().

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

Definition at line 226 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

226 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:117
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(), 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 463 of file base_struct.h.

Referenced by PART_LIB::GetEntryTypePowerNames().

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

Function TestDanglingEnds tests all of the connectible objects in the schematic for unused connection points.

Returns
True if any connection state changes were made.

Definition at line 915 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::LoadOneEEFile(), 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().

916 {
917  SCH_ITEM* item;
918  std::vector< DANGLING_END_ITEM > endPoints;
919  bool hasStateChanged = false;
920 
921  for( item = m_drawList.begin(); item; item = item->Next() )
922  item->GetEndPoints( endPoints );
923 
924  for( item = m_drawList.begin(); item; item = item->Next() )
925  {
926  if( item->IsDanglingStateChanged( endPoints ) )
927  {
928  hasStateChanged = true;
929  }
930  }
931 
932  return hasStateChanged;
933 }
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 198 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(), SCH_EDIT_FRAME::AppendOneEEProject(), 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::BuildSheetsTree(), calcArea(), calcMaxArea(), calcMinArea(), DIALOG_EXCHANGE_MODULE::changeAllFootprints(), DIALOG_EXCHANGE_MODULE::changeSameFootprints(), 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(), LIB_PART::CopySelectedItems(), 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::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(), LIB_PART::GetBodyBoundingBox(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), NETLIST_OBJECT::GetComponentParent(), GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstVia(), GetHierarchicalItems(), 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_PART::GetUnitBoundingBox(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), 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::IsDanglingSt