KiCad PCB EDA Suite
SCH_SCREEN Class Reference

#include <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 ()
 
DLIST< SCH_ITEM > & GetDrawList ()
 
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 wxPoint & GetAuxOrigin () const
 
void SetAuxOrigin (const wxPoint &aPosition)
 
const TITLE_BLOCKGetTitleBlock () const
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
 
void DecRefCount ()
 
void IncRefCount ()
 
int GetRefCount () const
 
int GetClientSheetPathsCount ()
 
wxArrayString & GetClientSheetPaths ()
 
SCH_ITEMGetDrawItems () const
 
void Append (SCH_ITEM *aItem)
 
void Append (SCH_SCREEN *aScreen)
 Copy the contents of aScreen into this SCH_SCREEN object. More...
 
void Append (DLIST< SCH_ITEM > &aList)
 Add aList of SCH_ITEM objects to the list for draw items for the sheet. More...
 
void Clear ()
 Delete all draw items and clears the project settings. More...
 
void FreeDrawList ()
 Free all the items from the schematic associated with the screen. More...
 
SCH_ITEMGetItem (const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
 Check aPosition within a distance of aAccuracy for items of type aFilter. More...
 
void Place (SCH_EDIT_FRAME *frame, wxDC *DC)
 
void UpdateSymbolLinks (bool aForce=false)
 Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawList. More...
 
void Draw (EDA_DRAW_PANEL *aCanvas, wxDC *aDC)
 Draw all the items in the screen to aCanvas. More...
 
void Plot (PLOTTER *aPlotter)
 Plot all the schematic objects to aPlotter. More...
 
void Remove (SCH_ITEM *aItem)
 Remove aItem from the schematic associated with this screen. More...
 
void DeleteItem (SCH_ITEM *aItem)
 Removes aItem from the linked list and deletes the object. More...
 
bool CheckIfOnDrawList (SCH_ITEM *st)
 
bool TestDanglingEnds ()
 Test all of the connectable objects in the schematic for unused connection points. More...
 
void ReplaceWires (DLIST< SCH_ITEM > &aWireList)
 Replace all of the wires, buses, and junctions in the screen with aWireList. More...
 
void MarkConnections (SCH_LINE *aSegment)
 Add all wires and junctions connected to aSegment which are not connected any component pin to aItemList. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_CONTAINER &aList, int aItemCount=-1) override
 Free the undo or redo list from aList element. More...
 
void ClearDrawingState ()
 Clear the state flags of all the items in the screen. More...
 
int CountConnectedItems (const wxPoint &aPos, bool aTestJunctions) const
 
bool IsJunctionNeeded (const wxPoint &aPosition, bool aNew=false)
 Test if a junction is required for the items at aPosition on the screen. More...
 
bool IsTerminalPoint (const wxPoint &aPosition, int aLayer)
 Test if aPosition is a connection point on aLayer. More...
 
