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 Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

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 Print (wxDC *aDC)
 Print all the items in the screen to aDC. 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 InitDataPoints (const wxSize &aPageSizeInternalUnits)
 
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...
 
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...
 
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 AddGrid (const GRID_TYPE &aGrid)
 
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...
 
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
 
bool HasFlag (STATUS_FLAGS aFlag)
 
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)
 Function Matches compares the item against the search criteria in aSearchData. 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 ()
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
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...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static 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...
 
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...
 
VECTOR2D m_LocalOrigin
 Relative Screen cursor coordinate (on grid) in user 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...
 
VECTOR2D m_ScrollCenter
 Current scroll center point in logical units. 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...
 
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 64 of file sch_screen.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ SCH_SCREEN()

SCH_SCREEN::SCH_SCREEN ( KIWAY aKiway)

Constructor.

Definition at line 105 of file sch_screen.cpp.

105  :
107  KIWAY_HOLDER( aKiway, KIWAY_HOLDER::HOLDER_TYPE::SCREEN ),
108  m_paper( wxT( "A4" ) )
109 {
111 
112  SetZoom( 32 );
113 
114  for( unsigned zoom : SchematicZoomList )
115  m_ZoomList.push_back( zoom );
116 
117  for( GRID_TYPE grid : SchematicGridList )
118  AddGrid( grid );
119 
120  // Set the default grid size, now that the grid list is populated
121  SetGrid( wxRealPoint( 50, 50 ) );
122 
123  m_refCount = 0;
124 
125  // Suitable for schematic only. For libedit and viewlib, must be set to true
126  m_Center = false;
127 
128  InitDataPoints( m_paper.GetSizeIU() );
129 }
static double SchematicZoomList[]
Definition: sch_screen.cpp:76
void AddGrid(const GRID_TYPE &aGrid)
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:70
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:91
static GRID_TYPE SchematicGridList[]
Definition: sch_screen.cpp:94
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:63
PAGE_INFO m_paper
The size of the paper to print or plot on.
Definition: sch_screen.h:82
bool m_Center
Center on screen.
Definition: base_screen.h:121
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
Definition: base_screen.cpp:86
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Definition: kiway_holder.h:44
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
BASE_SCREEN(KICAD_T aType=SCREEN_T)
Definition: base_screen.cpp:45
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:138

References BASE_SCREEN::AddGrid(), 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 132 of file sch_screen.cpp.

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

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

914 {
915  m_aliases.insert( aAlias );
916 }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:95

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN::LoadContent().

◆ AddGrid() [1/2]

void BASE_SCREEN::AddGrid ( const GRID_TYPE aGrid)
inherited

Definition at line 197 of file base_screen.cpp.

198 {
199  for( GRID_TYPE& existing : m_grids )
200  {
201  if( existing.m_Size == aGrid.m_Size && aGrid.m_CmdId != ID_POPUP_GRID_USER )
202  {
203  wxLogTrace( traceScreen, "Discarding duplicate grid size( %g, %g ).",
204  aGrid.m_Size.x, aGrid.m_Size.y );
205  return;
206  }
207 
208  if( existing.m_CmdId == aGrid.m_CmdId )
209  {
210  wxLogTrace( traceScreen, wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
211  wxT( "size( %g, %g )." ),
212  aGrid.m_CmdId, existing.m_Size.x,
213  existing.m_Size.y, aGrid.m_Size.x, aGrid.m_Size.y );
214  existing.m_Size = aGrid.m_Size;
215  return;
216  }
217  }
218 
219  m_grids.push_back( aGrid );
220 }
const wxChar *const traceScreen
Flag to enable debug output of BASE_SCREEN and it's derivatives.
wxRealPoint m_Size
Definition: base_screen.h:47
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
int m_CmdId
Definition: base_screen.h:46

References 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/2]

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

Definition at line 223 of file base_screen.cpp.

224 {
225  wxRealPoint new_size;
226  GRID_TYPE new_grid;
227 
228  new_size.x = From_User_Unit( aUnit, size.x );
229  new_size.y = From_User_Unit( aUnit, size.y );
230  new_grid.m_CmdId = id;
231  new_grid.m_Size = new_size;
232 
233  AddGrid( new_grid );
234 }
void AddGrid(const GRID_TYPE &aGrid)
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:289
wxRealPoint m_Size
Definition: base_screen.h:47
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
int m_CmdId
Definition: base_screen.h:46

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 154 of file sch_screen.h.

