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 ()
 
EE_RTREEItems ()
 
const EE_RTREEItems () const
 
bool IsEmpty ()
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
const PAGE_INFOGetPageSettings () const
 
void SetPageSettings (const PAGE_INFO &aPageSettings)
 
void SetFileName (const wxString &aFileName)
 
const wxString & GetFileName () const
 
const wxPointGetAuxOrigin () const
 
void SetAuxOrigin (const wxPoint &aPosition)
 
const TITLE_BLOCKGetTitleBlock () const
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
 
void DecRefCount ()
 
void IncRefCount ()
 
int GetRefCount () const
 
int GetClientSheetPathsCount ()
 
wxArrayString & GetClientSheetPaths ()
 
void Append (SCH_ITEM *aItem)
 
void Append (SCH_SCREEN *aScreen)
 Copy the contents of aScreen into this SCH_SCREEN object. More...
 
void Clear (bool aFree=true)
 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)
 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 Update (SCH_ITEM *aItem)
 Updates aItem's bounding box in the tree. 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...
 
std::set< SCH_ITEM * > MarkConnections (SCH_LINE *aSegment)
 Return all wires and junctions connected to aSegment which are not connected any component pin. 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...
 
size_t CountConnectedItems (const wxPoint &aPos, bool aTestJunctions)
 
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)
 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_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 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_ITEMGetParent () const
 
void SetParent (EDA_ITEM *aParent)
 
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[]) const
 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 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 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...
 
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_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...
 
EE_RTREE m_rtree
 
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 85 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 127 of file sch_screen.cpp.

127  :
129  KIWAY_HOLDER( aKiway, KIWAY_HOLDER::HOLDER_TYPE::SCREEN ),
130  m_paper( wxT( "A4" ) )
131 {
133 
134  SetZoom( 32 );
135 
136  for( unsigned zoom : SchematicZoomList )
137  m_ZoomList.push_back( zoom );
138 
139  for( GRID_TYPE grid : SchematicGridList )
140  AddGrid( grid );
141 
142  // Set the default grid size, now that the grid list is populated
143  SetGrid( wxRealPoint( Mils2iu( 50 ), Mils2iu( 50 ) ) );
144 
145  m_refCount = 0;
146 
147  // Suitable for schematic only. For libedit and viewlib, must be set to true
148  m_Center = false;
149 
150  InitDataPoints( m_paper.GetSizeIU() );
151 }
static double SchematicZoomList[]
Definition: sch_screen.cpp:80
void AddGrid(const GRID_TYPE &aGrid)
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:91
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:112
static GRID_TYPE SchematicGridList[]
Definition: sch_screen.cpp:116
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:65
PAGE_INFO m_paper
The size of the paper to print or plot on.
Definition: sch_screen.h:103
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:88
KIWAY_HOLDER(KIWAY *aKiway, HOLDER_TYPE aType)
Definition: kiway_holder.h:44
GRID_TYPE is for grid arrays.
Definition: base_screen.h:43
BASE_SCREEN(KICAD_T aType=SCREEN_T)
Definition: base_screen.cpp:47
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 154 of file sch_screen.cpp.

155 {
157  FreeDrawList();
158 }
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:210

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

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

902 {
903  m_aliases.insert( aAlias );
904 }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:116

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN::LoadContent().

◆ AddGrid() [1/2]

void BASE_SCREEN::AddGrid ( const GRID_TYPE aGrid)
inherited

Definition at line 199 of file base_screen.cpp.

200 {
201  for( GRID_TYPE& existing : m_grids )
202  {
203  if( existing.m_Size == aGrid.m_Size && aGrid.m_CmdId != ID_POPUP_GRID_USER )
204  {
205  wxLogTrace( traceScreen, "Discarding duplicate grid size( %g, %g ).",
206  aGrid.m_Size.x, aGrid.m_Size.y );
207  return;
208  }
209 
210  if( existing.m_CmdId == aGrid.m_CmdId )
211  {
212  wxLogTrace( traceScreen, wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
213  wxT( "size( %g, %g )." ),
214  aGrid.m_CmdId, existing.m_Size.x,
215  existing.m_Size.y, aGrid.m_Size.x, aGrid.m_Size.y );
216  existing.m_Size = aGrid.m_Size;
217  return;
218  }
219  }
220 
221  m_grids.push_back( aGrid );
222 }
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
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(), and SCH_SCREEN().

◆ AddGrid() [2/2]

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

Definition at line 225 of file base_screen.cpp.

226 {
227  wxRealPoint new_size;
228  GRID_TYPE new_grid;
229 
230  new_size.x = From_User_Unit( aUnit, size.x );
231  new_size.y = From_User_Unit( aUnit, size.y );
232  new_grid.m_CmdId = id;
233  new_grid.m_Size = new_size;
234 
235  AddGrid( new_grid );
236 }
void AddGrid(const GRID_TYPE &aGrid)
double From_User_Unit(EDA_UNITS 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:291
wxRealPoint m_Size
Definition: base_screen.h:47
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/2]

void SCH_SCREEN::Append ( SCH_ITEM aItem)

◆ Append() [2/2]

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

183 {
184  wxCHECK_RET( aScreen, "Invalid screen object." );
185 
186  // No need to descend the hierarchy. Once the top level screen is copied, all of it's
187  // children are copied as well.
188  for( auto aItem : aScreen->m_rtree )
189  m_rtree.insert( aItem );
190 
192  aScreen->Clear( false );
193 }
void insert(SCH_ITEM *aItem)
Function Insert() Inserts an item into the tree.
Definition: sch_rtree.h:62
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:112
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
Definition: sch_screen.cpp:196
EE_RTREE m_rtree
Definition: sch_screen.h:110

References Clear(), EE_RTREE::insert(), m_modification_sync, and m_rtree.

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

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

265 {
266  return m_rtree.contains( aItem, true );
267 }
bool contains(SCH_ITEM *aItem, bool aRobust=false)
Determine if a given item exists in the tree.
Definition: sch_rtree.h:122
EE_RTREE m_rtree
Definition: sch_screen.h:110

References EE_RTREE::contains(), and m_rtree.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

◆ ClassOf()

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

Definition at line 142 of file sch_screen.h.

143  {
144  return aItem && SCH_SCREEN_T == aItem->Type();
145  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_SCREEN_T, and EDA_ITEM::Type().

◆ Clear()

void SCH_SCREEN::Clear ( bool  aFree = true)

Delete all draw items and clears the project settings.

Definition at line 196 of file sch_screen.cpp.

197 {
198  if( aFree )
199  FreeDrawList();
200  else
201  m_rtree.clear();
202 
203  // Clear the project settings
205 
206  m_titles.Clear();
207 }
int m_ScreenNumber
Definition: base_screen.h:135
void Clear()
Definition: title_block.h:116
TITLE_BLOCK m_titles
Definition: sch_screen.h:105
EE_RTREE m_rtree
Definition: sch_screen.h:110
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:210
int m_NumberOfScreens
Definition: base_screen.h:136
void clear()
Function RemoveAll() Removes all items from the RTree.
Definition: sch_rtree.h:108

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

Referenced by Append(), and 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 742 of file sch_screen.cpp.

743 {
744 
745  for( auto item : Items().OfType( SCH_COMPONENT_T ) )
746  {
747  auto component = static_cast<SCH_COMPONENT*>( item );
748 
749  component->ClearAnnotation( aSheetPath );
750 
751  // Clear the modified component flag set by component->ClearAnnotation
752  // because we do not use it here and we should not leave this flag set,
753  // when an editing is finished:
754  component->ClearFlags();
755  }
756 }
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), 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 235 of file base_struct.h.

235 { 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:256

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), 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 463 of file sch_screen.h.

464  {
465  m_aliases.clear();
466  }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:116

References m_aliases.

◆ ClearDrawingState()

void SCH_SCREEN::ClearDrawingState ( )

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

Definition at line 638 of file sch_screen.cpp.

639 {
640  for( auto item : Items() )
641  item->ClearTempFlags();
642 }
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items().

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

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

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), 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(), 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 234 of file base_struct.h.

234 { 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:256

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 268 of file base_struct.h.

269  {
271  }
#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:256
#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 623 of file sch_screen.cpp.

624 {
625  if( aItemCount == 0 )
626  return;
627 
628  for( auto& command : aList.m_CommandsList )
629  {
630  command->ClearListAndDeleteItems();
631  delete command;
632  }
633 
634  aList.m_CommandsList.clear();
635 }
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 281 of file base_screen.cpp.

282 {
285 }
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(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), GBR_SCREEN::~GBR_SCREEN(), PCB_SCREEN::~PCB_SCREEN(), and ~SCH_SCREEN().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

Definition at line 118 of file base_struct.cpp.

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

References EDA_ITEM::GetClass(), and NULL.

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_PART::operator=(), 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()

size_t SCH_SCREEN::CountConnectedItems ( const wxPoint aPos,
bool  aTestJunctions 
)

Definition at line 728 of file sch_screen.cpp.

729 {
730  size_t count = 0;
731 
732  for( auto item : Items() )
733  {
734  if( ( item->Type() != SCH_JUNCTION_T || aTestJunctions ) && item->IsConnected( aPos ) )
735  count++;
736  }
737 
738  return count;
739 }
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), and SCH_JUNCTION_T.

◆ DecRefCount()

void SCH_SCREEN::DecRefCount ( )

Definition at line 167 of file sch_screen.cpp.

168 {
169  wxCHECK_RET( m_refCount != 0,
170  wxT( "Screen reference count already zero. Bad programmer!" ) );
171  m_refCount--;
172 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:91

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

242 {
243  wxCHECK_RET( aItem, wxT( "Cannot delete invalid item from screen." ) );
244 
245  SetModify();
246  Remove( aItem );
247 
248  if( aItem->Type() == SCH_SHEET_PIN_T )
249  {
250  // This structure is attached to a sheet, get the parent sheet object.
251  SCH_SHEET_PIN* sheetPin = (SCH_SHEET_PIN*) aItem;
252  SCH_SHEET* sheet = sheetPin->GetParent();
253  wxCHECK_RET( sheet, wxT( "Sheet label parent not properly set, bad programmer!" ) );
254  sheet->RemovePin( sheetPin );
255  return;
256  }
257  else
258  {
259  delete aItem;
260  }
261 }
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
Definition: sch_sheet.h:158
void Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:235
void RemovePin(SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
Definition: sch_sheet.cpp:189
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:206
void SetModify()
Definition: base_screen.h:224
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_SHEET_PIN::GetParent(), Remove(), SCH_SHEET::RemovePin(), SCH_SHEET_PIN_T, BASE_SCREEN::SetModify(), and EDA_ITEM::Type().

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

760 {
761  if( GetClientSheetPathsCount() <= 1 ) // No need for alternate reference
762  return;
763 
764  for( auto item : Items().OfType( SCH_COMPONENT_T ) )
765  {
766  auto component = static_cast<SCH_COMPONENT*>( item );
767 
768  // Add (when not existing) all sheet path entries
769  for( unsigned int ii = 0; ii < m_clientSheetPathList.GetCount(); ii++ )
770  component->AddSheetPathReferenceEntryIfMissing( m_clientSheetPathList[ii] );
771  }
772 }
int GetClientSheetPathsCount()
Definition: sch_screen.h:179
EE_RTREE & Items()
Definition: sch_screen.h:127
wxArrayString m_clientSheetPathList
the list of scheet paths sharing this screen used in some annotation calculations to update alternate...
Definition: sch_screen.h:100

References GetClientSheetPathsCount(), Items(), m_clientSheetPathList, 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 210 of file sch_screen.cpp.

211 {
212  // We don't know which order we will encounter dependent items (e.g. pins or fields), so
213  // we store the items to be deleted until we've fully cleared the tree before deleting
214  std::vector<SCH_ITEM*> delete_list;
215 
216  std::copy_if( m_rtree.begin(), m_rtree.end(), std::back_inserter( delete_list ),
217  []( SCH_ITEM* aItem ) {
218  return ( aItem->Type() != SCH_SHEET_PIN_T && aItem->Type() != SCH_FIELD_T );
219  } );
220 
221  m_rtree.clear();
222 
223  for( auto item : delete_list )
224  delete item;
225 }
iterator end()
Definition: sch_rtree.h:253
EE_RTREE m_rtree
Definition: sch_screen.h:110
iterator begin()
Definition: sch_rtree.h:248
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
void clear()
Function RemoveAll() Removes all items from the RTree.
Definition: sch_rtree.h:108

References EE_RTREE::begin(), EE_RTREE::clear(), EE_RTREE::end(), m_rtree, SCH_FIELD_T, and SCH_SHEET_PIN_T.

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

◆ GetAuxOrigin()

const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const
inline

Definition at line 159 of file sch_screen.h.

159 { 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:108

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

Definition at line 105 of file base_struct.cpp.

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

Referenced by CN_ITEM::BBox(), EE_RTREE::contains(), MODULE::CoverageRatio(), SELECTION::GetBoundingBox(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), GERBVIEW_SELECTION::GetCenter(), getRect(), EE_RTREE::insert(), SCH_EDIT_TOOL::Mirror(), SCH_EAGLE_PLUGIN::moveLabels(), EE_RTREE::remove(), 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 426 of file sch_screen.h.

428  {
429  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
430  }
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:803

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

926 {
927  SCH_SHEET_LIST aSheets( g_RootSheet );
928  for( unsigned i = 0; i < aSheets.size(); i++ )
929  {
930  for( auto alias : aSheets[i].LastScreen()->GetBusAliases() )
931  {
932  if( alias->GetName() == aLabel )
933  {
934  return alias;
935  }
936  }
937  }
938 
939  return NULL;
940 }
SCH_SHEET_LIST.
#define NULL
SCH_SHEET * g_RootSheet

References g_RootSheet, and NULL.

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

472  {
473  return m_aliases;
474  }
std::unordered_set< std::shared_ptr< BUS_ALIAS > > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:116

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

148  {
149  return wxT( "SCH_SCREEN" );
150  }

◆ GetClientSheetPaths()

wxArrayString& SCH_SCREEN::GetClientSheetPaths ( )
inline

Definition at line 181 of file sch_screen.h.

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

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

179 { 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:100

References m_clientSheetPathList.

Referenced by EnsureAlternateReferencesExist().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 260 of file base_struct.h.

261  {
265  return m_Flags & mask;
266  }
#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:184
#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(), 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(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

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

240 {
241  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
242  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
243 
244  return m_grids[ aIndex ];
245 }
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::TransferDataToWindow(), 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(), PCB_BASE_FRAME::SetFastGrid2(), DIALOG_SET_GRID::TransferDataFromWindow(), and DIALOG_SET_GRID::TransferDataToWindow().

◆ GetGridSize()

const wxRealPoint& BASE_SCREEN::GetGridSize ( ) const
inlineinherited

◆ GetHierarchicalItems()

void SCH_SCREEN::GetHierarchicalItems ( EDA_ITEMS aItems)

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

Parameters
aItemsHierarchical item list to fill.

Definition at line 775 of file sch_screen.cpp.

776 {
777  for( auto item : Items() )
778  {
779  if( ( item->Type() == SCH_SHEET_T ) || ( item->Type() == SCH_COMPONENT_T ) )
780  aItems.push_back( item );
781  }
782 }
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), SCH_COMPONENT_T, and SCH_SHEET_T.

◆ GetItem()

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

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

271 {
272  EDA_RECT bbox;
273  bbox.SetOrigin( aPosition );
274  bbox.Inflate( aAccuracy );
275 
276  for( auto item : Items().Overlapping( aType, bbox ) )
277  {
278  if( item->HitTest( aPosition, aAccuracy ) )
279  return item;
280  }
281 
282  return nullptr;
283 }
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
EE_RTREE & Items()
Definition: sch_screen.h:127
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Inflate(), Items(), and EDA_RECT::SetOrigin().

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

838 {
839  for( auto item : Items().Overlapping( aPosition, aAccuracy ) )
840  {
841  switch( item->Type() )
842  {
843  case SCH_LABEL_T:
844  case SCH_GLOBAL_LABEL_T:
845  case SCH_HIER_LABEL_T:
846  if( item->HitTest( aPosition, aAccuracy ) )
847  return (SCH_TEXT*) item;
848 
849  default:
850  ;
851  }
852  }
853 
854  return NULL;
855 }
#define NULL
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), NULL, 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 803 of file sch_screen.cpp.

805 {
806  for( auto item : Items() )
807  {
808  if( item->Type() != SCH_LINE_T )
809  continue;
810 
811  if( item->GetLayer() != aLayer )
812  continue;
813 
814  if( !item->HitTest( aPosition, aAccuracy ) )
815  continue;
816 
817  switch( aSearchType )
818  {
819  case ENTIRE_LENGTH_T:
820  return (SCH_LINE*) item;
821 
823  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
824  return (SCH_LINE*) item;
825  break;
826 
827  case END_POINTS_ONLY_T:
828  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
829  return (SCH_LINE*) item;
830  }
831  }
832 
833  return NULL;
834 }
#define NULL
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:38
EE_RTREE & Items()
Definition: sch_screen.h:127

References END_POINTS_ONLY_T, ENTIRE_LENGTH_T, EXCLUDE_END_POINTS_T, Items(), NULL, and SCH_LINE_T.

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

◆ 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, SCH_HIERLABEL, LIB_PIN, SCH_GLOBALLABEL, SCH_LABEL, VIA, SCH_TEXT, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, SCH_BUS_BUS_ENTRY, SCH_LINE, 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, LIB_CIRCLE, SCH_JUNCTION, SCH_MARKER, and LIB_RECTANGLE.

Definition at line 246 of file base_struct.cpp.

247 {
248  return dummy_xpm;
249 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:54

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), 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  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_TEXT, SCH_SHEET, SCH_COMPONENT, GERBER_DRAW_ITEM, NETINFO_ITEM, DIMENSION, DRAWSEGMENT, SCH_LINE, LIB_ITEM, TEXTE_MODULE, TRACK, LIB_FIELD, SCH_BITMAP, EDGE_MODULE, LIB_PIN, SCH_BUS_ENTRY_BASE, MARKER_PCB, ZONE_CONTAINER, LIB_BEZIER, SCH_MARKER, TEXTE_PCB, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 318 of file base_struct.h.

319  {
320  }

Referenced by EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_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 
)

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

647 {
648  SCH_COMPONENT* component = NULL;
649  LIB_PIN* pin = NULL;
650 
651  for( auto item : Items().Overlapping( SCH_COMPONENT_T, aPosition ) )
652  {
653  component = static_cast<SCH_COMPONENT*>( item );
654 
655  if( aEndPointOnly )
656  {
657  pin = NULL;
658 
659  if( !component->GetPartRef() )
660  continue;
661 
662  for( pin = component->GetPartRef()->GetNextPin(); pin;
663  pin = component->GetPartRef()->GetNextPin( pin ) )
664  {
665  // Skip items not used for this part.
666  if( component->GetUnit() && pin->GetUnit() &&
667  ( pin->GetUnit() != component->GetUnit() ) )
668  continue;
669 
670  if( component->GetConvert() && pin->GetConvert() &&
671  ( pin->GetConvert() != component->GetConvert() ) )
672  continue;
673 
674  if(component->GetPinPhysicalPosition( pin ) == aPosition )
675  break;
676  }
677  if( pin )
678  break;
679  }
680  else
681  {
682  pin = (LIB_PIN*) component->GetDrawItem( aPosition, LIB_PIN_T );
683 
684  if( pin )
685  break;
686  }
687  }
688 
689  if( pin && aComponent )
690  *aComponent = component;
691 
692  return pin;
693 }
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:300
int GetUnit() const
#define NULL
std::unique_ptr< LIB_PART > & GetPartRef()
int GetConvert() const
Definition: lib_item.h:303
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:89
int GetConvert() const
wxPoint GetPinPhysicalPosition(const LIB_PIN *Pin) const

References SCH_COMPONENT::GetConvert(), LIB_ITEM::GetConvert(), SCH_COMPONENT::GetDrawItem(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_COMPONENT::GetUnit(), LIB_ITEM::GetUnit(), Items(), LIB_PIN_T, NULL, and SCH_COMPONENT_T.

Referenced by IsTerminalPoint(), and MarkConnections().

◆ GetRedoCommandCount()

int BASE_SCREEN::GetRedoCommandCount ( ) const
inlineinherited

Definition at line 206 of file base_screen.h.

207  {
208  return m_RedoList.m_CommandsList.size();
209  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:133

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

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

◆ GetRefCount()

int SCH_SCREEN::GetRefCount ( ) const
inline

Definition at line 170 of file sch_screen.h.

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

References m_refCount.

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

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS  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, SCH_HIERLABEL, LIB_PIN, SCH_GLOBALLABEL, SCH_LABEL, WS_DRAW_ITEM_BITMAP, VIA, SCH_TEXT, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, DRAWSEGMENT, DIMENSION, WS_DRAW_ITEM_RECT, TEXTE_MODULE, TRACK, SCH_BUS_BUS_ENTRY, SCH_LINE, 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, SCH_NO_CONNECT, PCB_TARGET, LIB_TEXT, LIB_CIRCLE, LIB_RECTANGLE, SCH_JUNCTION, SCH_MARKER, SCH_PIN, and DELETED_BOARD_ITEM.

Definition at line 144 of file base_struct.cpp.

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

References EDA_ITEM::GetClass().

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

697 {
698  for( auto item : Items().OfType( SCH_SHEET_T ) )
699  {
700  auto sheet = static_cast<SCH_SHEET*>( item );
701 
702  if( aName.CmpNoCase( sheet->GetName() ) == 0 )
703  return sheet;
704  }
705 
706  return NULL;
707 }
#define NULL
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), NULL, 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 710 of file sch_screen.cpp.

711 {
712  SCH_SHEET_PIN* sheetPin = nullptr;
713 
714  for( auto item : Items().OfType( SCH_SHEET_T ) )
715  {
716  auto sheet = static_cast<SCH_SHEET*>( item );
717 
718  sheetPin = sheet->GetPin( aPosition );
719 
720  if( sheetPin )
721  break;
722  }
723 
724  return sheetPin;
725 }
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items(), and SCH_SHEET_T.

Referenced by IsTerminalPoint().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 239 of file base_struct.h.

240  {
241  return m_Status & type;
242  }
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 252 of file base_struct.h.

252 { 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(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUndoCommandCount()

int BASE_SCREEN::GetUndoCommandCount ( ) const
inlineinherited

Definition at line 201 of file base_screen.h.

202  {
203  return m_UndoList.m_CommandsList.size();
204  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:132

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

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

◆ GetWire()

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

Definition at line 420 of file sch_screen.h.

422  {
423  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
424  }
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:803

References GetLine(), and LAYER_WIRE.

Referenced by IsTerminalPoint().

◆ 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(), 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 248 of file base_screen.cpp.

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

References BASE_SCREEN::m_grids.

Referenced by COMMON_TOOLS::GridPreset().

◆ HasFlag()

◆ 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, SCH_TEXT, VIA, WS_DRAW_ITEM_TEXT, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, ZONE_CONTAINER, DIMENSION, DRAWSEGMENT, WS_DRAW_ITEM_RECT, SCH_LINE, TEXTE_MODULE, SCH_FIELD, SCH_SHEET_PIN, LIB_ITEM, TRACK, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, SCH_BITMAP, WS_DRAW_ITEM_LINE, LIB_PIN, SCH_NO_CONNECT, SCH_BUS_ENTRY_BASE, 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 330 of file base_struct.h.

331  {
332  return false; // derived classes should override this function
333  }

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

Definition at line 344 of file base_struct.h.

345  {
346  return false; // derived classes should override this function
347  }

◆ IncRefCount()

void SCH_SCREEN::IncRefCount ( )

Definition at line 161 of file sch_screen.cpp.

162 {
163  m_refCount++;
164 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:91

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

66 {
67  if( m_Center )
68  {
71 
72  m_DrawOrg.x = -aPageSizeIU.x / 2;
73  m_DrawOrg.y = -aPageSizeIU.y / 2;
74  }
75  else
76  {
77  m_crossHairPosition.x = aPageSizeIU.x / 2;
78  m_crossHairPosition.y = aPageSizeIU.y / 2;
79 
80  m_DrawOrg.x = 0;
81  m_DrawOrg.y = 0;
82  }
83 
84  m_LocalOrigin = { 0, 0 };
85 }
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, BASE_SCREEN::m_LocalOrigin, wxPoint::x, and wxPoint::y.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), GBR_SCREEN::GBR_SCREEN(), PCB_SCREEN::PCB_SCREEN(), SCH_SCREEN(), GERBVIEW_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 907 of file sch_screen.cpp.

908 {
909  SCH_SHEET_LIST aSheets( g_RootSheet );
910  for( unsigned i = 0; i < aSheets.size(); i++ )
911  {
912  for( const auto& alias : aSheets[i].LastScreen()->GetBusAliases() )
913  {
914  if( alias->GetName() == aLabel )
915  {
916  return true;
917  }
918  }
919  }
920 
921  return false;
922 }
SCH_SHEET_LIST.
SCH_SHEET * g_RootSheet

References g_RootSheet.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

221 { 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:184

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

◆ IsEmpty()

bool SCH_SCREEN::IsEmpty ( )
inline

Definition at line 137 of file sch_screen.h.

138  {
139  return m_rtree.empty();
140  }
bool empty()
Definition: sch_rtree.h:166
EE_RTREE m_rtree
Definition: sch_screen.h:110

References EE_RTREE::empty(), and m_rtree.

Referenced by SCH_EDIT_FRAME::OnCloseWindow(), and UpdateSymbolLinks().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

225 { 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:184

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.

A line with a midpoint should be counted as two endpoints for this calculation because the junction will split the line into two if there is another item present at the point.

Overlapping lines that point in the same direction should not be counted as extra end_points.

Definition at line 332 of file sch_screen.cpp.

333 {
334  enum { WIRES, BUSSES } layers;
335 
336  bool has_nonparallel[ sizeof( layers ) ] = { false };
337  int end_count[ sizeof( layers ) ] = { 0 };
338  int pin_count = 0;
339 
340  std::vector<SCH_LINE*> lines[ sizeof( layers ) ];
341 
342  for( auto item : Items().Overlapping( aPosition ) )
343  {
344  if( item->GetEditFlags() & STRUCT_DELETED )
345  continue;
346 
347  if( aNew && ( item->Type() == SCH_JUNCTION_T ) && ( item->HitTest( aPosition ) ) )
348  return false;
349 
350  if( ( item->Type() == SCH_LINE_T ) && ( item->HitTest( aPosition, 0 ) ) )
351  {
352  if( item->GetLayer() == LAYER_WIRE )
353  lines[WIRES].push_back( (SCH_LINE*) item );
354  else if( item->GetLayer() == LAYER_BUS )
355  lines[BUSSES].push_back( (SCH_LINE*) item );
356  }
357 
358  if( ( item->Type() == SCH_COMPONENT_T ) && ( item->IsConnected( aPosition ) ) )
359  pin_count++;
360  }
361 
362  for( int i : { WIRES, BUSSES } )
363  {
364  bool removed_overlapping = false;
365  bool mid_point = false;
366 
367  for( auto line = lines[i].begin(); line < lines[i].end(); line++ )
368  {
369  if( !(*line)->IsEndPoint( aPosition ) )
370  mid_point = true;
371  else
372  end_count[i]++;
373 
374  for( auto second_line = lines[i].end() - 1; second_line > line; second_line-- )
375  {
376  if( !(*line)->IsParallel( *second_line ) )
377  has_nonparallel[i] = true;
378  else if( !removed_overlapping
379  && (*line)->IsSameQuadrant( *second_line, aPosition ) )
380  {
381  removed_overlapping = true;
382  }
383  }
384  }
385 
389  if( mid_point )
390  end_count[i] += 2;
391 
394  if( removed_overlapping )
395  end_count[i]--;
396  }
397 
398  // If there are three or more endpoints
399  if( pin_count && pin_count + end_count[WIRES] > 2 )
400  return true;
401 
402  // If there is at least one segment that ends on a non-parallel line or
403  // junction of two other lines
404  if( has_nonparallel[WIRES] && end_count[WIRES] > 2 )
405  return true;
406 
407  // Check for bus - bus junction requirements
408  if( has_nonparallel[BUSSES] && end_count[BUSSES] > 2 )
409  return true;
410 
411  return false;
412 }
EE_TYPE Overlapping(const EDA_RECT &aRect)
Definition: sch_rtree.h:224
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:129
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:38
EE_RTREE & Items()
Definition: sch_screen.h:127
boost::ptr_vector< WIRE > WIRES
Definition: specctra.h:2950

References Items(), LAYER_BUS, LAYER_WIRE, EE_RTREE::Overlapping(), 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 219 of file base_struct.h.

219 { 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:184

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsModify()

bool BASE_SCREEN::IsModify ( ) const
inlineinherited

◆ 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_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 515 of file base_struct.h.

515 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

224 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#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 415 of file sch_screen.cpp.

416 {
417  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
418  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
419 
420  SCH_SHEET_PIN* label;
421  SCH_TEXT* text;
422  SCH_CONNECTION conn;
423 
424  switch( aLayer )
425  {
426  case LAYER_BUS:
427 
428  if( GetBus( aPosition ) )
429  return true;
430 
431  label = GetSheetLabel( aPosition );
432 
433  if( label && conn.IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
434  return true;
435 
436  text = GetLabel( aPosition );
437 
438  if( text && conn.IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
439  && (text->Type() != SCH_LABEL_T) )
440  return true;
441 
442  break;
443 
444  case LAYER_NOTES:
445 
446  if( GetLine( aPosition ) )
447  return true;
448 
449  break;
450 
451  case LAYER_WIRE:
452  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_WIRE_ENTRY_T) )
453  return true;
454 
455  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
456  return true;
457 
458  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
459  return true;
460 
461  if( GetPin( aPosition, NULL, true ) )
462  return true;
463 
464  if( GetWire( aPosition ) )
465  return true;
466 
467  text = GetLabel( aPosition );
468 
469  if( text && text->IsConnected( aPosition ) && !conn.IsBusLabel( text->GetText() ) )
470  return true;
471 
472  label = GetSheetLabel( aPosition );
473 
474  if( label && label->IsConnected( aPosition ) && !conn.IsBusLabel( label->GetText() ) )
475  return true;
476 
477  break;
478 
479  default:
480  break;
481  }
482 
483  return false;
484 }
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false)
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:645
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....
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:803
#define NULL
SCH_SHEET_PIN * GetSheetLabel(const wxPoint &aPosition)
Test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:710
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:420
SCH_TEXT * GetLabel(const wxPoint &aPosition, int aAccuracy=0)
Return a label item located at aPosition.
Definition: sch_screen.cpp:837
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T)
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:270
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
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:207
SCH_LINE * GetBus(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:426

References GetBus(), GetDefaultLineThickness(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheetLabel(), EDA_TEXT::GetText(), GetWire(), SCH_CONNECTION::IsBusLabel(), SCH_ITEM::IsConnected(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, NULL, 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[]) const
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 284 of file base_struct.h.

285  {
286  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
287  return true;
288 
289  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
290  {
291  if( m_StructType == *p )
292  return true;
293  }
294 
295  return false;
296  }
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 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(), 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 222 of file base_struct.h.

222 { 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:184

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ Items() [1/2]

EE_RTREE& SCH_SCREEN::Items ( )
inline

Definition at line 127 of file sch_screen.h.

128  {
129  return m_rtree;
130  }
EE_RTREE m_rtree
Definition: sch_screen.h:110

References m_rtree.

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::BreakSegments(), SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), NETLIST_OBJECT_LIST::BuildNetListInfo(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_SHEET::CleanupSheet(), ClearAnnotation(), ClearDrawingState(), EE_COLLECTOR::Collect(), SCH_SHEET::ComponentCount(), CountConnectedItems(), SCH_SHEET::CountSheets(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::SCH_VIEW::DisplaySheet(), EnsureAlternateReferencesExist(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_LEGACY_PLUGIN::Format(), AUTOPLACER::get_possible_colliders(), SCH_MOVE_TOOL::getConnectedDragItems(), GetHierarchicalItems(), GetItem(), GetLabel(), GetLine(), GetPin(), GetSheet(), getSheetBbox(), GetSheetLabel(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportHierLabel(), IsJunctionNeeded(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_SHEET::LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), SCH_EDITOR_CONTROL::nextMatch(), SCH_EDITOR_CONTROL::Paste(), Plot(), Print(), EE_SELECTION_TOOL::RebuildSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SetComponentFootprint(), TestDanglingEnds(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), SCH_EDIT_TOOL::UpdateFields(), SCH_EDITOR_CONTROL::UpdateFind(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and UpdateSymbolLinks().

◆ Items() [2/2]

const EE_RTREE& SCH_SCREEN::Items ( ) const
inline

Definition at line 132 of file sch_screen.h.

133  {
134  return m_rtree;
135  }
EE_RTREE m_rtree
Definition: sch_screen.h:110

References m_rtree.

◆ IterateForward() [1/2]

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

401  {
402  for( auto it : aList )
403  {
404  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
406  return SEARCH_RESULT::QUIT;
407  }
408 
410  }
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 CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

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

420  {
421  for( auto it : aList )
422  {
423  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
425  return SEARCH_RESULT::QUIT;
426  }
427 
429  }
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 CONTINUE, 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(), 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(), SCH_EDITOR_CONTROL::Paste(), 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()

std::set< SCH_ITEM * > SCH_SCREEN::MarkConnections ( SCH_LINE aSegment)

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

Parameters
aSegmentThe segment to test for connections.

Definition at line 286 of file sch_screen.cpp.

287 {
288  std::set<SCH_ITEM*> retval;
289  std::stack<SCH_LINE*> to_search;
290 
291  wxCHECK_MSG( ( aSegment ) && ( aSegment->Type() == SCH_LINE_T ), retval,
292  wxT( "Invalid object pointer." ) );
293 
294  to_search.push( aSegment );
295 
296  while( !to_search.empty() )
297  {
298  auto test_item = to_search.top();
299  to_search.pop();
300 
301  for( auto item : Items().Overlapping( SCH_JUNCTION_T, test_item->GetBoundingBox() ) )
302  {
303  if( test_item->IsEndPoint( item->GetPosition() ) )
304  retval.insert( item );
305  }
306 
307  for( auto item : Items().Overlapping( SCH_LINE_T, test_item->GetBoundingBox() ) )
308  {
309  // Skip connecting lines on different layers (e.g. busses)
310  if( test_item->GetLayer() != item->GetLayer() )
311  continue;
312 
313  auto line = static_cast<SCH_LINE*>( item );
314 
315  if( ( test_item->IsEndPoint( line->GetStartPoint() )
316  && !GetPin( line->GetStartPoint(), NULL, true ) )
317  || ( test_item->IsEndPoint( line->GetEndPoint() )
318  && !GetPin( line->GetEndPoint(), nullptr, true ) ) )
319  {
320  auto result = retval.insert( line );
321 
322  if( result.second )
323  to_search.push( line );
324  }
325  }
326  }
327 
328  return retval;
329 }
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false)
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:645
#define NULL
EE_RTREE & Items()
Definition: sch_screen.h:127
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References GetPin(), Items(), NULL, SCH_JUNCTION_T, SCH_LINE_T, 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_TEXT, SCH_FIELD, SCH_SHEET_PIN, LIB_PIN, MARKER_PCB, SCH_PIN, SCH_MARKER, TEXTE_MODULE, and TEXTE_PCB.

Definition at line 471 of file base_struct.h.

472  {
473  return false;
474  }

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

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

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

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

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

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

221 { };

◆ 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.

Sort to ensure plot-order consistency with screen drawing

Definition at line 569 of file sch_screen.cpp.

570 {
571  // Ensure links are up to date, even if a library was reloaded for some reason:
572  std::vector< SCH_ITEM* > junctions;
573  std::vector< SCH_ITEM* > bitmaps;
574  std::vector< SCH_ITEM* > other;
575 
576  // Ensure links are up to date, even if a library was reloaded for some reason:
578 
579  for( auto item : Items() )
580  {
581  if( item->IsMoving() || item->IsResized() )
582  continue;
583 
584  if( item->Type() == SCH_JUNCTION_T )
585  junctions.push_back( item );
586  else if( item->Type() == SCH_BITMAP_T )
587  bitmaps.push_back( item );
588  else
589  other.push_back( item );
590  }
591 
593  std::sort( other.begin(), other.end(), []( const SCH_ITEM* a, const SCH_ITEM* b ) {
594  if( a->Type() == b->Type() )
595  return a->GetLayer() > b->GetLayer();
596 
597  return a->Type() > b->Type();
598  } );
599 
600  // Bitmaps are drawn first to ensure they are in the background
601  // This is particularly important for the wxPostscriptDC (used in *nix printers) as
602  // the bitmap PS command clears the screen
603  for( auto item : bitmaps )
604  {
605  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
606  item->Plot( aPlotter );
607  }
608 
609  for( auto item : other )
610  {
611  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
612  item->Plot( aPlotter );
613  }
614 
615  for( auto item : junctions )
616  {
617  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
618  item->Plot( aPlotter );
619  }
620 }
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:487
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References SCH_ITEM::GetLayer(), Items(), SCH_BITMAP_T, SCH_JUNCTION_T, PLOTTER::SetCurrentLineWidth(), EDA_ITEM::Type(), 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 324 of file base_screen.cpp.

325 {
326  return m_RedoList.PopCommand();
327 }
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(), 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 318 of file base_screen.cpp.

319 {
320  return m_UndoList.PopCommand();
321 }
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(), 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.

Sort to ensure plot-order consistency with screen drawing

Definition at line 527 of file sch_screen.cpp.

528 {
529  // Ensure links are up to date, even if a library was reloaded for some reason:
530  std::vector< SCH_ITEM* > junctions;
531  std::vector<SCH_ITEM*> bitmaps;
532  std::vector<SCH_ITEM*> other;
533 
534  // Ensure links are up to date, even if a library was reloaded for some reason:
536 
537  for( auto item : Items() )
538  {
539  if( item->IsMoving() || item->IsResized() )
540  continue;
541 
542  if( item->Type() == SCH_JUNCTION_T )
543  junctions.push_back( item );
544  else if( item->Type() == SCH_BITMAP_T )
545  bitmaps.push_back( item );
546  else
547  other.push_back( item );
548  }
549 
551  std::sort( other.begin(), other.end(), []( const SCH_ITEM* a, const SCH_ITEM* b ) {
552  if( a->Type() == b->Type() )
553  return a->GetLayer() > b->GetLayer();
554 
555  return a->Type() > b->Type();
556  } );
557 
558  for( auto item : bitmaps )
559  item->Print( aDC, wxPoint( 0, 0 ) );
560 
561  for( auto item : other )
562  item->Print( aDC, wxPoint( 0, 0 ) );
563 
564  for( auto item : junctions )
565  item->Print( aDC, wxPoint( 0, 0 ) );
566 }
void UpdateSymbolLinks(bool aForce=false)
Initialize or reinitialize the weak reference to the LIB_PART for each SCH_COMPONENT found in m_drawL...
Definition: sch_screen.cpp:487
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References SCH_ITEM::GetLayer(), Items(), SCH_BITMAP_T, SCH_JUNCTION_T, EDA_ITEM::Type(), 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 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
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 303 of file base_screen.cpp.

304 {
305  m_RedoList.PushCommand( aNewitem );
306 
307  // Delete the extra items, if count max reached
308  if( m_UndoRedoCountMax > 0 )
309  {
310  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
311 
312  if( extraitems > 0 )
313  ClearUndoORRedoList( m_RedoList, extraitems );
314  }
315 }
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(), 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 288 of file base_screen.cpp.

289 {
290  m_UndoList.PushCommand( aNewitem );
291 
292  // Delete the extra items, if count max reached
293  if( m_UndoRedoCountMax > 0 )
294  {
295  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
296 
297  if( extraitems > 0 )
298  ClearUndoORRedoList( m_UndoList, extraitems );
299  }
300 }
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(), SCH_EDITOR_CONTROL::Redo(), 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 235 of file sch_screen.cpp.

236 {
237  m_rtree.remove( aItem );
238 }
bool remove(SCH_ITEM *aItem)
Function Remove() Removes an item from the tree.
Definition: sch_rtree.h:78
EE_RTREE m_rtree
Definition: sch_screen.h:110

References m_rtree, and EE_RTREE::remove().

Referenced by DeleteItem(), SCH_EDIT_FRAME::EditSheet(), Update(), and UpdateSymbolLinks().

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

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

Definition at line 503 of file base_struct.h.

503 { return false; }

◆ SetAuxOrigin()

void SCH_SCREEN::SetAuxOrigin ( const wxPoint aPosition)
inline

Definition at line 160 of file sch_screen.h.

160 { 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:108

References m_aux_origin.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 231 of file base_struct.h.

231 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#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(), 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 858 of file sch_screen.cpp.

860 {
861  SCH_COMPONENT* component;
862  bool found = false;
863 
864  for( auto item : Items().OfType( SCH_COMPONENT_T ) )
865  {
866  component = static_cast<SCH_COMPONENT*>( item );
867 
868  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
869  {
870  // Found: Init Footprint Field
871 
872  /* Give a reasonable value to the field position and
873  * orientation, if the text is empty at position 0, because
874  * it is probably not yet initialized
875  */
876  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
877  if( fpfield->GetText().IsEmpty()
878  && ( fpfield->GetTextPos() == component->GetPosition() ) )
879  {
880  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
881  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
882  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
883 
884  if( fpfield->GetTextAngle() == 0.0 )
885  fpfield->Offset( wxPoint( 0, Mils2iu( 100 ) ) );
886  else
887  fpfield->Offset( wxPoint( Mils2iu( 100 ), 0 ) );
888  }
889 
890  fpfield->SetText( aFootPrint );
891  fpfield->SetVisible( aSetVisible );
892 
893  found = true;
894  }
895  }
896 
897  return found;
898 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:150
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
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
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:111
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.
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:89
wxPoint GetPosition() const override
Function GetPosition.
const wxPoint & GetTextPos() const
Definition: eda_text.h:232
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

References FOOTPRINT, SCH_COMPONENT::GetField(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetRef(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), Items(), 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 255 of file base_struct.h.

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

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(), 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(), 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 306 of file base_struct.h.

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

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

154 {
155  wxASSERT( !m_grids.empty() );
156 
157  GRID_TYPE nearest_grid = m_grids[0];
158  int gridIdx = 0;
159 
160  for( GRID_TYPE& grid : m_grids )
161  {
162  if( grid.m_Size == size )
163  {
164  m_Grid = grid;
165  return grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
166  }
167 
168  // keep track of the nearest larger grid size, if the exact size is not found
169  if ( size.x < grid.m_Size.x )
170  {
171  gridIdx = grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
172  nearest_grid = grid;
173  }
174  }
175 
176  m_Grid = nearest_grid;
177  return gridIdx;
178 }
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
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(), 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 181 of file base_screen.cpp.

182 {
183  wxASSERT( !m_grids.empty() );
184 
185  for( GRID_TYPE& grid : m_grids )
186  {
187  if( grid.m_CmdId == aCommandId )
188  {
189  m_Grid = grid;
190  return grid.m_CmdId - ID_POPUP_GRID_LEVEL_1000;
191  }
192  }
193 
194  m_Grid = m_grids[0];
195  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
196 }
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
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 230 of file base_struct.h.

230 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#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 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

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

◆ SetPageSettings()

void SCH_SCREEN::SetPageSettings ( const PAGE_INFO aPageSettings)
inline

Definition at line 153 of file sch_screen.h.

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

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

245  {
246  if( state )
247  m_Status |= type; // state = ON or OFF
248  else
249  m_Status &= ~type;
250  }
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 253 of file base_struct.h.

253 { 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 212 of file base_struct.h.

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

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(), EDIT_TOOL::EditFpInFpEditor(), 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 164 of file sch_screen.h.

164 { m_titles = aTitleBlock; }
TITLE_BLOCK m_titles
Definition: sch_screen.h:105

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

228 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#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 88 of file base_screen.cpp.

89 {
90  if( iu_per_du == m_Zoom )
91  return false;
92 
93  wxLogTrace( traceScreen, "Zoom:%.16g 1/Zoom:%.16g", iu_per_du, 1/iu_per_du );
94 
95  if( iu_per_du < GetMinAllowedZoom() )
96  return false;
97 
98  if( iu_per_du > GetMaxAllowedZoom() )
99  return false;
100 
101  m_Zoom = iu_per_du;
102 
103  return true;
104 }
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(), 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 534 of file base_struct.h.

534 { 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 785 of file sch_screen.cpp.

786 {
787  std::vector< DANGLING_END_ITEM > endPoints;
788  bool hasStateChanged = false;
789 
790  for( auto item : Items() )
791  item->GetEndPoints( endPoints );
792 
793  for( auto item : Items() )
794  {
795  if( item->UpdateDanglingState( endPoints ) )
796  hasStateChanged = true;
797  }
798 
799  return hasStateChanged;
800 }
EE_RTREE & Items()
Definition: sch_screen.h:127

References Items().

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

208  {
209  return m_StructType;
210  }
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(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::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(), ZONE_CONTAINER::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), VIA::ClassOf(), SCH_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), 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::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), 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(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), 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_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(), 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(), Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), Print(), 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(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), 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(), 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(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Update()

void SCH_SCREEN::Update ( SCH_ITEM aItem)

Updates aItem's bounding box in the tree.

Parameters
aItemItem that needs to be updated.

Definition at line 228 of file sch_screen.cpp.

229 {
230  Remove( aItem );
231  Append( aItem );
232 }
void Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:235
void Append(SCH_ITEM *aItem)
Definition: sch_screen.cpp:175

References Append(), and Remove().

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeShape(), SCH_EDIT_TOOL::CleanupSheetPins(), SCH_MOVE_TOOL::Main(), and SCH_EDIT_TOOL::Properties().

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

488 {
489  // Initialize or reinitialize the pointer to the LIB_PART for each component
490  // found in m_drawList, but only if needed (change in lib or schematic)
491  // therefore the calculation time is usually very low.
492  if( !IsEmpty() )
493  {
494  std::vector<SCH_COMPONENT*> cmps;
495  SYMBOL_LIB_TABLE* libs = Prj().SchSymbolLibTable();
496  int mod_hash = libs->GetModifyHash();
497 
498  for( auto aItem : Items().OfType( SCH_COMPONENT_T ) )
499  cmps.push_back( static_cast<SCH_COMPONENT*>( aItem ) );
500 
501  for( auto cmp : cmps )
502  Remove( cmp );
503 
504  // Must we resolve?
505  if( (m_modification_sync != mod_hash) || aForce )
506  {
507  SCH_COMPONENT::ResolveAll( cmps, *libs, Prj().SchLibs()->GetCacheLibrary() );
508 
509  m_modification_sync = mod_hash; // note the last mod_hash
510  }
511  // Resolving will update the pin caches but we must ensure that this happens
512  // even if the libraries don't change.
513  else
514  {
515  for( auto cmp : cmps )
516  cmp->UpdatePins();
517  }
518 
519  // Changing the symbol may adjust the bbox of the symbol. This re-inserts the
520  // item with the new bbox
521  for( auto cmp : cmps )
522  Append( cmp );
523  }
524 }
bool IsEmpty()
Definition: sch_screen.h:137
void Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:235
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:112
static void ResolveAll(std::vector< SCH_COMPONENT * > &aComponents, SYMBOL_LIB_TABLE &aLibTable, PART_LIB *aCacheLib=NULL)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void Append(SCH_ITEM *aItem)
Definition: sch_screen.cpp:175
EE_RTREE & Items()
Definition: sch_screen.h:127

References Append(), SYMBOL_LIB_TABLE::GetModifyHash(), IsEmpty(), Items(), m_modification_sync, KIWAY_HOLDER::Prj(), Remove(), SCH_COMPONENT::ResolveAll(), and SCH_COMPONENT_T.

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, TEXTE_MODULE, TRACK, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, 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 231 of file base_struct.cpp.

232 {
233  // Basic fallback
234  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
235  VECTOR2I( GetBoundingBox().GetSize() ) );
236 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
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, MY_DRAWING, 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, SCH_ITEM, TEXTE_MODULE, TRACK, LIB_PART, MY_DRAWING, 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, SCH_NO_CONNECT, KIGFX::ORIGIN_VIEWITEM, WS_DRAW_ITEM_BASE, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, SCH_JUNCTION, LIB_TEXT, BRIGHT_BOX, KIGFX::RATSNEST_VIEWITEM, SCH_MARKER, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 239 of file base_struct.cpp.

240 {
241  // Basic fallback
242  aCount = 1;
243  aLayers[0] = 0;
244 }

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

129 {
130 #if 0 && defined(DEBUG)
131  std::cout << GetClass().mb_str() << ' ';
132 #endif
133 
134  if( IsType( scanTypes ) )
135  {
136  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
137  return SEARCH_RESULT::QUIT;
138  }
139 
141 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:284
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References CONTINUE, EDA_ITEM::GetClass(), EDA_ITEM::IsType(), and 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 116 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 108 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(), 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 100 of file sch_screen.h.

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

◆ 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(), and SCH_PRINTOUT::PrintPage().

◆ m_fileName

wxString SCH_SCREEN::m_fileName
private

File used to load the screen.

Definition at line 89 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 181 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

bool BASE_SCREEN::m_IsPrinting
inherited

◆ m_LocalOrigin

VECTOR2D BASE_SCREEN::m_LocalOrigin
inherited

◆ m_modification_sync

int SCH_SCREEN::m_modification_sync
private

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

Definition at line 112 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 103 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 91 of file sch_screen.h.

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

◆ m_rtree

EE_RTREE SCH_SCREEN::m_rtree
private

Definition at line 110 of file sch_screen.h.

Referenced by Append(), CheckIfOnDrawList(), Clear(), FreeDrawList(), IsEmpty(), Items(), and Remove().

◆ 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(), 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 105 of file sch_screen.h.

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

◆ m_UndoList

◆ m_ZoomList


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