LIB_PINGetPin (const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
 Test the screen for a component pin item at aPosition. More...
 
SCH_SHEETGetSheet (const wxString &aName)
 Returns a sheet object pointer that is named aName. More...
 
SCH_SHEET_PINGetSheetLabel (const wxPoint &aPosition)
 Test the screen if aPosition is a sheet label object. More...
 
void ClearAnnotation (SCH_SHEET_PATH *aSheetPath)
 Clear the annotation for the components in aSheetPath on the screen. More...
 
void EnsureAlternateReferencesExist ()
 For screens shared by many sheetpaths (complex hierarchies): to be able to clear or modify any reference related sharing this screen (i.e. More...
 
void GetHierarchicalItems (EDA_ITEMS &aItems)
 Add all schematic sheet and component objects in the screen to aItems. More...
 
SCH_LINEGetWireOrBus (const wxPoint &aPosition)
 Return a wire or bus item located at aPosition. More...
 
SCH_LINEGetLine (const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 Return a line item located at aPosition. More...
 
SCH_LINEGetWire (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 
SCH_LINEGetBus (const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
 
SCH_TEXTGetLabel (const wxPoint &aPosition, int aAccuracy=0)
 Return a label item located at aPosition. More...
 
bool SetComponentFootprint (SCH_SHEET_PATH *aSheetPath, const wxString &aReference, const wxString &aFootPrint, bool aSetVisible)
 Search this screen for a symbol with aReference and set the footprint field to aFootPrint if found. More...
 
void AddBusAlias (std::shared_ptr< BUS_ALIAS > aAlias)
 Adds a bus alias definition (and transfers ownership of the pointer) More...
 
void ClearBusAliases ()
 Removes all bus alias definitions. More...
 
std::unordered_set< std::shared_ptr< BUS_ALIAS > > GetBusAliases ()
 Returns a list of bus aliases defined in this screen. More...
 
void SetCurItem (EDA_ITEM *aItem)
 Function SetCurItem sets the currently selected object, m_CurrentItem. More...
 
EDA_ITEMGetCurItem () const
 
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...
 
virtual 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 (timestamp_t aNewTimeStamp)
 
timestamp_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
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
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 (EDA_UNITS_T aUnits, 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, int aAccuracy=0) const
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
virtual bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const
 Function HitTest tests if aRect intersects or is contained within the bounding box 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 (EDA_UNITS_T aUnits) const
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
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...
 
VTBL_ENTRY EDA_UNITS_T GetUserUnits () const
 Function GetUserUnits Allows participation in KEYWAY_PLAYER/DIALOG_SHIM userUnits inheritance. More...
 
VTBL_ENTRY TOOL_MANAGERGetToolManager () const
 Function GetToolManager Return the tool manager instance, if any. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static bool IsBusAlias (const wxString &aLabel)
 Returns true if the given string is a valid bus alias in a loaded screen. More...
 
static std::shared_ptr< BUS_ALIASGetBusAlias (const wxString &aLabel)
 Returns a pointer to a bus alias object for the given label, or null if one doesn't exist. More...
 
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_Initialized
 
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...
 
timestamp_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 Attributes

wxString m_fileName
 File used to load the screen. More...
 
int m_refCount
 Number of sheets referencing this screen. More...
 
wxArrayString m_clientSheetPathList
 the list of scheet paths sharing this screen used in some annotation calculations to update alternate references Note: a screen having a m_refCount = 1 (only one sheet path using it) can have many scheet paths sharing this screen, if this sheet is inside an other sheet having many instances (one sheet path by parent sheet instance). More...
 
PAGE_INFO m_paper
 The size of the paper to print or plot on. More...
 
TITLE_BLOCK m_titles
 
wxPoint m_aux_origin
 Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA. More...
 
DLIST< SCH_ITEMm_drawList
 Object list for the screen. More...
 
int m_modification_sync
 inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll(). More...
 
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
 List of bus aliases stored in this screen. More...
 

Detailed Description

Definition at line 70 of file sch_screen.h.

Constructor & Destructor Documentation

◆ SCH_SCREEN()

SCH_SCREEN::SCH_SCREEN ( KIWAY aKiway)

Constructor.

Definition at line 104 of file sch_screen.cpp.

104  :
106  KIWAY_HOLDER( aKiway ),
107  m_paper( wxT( "A4" ) )
108 {
110 
111  SetZoom( 32 );
112 
113  for( unsigned i = 0; i < arrayDim( SchematicZoomList ); i++ )
114  m_ZoomList.push_back( SchematicZoomList[i] );
115 
116  for( unsigned i = 0; i < arrayDim( SchematicGridList ); i++ )
118 
119  // Set the default grid size, now that the grid list is populated
120  SetGrid( wxRealPoint( 50, 50 ) );
121 
122  m_refCount = 0;
123 
124  // Suitable for schematic only. For libedit and viewlib, must be set to true
125  m_Center = false;
126 
127  InitDataPoints( m_paper.GetSizeIU() );
128 }
static double SchematicZoomList[]
Definition: sch_screen.cpp:75
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:76
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:97
static GRID_TYPE SchematicGridList[]
Definition: sch_screen.cpp:93
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:72
PAGE_INFO m_paper
The size of the paper to print or plot on.
Definition: sch_screen.h:88
bool m_Center
Center on screen.
Definition: base_screen.h:202
KIWAY_HOLDER(KIWAY *aKiway)
Definition: kiway_player.h:52
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:107
void AddGrid(const GRID_TYPE &grid)
BASE_SCREEN(KICAD_T aType=SCREEN_T)
Definition: base_screen.cpp:45
size_t i
Definition: json11.cpp:597
int SetGrid(const wxRealPoint &size)
set the current grid size m_Grid.
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219

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

◆ ~SCH_SCREEN()

SCH_SCREEN::~SCH_SCREEN ( )

Definition at line 131 of file sch_screen.cpp.

132 {
134 
135  // Now delete items in draw list. We do that only if the list is not empty,
136  // because if the list was appended to another list (see SCH_SCREEN::Append( SCH_SCREEN* aScreen )
137  // it is empty but as no longer the ownership (m_drawList.meOwner == false) of items, and calling
138  // FreeDrawList() with m_drawList.meOwner == false will generate a debug alert in debug mode
139  if( GetDrawItems() )
140  FreeDrawList();
141 }
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:183
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:153

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

Member Function Documentation

◆ AddBusAlias()

void SCH_SCREEN::AddBusAlias ( std::shared_ptr< BUS_ALIAS aAlias)

Adds a bus alias definition (and transfers ownership of the pointer)

Definition at line 908 of file sch_screen.cpp.

909 {
910  m_aliases.insert( aAlias );
911 }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:101

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN::LoadContent().

◆ AddGrid() [1/3]

void BASE_SCREEN::AddGrid ( const GRID_TYPE grid)
inherited

Definition at line 279 of file base_screen.cpp.

280 {
281  for( unsigned i = 0; i < m_grids.size(); i++ )
282  {
283  if( m_grids[i].m_Size == grid.m_Size && grid.m_CmdId != ID_POPUP_GRID_USER )
284  {
285  wxLogTrace( traceScreen, "Discarding duplicate grid size( %g, %g ).",
286  grid.m_Size.x, grid.m_Size.y );
287  return;
288  }
289 
290  if( m_grids[i].m_CmdId == grid.m_CmdId )
291  {
292  wxLogTrace( traceScreen, wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
293  wxT( "size( %g, %g )." ),
294  grid.m_CmdId, m_grids[i].m_Size.x,
295  m_grids[i].m_Size.y, grid.m_Size.x, grid.m_Size.y );
296  m_grids[i].m_Size = grid.m_Size;
297  return;
298  }
299  }
300 
301  m_grids.push_back( grid );
302 }
const wxChar *const traceScreen
Flag to enable debug output of BASE_SCREEN and it's derivatives.
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
int m_CmdId
Definition: base_screen.h:48

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

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

◆ AddGrid() [2/3]

void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
int  id 
)
inherited

Definition at line 305 of file base_screen.cpp.

306 {
307  GRID_TYPE grid;
308 
309  grid.m_Size = size;
310  grid.m_CmdId = id;
311  AddGrid( grid );
312 }
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48

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

◆ AddGrid() [3/3]

void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
EDA_UNITS_T  aUnit,
int  id 
)
inherited

Definition at line 315 of file base_screen.cpp.

316 {
317  wxRealPoint new_size;
318  GRID_TYPE new_grid;
319 
320  new_size.x = From_User_Unit( aUnit, size.x );
321  new_size.y = From_User_Unit( aUnit, size.y );
322  new_grid.m_CmdId = id;
323  new_grid.m_Size = new_size;
324 
325  AddGrid( new_grid );
326 }
double From_User_Unit(EDA_UNITS_T aUnits, double aValue, bool aUseMils)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:278
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48

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

◆ Append() [1/3]

void SCH_SCREEN::Append ( SCH_ITEM aItem)
inline

Definition at line 155 of file sch_screen.h.

156  {
157  m_drawList.Append( aItem );
159  }
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().
Definition: sch_screen.h:97
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EDIT_FRAME::AppendSchematic(), Diagnose(), CONNECTION_GRAPH::ercCheckLabels(), SCH_LEGACY_PLUGIN::LoadContent(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSegments(), CONNECTION_SUBGRAPH::ResolveDrivers(), SimilarLabelsDiagnose(), TestDuplicateSheetNames(), and TestMultiunitFootprints().

◆ Append() [2/3]

void SCH_SCREEN::Append ( SCH_SCREEN aScreen)

Copy the contents of aScreen into this SCH_SCREEN object.

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

Definition at line 158 of file sch_screen.cpp.

159 {
160  wxCHECK_RET( aScreen, "Invalid screen object." );
161 
162  // No need to decend the hierarchy. Once the top level screen is copied, all of it's
163  // children are copied as well.
164  m_drawList.Append( aScreen->m_drawList );
165 
166  // This screen owns the objects now. This prevents the object from being delete when
167  // aSheet is deleted.
168  aScreen->m_drawList.SetOwnership( false );
169 }
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
void SetOwnership(bool Iown)
Function SetOwnership controls whether the list owns the objects and is responsible for deleteing the...
Definition: dlist.h:119

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

◆ Append() [3/3]

void SCH_SCREEN::Append ( DLIST< SCH_ITEM > &  aList)
inline

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

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

Definition at line 178 of file sch_screen.h.

179  {
180  m_drawList.Append( aList );
182  }
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().
Definition: sch_screen.h:97
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95

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

◆ Back()

EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 213 of file base_struct.h.

213 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:171

References EDA_ITEM::Pback.

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

◆ BuildGridsChoiceList()

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 178 of file base_screen.cpp.

179 {
180  wxString msg;
181  wxRealPoint curr_grid_size = GetGridSize();
182  int idx = -1;
183  int idx_usergrid = -1;
184 
185  for( size_t i = 0; i < GetGridCount(); i++ )
186  {
187  const GRID_TYPE& grid = m_grids[i];
188  double gridValueMils = To_User_Unit( INCHES, grid.m_Size.x ) * 1000;
189  double gridValue_mm = To_User_Unit( MILLIMETRES, grid.m_Size.x );
190 
191  if( grid.m_CmdId == ID_POPUP_GRID_USER )
192  {
193  if( aMmFirst )
194  msg.Printf( _( "User grid: %.4f mm (%.2f mils)" ),
195  gridValue_mm, gridValueMils );
196  else
197  msg.Printf( _( "User grid: %.2f mils (%.4f mm)" ),
198  gridValueMils, gridValue_mm );
199  idx_usergrid = i;
200  }
201  else
202  {
203  if( aMmFirst )
204  msg.Printf( _( "Grid: %.4f mm (%.2f mils)" ),
205  gridValue_mm, gridValueMils );
206  else
207  msg.Printf( _( "Grid: %.2f mils (%.4f mm)" ),
208  gridValueMils, gridValue_mm );
209  }
210 
211  aGridsList.Add( msg );
212 
213  if( curr_grid_size == grid.m_Size )
214  idx = i;
215  }
216 
217  if( idx < 0 )
218  idx = idx_usergrid;
219 
220  return idx;
221 }
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:410
double To_User_Unit(EDA_UNITS_T aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:93
Definition: common.h:158
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
size_t i
Definition: json11.cpp:597
size_t GetGridCount() const
Function GetGridCount().
Definition: base_screen.h:457
int m_CmdId
Definition: base_screen.h:48

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

Referenced by GRID_MENU::GRID_MENU(), GRID_MENU::update(), GERBVIEW_FRAME::updateGridSelectBox(), and PCB_BASE_FRAME::UpdateGridSelectBox().

◆ CheckIfOnDrawList()

bool SCH_SCREEN::CheckIfOnDrawList ( SCH_ITEM st)

Definition at line 221 of file sch_screen.cpp.

222 {
223  SCH_ITEM* itemList = m_drawList.begin();
224 
225  while( itemList )
226  {
227  if( itemList == aItem )
228  return true;
229 
230  itemList = itemList->Next();
231  }
232 
233  return false;
234 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

◆ Clear()

void SCH_SCREEN::Clear ( )

Delete all draw items and clears the project settings.

Definition at line 172 of file sch_screen.cpp.

173 {
174  FreeDrawList();
175 
176  // Clear the project settings
178 
179  m_titles.Clear();
180 }
int m_ScreenNumber
Definition: base_screen.h:216
void Clear()
Definition: title_block.h:127
TITLE_BLOCK m_titles
Definition: sch_screen.h:90
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:183
int m_NumberOfScreens
Definition: base_screen.h:217

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

Referenced by SCH_EDIT_FRAME::OnCloseWindow().

◆ ClearAnnotation()

void SCH_SCREEN::ClearAnnotation ( SCH_SHEET_PATH aSheetPath)

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

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

Definition at line 722 of file sch_screen.cpp.

723 {
724  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
725  {
726  if( item->Type() == SCH_COMPONENT_T )
727  {
728  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
729 
730  component->ClearAnnotation( aSheetPath );
731 
732  // Clear the modified component flag set by component->ClearAnnotation
733  // because we do not use it here and we should not leave this flag set,
734  // when an editing is finished:
735  component->ClearFlags();
736  }
737  }
738 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath)
Clear exiting component annotation.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:260
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), and SCH_EDIT_FRAME::DeleteAnnotation().

◆ ClearBlockCommand()

void BASE_SCREEN::ClearBlockCommand ( )
inlineinherited

Definition at line 501 of file base_screen.h.

501 { m_BlockLocate.Clear(); }
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
void Clear()
Function Clear clears the block selector by setting the command to idle, the state to no block,...

References BLOCK_SELECTOR::Clear(), and BASE_SCREEN::m_BlockLocate.

Referenced by PL_EDITOR_FRAME::HandleBlockEnd(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), GERBVIEW_FRAME::HandleBlockEnd(), PCB_EDIT_FRAME::HandleBlockEnd(), PL_EDITOR_FRAME::HandleBlockPlace(), GERBVIEW_FRAME::HandleBlockPlace(), and PCB_EDIT_FRAME::HandleBlockPlace().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 239 of file base_struct.h.

239 { 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:260

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearBusAliases()

void SCH_SCREEN::ClearBusAliases ( )
inline

Removes all bus alias definitions.

Definition at line 458 of file sch_screen.h.

459  {
460  m_aliases.clear();
461  }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:101

References m_aliases.

◆ ClearDrawingState()

void SCH_SCREEN::ClearDrawingState ( )

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

Definition at line 604 of file sch_screen.cpp.

605 {
606  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
607  item->ClearTempFlags();
608 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and EE_SELECTION_TOOL::SelectConnection().

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )
inlineinherited

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 260 of file base_struct.h.

260 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References EDA_ITEM::m_Flags.

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(), AbortMoveDimensionText(), AbortMoveTextModule(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_COMPONENT::ClearAllHighlightFlags(), ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), 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_Route(), PCB_EDIT_FRAME::End_Zone(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), PCB_BASE_FRAME::Import_Pad_Settings(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), EDIT_POINTS_FACTORY::Make(), MarkItemsInBloc(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), 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(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), BOARD_COMMIT::Revert(), LIB_EDIT_FRAME::RollbackPartFromUndo(), PCB_BASE_FRAME::Rotate_Module(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 238 of file base_struct.h.

238 { 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:260

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 271 of file base_struct.h.

272  {
274  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:111
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:124
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:120
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:260
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:119

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, and STARTPOINT.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearUndoORRedoList()

void SCH_SCREEN::ClearUndoORRedoList ( UNDO_REDO_CONTAINER aList,
int  aItemCount = -1 
)
overridevirtual

Free the undo or redo list from aList element.

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

Implements BASE_SCREEN.

Definition at line 589 of file sch_screen.cpp.

590 {
591  if( aItemCount == 0 )
592  return;
593 
594  for( auto& command : aList.m_CommandsList )
595  {
596  command->ClearListAndDeleteItems();
597  delete command;
598  }
599 
600  aList.m_CommandsList.clear();
601 }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_FRAME::importFile(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::rescueProject(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearUndoRedoList()

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 408 of file base_screen.cpp.

409 {
412 }
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)
Definition: base_screen.h:210
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
155  m_viewPrivData = NULL;
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

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

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

Returns
A clone of the item.

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

Definition at line 123 of file base_struct.cpp.

124 {
125  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
126  wxT( ". Bad programmer!" ) );
127 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), CopyMarkedItems(), LIB_DRAWING_TOOLS::doTwoClickPlace(), SCH_DRAWING_TOOLS::doTwoClickPlace(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), LIB_EDIT_TOOL::Paste(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

◆ ClrModify()

◆ ClrSave()

void BASE_SCREEN::ClrSave ( )
inlineinherited

Definition at line 327 of file base_screen.h.

327 { m_FlagSave = false; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81

References BASE_SCREEN::m_FlagSave.

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

◆ CountConnectedItems()

int SCH_SCREEN::CountConnectedItems ( const wxPoint &  aPos,
bool  aTestJunctions 
) const

Definition at line 704 of file sch_screen.cpp.

705 {
706  SCH_ITEM* item;
707  int count = 0;
708 
709  for( item = m_drawList.begin(); item; item = item->Next() )
710  {
711  if( item->Type() == SCH_JUNCTION_T && !aTestJunctions )
712  continue;
713 
714  if( item->IsConnected( aPos ) )
715  count++;
716  }
717 
718  return count;
719 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
Definition: sch_item.cpp:118
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

◆ DecRefCount()

void SCH_SCREEN::DecRefCount ( )

Definition at line 150 of file sch_screen.cpp.

151 {
152  wxCHECK_RET( m_refCount != 0,
153  wxT( "Screen reference count already zero. Bad programmer!" ) );
154  m_refCount--;
155 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:76

References m_refCount.

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

◆ DeleteItem()

void SCH_SCREEN::DeleteItem ( SCH_ITEM aItem)

Removes aItem from the linked list and deletes the object.

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

Parameters
aItemThe schematic object to be deleted from the screen.

Definition at line 195 of file sch_screen.cpp.

196 {
197  wxCHECK_RET( aItem, wxT( "Cannot delete invalid item from screen." ) );
198 
199  SetModify();
200 
201  if( aItem->Type() == SCH_SHEET_PIN_T )
202  {
203  // This structure is attached to a sheet, get the parent sheet object.
204  SCH_SHEET_PIN* sheetPin = (SCH_SHEET_PIN*) aItem;
205  SCH_SHEET* sheet = sheetPin->GetParent();
206  wxCHECK_RET( sheet, wxT( "Sheet label parent not properly set, bad programmer!" ) );
207  sheet->RemovePin( sheetPin );
208  return;
209  }
210  else
211  {
212  if( GetCurItem() == aItem )
213  SetCurItem( nullptr );
214 
215  m_drawList.Remove( aItem );
216  delete aItem;
217  }
218 }
void SetCurItem(EDA_ITEM *aItem)
Function SetCurItem sets the currently selected object, m_CurrentItem.
Definition: base_screen.h:231
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
Definition: sch_sheet.h:153
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
EDA_ITEM * GetCurItem() const
Definition: base_screen.h:233
void RemovePin(SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
Definition: sch_sheet.cpp:187
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:56
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:201
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
void SetModify()
Definition: base_screen.h:324
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

Referenced by SCH_SCREENS::DeleteAllMarkers().

◆ Draw()

void SCH_SCREEN::Draw ( EDA_DRAW_PANEL aCanvas,
wxDC *  aDC 
)

Draw all the items in the screen to aCanvas.

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

Definition at line 530 of file sch_screen.cpp.

531 {
532  /* note: SCH_SCREEN::Draw is useful only for schematic.
533  * library editor and library viewer do not use m_drawList, and therefore
534  * their SCH_SCREEN::Draw() draws nothing
535  */
536  std::vector< SCH_ITEM* > junctions;
537 
538  // Ensure links are up to date, even if a library was reloaded for some reason:
540 
541  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
542  {
543  if( item->IsMoving() || item->IsResized() )
544  continue;
545 
546  if( item->Type() == SCH_JUNCTION_T )
547  junctions.push_back( item );
548  else
549  // uncomment line below when there is a virtual EDA_ITEM::GetBoundingBox()
550  // if( panel->GetClipBox().Intersects( item->GetBoundingBox() ) )
551  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ) );
552 
553  // TODO(JE) Remove debugging code
554 #ifdef DEBUG
555 
556  auto conn = item->Connection( *g_CurrentSheet );
557 
558  if( conn )
559  {
560  auto pos = item->GetBoundingBox().Centre();
561  int sz = Mils2iu( 15 );
562  auto label = conn->Name( true );
563 
564  auto text = SCH_TEXT( pos, label, SCH_TEXT_T );
565  text.SetTextSize( wxSize( sz, sz ) );
566  text.Draw( aCanvas, aDC, wxPoint( 10, 10 ) );
567  }
568 #endif
569  }
570 
571  for( auto item : junctions )
572  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ) );
573 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:502
T * begin() const
Definition: dlist.h:218
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

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

◆ EnsureAlternateReferencesExist()

void SCH_SCREEN::EnsureAlternateReferencesExist ( )

For screens shared by many sheetpaths (complex hierarchies): to be able to clear or modify any reference related sharing this screen (i.e.

thie list of components), an entry for each screen path must exist. This function creates missing entries, using as default reference the current reference field and unit number Note: m_clientSheetPathList must be up to date ( built by SCH_SCREENS::BuildClientSheetPathList() )

Definition at line 741 of file sch_screen.cpp.

742 {
743  if( GetClientSheetPathsCount() <= 1 ) // No need for alternate reference
744  return;
745 
746  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
747  {
748  if( item->Type() != SCH_COMPONENT_T )
749  continue;
750 
751  // Add (when not existing) all sheet path entries
752  for( unsigned int ii = 0; ii < m_clientSheetPathList.GetCount(); ii++ )
753  ((SCH_COMPONENT*)item)->AddSheetPathReferenceEntryIfMissing( m_clientSheetPathList[ii] );
754  }
755 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
int GetClientSheetPathsCount()
Definition: sch_screen.h:146
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
wxArrayString m_clientSheetPathList
the list of scheet paths sharing this screen used in some annotation calculations to update alternate...
Definition: sch_screen.h:85

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

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths().

◆ FreeDrawList()

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 183 of file sch_screen.cpp.

184 {
186 }
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:44
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95

References DHEAD::DeleteAll(), and m_drawList.

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

◆ GetAuxOrigin()

const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const
inline

Definition at line 126 of file sch_screen.h.

126 { return m_aux_origin; }
wxPoint m_aux_origin
Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA.
Definition: sch_screen.h:93

References m_aux_origin.

Referenced by SCH_BASE_FRAME::GetAuxOrigin().

◆ GetBoundingBox()

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_COMPONENT, SCH_HIERLABEL, SCH_GLOBALLABEL, DIMENSION, GERBER_DRAW_ITEM, LIB_ITEM, SCH_LABEL, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, MODULE, SCH_TEXT, TRACK, ZONE_CONTAINER, LIB_PIN, SCH_FIELD, TEXTE_PCB, SCH_LINE, MARKER_PCB, SCH_BITMAP, LIB_ALIAS, GBR_LAYOUT, PCB_TARGET, LIB_TEXT, SCH_BUS_ENTRY_BASE, LIB_ARC, LIB_BEZIER, LIB_POLYLINE, SCH_PIN, LIB_RECTANGLE, SCH_NO_CONNECT, LIB_CIRCLE, SCH_JUNCTION, and SCH_MARKER.

Definition at line 110 of file base_struct.cpp.

111 {
112 #if defined(DEBUG)
113  printf( "Missing GetBoundingBox()\n" );
114  Show( 0, std::cout ); // tell me which classes still need GetBoundingBox support
115 #endif
116 
117  // return a zero-sized box per default. derived classes should override
118  // this
119  return EDA_RECT( wxPoint( 0, 0 ), wxSize( 0, 0 ) );
120 }
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), CN_ITEM::BBox(), MODULE::CoverageRatio(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), getRect(), getSheetBbox(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Rotate(), and EDA_ITEM::ViewBBox().

◆ GetBus()

SCH_LINE* SCH_SCREEN::GetBus ( const wxPoint &  aPosition,
int  aAccuracy = 0,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)
inline

Definition at line 421 of file sch_screen.h.

423  {
424  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
425  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:807

References GetLine(), and LAYER_BUS.

Referenced by IsTerminalPoint(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ GetBusAlias()

std::shared_ptr< BUS_ALIAS > SCH_SCREEN::GetBusAlias ( const wxString &  aLabel)
static

Returns a pointer to a bus alias object for the given label, or null if one doesn't exist.

Definition at line 932 of file sch_screen.cpp.

933 {
934  SCH_SHEET_LIST aSheets( g_RootSheet );
935  for( unsigned i = 0; i < aSheets.size(); i++ )
936  {
937  for( auto alias : aSheets[i].LastScreen()->GetBusAliases() )
938  {
939  if( alias->GetName() == aLabel )
940  {
941  return alias;
942  }
943  }
944  }
945 
946  return NULL;
947 }
Class SCH_SHEET_LIST.
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:56
size_t i
Definition: json11.cpp:597

References g_RootSheet, and i.

Referenced by NETLIST_OBJECT::ConvertBusToNetListItems().

◆ GetBusAliases()

std::unordered_set< std::shared_ptr<BUS_ALIAS> > SCH_SCREEN::GetBusAliases ( )
inline

Returns a list of bus aliases defined in this screen.

Definition at line 466 of file sch_screen.h.

467  {
468  return m_aliases;
469  }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:101

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN::Format().

◆ GetClass()

virtual wxString SCH_SCREEN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from BASE_SCREEN.

Definition at line 114 of file sch_screen.h.

115  {
116  return wxT( "SCH_SCREEN" );
117  }

◆ GetClientSheetPaths()

wxArrayString& SCH_SCREEN::GetClientSheetPaths ( )
inline

Definition at line 148 of file sch_screen.h.

148 { return m_clientSheetPathList; }
wxArrayString m_clientSheetPathList
the list of scheet paths sharing this screen used in some annotation calculations to update alternate...
Definition: sch_screen.h:85

References m_clientSheetPathList.

Referenced by SCH_SCREENS::BuildClientSheetPathList().

◆ GetClientSheetPathsCount()

int SCH_SCREEN::GetClientSheetPathsCount ( )
inline
Returns
the sheet paths count sharing this screen if 1 this screen is not in a complex hierarchy: the reference field can be used to store the component reference if > 1 this screen is in a complex hierarchy, and components must have a full alternate reference management

Definition at line 146 of file sch_screen.h.

146 { return (int) m_clientSheetPathList.GetCount(); }
wxArrayString m_clientSheetPathList
the list of scheet paths sharing this screen used in some annotation calculations to update alternate...
Definition: sch_screen.h:85

References m_clientSheetPathList.

Referenced by EnsureAlternateReferencesExist().

◆ GetCurItem()

◆ GetDrawItems()

SCH_ITEM* SCH_SCREEN::GetDrawItems ( ) const
inline
Returns
A pointer to the first item in the linked list of draw items.

Definition at line 153 of file sch_screen.h.

153 { return m_drawList.begin(); }
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95

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

Referenced by SCH_EDIT_FRAME::AddMissingJunctions(), SCH_EDIT_FRAME::AppendSchematic(), SCH_EDIT_FRAME::BreakSegments(), SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), NETLIST_OBJECT_LIST::BuildNetListInfo(), SCH_SCREENS::buildScreenList(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_SHEET::CleanupSheet(), SCH_SHEET::ComponentCount(), SCH_SHEET::CountSheets(), SCH_SCREENS::DeleteAllMarkers(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_WIRE_BUS_TOOL::finishSegments(), SCH_SHEET_PATH::FirstDrawList(), SCH_LEGACY_PLUGIN::Format(), AUTOPLACER::get_possible_colliders(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_SCREENS::GetLibNicknames(), EE_SELECTION_TOOL::GetNode(), getSheetBbox(), getSheetPin(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_SHEET_PATH::LastDrawList(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_EDIT_FRAME::OnCloseWindow(), EE_SELECTION_TOOL::RebuildSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), EE_SELECTION_TOOL::SelectConnection(), EE_SELECTION_TOOL::SelectPoint(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), UpdateSymbolLinks(), and ~SCH_SCREEN().

◆ GetDrawList()

DLIST< SCH_ITEM >& SCH_SCREEN::GetDrawList ( )
inline

Definition at line 112 of file sch_screen.h.

112 { return m_drawList; }
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95

References m_drawList.

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 263 of file base_struct.h.

264  {
268  return m_Flags & mask;
269  }
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:133
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:132
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:148
#define SELECTED
Definition: base_struct.h:121
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:139
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:143
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:120
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:119

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, and STARTPOINT.

Referenced by AbortMoveAndEditTarget(), SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), 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(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), FOOTPRINT_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(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ GetFileName()

◆ GetFlags()

◆ GetGrid() [1/2]

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 base_screen.h.

417 { return m_Grid; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83

References BASE_SCREEN::m_Grid.

Referenced by GRID_MENU::GRID_MENU(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), GRID_MENU::update(), GERBVIEW_FRAME::updateGridSelectBox(), and PCB_BASE_FRAME::UpdateGridSelectBox().

◆ GetGrid() [2/2]

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 329 of file base_screen.cpp.

330 {
331  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
332  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
333 
334  return m_grids[ aIndex ];
335 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79

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

◆ GetGridCmdId()

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 base_screen.h.

403 { return m_Grid.m_CmdId; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
int m_CmdId
Definition: base_screen.h:48

References GRID_TYPE::m_CmdId, and BASE_SCREEN::m_Grid.

Referenced by COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPrev(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), DIALOG_SET_GRID::TransferDataFromWindow(), and GRID_MENU::update().

◆ GetGridCount()

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 base_screen.h.

457 { return m_grids.size(); }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79

References BASE_SCREEN::m_grids.

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

◆ GetGrids()

const GRIDS& BASE_SCREEN::GetGrids ( ) const
inlineinherited

Function GetGrids().

Returns the current list of grids.

Definition at line 472 of file base_screen.h.

473  {
474  return m_grids;
475  }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79

References BASE_SCREEN::m_grids.

Referenced by PCB_BASE_FRAME::SetFastGrid1(), and PCB_BASE_FRAME::SetFastGrid2().

◆ GetGridSize()

const wxRealPoint& BASE_SCREEN::GetGridSize ( ) const
inlineinherited

◆ GetHierarchicalItems()

void SCH_SCREEN::GetHierarchicalItems ( EDA_ITEMS aItems)

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

Parameters
aItemsHierarchical item list to fill.

Definition at line 758 of file sch_screen.cpp.

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 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

◆ GetItem()

SCH_ITEM * SCH_SCREEN::GetItem ( const wxPoint &  aPosition,
int  aAccuracy = 0,
KICAD_T  aType = SCH_LOCATE_ANY_T 
) const

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

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

Definition at line 237 of file sch_screen.cpp.

238 {
239  KICAD_T types[] = { aType, EOT };
240 
241  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
242  {
243  switch( item->Type() )
244  {
245  case SCH_COMPONENT_T:
246  {
247  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
248 
249  for( int i = REFERENCE; i < component->GetFieldCount(); i++ )
250  {
251  SCH_FIELD* field = component->GetField( i );
252 
253  if( field->IsType( types ) && field->HitTest( aPosition, aAccuracy ) )
254  return field;
255  }
256 
257  break;
258  }
259  case SCH_SHEET_T:
260  {
261  SCH_SHEET* sheet = (SCH_SHEET*)item;
262 
263  SCH_SHEET_PIN* pin = sheet->GetPin( aPosition );
264 
265  if( pin && pin->IsType( types ) )
266  return pin;
267 
268  break;
269  }
270  default:
271  break;
272  }
273 
274  if( item->IsType( types ) && item->HitTest( aPosition, aAccuracy ) )
275  return item;
276  }
277 
278  return NULL;
279 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
bool IsType(const KICAD_T aScanTypes[]) override
Function IsType Checks whether the item is one of the listed types.
Definition: sch_field.h:73
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:371
SCH_ITEM * Next() const
Definition: sch_item.h:153
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:287
T * begin() const
Definition: dlist.h:218
Field Reference of part, i.e. "IC21".
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: sch_field.cpp:453
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:56
int GetFieldCount() const
Return the number of fields in this symbol.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:201
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
size_t i
Definition: json11.cpp:597
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

References DLIST< T >::begin(), EOT, SCH_COMPONENT::GetField(), SCH_COMPONENT::GetFieldCount(), SCH_SHEET::GetPin(), SCH_FIELD::HitTest(), i, SCH_FIELD::IsType(), EDA_ITEM::IsType(), m_drawList, SCH_ITEM::Next(), REFERENCE, SCH_COMPONENT_T, and SCH_SHEET_T.

Referenced by SCH_EDIT_TOOL::DoDelete(), SCH_DRAWING_TOOLS::doSingleClickPlace(), and IsTerminalPoint().

◆ GetLabel()

SCH_TEXT * SCH_SCREEN::GetLabel ( const wxPoint &  aPosition,
int  aAccuracy = 0 
)

Return a label item located at aPosition.

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

Definition at line 841 of file sch_screen.cpp.

842 {
843  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
844  {
845  switch( item->Type() )
846  {
847  case SCH_LABEL_T:
848  case SCH_GLOBAL_LABEL_T:
849  case SCH_HIER_LABEL_T:
850  if( item->HitTest( aPosition, aAccuracy ) )
851  return (SCH_TEXT*) item;
852 
853  default:
854  ;
855  }
856  }
857 
858  return NULL;
859 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by IsTerminalPoint().

◆ GetLine()

SCH_LINE * SCH_SCREEN::GetLine ( const wxPoint &  aPosition,
int  aAccuracy = 0,
int  aLayer = LAYER_NOTES,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)

Return a line item located at aPosition.

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

Definition at line 807 of file sch_screen.cpp.

809 {
810  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
811  {
812  if( item->Type() != SCH_LINE_T )
813  continue;
814 
815  if( item->GetLayer() != aLayer )
816  continue;
817 
818  if( !item->HitTest( aPosition, aAccuracy ) )
819  continue;
820 
821  switch( aSearchType )
822  {
823  case ENTIRE_LENGTH_T:
824  return (SCH_LINE*) item;
825 
827  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
828  return (SCH_LINE*) item;
829  break;
830 
831  case END_POINTS_ONLY_T:
832  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
833  return (SCH_LINE*) item;
834  }
835  }
836 
837  return NULL;
838 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

◆ GetList()

DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited

◆ GetMaxAllowedZoom()

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 base_screen.h.

361 { return m_ZoomList.size() ? *m_ZoomList.rbegin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219

References BASE_SCREEN::m_ZoomList.

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

◆ GetMaxUndoItems()

int BASE_SCREEN::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 311 of file base_screen.h.

311 { return m_UndoRedoCountMax; }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86

References BASE_SCREEN::m_UndoRedoCountMax.

◆ GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

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

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

Returns
The menu image associated with the item.

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

Definition at line 272 of file base_struct.cpp.

273 {
274  return dummy_xpm;
275 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

◆ GetMinAllowedZoom()

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 base_screen.h.

368 { return m_ZoomList.size() ? *m_ZoomList.begin() : 1.0; }
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219

References BASE_SCREEN::m_ZoomList.

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

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
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, GERBER_DRAW_ITEM, NETINFO_ITEM, LIB_ITEM, TRACK, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, SCH_LINE, SCH_TEXT, LIB_FIELD, EDGE_MODULE, LIB_PIN, SCH_BUS_ENTRY_BASE, MARKER_PCB, LIB_BEZIER, ZONE_CONTAINER, LIB_TEXT, LIB_ARC, LIB_POLYLINE, SCH_MARKER, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 321 of file base_struct.h.

322  {
323  }

Referenced by EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), PCB_BASE_FRAME::UpdateMsgPanel(), and FOOTPRINT_EDIT_FRAME::UpdateMsgPanel().

◆ GetPageSettings()

◆ GetParent()

◆ GetPin()

LIB_PIN * SCH_SCREEN::GetPin ( const wxPoint &  aPosition,
SCH_COMPONENT **  aComponent = NULL,
bool  aEndPointOnly = false 
) const

Test the screen for a component pin item at aPosition.

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

Definition at line 611 of file sch_screen.cpp.

613 {
614  SCH_ITEM* item;
615  SCH_COMPONENT* component = NULL;
616  LIB_PIN* pin = NULL;
617 
618  for( item = m_drawList.begin(); item; item = item->Next() )
619  {
620  if( item->Type() != SCH_COMPONENT_T )
621  continue;
622 
623  component = (SCH_COMPONENT*) item;
624 
625  if( aEndPointOnly )
626  {
627  pin = NULL;
628 
629  auto part = component->GetPartRef().lock();
630 
631  if( !part )
632  continue;
633 
634  for( pin = part->GetNextPin(); pin; pin = part->GetNextPin( pin ) )
635  {
636  // Skip items not used for this part.
637  if( component->GetUnit() && pin->GetUnit() &&
638  ( pin->GetUnit() != component->GetUnit() ) )
639  continue;
640 
641  if( component->GetConvert() && pin->GetConvert() &&
642  ( pin->GetConvert() != component->GetConvert() ) )
643  continue;
644 
645  if(component->GetPinPhysicalPosition( pin ) == aPosition )
646  break;
647  }
648  if( pin )
649  break;
650  }
651  else
652  {
653  pin = (LIB_PIN*) component->GetDrawItem( aPosition, LIB_PIN_T );
654 
655  if( pin )
656  break;
657  }
658  }
659 
660  if( pin && aComponent )
661  *aComponent = component;
662 
663  return pin;
664 }
PART_REF & GetPartRef()
SCH_ITEM * Next() const
Definition: sch_item.h:153
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.
int GetUnit() const
int GetUnit() const
int GetConvert() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
int GetConvert() const
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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 IsTerminalPoint(), and MarkConnections().

◆ GetRedoCommandCount()

int BASE_SCREEN::GetRedoCommandCount ( ) const
inlineinherited

Definition at line 306 of file base_screen.h.

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)
Definition: base_screen.h:211

References UNDO_REDO_CONTAINER::m_CommandsList, and BASE_SCREEN::m_RedoList.

Referenced by BASE_SCREEN::PushCommandToRedoList(), LIB_EDIT_FRAME::ReCreateMenuBar(), and SCH_EDITOR_CONTROL::Redo().

◆ GetRefCount()

int SCH_SCREEN::GetRefCount ( ) const
inline

Definition at line 137 of file sch_screen.h.

137 { return m_refCount; }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:76

References m_refCount.

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

◆ GetScalingFactor()

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 95 of file base_screen.cpp.

96 {
97  double scale = 1.0 / GetZoom();
98  return scale;
99 }
double GetZoom() const
Function GetZoom returns the current "zoom factor", which is a measure of "internal units per device ...
Definition: base_screen.h:340
const int scale

References BASE_SCREEN::GetZoom(), and scale.

Referenced by EDA_DRAW_PANEL::DoPrepareDC(), BASE_SCREEN::getCrossHairScreenPosition(), EDA_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseWheel(), EDA_DRAW_PANEL::OnPan(), and EDA_DRAW_PANEL::OnScroll().

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
virtualinherited

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

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

Returns
The menu text string.

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

Definition at line 165 of file base_struct.cpp.

166 {
167  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
168  GetClass() );
169 
170  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
171 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), SCH_FIND_COLLECTOR::GetText(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ GetSheet()

SCH_SHEET * SCH_SCREEN::GetSheet ( const wxString &  aName)

Returns a sheet object pointer that is named aName.

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

Definition at line 667 of file sch_screen.cpp.

668 {
669  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
670  {
671  if( item->Type() != SCH_SHEET_T )
672  continue;
673 
674  SCH_SHEET* sheet = (SCH_SHEET*) item;
675 
676  if( aName.CmpNoCase( sheet->GetName() ) == 0 )
677  return sheet;
678  }
679 
680  return NULL;
681 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
wxString GetName() const
Definition: sch_sheet.h:259
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:201
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_EDIT_FRAME::AppendSchematic().

◆ GetSheetLabel()

SCH_SHEET_PIN * SCH_SCREEN::GetSheetLabel ( const wxPoint &  aPosition)

Test the screen if aPosition is a sheet label object.

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

Definition at line 684 of file sch_screen.cpp.

685 {
686  SCH_SHEET_PIN* sheetPin = NULL;
687 
688  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
689  {
690  if( item->Type() != SCH_SHEET_T )
691  continue;
692 
693  SCH_SHEET* sheet = (SCH_SHEET*) item;
694  sheetPin = sheet->GetPin( aPosition );
695 
696  if( sheetPin )
697  break;
698  }
699 
700  return sheetPin;
701 }
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:371
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:56
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:201
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by IsTerminalPoint().

◆ GetState()

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 256 of file base_struct.h.

256 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:167

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetTimeStamp()

◆ GetTitleBlock()

const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const
inline

◆ GetToolManager()

TOOL_MANAGER * KIWAY_HOLDER::GetToolManager ( ) const
inherited

Function GetToolManager Return the tool manager instance, if any.

Definition at line 46 of file kiway_holder.cpp.

47 {
48  return nullptr;
49 }

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

int BASE_SCREEN::GetUndoCommandCount ( ) const
inlineinherited

Definition at line 301 of file base_screen.h.

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)
Definition: base_screen.h:210

References UNDO_REDO_CONTAINER::m_CommandsList, and BASE_SCREEN::m_UndoList.

Referenced by BASE_SCREEN::PushCommandToUndoList(), LIB_EDIT_FRAME::ReCreateMenuBar(), and SCH_EDITOR_CONTROL::Undo().

◆ GetUserUnits()

EDA_UNITS_T KIWAY_HOLDER::GetUserUnits ( ) const
inherited

Function GetUserUnits Allows participation in KEYWAY_PLAYER/DIALOG_SHIM userUnits inheritance.

This would fit better in KEYWAY_PLAYER, but DIALOG_SHIMs can only use mix-ins because their primary superclass must be wxDialog.

Definition at line 40 of file kiway_holder.cpp.

41 {
42  return MILLIMETRES;
43 }

References MILLIMETRES.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetWire()

SCH_LINE* SCH_SCREEN::GetWire ( const wxPoint &  aPosition,
int  aAccuracy = 0,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)
inline

Definition at line 415 of file sch_screen.h.

417  {
418  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
419  }
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:807

References GetLine(), and LAYER_WIRE.

Referenced by IsTerminalPoint().

◆ GetWireOrBus()

SCH_LINE * SCH_SCREEN::GetWireOrBus ( const wxPoint &  aPosition)

Return a wire or bus item located at aPosition.

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

Definition at line 793 of file sch_screen.cpp.

794 {
796 
797  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
798  {
799  if( item->IsType( types ) && item->HitTest( aPosition ) )
800  return (SCH_LINE*) item;
801  }
802 
803  return nullptr;
804 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

◆ GetZoom()

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 base_screen.h.

340 { return m_Zoom; }
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95

References BASE_SCREEN::m_Zoom.

Referenced by PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), BASE_SCREEN::GetScalingFactor(), EDA_DRAW_FRAME::GetZoom(), DIALOG_MIGRATE_BUSES::onItemSelected(), DIALOG_ERC::OnLeftClickMarkersList(), GERBVIEW_FRAME::OnUpdateSelectZoom(), PCB_BASE_FRAME::OnUpdateSelectZoom(), SCH_BASE_FRAME::RedrawScreen(), SCH_BASE_FRAME::RedrawScreen2(), and ZOOM_MENU::update().

◆ GridExists()

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 338 of file base_screen.cpp.

339 {
340  // tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.
341  for( unsigned i = 0; i < m_grids.size(); i++ )
342  {
343  if( m_grids[i].m_CmdId == aCommandId )
344  return true;
345  }
346 
347  return false;
348 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597

References i, and BASE_SCREEN::m_grids.

Referenced by COMMON_TOOLS::doGridPreset(), COMMON_TOOLS::GridNext(), and COMMON_TOOLS::GridPrev().

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest ( const wxPoint &  aPosition,
int  aAccuracy = 0 
) const
inlinevirtualinherited

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented in D_PAD, SCH_COMPONENT, SCH_SHEET, MODULE, VIA, ZONE_CONTAINER, GERBER_DRAW_ITEM, TRACK, DIMENSION, DRAWSEGMENT, LIB_ITEM, TEXTE_MODULE, SCH_FIELD, SCH_LINE, SCH_TEXT, SCH_SHEET_PIN, LIB_FIELD, SCH_BITMAP, LIB_PIN, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, MARKER_PCB, SCH_JUNCTION, SCH_MARKER, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_ARC, LIB_BEZIER, LIB_POLYLINE, SCH_PIN, LIB_RECTANGLE, LIB_CIRCLE, and KIGFX::RATSNEST_VIEWITEM.

Definition at line 333 of file base_struct.h.

334  {
335  return false; // derived classes should override this function
336  }

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), LIB_ITEM::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), EE_SELECTION_TOOL::selectMultiple(), and SELECTION_TOOL::selectMultiple().

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
inlinevirtualinherited

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented in D_PAD, SCH_COMPONENT, SCH_SHEET, MODULE, VIA, ZONE_CONTAINER, GERBER_DRAW_ITEM, TRACK, DIMENSION, LIB_ITEM, DRAWSEGMENT, TEXTE_MODULE, SCH_FIELD, SCH_LINE, SCH_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, SCH_JUNCTION, PCB_TARGET, TEXTE_PCB, LIB_TEXT, LIB_ARC, LIB_BEZIER, LIB_POLYLINE, and LIB_CIRCLE.

Definition at line 347 of file base_struct.h.

348  {
349  return false; // derived classes should override this function
350  }

◆ IncRefCount()

void SCH_SCREEN::IncRefCount ( )

Definition at line 144 of file sch_screen.cpp.

145 {
146  m_refCount++;
147 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:76

References m_refCount.

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

◆ InitDataPoints()

void BASE_SCREEN::InitDataPoints ( const wxSize &  aPageSizeInternalUnits)
inherited

Definition at line 72 of file base_screen.cpp.

73 {
74  if( m_Center )
75  {
76  m_crossHairPosition.x = 0;
77  m_crossHairPosition.y = 0;
78 
79  m_DrawOrg.x = -aPageSizeIU.x / 2;
80  m_DrawOrg.y = -aPageSizeIU.y / 2;
81  }
82  else
83  {
84  m_crossHairPosition.x = aPageSizeIU.x / 2;
85  m_crossHairPosition.y = aPageSizeIU.y / 2;
86 
87  m_DrawOrg.x = 0;
88  m_DrawOrg.y = 0;
89  }
90 
91  m_O_Curseur.x = m_O_Curseur.y = 0;
92 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:93
wxPoint m_O_Curseur
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:185
bool m_Center
Center on screen.
Definition: base_screen.h:202
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:183

References BASE_SCREEN::m_Center, BASE_SCREEN::m_crossHairPosition, BASE_SCREEN::m_DrawOrg, and BASE_SCREEN::m_O_Curseur.

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

◆ IsBlockActive()

bool BASE_SCREEN::IsBlockActive ( ) const
inlineinherited

Definition at line 499 of file base_screen.h.

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

References BLOCK_SELECTOR::IsIdle(), and BASE_SCREEN::m_BlockLocate.

Referenced by DrawPageOnClipboard(), EDA_DRAW_PANEL::OnMouseEvent(), and PL_EDITOR_FRAME::OnRightClick().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 230 of file base_struct.h.

230 { 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:181

References BRIGHTENED, and EDA_ITEM::m_Flags.

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

◆ IsBusAlias()

bool SCH_SCREEN::IsBusAlias ( const wxString &  aLabel)
static

Returns true if the given string is a valid bus alias in a loaded screen.

Definition at line 914 of file sch_screen.cpp.

915 {
916  SCH_SHEET_LIST aSheets( g_RootSheet );
917  for( unsigned i = 0; i < aSheets.size(); i++ )
918  {
919  for( auto alias : aSheets[i].LastScreen()->GetBusAliases() )
920  {
921  if( alias->GetName() == aLabel )
922  {
923  return true;
924  }
925  }
926  }
927 
928  return false;
929 }
Class SCH_SHEET_LIST.
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:56
size_t i
Definition: json11.cpp:597

References g_RootSheet, and i.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

229 { 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:181

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::getRenderColor().

◆ IsJunctionNeeded()

bool SCH_SCREEN::IsJunctionNeeded ( const wxPoint &  aPosition,
bool  aNew = false 
)

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

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

  • one wire midpoint and one or more wire endpoints;
  • three or more wire endpoints;
  • one wire midpoint and a component pin;
  • two or more wire endpoints and a component pin.
Parameters
aPositionThe position to test.
aNewChecks if a new junction is needed, i.e. there isn't one already
Returns
True if a junction is required at aPosition.

Overlapping lines that point in the same direction should not be counted as extra end_points. We remove the overlapping lines, being careful to only remove them once.

Definition at line 350 of file sch_screen.cpp.

351 {
352  bool has_nonparallel[2] = { false };
353  int end_count[2] = { 0 };
354  int pin_count = 0;
355 
356  std::vector<SCH_LINE*> lines[2];
357 
358  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
359  {
360  if( item->GetEditFlags() & STRUCT_DELETED )
361  continue;
362 
363  if( aNew && ( item->Type() == SCH_JUNCTION_T ) && ( item->HitTest( aPosition ) ) )
364  return false;
365 
366  if( ( item->Type() == SCH_LINE_T )
367  && ( item->HitTest( aPosition, 0 ) ) )
368  {
369  if( item->GetLayer() == LAYER_WIRE )
370  lines[0].push_back( (SCH_LINE*) item );
371  else if( item->GetLayer() == LAYER_BUS )
372  lines[1].push_back( (SCH_LINE*) item );
373  }
374 
375  if( ( item->Type() == SCH_COMPONENT_T )
376  && ( item->IsConnected( aPosition ) ) )
377  pin_count++;
378  }
379 
380  for( int i = 0; i < 2; i++ )
381  {
382  bool removed_overlapping = false;
383  end_count[i] = lines[i].size();
384 
385  for( auto line = lines[i].begin(); line < lines[i].end(); line++ )
386  {
387  // Consider ending on a line to be equivalent to two endpoints because
388  // we will want to split the line if anything else connects
389  if( !(*line)->IsEndPoint( aPosition ) )
390  end_count[i]++;
391 
392  for( auto second_line = lines[i].end() - 1; second_line > line; second_line-- )
393  {
394  if( !(*line)->IsParallel( *second_line ) )
395  has_nonparallel[i] = true;
396  else if( !removed_overlapping
397  && (*line)->IsSameQuadrant( *second_line, aPosition ) )
398  {
404  removed_overlapping = true;
405  end_count[i]--;
406  }
407  }
408  }
409  }
410 
411  //
412 
413  // If there are three or more endpoints
414  if( pin_count + end_count[0] > 2 )
415  return true;
416 
417  // If there is at least one segment that ends on a non-parallel line or
418  // junction of two other lines
419  if( has_nonparallel[0] && end_count[0] > 2 )
420  return true;
421 
422  // Check for bus - bus junction requirements
423  if( has_nonparallel[1] && end_count[1] > 2 )
424  return true;
425 
426  return false;
427 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
size_t i
Definition: json11.cpp:597
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::addJunctionsIfNeeded(), SCH_EDIT_FRAME::AddMissingJunctions(), SCH_EDIT_TOOL::DoDelete(), SCH_WIRE_BUS_TOOL::finishSegments(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

223 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsModify()

bool BASE_SCREEN::IsModify ( ) const
inlineinherited

◆ IsMoving()

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References IS_NEW, and EDA_ITEM::m_Flags.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_CIRCLE::CalcEdit(), LIB_RECTANGLE::CalcEdit(), LIB_FIELD::CalcEdit(), LIB_POLYLINE::CalcEdit(), LIB_ARC::CalcEdit(), LIB_TEXT::CalcEdit(), LIB_POLYLINE::ContinueEdit(), LIB_ARC::ContinueEdit(), SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertTextType(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), LIB_ARC::drawGraphic(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN::EnableEditMode(), LIB_DRAWING_TOOLS::Init(), isNewSegment(), SCH_MOVE_TOOL::Main(), LIB_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 502 of file base_struct.h.

502 { return false; }

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

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 228 of file base_struct.h.

228 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by LIB_POLYLINE::CalcEdit(), and KIGFX::SCH_PAINTER::setColors().

◆ IsSave()

bool BASE_SCREEN::IsSave ( ) const
inlineinherited

Definition at line 329 of file base_screen.h.

329 { return m_FlagSave; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81

References BASE_SCREEN::m_FlagSave.

◆ IsSelected()

◆ IsTerminalPoint()

bool SCH_SCREEN::IsTerminalPoint ( const wxPoint &  aPosition,
int  aLayer 
)

Test if aPosition is a connection point on aLayer.

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

Definition at line 430 of file sch_screen.cpp.

431 {
432  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
433  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
434 
435  SCH_SHEET_PIN* label;
436  SCH_TEXT* text;
437  SCH_CONNECTION conn;
438 
439  switch( aLayer )
440  {
441  case LAYER_BUS:
442 
443  if( GetBus( aPosition ) )
444  return true;
445 
446  label = GetSheetLabel( aPosition );
447 
448  if( label && conn.IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
449  return true;
450 
451  text = GetLabel( aPosition );
452 
453  if( text && conn.IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
454  && (text->Type() != SCH_LABEL_T) )
455  return true;
456 
457  break;
458 
459  case LAYER_NOTES:
460 
461  if( GetLine( aPosition ) )
462  return true;
463 
464  break;
465 
466  case LAYER_WIRE:
468  return true;
469 
470  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
471  return true;
472 
473  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
474  return true;
475 
476  if( GetPin( aPosition, NULL, true ) )
477  return true;
478 
479  if( GetWire( aPosition ) )
480  return true;
481 
482  text = GetLabel( aPosition );
483 
484  if( text && text->IsConnected( aPosition ) && !conn.IsBusLabel( text->GetText() ) )
485  return true;
486 
487  label = GetSheetLabel( aPosition );
488 
489  if( label && label->IsConnected( aPosition ) && !conn.IsBusLabel( label->GetText() ) )
490  return true;
491 
492  break;
493 
494  default:
495  break;
496  }
497 
498  return false;
499 }
static bool IsBusLabel(const wxString &aLabel)
Test if aLabel has a bus notation.
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
virtual const wxString GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:147
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:611
SCH_LINE * GetLine(const wxPoint &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Return a line item located at aPosition.
Definition: sch_screen.cpp:807
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:237
SCH_SHEET_PIN * GetSheetLabel(const wxPoint &aPosition)
Test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:684
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:56
SCH_LINE * GetWire(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:415
SCH_TEXT * GetLabel(const wxPoint &aPosition, int aAccuracy=0)
Return a label item located at aPosition.
Definition: sch_screen.cpp:841
#define max(a, b)
Definition: auxiliary.h:86
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
Definition: sch_item.cpp:118
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204
SCH_LINE * GetBus(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:421

References GetBus(), GetDefaultLineThickness(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheetLabel(), EDA_TEXT::GetText(), GetWire(), SCH_CONNECTION::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().

Referenced by SCH_WIRE_BUS_TOOL::doDrawSegments().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlinevirtualinherited

Function IsType Checks whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in SCH_FIELD, and SCH_LINE.

Definition at line 287 of file base_struct.h.

288  {
289  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
290  return true;
291 
292  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
293  {
294  if( m_StructType == *p )
295  return true;
296  }
297 
298  return false;
299  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:166
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by GetItem(), SCH_WIRE_BUS_TOOL::IsDrawingBus(), SCH_WIRE_BUS_TOOL::IsDrawingLine(), SCH_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), and EDA_ITEM::Visit().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

226 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward()

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 130 of file base_struct.cpp.

134 {
135  EDA_ITEM* p = listStart;
136 
137  for( ; p; p = p->Pnext )
138  {
139  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
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:157
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:170

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

Referenced by EE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EE_SELECTION_TOOL::RebuildSelection(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and BOARD::Visit().

◆ Kiway()

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 61 of file kiway_player.h.

62  {
63  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
64  return *m_kiway;
65  }
KIWAY * m_kiway
Definition: kiway_player.h:101

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ MarkConnections()

void SCH_SCREEN::MarkConnections ( SCH_LINE aSegment)

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

Parameters
aSegmentThe segment to test for connections.

Definition at line 308 of file sch_screen.cpp.

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

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 EE_SELECTION_TOOL::SelectConnection().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint *  aFindLocation 
)
inlinevirtualinherited

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

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

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

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

Definition at line 458 of file base_struct.h.

459  {
460  return false;
461  }

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

◆ Matches() [2/2]

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 174 of file base_struct.cpp.

175 {
176  wxString text = aText;
177  wxString searchText = aSearchData.GetFindString();
178 
179  // Don't match if searching for replaceable item and the item doesn't support text replace.
180  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
181  return false;
182 
183  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
184  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
185 
186  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
187  {
188  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
189  return text.Matches( searchText );
190 
191  return text.MakeUpper().Matches( searchText.MakeUpper() );
192  }
193 
194  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
195  return aText.Find( searchText ) != wxNOT_FOUND;
196 
197  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
198 }
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

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

◆ MilsToIuScalar()

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 base_screen.h.

245 { return 1; }

Referenced by DrawPageOnClipboard().

◆ Next()

◆ operator<()

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 231 of file base_struct.cpp.

232 {
233  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
234  GetChars( GetClass() ) ) );
235 
236  return false;
237 }
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:100
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

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

◆ Place()

void SCH_SCREEN::Place ( SCH_EDIT_FRAME frame,
wxDC *  DC 
)
inline

Definition at line 207 of file sch_screen.h.

207 { };

◆ Plot()

void SCH_SCREEN::Plot ( PLOTTER aPlotter)

Plot all the schematic objects to aPlotter.

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

Definition at line 576 of file sch_screen.cpp.

577 {
578  // Ensure links are up to date, even if a library was reloaded for some reason:
580 
581  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
582  {
583  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
584  item->Plot( aPlotter );
585  }
586 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:502
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

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

◆ PopCommandFromRedoList()

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 451 of file base_screen.cpp.

452 {
453  return m_RedoList.PopCommand();
454 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211

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

Referenced by LIB_EDIT_FRAME::GetComponentFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), and SCH_EDITOR_CONTROL::Redo().

◆ PopCommandFromUndoList()

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 445 of file base_screen.cpp.

446 {
447  return m_UndoList.PopCommand();
448 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210

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

Referenced by LIB_EDIT_FRAME::GetComponentFromUndoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PL_EDITOR_FRAME::RemoveLastCommandInUndoList(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDITOR_CONTROL::Undo().

◆ Prj()

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.

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:61
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), PCB_EDIT_FRAME::doAutoSave(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::saveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ PushCommandToRedoList()

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 430 of file base_screen.cpp.

431 {
432  m_RedoList.PushCommand( aNewitem );
433 
434  // Delete the extra items, if count max reached
435  if( m_UndoRedoCountMax > 0 )
436  {
437  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
438 
439  if( extraitems > 0 )
440  ClearUndoORRedoList( m_RedoList, extraitems );
441  }
442 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
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)
Definition: base_screen.h:211
int GetRedoCommandCount() const
Definition: base_screen.h:306

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_EDITOR_CONTROL::Undo().

◆ PushCommandToUndoList()

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 415 of file base_screen.cpp.

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

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_EDITOR_CONTROL::Redo(), PL_EDITOR_FRAME::SaveCopyInUndoList(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ Remove()

void SCH_SCREEN::Remove ( SCH_ITEM aItem)

Remove aItem from the schematic associated with this screen.

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

Definition at line 189 of file sch_screen.cpp.

190 {
191  m_drawList.Remove( aItem );
192 }
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.
Definition: sch_screen.h:95

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

Referenced by ReplaceWires().

◆ Replace() [1/2]

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 201 of file base_struct.cpp.

202 {
203  wxCHECK_MSG( IsReplaceable(), false,
204  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
205 
206  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
207 
208  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
209  aSearchData.GetFindString() :
210  aSearchData.GetFindString().Upper() );
211 
212  if( result == wxNOT_FOUND )
213  return false;
214 
215  wxString prefix = aText.Left( result );
216  wxString suffix;
217 
218  if( aSearchData.GetFindString().length() + result < aText.length() )
219  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
220 
221  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
222  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
223  GetChars( suffix ) );
224 
225  aText = prefix + aSearchData.GetReplaceString() + suffix;
226 
227  return true;
228 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
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:100
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

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

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

◆ Replace() [2/2]

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_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 490 of file base_struct.h.

490 { return false; }

◆ ReplaceWires()

void SCH_SCREEN::ReplaceWires ( DLIST< SCH_ITEM > &  aWireList)

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

Parameters
aWireListList of wires to replace the existing wires with.

Definition at line 282 of file sch_screen.cpp.

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

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

◆ SetAuxOrigin()

void SCH_SCREEN::SetAuxOrigin ( const wxPoint &  aPosition)
inline

Definition at line 127 of file sch_screen.h.

127 { m_aux_origin = aPosition; }
wxPoint m_aux_origin
Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA.
Definition: sch_screen.h:93

References m_aux_origin.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 218 of file base_struct.h.

218 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:171

References EDA_ITEM::Pback.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 235 of file base_struct.h.

235 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:259
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetComponentFootprint()

bool SCH_SCREEN::SetComponentFootprint ( SCH_SHEET_PATH aSheetPath,
const wxString &  aReference,
const wxString &  aFootPrint,
bool  aSetVisible 
)

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

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

Definition at line 862 of file sch_screen.cpp.

864 {
865  SCH_COMPONENT* component;
866  bool found = false;
867 
868  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
869  {
870  if( item->Type() != SCH_COMPONENT_T )
871  continue;
872 
873  component = (SCH_COMPONENT*) item;
874 
875  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
876  {
877  // Found: Init Footprint Field
878 
879  /* Give a reasonable value to the field position and
880  * orientation, if the text is empty at position 0, because
881  * it is probably not yet initialized
882  */
883  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
884  if( fpfield->GetText().IsEmpty()
885  && ( fpfield->GetTextPos() == component->GetPosition() ) )
886  {
887  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
888  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
889  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
890 
891  if( fpfield->GetTextAngle() == 0.0 )
892  fpfield->Offset( wxPoint( 0, 100 ) );
893  else
894  fpfield->Offset( wxPoint( 100, 0 ) );
895  }
896 
897  fpfield->SetText( aFootPrint );
898  fpfield->SetVisible( aSetVisible );
899 
900  found = true;
901  }
902  }
903 
904  return found;
905 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:173
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:246
SCH_ITEM * Next() const
Definition: sch_item.h:153
const wxString GetText() const override
Function GetText returns the string associated with the text object.
Definition: sch_field.cpp:105
void SetText(const wxString &aText) override
Definition: sch_field.cpp:125
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:240
void SetVisible(bool aVisible)
Definition: eda_text.h:192
double GetTextAngle() const
Definition: eda_text.h:181
T * begin() const
Definition: dlist.h:218
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:231
Field Name Module PCB, i.e. "16DIP300".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define VALUE
const wxSize & GetTextSize() const
Definition: eda_text.h:232
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.
Definition: sch_screen.h:95
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
wxPoint GetPosition() const override
Function GetPosition.
const wxPoint & GetTextPos() const
Definition: eda_text.h:241
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_SHEET_PATH::SetComponentFootprint().

◆ SetCurItem()

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 base_screen.h.

231 { m_CurrentItem = aItem; }
EDA_ITEM * m_CurrentItem
Currently selected object.
Definition: base_screen.h:82

References BASE_SCREEN::m_CurrentItem.

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

◆ SetFileName()

void SCH_SCREEN::SetFileName ( const wxString &  aFileName)
inline

◆ SetFirstZoom()

bool BASE_SCREEN::SetFirstZoom ( )
inherited

Definition at line 111 of file base_screen.cpp.

112 {
113  return SetZoom( GetMinAllowedZoom() );
114 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 259 of file base_struct.h.

259 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), 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(), LIB_ITEM::BeginEdit(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_DRAWING_TOOLS::doSingleClickPlace(), LIB_DRAWING_TOOLS::doTwoClickPlace(), SCH_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawSheet(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), KIGFX::SCH_VIEW::HighlightItem(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), InvokeDialogImportGfxBoard(), InvokeDialogImportGfxModule(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), MarkItemsInBloc(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), SCH_WIRE_BUS_TOOL::startSegments(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

◆ SetForceVisible()

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 309 of file base_struct.h.

309 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:178

References EDA_ITEM::m_forceVisible.

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

◆ SetGrid() [1/2]

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 233 of file base_screen.cpp.

234 {
235  wxASSERT( !m_grids.empty() );
236 
237  GRID_TYPE nearest_grid = m_grids[0];
238  int gridIdx = 0;
239 
240  for( unsigned i = 0; i < m_grids.size(); i++ )
241  {
242  if( m_grids[i].m_Size == size )
243  {
244  m_Grid = m_grids[i];
245  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
246  }
247 
248  // keep track of the nearest larger grid size, if the exact size is not found
249  if ( size.x < m_grids[i].m_Size.x )
250  {
251  gridIdx = m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
252  nearest_grid = m_grids[i];
253  }
254  }
255 
256  m_Grid = nearest_grid;
257  return gridIdx;
258 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
size_t i
Definition: json11.cpp:597

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

Referenced by SCH_EDIT_FRAME::AppendSchematic(), SCH_EDIT_FRAME::DisplayCurrentSheet(), COMMON_TOOLS::doGridPreset(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), synchronizeLibEditScreenSettings(), and DIALOG_SET_GRID::TransferDataFromWindow().

◆ SetGrid() [2/2]

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 261 of file base_screen.cpp.

262 {
263  wxASSERT( !m_grids.empty() );
264 
265  for( unsigned i = 0; i < m_grids.size(); i++ )
266  {
267  if( m_grids[i].m_CmdId == aCommandId )
268  {
269  m_Grid = m_grids[i];
270  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
271  }
272  }
273 
274  m_Grid = m_grids[0];
275  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
276 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597

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

◆ SetGridList()

void BASE_SCREEN::SetGridList ( GRIDS sizelist)
inherited

Definition at line 224 of file base_screen.cpp.

225 {
226  if( !m_grids.empty() )
227  m_grids.clear();
228 
229  m_grids = gridlist;
230 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79

References BASE_SCREEN::m_grids.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 234 of file base_struct.h.

234 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:259
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetKiway()

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 53 of file kiway_holder.cpp.

54 {
55 #if defined(DEBUG)
56  // offer a trap point for debugging most any window
57  wxASSERT( aDest );
58  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
59  {
60  int breakhere=1;
61  (void) breakhere;
62  }
63 #endif
64 
65  (void) aDest;
66 
67  m_kiway = aKiway;
68 }
KIWAY * m_kiway
Definition: kiway_player.h:101
const char * name
Definition: DXF_plotter.cpp:61

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetLastZoom()

bool BASE_SCREEN::SetLastZoom ( )
inherited

Definition at line 117 of file base_screen.cpp.

118 {
119  return SetZoom( GetMaxAllowedZoom() );
120 }
virtual 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...
Definition: base_screen.h:361

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

◆ SetList()

void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 220 of file base_struct.h.

220 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:172

References EDA_ITEM::m_List.

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

◆ SetMaxUndoItems()

void BASE_SCREEN::SetMaxUndoItems ( int  aMax)
inlineinherited

Definition at line 313 of file base_screen.h.

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
Definition: base_screen.h:86
#define DEFAULT_MAX_UNDO_ITEMS
Definition: draw_frame.h:48
#define ABS_MAX_UNDO_ITEMS
Definition: draw_frame.h:49

References ABS_MAX_UNDO_ITEMS, DEFAULT_MAX_UNDO_ITEMS, and BASE_SCREEN::m_UndoRedoCountMax.

Referenced by SCH_EDIT_FRAME::CreateScreens(), and SCH_EDIT_FRAME::InitSheet().

◆ SetModified()

◆ SetModify()

◆ SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 217 of file base_struct.h.

217 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:170

References EDA_ITEM::Pnext.

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

◆ SetNextZoom()

bool BASE_SCREEN::SetNextZoom ( )
inherited

Definition at line 142 of file base_screen.cpp.

143 {
144  // Step must be AT LEAST 1.2
145  double target = m_Zoom * 1.2;
146 
147  for( unsigned i=0; i < m_ZoomList.size(); ++i )
148  {
149  if( target < m_ZoomList[i] )
150  {
151  SetZoom( m_ZoomList[i] );
152  return true;
153  }
154  }
155 
156  return false;
157 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
size_t i
Definition: json11.cpp:597
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219

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

Referenced by EDA_DRAW_FRAME::SetNextZoom().

◆ SetPageSettings()

void SCH_SCREEN::SetPageSettings ( const PAGE_INFO aPageSettings)
inline

Definition at line 120 of file sch_screen.h.

120 { m_paper = aPageSettings; }
PAGE_INFO m_paper
The size of the paper to print or plot on.
Definition: sch_screen.h:88

References m_paper.

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

◆ SetParent()

◆ SetPreviousZoom()

bool BASE_SCREEN::SetPreviousZoom ( )
inherited

Definition at line 160 of file base_screen.cpp.

161 {
162  // Step must be AT LEAST 1.2
163  double target = m_Zoom / 1.2;
164 
165  for( unsigned i = m_ZoomList.size(); i != 0; --i )
166  {
167  if( target > m_ZoomList[i - 1] )
168  {
169  SetZoom( m_ZoomList[i - 1] );
170  return true;
171  }
172  }
173 
174  return false;
175 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
size_t i
Definition: json11.cpp:597
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
std::vector< double > m_ZoomList
standard zoom (i.e. scale) coefficients.
Definition: base_screen.h:219

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

Referenced by EDA_DRAW_FRAME::SetPrevZoom().

◆ SetSave()

void BASE_SCREEN::SetSave ( )
inlineinherited

Definition at line 326 of file base_screen.h.

326 { m_FlagSave = true; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:81

References BASE_SCREEN::m_FlagSave.

Referenced by PCB_BASE_FRAME::OnModify(), and SCH_EDIT_FRAME::OnModify().

◆ SetScalingFactor()

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 102 of file base_screen.cpp.

103 {
104  // Limit zoom to max and min allowed values:
105  double zoom = Clamp( GetMinAllowedZoom(), aScale, GetMaxAllowedZoom() );
106 
107  SetZoom( zoom );
108 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
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:138
virtual 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...
Definition: base_screen.h:361

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

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

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 233 of file base_struct.h.

233 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:259

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetState()

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 209 of file base_struct.h.

209 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:175

References EDA_ITEM::m_TimeStamp.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), Diagnose(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

◆ SetTitleBlock()

void SCH_SCREEN::SetTitleBlock ( const TITLE_BLOCK aTitleBlock)
inline

Definition at line 131 of file sch_screen.h.

131 { m_titles = aTitleBlock; }
TITLE_BLOCK m_titles
Definition: sch_screen.h:90

References m_titles.

Referenced by SCH_LEGACY_PLUGIN::loadPageSettings(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and SCH_BASE_FRAME::SetTitleBlock().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 232 of file base_struct.h.

232 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:259
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetZoom()

bool BASE_SCREEN::SetZoom ( double  iu_per_du)
virtualinherited

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 123 of file base_screen.cpp.

124 {
125  if( iu_per_du == m_Zoom )
126  return false;
127 
128  wxLogTrace( traceScreen, "Zoom:%.16g 1/Zoom:%.16g", iu_per_du, 1/iu_per_du );
129 
130  if( iu_per_du < GetMinAllowedZoom() )
131  return false;
132 
133  if( iu_per_du > GetMaxAllowedZoom() )
134  return false;
135 
136  m_Zoom = iu_per_du;
137 
138  return true;
139 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:368
const wxChar *const traceScreen
Flag to enable debug output of BASE_SCREEN and it's derivatives.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
Definition: base_screen.h:361
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95

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

Referenced by SCH_EDIT_FRAME::CreateScreens(), PLEDITOR_PRINTOUT::DrawPage(), SCH_PRINTOUT::DrawPage(), DrawPageOnClipboard(), SCH_EDIT_FRAME::FindComponentAndItem(), GBR_SCREEN::GBR_SCREEN(), SCH_EDIT_FRAME::OnFindDrcMarker(), EDA_DRAW_PANEL_GAL::onPaint(), 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(), and BASE_SCREEN::SetScalingFactor().

◆ Sort()

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 521 of file base_struct.h.

521 { return *aLeft < *aRight; }

Referenced by PART_LIB::GetEntryTypePowerNames().

◆ TestDanglingEnds()

bool SCH_SCREEN::TestDanglingEnds ( )

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

Returns
True if any connection state changes were made.

Definition at line 772 of file sch_screen.cpp.

773 {
774  SCH_ITEM* item;
775  std::vector< DANGLING_END_ITEM > endPoints;
776  bool hasStateChanged = false;
777 
778  for( item = m_drawList.begin(); item; item = item->Next() )
779  item->GetEndPoints( endPoints );
780 
781  for( item = m_drawList.begin(); item; item = item->Next() )
782  {
783  if( item->UpdateDanglingState( endPoints ) )
784  {
785  hasStateChanged = true;
786  }
787  }
788 
789  return hasStateChanged;
790 }
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.
Definition: sch_item.h:274
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
virtual bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemList)
Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state...
Definition: sch_item.h:289
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114

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

Referenced by SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ Type()

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 204 of file base_struct.h.

205  {
206  return m_StructType;
207  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:166

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::addJunctionsIfNeeded(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Begin_Route(), 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(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), TRACK::ClassOf(), MODULE::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), EE_COLLECTOR::Collect(), Collect_TrackSegmentsToDrag(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_EDIT_FRAME::ConvertTextType(), CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), 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(), SCH_SCREENS::DeleteAllMarkers(), DeleteItem(), DeleteNullTrackSegments(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), LIB_DRAWING_TOOLS::doTwoClickPlace(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), PCB_EDIT_FRAME::EraseRedundantTrack(), CONNECTION_GRAPH::ercCheckLabels(), 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(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), EE_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isNewSegment(), TRACK::IsNull(), SCH_LINE::IsParallel(), IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), SCH_MOVE_TOOL::moveItem(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_CONNECTION::Name(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftDClick(), FOOTPRINT_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::PasteItemsFromClipboard(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), GAL_ARRAY_CREATOR::prePushAction(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), BOARD_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectable(), SELECTION_TOOL::selectable(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

◆ UpdateSymbolLinks()

void SCH_SCREEN::UpdateSymbolLinks ( bool  aForce = false)

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

It must be called from:

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

Definition at line 502 of file sch_screen.cpp.

503 {
504  // Initialize or reinitialize the pointer to the LIB_PART for each component
505  // found in m_drawList, but only if needed (change in lib or schematic)
506  // therefore the calculation time is usually very low.
507  if( m_drawList.GetCount() )
508  {
509  SYMBOL_LIB_TABLE* libs = Prj().SchSymbolLibTable();
510  int mod_hash = libs->GetModifyHash();
512 
514 
515  // Must we resolve?
516  if( (m_modification_sync != mod_hash) || aForce )
517  {
518  SCH_COMPONENT::ResolveAll( c, *libs, Prj().SchLibs()->GetCacheLibrary() );
519 
520  m_modification_sync = mod_hash; // note the last mod_hash
521  }
522  // Resolving will update the pin caches but we must ensure that this happens
523  // even if the libraries don't change.
524  else
526  }
527 }
void Collect(EDA_ITEM *aItem, const KICAD_T aScanList[])
Function Collect scans a DLIST using this class's Inspector method, which does the collection.
static void UpdatePins(const EE_COLLECTOR &aComponents)
Update the pin cache for all components in aComponents.
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
static const KICAD_T ComponentsOnly[]
Definition: ee_collectors.h:44
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:97
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:95
Class EE_TYPE_COLLECTOR merely gathers up all SCH_ITEMs of a given set of KICAD_T type(s).
static void ResolveAll(const EE_COLLECTOR &aComponents, SYMBOL_LIB_TABLE &aLibTable, PART_LIB *aCacheLib=NULL)
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:153

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

Referenced by Draw(), and Plot().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, TRACK, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, LIB_ALIAS, KIGFX::WORKSHEET_VIEWITEM, MARKER_PCB, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 257 of file base_struct.cpp.

258 {
259  // Basic fallback
260  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
261  VECTOR2I( GetBoundingBox().GetSize() ) );
262 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:520
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_ITEM::GetBoundingBox().

Referenced by BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

117  {}

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

void EDA_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtualinherited

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, SCH_SHEET, EDIT_POINTS, VIA, LIB_PART, GERBER_DRAW_ITEM, TRACK, BOARD_ITEM, TEXTE_MODULE, LIB_ITEM, SCH_ITEM, LIB_ALIAS, ZONE_CONTAINER, SCH_COMPONENT, LIB_FIELD, KIGFX::WORKSHEET_VIEWITEM, MARKER_PCB, SCH_BITMAP, ROUTER_PREVIEW_ITEM, SCH_BUS_ENTRY_BASE, LIB_TEXT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, SCH_NO_CONNECT, BRIGHT_BOX, SCH_JUNCTION, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::RULER_ITEM, and SCH_MARKER.

Definition at line 265 of file base_struct.cpp.

266 {
267  // Basic fallback
268  aCount = 1;
269  aLayers[0] = 0;
270 }

◆ ViewGetLOD()

virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TRACK, TEXTE_MODULE, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

141  {
142  // By default always show the item
143  return 0;
144  }

Referenced by KIGFX::VIEW::drawItem::operator()().

◆ viewPrivData()

◆ Visit()

SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, LIB_PART, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 149 of file base_struct.cpp.

150 {
151 #if 0 && defined(DEBUG)
152  std::cout << GetClass().mb_str() << ' ';
153 #endif
154 
155  if( IsType( scanTypes ) )
156  {
157  if( SEARCH_QUIT == inspector( this, testData ) )
158  return SEARCH_QUIT;
159  }
160 
161  return SEARCH_CONTINUE;
162 }
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:287
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass(), EDA_ITEM::IsType(), SEARCH_CONTINUE, and SEARCH_QUIT.

Referenced by GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), and EDA_ITEM::IterateForward().

Member Data Documentation

◆ m_aliases

std::unordered_set< std::shared_ptr< BUS_ALIAS > > SCH_SCREEN::m_aliases
private

List of bus aliases stored in this screen.

Definition at line 101 of file sch_screen.h.

Referenced by AddBusAlias(), ClearBusAliases(), and GetBusAliases().

◆ m_aux_origin

wxPoint SCH_SCREEN::m_aux_origin
private

Origin of the auxiliary axis, which is used in exports mostly, but not yet in EESCHEMA.

Definition at line 93 of file sch_screen.h.

Referenced by GetAuxOrigin(), and SetAuxOrigin().

◆ m_BlockLocate

◆ m_Center

bool BASE_SCREEN::m_Center
inherited

Center on screen.

If true (0.0) is centered on screen coordinates can be < 0 and

0 except for schematics.

false: when coordinates can only be >= 0 Schematic

Definition at line 202 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), BASE_SCREEN::InitDataPoints(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), and SCH_SCREEN().

◆ m_clientSheetPathList

wxArrayString SCH_SCREEN::m_clientSheetPathList
private

the list of scheet paths sharing this screen used in some annotation calculations to update alternate references Note: a screen having a m_refCount = 1 (only one sheet path using it) can have many scheet paths sharing this screen, if this sheet is inside an other sheet having many instances (one sheet path by parent sheet instance).

Definition at line 85 of file sch_screen.h.

Referenced by EnsureAlternateReferencesExist(), GetClientSheetPaths(), and GetClientSheetPathsCount().

◆ m_drawList

◆ m_DrawOrg

wxPoint BASE_SCREEN::m_DrawOrg
inherited

◆ m_fileName

wxString SCH_SCREEN::m_fileName
private

File used to load the screen.

Definition at line