155  {
156  m_drawList.Append( aItem );
158  }
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:91
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), Diagnose(), SCH_EDIT_FRAME::EditSheet(), CONNECTION_GRAPH::ercCheckLabels(), SCH_LEGACY_PLUGIN::LoadContent(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSegments(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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 159 of file sch_screen.cpp.

160 {
161  wxCHECK_RET( aScreen, "Invalid screen object." );
162 
163  // No need to decend the hierarchy. Once the top level screen is copied, all of it's
164  // children are copied as well.
165  m_drawList.Append( aScreen->m_drawList );
166 
167  // This screen owns the objects now. This prevents the object from being delete when
168  // aSheet is deleted.
169  aScreen->m_drawList.SetOwnership( false );
170 }
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:89
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 177 of file sch_screen.h.

178  {
179  m_drawList.Append( aList );
181  }
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:91
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89

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

◆ Back()

EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

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

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

106 {
107  wxString msg;
108  wxRealPoint curr_grid_size = GetGridSize();
109  int idx = -1;
110  int idx_usergrid = -1;
111 
112  for( size_t i = 0; i < GetGridCount(); i++ )
113  {
114  const GRID_TYPE& grid = m_grids[i];
115  double gridValueMils = To_User_Unit( INCHES, grid.m_Size.x ) * 1000;
116  double gridValue_mm = To_User_Unit( MILLIMETRES, grid.m_Size.x );
117 
118  if( grid.m_CmdId == ID_POPUP_GRID_USER )
119  {
120  if( aMmFirst )
121  msg.Printf( _( "User grid: %.4f mm (%.2f mils)" ),
122  gridValue_mm, gridValueMils );
123  else
124  msg.Printf( _( "User grid: %.2f mils (%.4f mm)" ),
125  gridValueMils, gridValue_mm );
126  idx_usergrid = i;
127  }
128  else
129  {
130  if( aMmFirst )
131  msg.Printf( _( "Grid: %.4f mm (%.2f mils)" ),
132  gridValue_mm, gridValueMils );
133  else
134  msg.Printf( _( "Grid: %.2f mils (%.4f mm)" ),
135  gridValueMils, gridValue_mm );
136  }
137 
138  aGridsList.Add( msg );
139 
140  if( curr_grid_size == grid.m_Size )
141  idx = i;
142  }
143 
144  if( idx < 0 )
145  idx = idx_usergrid;
146 
147  return idx;
148 }
const wxRealPoint & GetGridSize() const
Return the grid size of the currently selected grid.
Definition: base_screen.h:279
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:134
wxRealPoint m_Size
Definition: base_screen.h:47
#define _(s)
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
size_t i
Definition: json11.cpp:649
size_t GetGridCount() const
Function GetGridCount().
Definition: base_screen.h:324
int m_CmdId
Definition: base_screen.h:46

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 GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), 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 219 of file sch_screen.cpp.

220 {
221  SCH_ITEM* itemList = m_drawList.begin();
222 
223  while( itemList )
224  {
225  if( itemList == aItem )
226  return true;
227 
228  itemList = itemList->Next();
229  }
230 
231  return false;
232 }
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:89
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().

◆ ClassOf()

static bool SCH_SCREEN::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 108 of file sch_screen.h.

109  {
110  return aItem && SCH_SCREEN_T == aItem->Type();
111  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_SCREEN_T, and EDA_ITEM::Type().

◆ Clear()

void SCH_SCREEN::Clear ( )

Delete all draw items and clears the project settings.

Definition at line 173 of file sch_screen.cpp.

174 {
175  FreeDrawList();
176 
177  // Clear the project settings
179 
180  m_titles.Clear();
181 }
int m_ScreenNumber
Definition: base_screen.h:135
void Clear()
Definition: title_block.h:116
TITLE_BLOCK m_titles
Definition: sch_screen.h:84
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:184
int m_NumberOfScreens
Definition: base_screen.h:136

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

730 {
731  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
732  {
733  if( item->Type() == SCH_COMPONENT_T )
734  {
735  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
736 
737  component->ClearAnnotation( aSheetPath );
738 
739  // Clear the modified component flag set by component->ClearAnnotation
740  // because we do not use it here and we should not leave this flag set,
741  // when an editing is finished:
742  component->ClearFlags();
743  }
744  }
745 }
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:89
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:266
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(), SCH_EDIT_FRAME::DeleteAnnotation(), and SCH_EDITOR_CONTROL::Paste().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 245 of file base_struct.h.

245 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearBusAliases()

void SCH_SCREEN::ClearBusAliases ( )
inline

Removes all bus alias definitions.

Definition at line 456 of file sch_screen.h.

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

References m_aliases.

◆ ClearDrawingState()

void SCH_SCREEN::ClearDrawingState ( )

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

Definition at line 612 of file sch_screen.cpp.

613 {
614  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
615  item->ClearTempFlags();
616 }
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:89
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()

◆ ClearFlags()

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

Definition at line 266 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MWAVE::CreateMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::HighlightItem(), MODULE_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), EDIT_POINTS_FACTORY::Make(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 244 of file base_struct.h.

244 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 278 of file base_struct.h.

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

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

598 {
599  if( aItemCount == 0 )
600  return;
601 
602  for( auto& command : aList.m_CommandsList )
603  {
604  command->ClearListAndDeleteItems();
605  delete command;
606  }
607 
608  aList.m_CommandsList.clear();
609 }
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 279 of file base_screen.cpp.

280 {
283 }
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:132
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:133

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(), MODULE_EDITOR_TOOLS::ImportFootprint(), 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 MODULE_ZONE_CONTAINER, D_PAD, SCH_COMPONENT, ZONE_CONTAINER, MODULE, SCH_SHEET, LIB_PIN, SCH_HIERLABEL, VIA, SCH_GLOBALLABEL, DRAWSEGMENT, SCH_LABEL, DIMENSION, TRACK, TEXTE_MODULE, SCH_LINE, SCH_TEXT, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, EDGE_MODULE, LIB_ARC, TEXTE_PCB, SCH_NO_CONNECT, LIB_POLYLINE, SCH_JUNCTION, PCB_TARGET, SCH_MARKER, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 121 of file base_struct.cpp.

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

References EDA_ITEM::GetClass().

Referenced by 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_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), LIB_PART::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClrModify()

◆ ClrSave()

void BASE_SCREEN::ClrSave ( )
inlineinherited

Definition at line 227 of file base_screen.h.

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

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

712 {
713  SCH_ITEM* item;
714  int count = 0;
715 
716  for( item = m_drawList.begin(); item; item = item->Next() )
717  {
718  if( item->Type() == SCH_JUNCTION_T && !aTestJunctions )
719  continue;
720 
721  if( item->IsConnected( aPos ) )
722  count++;
723  }
724 
725  return count;
726 }
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:89
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:119
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

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

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

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

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

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

Referenced by SCH_SCREENS::DeleteAllMarkers().

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

749 {
750  if( GetClientSheetPathsCount() <= 1 ) // No need for alternate reference
751  return;
752 
753  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
754  {
755  if( item->Type() != SCH_COMPONENT_T )
756  continue;
757 
758  // Add (when not existing) all sheet path entries
759  for( unsigned int ii = 0; ii < m_clientSheetPathList.GetCount(); ii++ )
760  ((SCH_COMPONENT*)item)->AddSheetPathReferenceEntryIfMissing( m_clientSheetPathList[ii] );
761  }
762 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
int GetClientSheetPathsCount()
Definition: sch_screen.h:145
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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:79

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

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), and SCH_EDITOR_CONTROL::Paste().

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

185 {
187 }
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:89

References DHEAD::DeleteAll(), and m_drawList.

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

◆ GetAuxOrigin()

const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const
inline

Definition at line 125 of file sch_screen.h.

125 { 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:87

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, SCH_HIERLABEL, WS_DRAW_ITEM_BITMAP, SCH_COMPONENT, WS_DRAW_ITEM_TEXT, SCH_GLOBALLABEL, WS_DRAW_ITEM_PAGE, GERBER_DRAW_ITEM, SCH_LABEL, DIMENSION, LIB_PART, DRAWSEGMENT, WS_DRAW_ITEM_RECT, LIB_ITEM, TEXTE_MODULE, MODULE, WS_DRAW_ITEM_POLYPOLYGONS, SCH_TEXT, LIB_FIELD, ZONE_CONTAINER, SCH_LINE, WS_DRAW_ITEM_LINE, LIB_PIN, SCH_FIELD, TRACK, TEXTE_PCB, MARKER_PCB, PCB_TARGET, SCH_BITMAP, SCH_BUS_ENTRY_BASE, GBR_LAYOUT, WS_DRAW_ITEM_BASE, SCH_PIN, LIB_POLYLINE, LIB_BEZIER, LIB_ARC, LIB_TEXT, SCH_NO_CONNECT, SCH_JUNCTION, SCH_MARKER, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 108 of file base_struct.cpp.

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

Referenced by CN_ITEM::BBox(), MODULE::CoverageRatio(), SCH_EDITOR_CONTROL::FindNext(), SELECTION::GetBoundingBox(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), GERBVIEW_SELECTION::GetCenter(), getRect(), getSheetBbox(), SCH_EDIT_TOOL::Mirror(), GERBVIEW_SELECTION::ViewBBox(), 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 419 of file sch_screen.h.

421  {
422  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
423  }
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:812

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

938 {
939  SCH_SHEET_LIST aSheets( g_RootSheet );
940  for( unsigned i = 0; i < aSheets.size(); i++ )
941  {
942  for( auto alias : aSheets[i].LastScreen()->GetBusAliases() )
943  {
944  if( alias->GetName() == aLabel )
945  {
946  return alias;
947  }
948  }
949  }
950 
951  return NULL;
952 }
Class SCH_SHEET_LIST.
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:47
size_t i
Definition: json11.cpp:649

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 464 of file sch_screen.h.

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

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 113 of file sch_screen.h.

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

◆ GetClientSheetPaths()

wxArrayString& SCH_SCREEN::GetClientSheetPaths ( )
inline

Definition at line 147 of file sch_screen.h.

147 { 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:79

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 145 of file sch_screen.h.

145 { 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:79

References m_clientSheetPathList.

Referenced by EnsureAlternateReferencesExist().

◆ 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 152 of file sch_screen.h.

152 { 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:89

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

Referenced by 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_TOOL::DeleteItemCursor(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_LINE_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(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportHierLabel(), SCH_SHEET_PATH::LastDrawList(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), nextMatch(), 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_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), UpdateSymbolLinks(), and ~SCH_SCREEN().

◆ GetDrawList()

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

Definition at line 106 of file sch_screen.h.

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

References m_drawList.

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 270 of file base_struct.h.

271  {
275  return m_Flags & mask;
276  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:154
#define SELECTED
Definition: base_struct.h:127
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:187
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

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

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), BOARD::Print(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::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 286 of file base_screen.h.

286 { return m_Grid; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:89

References BASE_SCREEN::m_Grid.

Referenced by GERBVIEW_FRAME::DisplayGridMsg(), PCB_BASE_FRAME::DisplayGridMsg(), getNextPreviousGrid(), 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 237 of file base_screen.cpp.

238 {
239  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
240  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
241 
242  return m_grids[ aIndex ];
243 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:89
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88

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 272 of file base_screen.h.

272 { return m_Grid.m_CmdId; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:89
int m_CmdId
Definition: base_screen.h:46

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

Referenced by 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 324 of file base_screen.h.

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

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 339 of file base_screen.h.

340  {
341  return m_grids;
342  }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88

References BASE_SCREEN::m_grids.

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

◆ GetGridSize()

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

766 {
767  SCH_ITEM* item = m_drawList.begin();
768 
769  while( item )
770  {
771  if( ( item->Type() == SCH_SHEET_T ) || ( item->Type() == SCH_COMPONENT_T ) )
772  aItems.push_back( item );
773 
774  item = item->Next();
775  }
776 }
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:89
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:210

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

236 {
237  KICAD_T types[] = { aType, EOT };
238 
239  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
240  {
241  switch( item->Type() )
242  {
243  case SCH_COMPONENT_T:
244  {
245  SCH_COMPONENT* component = (SCH_COMPONENT*) item;
246 
247  for( int i = REFERENCE; i < component->GetFieldCount(); i++ )
248  {
249  SCH_FIELD* field = component->GetField( i );
250 
251  if( field->IsType( types ) && field->HitTest( aPosition, aAccuracy ) )
252  return field;
253  }
254 
255  break;
256  }
257  case SCH_SHEET_T:
258  {
259  SCH_SHEET* sheet = (SCH_SHEET*)item;
260 
261  SCH_SHEET_PIN* pin = sheet->GetPin( aPosition );
262 
263  if( pin && pin->IsType( types ) )
264  return pin;
265 
266  break;
267  }
268  default:
269  break;
270  }
271 
272  if( item->IsType( types ) && item->HitTest( aPosition, aAccuracy ) )
273  return item;
274  }
275 
276  return NULL;
277 }
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:76
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:381
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:294
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:396
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
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:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
size_t i
Definition: json11.cpp:649
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(), IsTerminalPoint(), and SCH_DRAWING_TOOLS::SingleClickPlace().

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

847 {
848  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
849  {
850  switch( item->Type() )
851  {
852  case SCH_LABEL_T:
853  case SCH_GLOBAL_LABEL_T:
854  case SCH_HIER_LABEL_T:
855  if( item->HitTest( aPosition, aAccuracy ) )
856  return (SCH_TEXT*) item;
857 
858  default:
859  ;
860  }
861  }
862 
863  return NULL;
864 }
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:89
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 812 of file sch_screen.cpp.

814 {
815  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
816  {
817  if( item->Type() != SCH_LINE_T )
818  continue;
819 
820  if( item->GetLayer() != aLayer )
821  continue;
822 
823  if( !item->HitTest( aPosition, aAccuracy ) )
824  continue;
825 
826  switch( aSearchType )
827  {
828  case ENTIRE_LENGTH_T:
829  return (SCH_LINE*) item;
830 
832  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
833  return (SCH_LINE*) item;
834  break;
835 
836  case END_POINTS_ONLY_T:
837  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
838  return (SCH_LINE*) item;
839  }
840  }
841 
842  return NULL;
843 }
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:89
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

Definition at line 221 of file base_struct.h.

221 { return m_List; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:178

References EDA_ITEM::m_List.

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

◆ 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 256 of file base_screen.h.

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

References BASE_SCREEN::m_ZoomList.

Referenced by BASE_SCREEN::SetZoom().

◆ GetMaxUndoItems()

int BASE_SCREEN::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 211 of file base_screen.h.

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

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, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PIN, SCH_HIERLABEL, VIA, GERBER_DRAW_ITEM, SCH_GLOBALLABEL, DRAWSEGMENT, SCH_LABEL, DIMENSION, TRACK, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_LINE, SCH_TEXT, LIB_FIELD, SCH_SHEET_PIN, SCH_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, EDGE_MODULE, LIB_ARC, TEXTE_PCB, MARKER_PCB, LIB_POLYLINE, SCH_NO_CONNECT, PCB_TARGET, LIB_TEXT, SCH_JUNCTION, SCH_MARKER, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 251 of file base_struct.cpp.

252 {
253  return dummy_xpm;
254 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:54

References dummy_xpm.

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

◆ 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 263 of file base_screen.h.

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

References BASE_SCREEN::m_ZoomList.

Referenced by 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, DIMENSION, DRAWSEGMENT, SCH_LINE, SCH_TEXT, LIB_ITEM, TEXTE_MODULE, TRACK, LIB_FIELD, SCH_BITMAP, EDGE_MODULE, SCH_BUS_ENTRY_BASE, LIB_PIN, MARKER_PCB, ZONE_CONTAINER, LIB_BEZIER, SCH_MARKER, TEXTE_PCB, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 328 of file base_struct.h.

329  {
330  }

Referenced by EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCBNEW_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_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 619 of file sch_screen.cpp.

621 {
622  SCH_ITEM* item;
623  SCH_COMPONENT* component = NULL;
624  LIB_PIN* pin = NULL;
625 
626  for( item = m_drawList.begin(); item; item = item->Next() )
627  {
628  if( item->Type() != SCH_COMPONENT_T )
629  continue;
630 
631  component = (SCH_COMPONENT*) item;
632 
633  if( aEndPointOnly )
634  {
635  pin = NULL;
636 
637  if( !component->GetPartRef() )
638  continue;
639 
640  for( pin = component->GetPartRef()->GetNextPin(); pin;
641  pin = component->GetPartRef()->GetNextPin( pin ) )
642  {
643  // Skip items not used for this part.
644  if( component->GetUnit() && pin->GetUnit() &&
645  ( pin->GetUnit() != component->GetUnit() ) )
646  continue;
647 
648  if( component->GetConvert() && pin->GetConvert() &&
649  ( pin->GetConvert() != component->GetConvert() ) )
650  continue;
651 
652  if(component->GetPinPhysicalPosition( pin ) == aPosition )
653  break;
654  }
655  if( pin )
656  break;
657  }
658  else
659  {
660  pin = (LIB_PIN*) component->GetDrawItem( aPosition, LIB_PIN_T );
661 
662  if( pin )
663  break;
664  }
665  }
666 
667  if( pin && aComponent )
668  *aComponent = component;
669 
670  return pin;
671 }
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
Definition: lib_item.h:301
int GetUnit() const
std::unique_ptr< LIB_PART > & GetPartRef()
int GetConvert() const
Definition: lib_item.h:304
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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:210

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

◆ GetRefCount()

int SCH_SCREEN::GetRefCount ( ) const
inline

Definition at line 136 of file sch_screen.h.

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

References m_refCount.

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

◆ 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, SCH_COMPONENT, MODULE, BOARD, SCH_SHEET, LIB_PIN, SCH_HIERLABEL, WS_DRAW_ITEM_BITMAP, VIA, GERBER_DRAW_ITEM, WS_DRAW_ITEM_TEXT, SCH_GLOBALLABEL, WS_DRAW_ITEM_PAGE, DRAWSEGMENT, SCH_LABEL, DIMENSION, WS_DRAW_ITEM_RECT, TRACK, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_LINE, SCH_TEXT, LIB_FIELD, SCH_SHEET_PIN, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BUS_WIRE_ENTRY, WS_DRAW_ITEM_LINE, SCH_BITMAP, EDGE_MODULE, LIB_ARC, TEXTE_PCB, MARKER_PCB, LIB_POLYLINE, PCB_TARGET, LIB_TEXT, SCH_NO_CONNECT, LIB_CIRCLE, LIB_RECTANGLE, SCH_JUNCTION, SCH_MARKER, SCH_PIN, and DELETED_BOARD_ITEM.

Definition at line 147 of file base_struct.cpp.

148 {
149  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
150  GetClass() );
151 
152  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
153 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_SUBGRAPH::ResolveDrivers(), 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 674 of file sch_screen.cpp.

675 {
676  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
677  {
678  if( item->Type() != SCH_SHEET_T )
679  continue;
680 
681  SCH_SHEET* sheet = (SCH_SHEET*) item;
682 
683  if( aName.CmpNoCase( sheet->GetName() ) == 0 )
684  return sheet;
685  }
686 
687  return NULL;
688 }
SCH_ITEM * Next() const
Definition: sch_item.h:153
T * begin() const
Definition: dlist.h:218
wxString GetName() const
Definition: sch_sheet.h:272
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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::LoadSheetFromFile().

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

692 {
693  SCH_SHEET_PIN* sheetPin = NULL;
694 
695  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
696  {
697  if( item->Type() != SCH_SHEET_T )
698  continue;
699 
700  SCH_SHEET* sheet = (SCH_SHEET*) item;
701  sheetPin = sheet->GetPin( aPosition );
702 
703  if( sheetPin )
704  break;
705  }
706 
707  return sheetPin;
708 }
SCH_SHEET_PIN * GetPin(const wxPoint &aPosition)
Return the sheet pin item found at aPosition in the sheet.
Definition: sch_sheet.cpp:381
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:75
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 249 of file base_struct.h.

250  {
251  return m_Status & type;
252  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by SELECTION_TOOL::expandConnection(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::IsLocked(), TRACK::Print(), and ZONE_CONTAINER::PrintFilledArea().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 262 of file base_struct.h.

262 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetTimeStamp()

◆ GetTitleBlock()

const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const
inline

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUndoCommandCount()

◆ GetWire()

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

Definition at line 413 of file sch_screen.h.

415  {
416  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
417  }
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:812

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

799 {
801 
802  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
803  {
804  if( item->IsType( types ) && item->HitTest( aPosition ) )
805  return (SCH_LINE*) item;
806  }
807 
808  return nullptr;
809 }
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:89
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 240 of file base_screen.h.

240 { return m_Zoom; }
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:90

References BASE_SCREEN::m_Zoom.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_EDITOR_CONTROL::FindNext(), EDA_DRAW_FRAME::GetZoom(), DIALOG_MIGRATE_BUSES::onItemSelected(), DIALOG_ERC::OnLeftClickMarkersList(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), SCH_BASE_FRAME::RedrawScreen(), 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 246 of file base_screen.cpp.

247 {
248  // tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.
249  for( GRID_TYPE& grid : m_grids)
250  {
251  if( grid.m_CmdId == aCommandId )
252  return true;
253  }
254 
255  return false;
256 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43

References BASE_SCREEN::m_grids.

Referenced by COMMON_TOOLS::GridPreset().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS  aFlag)
inlineinherited

◆ 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, WS_DRAW_ITEM_BITMAP, VIA, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, ZONE_CONTAINER, DIMENSION, DRAWSEGMENT, WS_DRAW_ITEM_RECT, SCH_LINE, SCH_TEXT, TEXTE_MODULE, SCH_FIELD, SCH_SHEET_PIN, TRACK, LIB_ITEM, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, SCH_BITMAP, WS_DRAW_ITEM_LINE, LIB_PIN, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, SCH_JUNCTION, SCH_MARKER, MARKER_PCB, PCB_TARGET, WS_DRAW_ITEM_BASE, TEXTE_PCB, SCH_PIN, LIB_POLYLINE, LIB_BEZIER, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, LIB_CIRCLE, and KIGFX::RATSNEST_VIEWITEM.

Definition at line 340 of file base_struct.h.

341  {
342  return false; // derived classes should override this function
343  }

Referenced by SCH_MOVE_TOOL::getConnectedDragItems(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), WS_DRAW_ITEM_BASE::HitTest(), 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, ZONE_CONTAINER, WS_DRAW_ITEM_BITMAP, VIA, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, DIMENSION, DRAWSEGMENT, SCH_LINE, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, TRACK, LIB_ITEM, WS_DRAW_ITEM_POLYPOLYGONS, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, SCH_JUNCTION, WS_DRAW_ITEM_BASE, PCB_TARGET, TEXTE_PCB, LIB_POLYLINE, LIB_BEZIER, LIB_ARC, LIB_TEXT, and LIB_CIRCLE.

Definition at line 354 of file base_struct.h.

355  {
356  return false; // derived classes should override this function
357  }

◆ IncRefCount()

void SCH_SCREEN::IncRefCount ( )

Definition at line 145 of file sch_screen.cpp.

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

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

64 {
65  if( m_Center )
66  {
67  m_crossHairPosition.x = 0;
68  m_crossHairPosition.y = 0;
69 
70  m_DrawOrg.x = -aPageSizeIU.x / 2;
71  m_DrawOrg.y = -aPageSizeIU.y / 2;
72  }
73  else
74  {
75  m_crossHairPosition.x = aPageSizeIU.x / 2;
76  m_crossHairPosition.y = aPageSizeIU.y / 2;
77 
78  m_DrawOrg.x = 0;
79  m_DrawOrg.y = 0;
80  }
81 
82  m_LocalOrigin = { 0, 0 };
83 }
wxPoint m_crossHairPosition
The cross hair position in logical (drawing) units.
Definition: base_screen.h:86
bool m_Center
Center on screen.
Definition: base_screen.h:121
wxPoint m_DrawOrg
offsets for drawing the circuit on the screen
Definition: base_screen.h:112
VECTOR2D m_LocalOrigin
Relative Screen cursor coordinate (on grid) in user units.
Definition: base_screen.h:114

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

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

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

920 {
921  SCH_SHEET_LIST aSheets( g_RootSheet );
922  for( unsigned i = 0; i < aSheets.size(); i++ )
923  {
924  for( const auto& alias : aSheets[i].LastScreen()->GetBusAliases() )
925  {
926  if( alias->GetName() == aLabel )
927  {
928  return true;
929  }
930  }
931  }
932 
933  return false;
934 }
Class SCH_SHEET_LIST.
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:47
size_t i
Definition: json11.cpp:649

References g_RootSheet, and i.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

231 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:122
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:187

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), KIGFX::SCH_PAINTER::setDeviceColors(), and ShowClearance().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 235 of file base_struct.h.

235 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:187

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and KIGFX::SCH_VIEW::HighlightItem().

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

349 {
350  enum { WIRES, BUSSES } layers;
351 
352  bool has_nonparallel[ sizeof( layers ) ] = { false };
353  int end_count[ sizeof( layers ) ] = { 0 };
354  int pin_count = 0;
355 
356  std::vector<SCH_LINE*> lines[ sizeof( layers ) ];
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 ) && ( item->HitTest( aPosition, 0 ) ) )
367  {
368  if( item->GetLayer() == LAYER_WIRE )
369  lines[ WIRES ].push_back( (SCH_LINE*) item );
370  else if( item->GetLayer() == LAYER_BUS )
371  lines[ BUSSES ].push_back( (SCH_LINE*) item );
372  }
373 
374  if( ( item->Type() == SCH_COMPONENT_T ) && ( item->IsConnected( aPosition ) ) )
375  pin_count++;
376  }
377 
378  for( int i : { WIRES, BUSSES } )
379  {
380  bool removed_overlapping = false;
381  end_count[i] = lines[i].size();
382 
383  for( auto line = lines[i].begin(); line < lines[i].end(); line++ )
384  {
385  // Consider ending on a line to be equivalent to two endpoints because
386  // we will want to split the line if anything else connects
387  if( !(*line)->IsEndPoint( aPosition ) )
388  end_count[i]++;
389 
390  for( auto second_line = lines[i].end() - 1; second_line > line; second_line-- )
391  {
392  if( !(*line)->IsParallel( *second_line ) )
393  has_nonparallel[i] = true;
394  else if( !removed_overlapping
395  && (*line)->IsSameQuadrant( *second_line, aPosition ) )
396  {
402  removed_overlapping = true;
403  end_count[i]--;
404  }
405  }
406  }
407  }
408 
409  // If there are three or more endpoints
410  if( pin_count && pin_count + end_count[WIRES] > 2 )
411  return true;
412 
413  // If there is at least one segment that ends on a non-parallel line or
414  // junction of two other lines
415  if( has_nonparallel[WIRES] && end_count[WIRES] > 2 )
416  return true;
417 
418  // Check for bus - bus junction requirements
419  if( has_nonparallel[BUSSES] && end_count[BUSSES] > 2 )
420  return true;
421 
422  return false;
423 }
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:129
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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:649
boost::ptr_vector< WIRE > WIRES
Definition: specctra.h:2950
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_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::Main(), and SCH_EDIT_FRAME::SchematicCleanUp().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

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

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsModify()

◆ IsMoving()

◆ IsNew()

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

556 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

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

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSave()

bool BASE_SCREEN::IsSave ( ) const
inlineinherited

Definition at line 229 of file base_screen.h.

229 { return m_FlagSave; }
bool m_FlagSave
Indicates automatic file save.
Definition: base_screen.h:78

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

427 {
428  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
429  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
430 
431  SCH_SHEET_PIN* label;
432  SCH_TEXT* text;
433  SCH_CONNECTION conn;
434 
435  switch( aLayer )
436  {
437  case LAYER_BUS:
438 
439  if( GetBus( aPosition ) )
440  return true;
441 
442  label = GetSheetLabel( aPosition );
443 
444  if( label && conn.IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
445  return true;
446 
447  text = GetLabel( aPosition );
448 
449  if( text && conn.IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
450  && (text->Type() != SCH_LABEL_T) )
451  return true;
452 
453  break;
454 
455  case LAYER_NOTES:
456 
457  if( GetLine( aPosition ) )
458  return true;
459 
460  break;
461 
462  case LAYER_WIRE:
464  return true;
465 
466  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
467  return true;
468 
469  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
470  return true;
471 
472  if( GetPin( aPosition, NULL, true ) )
473  return true;
474 
475  if( GetWire( aPosition ) )
476  return true;
477 
478  text = GetLabel( aPosition );
479 
480  if( text && text->IsConnected( aPosition ) && !conn.IsBusLabel( text->GetText() ) )
481  return true;
482 
483  label = GetSheetLabel( aPosition );
484 
485  if( label && label->IsConnected( aPosition ) && !conn.IsBusLabel( label->GetText() ) )
486  return true;
487 
488  break;
489 
490  default:
491  break;
492  }
493 
494  return false;
495 }
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....
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:619
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:812
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:235
SCH_SHEET_PIN * GetSheetLabel(const wxPoint &aPosition)
Test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:691
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
SCH_LINE * GetWire(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:413
SCH_TEXT * GetLabel(const wxPoint &aPosition, int aAccuracy=0)
Return a label item located at aPosition.
Definition: sch_screen.cpp:846
#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).
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
Definition: sch_item.cpp:119
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_LINE * GetBus(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:419

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_LINE_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_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 294 of file base_struct.h.

295  {
296  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
297  return true;
298 
299  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
300  {
301  if( m_StructType == *p )
302  return true;
303  }
304 
305  return false;
306  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172
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_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 232 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/3]

static SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

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

423  {
424  for( EDA_ITEM* p = listStart; p; p = p->Pnext )
425  {
426  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
427  return SEARCH_QUIT;
428  }
429 
430  return SEARCH_CONTINUE;
431  }
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:176

References EDA_ITEM::Pnext, SEARCH_CONTINUE, and SEARCH_QUIT.

Referenced by EE_COLLECTOR::Collect(), EE_TYPE_COLLECTOR::Collect(), nextMatch(), EE_SELECTION_TOOL::RebuildSelection(), SCH_EDITOR_CONTROL::UpdateFind(), GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/3]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use the main queue instead

Definition at line 439 of file base_struct.h.

443  {
444  for( auto it : aList )
445  {
446  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes ) == SEARCH_QUIT )
447  return SEARCH_QUIT;
448  }
449 
450  return SEARCH_CONTINUE;
451  }
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...

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

◆ IterateForward() [3/3]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 459 of file base_struct.h.

461  {
462  for( auto it : aList )
463  {
464  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
465  == SEARCH_QUIT )
466  return SEARCH_QUIT;
467  }
468 
469  return SEARCH_CONTINUE;
470  }
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...

References SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), 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(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), 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(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), 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 306 of file sch_screen.cpp.

307 {
308  wxCHECK_RET( (aSegment) && (aSegment->Type() == SCH_LINE_T),
309  wxT( "Invalid object pointer." ) );
310 
311  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
312  {
313  if( item->HasFlag( CANDIDATE ) )
314  continue;
315 
316  if( item->Type() == SCH_JUNCTION_T )
317  {
318  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
319 
320  if( aSegment->IsEndPoint( junction->GetPosition() ) )
321  item->SetFlags( CANDIDATE );
322 
323  continue;
324  }
325 
326  if( item->Type() != SCH_LINE_T )
327  continue;
328 
329  SCH_LINE* segment = (SCH_LINE*) item;
330 
331  if( aSegment->IsEndPoint( segment->GetStartPoint() )
332  && !GetPin( segment->GetStartPoint(), NULL, true ) )
333  {
334  item->SetFlags( CANDIDATE );
335  MarkConnections( segment );
336  }
337 
338  if( aSegment->IsEndPoint( segment->GetEndPoint() )
339  && !GetPin( segment->GetEndPoint(), NULL, true ) )
340  {
341  item->SetFlags( CANDIDATE );
342  MarkConnections( segment );
343  }
344  }
345 }
wxPoint GetStartPoint() const
Definition: sch_line.h:99
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:130
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:619
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:265
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:100
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:306
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:92
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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:210
wxPoint GetEndPoint() const
Definition: sch_line.h:102

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 
)
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.
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, MARKER_PCB, SCH_PIN, SCH_MARKER, TEXTE_MODULE, and TEXTE_PCB.

Definition at line 512 of file base_struct.h.

513  {
514  return false;
515  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), TEXTE_PCB::Matches(), TEXTE_MODULE::Matches(), SCH_MARKER::Matches(), MARKER_PCB::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_SHEET::Matches(), nextMatch(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

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

157 {
158  wxString text = aText;
159  wxString searchText = aSearchData.GetFindString();
160 
161  // Don't match if searching for replaceable item and the item doesn't support text replace.
162  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
163  return false;
164 
165  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
166  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
167 
168  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
169  {
170  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
171  return text.Matches( searchText );
172 
173  return text.MakeUpper().Matches( searchText.MakeUpper() );
174  }
175 
176  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
177  return aText.Find( searchText ) != wxNOT_FOUND;
178 
179  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
180 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:556

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

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

211 {
212  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
213  GetChars( GetClass() ) ) );
214 
215  return false;
216 }
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:101
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 206 of file sch_screen.h.

206 { };

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

550 {
551  // Ensure links are up to date, even if a library was reloaded for some reason:
552  std::vector< SCH_ITEM* > junctions;
553  std::vector< SCH_ITEM* > bitmaps;
554  std::vector< SCH_ITEM* > other;
555 
556  // Ensure links are up to date, even if a library was reloaded for some reason:
558 
559  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
560  {
561  if( item->IsMoving() || item->IsResized() )
562  continue;
563 
564  if( item->Type() == SCH_JUNCTION_T )
565  junctions.push_back( item );
566  else if( item->Type() == SCH_BITMAP_T )
567  bitmaps.push_back( item );
568  else
569  // uncomment line below when there is a virtual EDA_ITEM::GetBoundingBox()
570  // if( panel->GetClipBox().Intersects( item->GetBoundingBox() ) )
571  other.push_back( item );
572  }
573 
574  // Bitmaps are drawn first to ensure they are in the background
575  // This is particularly important for the wxPostscriptDC (used in *nix printers) as
576  // the bitmap PS command clears the screen
577  for( auto item : bitmaps )
578  {
579  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
580  item->Plot( aPlotter );
581  }
582 
583  for( auto item : other )
584  {
585  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
586  item->Plot( aPlotter );
587  }
588 
589  for( auto item : junctions )
590  {
591  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
592  item->Plot( aPlotter );
593  }
594 }
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:498
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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(), SCH_BITMAP_T, SCH_JUNCTION_T, 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 322 of file base_screen.cpp.

323 {
324  return m_RedoList.PopCommand();
325 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:133

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

317 {
318  return m_UndoList.PopCommand();
319 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:132

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

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

◆ Print()

void SCH_SCREEN::Print ( wxDC *  aDC)

Print all the items in the screen to aDC.

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
aDCThe device context to draw on.

Definition at line 526 of file sch_screen.cpp.

527 {
528  std::vector< SCH_ITEM* > junctions;
529 
530  // Ensure links are up to date, even if a library was reloaded for some reason:
532 
533  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
534  {
535  if( item->IsMoving() || item->IsResized() )
536  continue;
537 
538  if( item->Type() == SCH_JUNCTION_T )
539  junctions.push_back( item );
540  else
541  item->Print( aDC, wxPoint( 0, 0 ) );
542  }
543 
544  for( auto item : junctions )
545  item->Print( aDC, wxPoint( 0, 0 ) );
546 }
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:498
T * begin() const
Definition: dlist.h:218
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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_JUNCTION_T, and UpdateSymbolLinks().

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

◆ 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_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:171

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), 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(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), 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(), DIALOG_BOARD_STATISTICS::saveReportClicked(), 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(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), 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 301 of file base_screen.cpp.

302 {
303  m_RedoList.PushCommand( aNewitem );
304 
305  // Delete the extra items, if count max reached
306  if( m_UndoRedoCountMax > 0 )
307  {
308  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
309 
310  if( extraitems > 0 )
311  ClearUndoORRedoList( m_RedoList, extraitems );
312  }
313 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:79
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:133
int GetRedoCommandCount() const
Definition: base_screen.h:206

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

287 {
288  m_UndoList.PushCommand( aNewitem );
289 
290  // Delete the extra items, if count max reached
291  if( m_UndoRedoCountMax > 0 )
292  {
293  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
294 
295  if( extraitems > 0 )
296  ClearUndoORRedoList( m_UndoList, extraitems );
297  }
298 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:79
int GetUndoCommandCount() const
Definition: base_screen.h:201
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:132

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

191 {
192  m_drawList.Remove( aItem );
193 }
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:89

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

Referenced by SCH_EDIT_FRAME::EditSheet(), and ReplaceWires().

◆ Replace() [1/2]

bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

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

184 {
185  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
186 
187  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
188  aSearchData.GetFindString() :
189  aSearchData.GetFindString().Upper() );
190 
191  if( result == wxNOT_FOUND )
192  return false;
193 
194  wxString prefix = aText.Left( result );
195  wxString suffix;
196 
197  if( aSearchData.GetFindString().length() + result < aText.length() )
198  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
199 
200  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
201  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
202  GetChars( suffix ) );
203 
204  aText = prefix + aSearchData.GetReplaceString() + suffix;
205 
206  return true;
207 }
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:101

References GetChars(), and traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_SHEET::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

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

544 { 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 280 of file sch_screen.cpp.

281 {
282  SCH_ITEM* item;
283  SCH_ITEM* next_item;
284 
285  for( item = m_drawList.begin(); item; item = next_item )
286  {
287  next_item = item->Next();
288 
289  switch( item->Type() )
290  {
291  case SCH_JUNCTION_T:
292  case SCH_LINE_T:
293  Remove( item );
294  delete item;
295  break;
296 
297  default:
298  break;
299  }
300  }
301 
302  m_drawList.Append( aWireList );
303 }
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:190
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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:210

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 126 of file sch_screen.h.

126 { 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:87

References m_aux_origin.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 224 of file base_struct.h.

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

References EDA_ITEM::Pback.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 241 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

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

869 {
870  SCH_COMPONENT* component;
871  bool found = false;
872 
873  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
874  {
875  if( item->Type() != SCH_COMPONENT_T )
876  continue;
877 
878  component = (SCH_COMPONENT*) item;
879 
880  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
881  {
882  // Found: Init Footprint Field
883 
884  /* Give a reasonable value to the field position and
885  * orientation, if the text is empty at position 0, because
886  * it is probably not yet initialized
887  */
888  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
889  if( fpfield->GetText().IsEmpty()
890  && ( fpfield->GetTextPos() == component->GetPosition() ) )
891  {
892  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
893  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
894  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
895 
896  if( fpfield->GetTextAngle() == 0.0 )
897  fpfield->Offset( wxPoint( 0, 100 ) );
898  else
899  fpfield->Offset( wxPoint( 100, 0 ) );
900  }
901 
902  fpfield->SetText( aFootPrint );
903  fpfield->SetVisible( aSetVisible );
904 
905  found = true;
906  }
907  }
908 
909  return found;
910 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:150
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:237
SCH_ITEM * Next() const
Definition: sch_item.h:153
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:231
void SetVisible(bool aVisible)
Definition: eda_text.h:169
double GetTextAngle() const
Definition: eda_text.h:158
T * begin() const
Definition: dlist.h:218
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:222
Field Name Module PCB, i.e. "16DIP300".
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define VALUE
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:126
const wxSize & GetTextSize() const
Definition: eda_text.h:223
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:89
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:232
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 const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124

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

Referenced by SCH_SHEET_PATH::SetComponentFootprint().

◆ SetFileName()

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 265 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), LIB_DRAWING_TOOLS::DrawShape(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_VIEW::HighlightItem(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

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

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

References EDA_ITEM::m_forceVisible.

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

152 {
153  wxASSERT( !m_grids.empty() );
154 
155  GRID_TYPE nearest_grid = m_grids[0];
156  int gridIdx = 0;
157 
158  for( GRID_TYPE& grid : m_grids )
159  {
160  if( grid.m_Size == size )
161  {
162  m_Grid = grid;
163  return grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
164  }
165 
166  // keep track of the nearest larger grid size, if the exact size is not found
167  if ( size.x < grid.m_Size.x )
168  {
169  gridIdx = grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
170  nearest_grid = grid;
171  }
172  }
173 
174  m_Grid = nearest_grid;
175  return gridIdx;
176 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:89
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
int m_CmdId
Definition: base_screen.h:46

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

Referenced by SCH_EDIT_FRAME::AppendSchematic(), SCH_EDIT_FRAME::DisplayCurrentSheet(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GBR_SCREEN::GBR_SCREEN(), COMMON_TOOLS::GridPreset(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_SCREEN::PCB_SCREEN(), 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 179 of file base_screen.cpp.

180 {
181  wxASSERT( !m_grids.empty() );
182 
183  for( GRID_TYPE& grid : m_grids )
184  {
185  if( grid.m_CmdId == aCommandId )
186  {
187  m_Grid = grid;
188  return grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
189  }
190  }
191 
192  m_Grid = m_grids[0];
193  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
194 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:89
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:88
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
int m_CmdId
Definition: base_screen.h:46

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

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 240 of file base_struct.h.

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

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

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
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().

◆ SetList()

void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 226 of file base_struct.h.

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

References EDA_ITEM::m_List.

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

◆ SetMaxUndoItems()

void BASE_SCREEN::SetMaxUndoItems ( int  aMax)
inlineinherited

Definition at line 213 of file base_screen.h.

214  {
215  if( aMax >= 0 && aMax < ABS_MAX_UNDO_ITEMS )
216  m_UndoRedoCountMax = aMax;
217  else
218  {
219  wxFAIL_MSG( "Maximum undo items not within limits" );
221  }
222  }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:79
#define ABS_MAX_UNDO_ITEMS
#define DEFAULT_MAX_UNDO_ITEMS

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

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

References EDA_ITEM::Pnext.

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

◆ SetPageSettings()

void SCH_SCREEN::SetPageSettings ( const PAGE_INFO aPageSettings)
inline

Definition at line 119 of file sch_screen.h.

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

References m_paper.

Referenced by LIB_CONTROL::ExportSymbolAsSVG(), SCH_LEGACY_PLUGIN::loadPageSettings(), and SCH_BASE_FRAME::SetPageSettings().

◆ SetParent()

◆ SetSave()

void BASE_SCREEN::SetSave ( )
inlineinherited

Definition at line 226 of file base_screen.h.

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

References BASE_SCREEN::m_FlagSave.

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

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetState()

void EDA_ITEM::SetState ( int  type,
int  state 
)
inlineinherited

Definition at line 254 of file base_struct.h.

255  {
256  if( state )
257  m_Status |= type; // state = ON or OFF
258  else
259  m_Status &= ~type;
260  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 263 of file base_struct.h.

263 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 215 of file base_struct.h.

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

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(), Diagnose(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), 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(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), SCH_EDIT_TOOL::RepeatDrawItem(), 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 130 of file sch_screen.h.

130 { m_titles = aTitleBlock; }
TITLE_BLOCK m_titles
Definition: sch_screen.h:84

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

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

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

87 {
88  if( iu_per_du == m_Zoom )
89  return false;
90 
91  wxLogTrace( traceScreen, "Zoom:%.16g 1/Zoom:%.16g", iu_per_du, 1/iu_per_du );
92 
93  if( iu_per_du < GetMinAllowedZoom() )
94  return false;
95 
96  if( iu_per_du > GetMaxAllowedZoom() )
97  return false;
98 
99  m_Zoom = iu_per_du;
100 
101  return true;
102 }
double GetMinAllowedZoom() const
Function GetMinAllowedZoom returns the minimum allowed zoom factor, which was established as the firs...
Definition: base_screen.h:263
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:256
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:90

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

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), SCH_EDITOR_CONTROL::FindComponentAndItem(), GBR_SCREEN::GBR_SCREEN(), EDA_DRAW_PANEL_GAL::onPaint(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), and SCH_SCREEN().

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

575 { return *aLeft < *aRight; }

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

780 {
781  SCH_ITEM* item;
782  std::vector< DANGLING_END_ITEM > endPoints;
783  bool hasStateChanged = false;
784 
785  for( item = m_drawList.begin(); item; item = item->Next() )
786  item->GetEndPoints( endPoints );
787 
788  for( item = m_drawList.begin(); item; item = item->Next() )
789  {
790  if( item->UpdateDanglingState( endPoints ) )
791  hasStateChanged = true;
792  }
793 
794  return hasStateChanged;
795 }
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:273
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:288
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:89
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 210 of file base_struct.h.

211  {
212  return m_StructType;
213  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), 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(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_NO_CONNECT::ClassOf(), TEXTE_PCB::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), ZONE_CONTAINER::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_TEXT::ClassOf(), ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_LABEL::ClassOf(), SCH_SHEET::ClassOf(), SCH_GLOBALLABEL::ClassOf(), VIA::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), SCH_SHEET::CleanupSheet(), EE_COLLECTOR::Collect(), LIB_RECTANGLE::compare(), LIB_CIRCLE::compare(), LIB_BEZIER::compare(), LIB_TEXT::compare(), LIB_POLYLINE::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(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), D_PAD::D_PAD(), SCH_SCREENS::DeleteAllMarkers(), DeleteItem(), 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(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckLabels(), SCH_EDITOR_CONTROL::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(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), 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(), GetHierarchicalItems(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), 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==(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), ReplaceWires(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), 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(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), VIA::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TestDuplicateSheetNames(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_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(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

499 {
500  // Initialize or reinitialize the pointer to the LIB_PART for each component
501  // found in m_drawList, but only if needed (change in lib or schematic)
502  // therefore the calculation time is usually very low.
503  if( m_drawList.GetCount() )
504  {
505  SYMBOL_LIB_TABLE* libs = Prj().SchSymbolLibTable();
506  int mod_hash = libs->GetModifyHash();
508 
510 
511  // Must we resolve?
512  if( (m_modification_sync != mod_hash) || aForce )
513  {
514  SCH_COMPONENT::ResolveAll( c, *libs, Prj().SchLibs()->GetCacheLibrary() );
515 
516  m_modification_sync = mod_hash; // note the last mod_hash
517  }
518  // Resolving will update the pin caches but we must ensure that this happens
519  // even if the libraries don't change.
520  else
522  }
523 }
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:91
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:89
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:152

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 Plot(), and Print().

◆ 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, DRAWSEGMENT, DIMENSION, TRACK, TEXTE_MODULE, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, 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 236 of file base_struct.cpp.

237 {
238  // Basic fallback
239  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
240  VECTOR2I( GetBoundingBox().GetSize() ) );
241 }
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 GERBVIEW_FRAME::GetDocumentExtents(), 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::WS_PROXY_VIEW_ITEM, 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, GERBER_DRAW_ITEM, BOARD_ITEM, TEXTE_MODULE, TRACK, SCH_ITEM, LIB_PART, LIB_ITEM, SCH_COMPONENT, ZONE_CONTAINER, LIB_FIELD, SCH_LINE, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, WS_DRAW_ITEM_BASE, SCH_NO_CONNECT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, SCH_JUNCTION, LIB_TEXT, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, SCH_MARKER, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 244 of file base_struct.cpp.

245 {
246  // Basic fallback
247  aCount = 1;
248  aLayers[0] = 0;
249 }

◆ 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 MODULE_ZONE_CONTAINER, D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, 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()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ 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, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PART, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 131 of file base_struct.cpp.

132 {
133 #if 0 && defined(DEBUG)
134  std::cout << GetClass().mb_str() << ' ';
135 #endif
136 
137  if( IsType( scanTypes ) )
138  {
139  if( SEARCH_QUIT == inspector( this, testData ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
virtual bool IsType(const KICAD_T aScanTypes[])
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:294
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 95 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 87 of file sch_screen.h.

Referenced by GetAuxOrigin(), and SetAuxOrigin().

◆ 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 121 of file base_screen.h.

Referenced by BASE_SCREEN::BASE_SCREEN(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), BASE_SCREEN::InitDataPoints(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), 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 79 of file sch_screen.h.

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

◆ m_drawList

◆ m_DrawOrg

wxPoint BASE_SCREEN::m_DrawOrg
inherited

offsets for drawing the circuit on the screen

Definition at line 112 of file base_screen.h.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), BASE_SCREEN::InitDataPoints(), PLEDITOR_PRINTOUT::PrintPage(), and SCH_PRINTOUT::PrintPage().

◆ m_fileName

wxString SCH_SCREEN::m_fileName
private

File used to load the screen.

Definition at line 68 of file sch_screen.h.

Referenced by GetFileName(), and SetFileName().

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 184 of file base_struct.h.

Referenced by EDA_ITEM::initVars(), EDA_ITEM::operator=(), SCH_FIELD::Print(), and EDA_ITEM::SetForceVisible().

◆ m_Initialized

bool BASE_SCREEN::m_Initialized
inherited

◆ m_IsPrinting

◆ m_List

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 178 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), EDA_ITEM::initVars(), and EDA_ITEM::SetList().

◆ m_LocalOrigin

◆ m_modification_sync

int SCH_SCREEN::m_modification_sync
private

inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().

Definition at line 91 of file sch_screen.h.

Referenced by Append(), SCH_SCREEN(), and UpdateSymbolLinks().

◆ m_NumberOfScreens

◆ m_PageLayoutDescrFileName

◆ m_paper

PAGE_INFO SCH_SCREEN::m_paper
private

The size of the paper to print or plot on.

Definition at line 82 of file sch_screen.h.

Referenced by GetPageSettings(), SCH_SCREEN(), and SetPageSettings().

◆ m_Parent

◆ m_RedoList

UNDO_REDO_CONTAINER BASE_SCREEN::m_RedoList
inherited

◆ m_refCount

int SCH_SCREEN::m_refCount
private

Number of sheets referencing this screen.

Delete when it goes to zero.

Definition at line 70 of file sch_screen.h.

Referenced by DecRefCount(), GetRefCount(), IncRefCount(), and SCH_SCREEN().

◆ m_ScreenNumber

◆ m_ScrollCenter

VECTOR2D BASE_SCREEN::m_ScrollCenter
inherited

Current scroll center point in logical units.

Definition at line 127 of file base_screen.h.

Referenced by DIALOG_ERC::OnLeftClickMarkersList(), and EDA_DRAW_PANEL_GAL::onPaint().

◆ m_StartVisu

wxPoint BASE_SCREEN::m_StartVisu
inherited

Coordinates in drawing units of the current view position (upper left corner of device)

Definition at line 117 of file base_screen.h.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), and DIALOG_FIND::search().

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ m_titles

TITLE_BLOCK SCH_SCREEN::m_titles
private

Definition at line 84 of file sch_screen.h.

Referenced by Clear(), GetTitleBlock(), and SetTitleBlock().

◆ m_UndoList

◆ m_ZoomList

◆ Pback

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

◆ Pnext


The documentation for this class was generated from the following files: