KiCad PCB EDA Suite
SCH_SCREEN Class Reference

#include <sch_screen.h>

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

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

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

Protected Member Functions

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

Protected Attributes

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

Private Member Functions

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

Private Attributes

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

Detailed Description

Definition at line 68 of file sch_screen.h.

Constructor & Destructor Documentation

SCH_SCREEN::SCH_SCREEN ( KIWAY aKiway)

Constructor.

Definition at line 93 of file sch_screen.cpp.

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

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

Definition at line 118 of file sch_screen.cpp.

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

119 {
121 
122  // Now delete items in draw list. We do that only if the list is not empty,
123  // because if the list was appended to another list (see SCH_SCREEN::Append( SCH_SCREEN* aScreen )
124  // it is empty but as no longer the ownership (m_drawList.meOwner == false) of items, and calling
125  // FreeDrawList() with m_drawList.meOwner == false will generate a debug alert in debug mode
126  if( GetDrawItems() )
127  FreeDrawList();
128 }
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:170
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:160

Member Function Documentation

void SCH_SCREEN::addConnectedItemsToBlock ( const SCH_ITEM aItem,
const wxPoint aPosition 
)
private

Add items connected at aPosition to the block pick list.

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

Parameters
aItem= The item we are connecting from
aPosition= The connection point to test.

Definition at line 808 of file sch_screen.cpp.

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

Referenced by SelectBlockItems().

809 {
810  SCH_ITEM* item;
811  ITEM_PICKER picker;
812 
813  for( item = m_drawList.begin(); item; item = item->Next() )
814  {
815 
816  if( !item->IsConnectable() || ( item->GetFlags() & SKIP_STRUCT )
817  || !item->CanConnect( aItem ) || item == aItem )
818  continue;
819 
820  // A line having 2 ends, it can be tested twice: one time per end
821  if( item->Type() == SCH_LINE_T )
822  {
823  SCH_LINE* line = (SCH_LINE*) item;
824 
825  if( !item->HitTest( position ) )
826  continue;
827 
828  // First time through. Flags set to denote an end that is not moving
829  if( !item->IsSelected() )
830  item->SetFlags( CANDIDATE | STARTPOINT | ENDPOINT );
831 
832  if( line->GetStartPoint() == position )
833  item->ClearFlags( STARTPOINT );
834  else if( line->GetEndPoint() == position )
835  item->ClearFlags( ENDPOINT );
836  else
837  // This picks up items such as labels that can connect to the middle of a line
838  item->ClearFlags( STARTPOINT | ENDPOINT );
839  }
840  // We want to move a mid-connected label or bus entry when the full line is being moved
841  else if( !item->IsSelected()
842  && aItem->Type() == SCH_LINE_T
843  && !( aItem->GetFlags() & ( ENDPOINT | STARTPOINT ) ) )
844  {
845  std::vector< wxPoint > connections;
846  item->GetConnectionPoints( connections );
847 
848  for( auto conn : connections )
849  {
850  if( aItem->HitTest( conn ) )
851  {
852  item->SetFlags( CANDIDATE );
853  break;
854  }
855  }
856  }
857 
858  if( item->IsSelected() )
859  continue;
860 
861  if( ( item->GetFlags() & CANDIDATE ) || item->IsConnected( position ) ) // Deal with all non-line items
862  {
863  item->ClearFlags( CANDIDATE );
864  item->SetFlags( SELECTED );
865  picker.SetItem( item );
866  picker.SetFlags( item->GetFlags() );
867  m_BlockLocate.GetItems().PushItem( picker );
868  }
869  }
870 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:258
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
virtual bool CanConnect(const SCH_ITEM *aItem) const
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
bool IsSelected() const
Definition: base_struct.h:224
T * begin() const
Definition: dlist.h:218
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
wxPoint GetEndPoint() const
Definition: sch_line.h:80
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:124
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
virtual bool IsConnectable() const
Function IsConnectable returns true if the schematic item can connect to another schematic item...
void SetFlags(STATUS_FLAGS aFlags)
void SetItem(EDA_ITEM *aItem)
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
virtual void GetConnectionPoints(std::vector< wxPoint > &aPoints) const
Function GetConnectionPoints add all the connection points for this item to aPoints.
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
virtual bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
#define ENDPOINT
Definition: base_struct.h:120
PICKED_ITEMS_LIST & GetItems()
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
#define STARTPOINT
Definition: base_struct.h:119
void BASE_SCREEN::AddGrid ( const GRID_TYPE grid)
inherited

Definition at line 288 of file base_screen.cpp.

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

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

289 {
290  for( unsigned i = 0; i < m_grids.size(); i++ )
291  {
292  if( m_grids[i].m_Size == grid.m_Size && grid.m_CmdId != ID_POPUP_GRID_USER )
293  {
294  wxLogTrace( traceScreen, "Discarding duplicate grid size( %g, %g ).",
295  grid.m_Size.x, grid.m_Size.y );
296  return;
297  }
298 
299  if( m_grids[i].m_CmdId == grid.m_CmdId )
300  {
301  wxLogTrace( traceScreen, wxT( "Changing grid ID %d from size( %g, %g ) to " ) \
302  wxT( "size( %g, %g )." ),
303  grid.m_CmdId, m_grids[i].m_Size.x,
304  m_grids[i].m_Size.y, grid.m_Size.x, grid.m_Size.y );
305  m_grids[i].m_Size = grid.m_Size;
306  return;
307  }
308  }
309 
310  m_grids.push_back( grid );
311 }
const wxChar *const traceScreen
Flag to enable debug output of BASE_SCREEN and it&#39;s derivatives.
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
int m_CmdId
Definition: base_screen.h:48
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
int  id 
)
inherited

Definition at line 314 of file base_screen.cpp.

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

315 {
316  GRID_TYPE grid;
317 
318  grid.m_Size = size;
319  grid.m_CmdId = id;
320  AddGrid( grid );
321 }
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48
void BASE_SCREEN::AddGrid ( const wxRealPoint &  size,
EDA_UNITS_T  aUnit,
int  id 
)
inherited

Definition at line 324 of file base_screen.cpp.

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

325 {
326  wxRealPoint new_size;
327  GRID_TYPE new_grid;
328 
329  new_size.x = From_User_Unit( aUnit, size.x );
330  new_size.y = From_User_Unit( aUnit, size.y );
331  new_grid.m_CmdId = id;
332  new_grid.m_Size = new_size;
333 
334  AddGrid( new_grid );
335 }
double From_User_Unit(EDA_UNITS_T aUnits, double aValue, bool aUseMils)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg"...
Definition: base_units.cpp:278
wxRealPoint m_Size
Definition: base_screen.h:49
void AddGrid(const GRID_TYPE &grid)
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
int m_CmdId
Definition: base_screen.h:48
void SCH_SCREEN::Append ( SCH_ITEM aItem)
inline

Definition at line 162 of file sch_screen.h.

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

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_BASE_FRAME::AddToScreen(), SCH_EDIT_FRAME::AppendSchematic(), Diagnose(), SCH_LEGACY_PLUGIN::loadFile(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSegments(), SimilarLabelsDiagnose(), TestDuplicateSheetNames(), and TestMultiunitFootprints().

163  {
164  m_drawList.Append( aItem );
166  }
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
int m_modification_sync
inequality with PART_LIBS::GetModificationHash() will trigger ResolveAll().
Definition: sch_screen.h:95
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
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 145 of file sch_screen.cpp.

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

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

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

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

Definition at line 185 of file sch_screen.h.

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

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

Definition at line 210 of file base_struct.h.

References EDA_ITEM::Pback.

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

210 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
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 182 of file base_screen.cpp.

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

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

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

Definition at line 205 of file sch_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::addCurrentItemToScreen(), and Place().

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

Delete all draw items and clears the project settings.

Definition at line 159 of file sch_screen.cpp.

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

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

160 {
161  FreeDrawList();
162 
163  // Clear the project settings
165 
166  m_titles.Clear();
167 }
int m_ScreenNumber
Definition: base_screen.h:216
void Clear()
Definition: title_block.h:127
TITLE_BLOCK m_titles
Definition: sch_screen.h:88
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:170
int m_NumberOfScreens
Definition: base_screen.h:217
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 679 of file sch_screen.cpp.

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

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

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

Definition at line 236 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

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

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

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

Definition at line 561 of file sch_screen.cpp.

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

Referenced by AbortCreateNewLine(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::EndSegment(), GetConnection(), LIB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), Place(), and SelectBlockItems().

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

Definition at line 257 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToScreen(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), GetConnection(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), MarkItemsInBloc(), MirrorX(), MirrorY(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnOrient(), LIB_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

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

Definition at line 235 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

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

Definition at line 234 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

234 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
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 546 of file sch_screen.cpp.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), Place(), LIB_EDIT_FRAME::SaveCopyInUndoList(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

547 {
548  if( aItemCount == 0 )
549  return;
550 
551  for( auto& command : aList.m_CommandsList )
552  {
553  command->ClearListAndDeleteItems();
554  delete command;
555  }
556 
557  aList.m_CommandsList.clear();
558 }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
void BASE_SCREEN::ClearUndoRedoList ( )
virtualinherited

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

Definition at line 417 of file base_screen.cpp.

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

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

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

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

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

Returns
A clone of the item.

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

Definition at line 123 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), DrawMovingBlockOutlines(), BOARD::Duplicate(), DuplicateStruct(), EDA_ITEM::HitTest(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), moveItemWithMouseCursor(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), RedrawWhileMovingCursor(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), LIB_PART::SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

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

Definition at line 327 of file base_screen.h.

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

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

Definition at line 661 of file sch_screen.cpp.

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

Referenced by GetConnection(), and Place().

662 {
663  SCH_ITEM* item;
664  int count = 0;
665 
666  for( item = m_drawList.begin(); item; item = item->Next() )
667  {
668  if( item->Type() == SCH_JUNCTION_T && !aTestJunctions )
669  continue;
670 
671  if( item->IsConnected( aPos ) )
672  count++;
673  }
674 
675  return count;
676 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::DecRefCount ( )

Definition at line 137 of file sch_screen.cpp.

References m_refCount.

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

138 {
139  wxCHECK_RET( m_refCount != 0,
140  wxT( "Screen reference count already zero. Bad programmer!" ) );
141  m_refCount--;
142 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:74
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 182 of file sch_screen.cpp.

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

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

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

Draw all the items in the screen to aCanvas.

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

Definition at line 504 of file sch_screen.cpp.

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

Referenced by SCH_PRINTOUT::DrawPage(), and Place().

505 {
506  /* note: SCH_SCREEN::Draw is useful only for schematic.
507  * library editor and library viewer do not use m_drawList, and therefore
508  * their SCH_SCREEN::Draw() draws nothing
509  */
510  std::vector< SCH_ITEM* > junctions;
511 
512  // Ensure links are up to date, even if a library was reloaded for some reason:
514 
515  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
516  {
517  if( item->IsMoving() || item->IsResized() )
518  continue;
519 
520  if( item->Type() == SCH_JUNCTION_T )
521  junctions.push_back( item );
522  else
523  // uncomment line below when there is a virtual EDA_ITEM::GetBoundingBox()
524  // if( panel->GetClipBox().Intersects( item->GetBoundingBox() ) )
525  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ), aDrawMode, aColor );
526  }
527 
528  for( auto item : junctions )
529  item->Draw( aCanvas, aDC, wxPoint( 0, 0 ), aDrawMode, aColor );
530 }
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:476
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
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 698 of file sch_screen.cpp.

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

Referenced by SCH_SCREENS::ClearAnnotationOfNewSheetPaths(), and Place().

699 {
700  if( GetClientSheetPathsCount() <= 1 ) // No need for alternate reference
701  return;
702 
703  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
704  {
705  if( item->Type() != SCH_COMPONENT_T )
706  continue;
707 
708  // Add (when not existing) all sheet path entries
709  for( unsigned int ii = 0; ii < m_clientSheetPathList.GetCount(); ii++ )
710  ((SCH_COMPONENT*)item)->AddSheetPathReferenceEntryIfMissing( m_clientSheetPathList[ii] );
711  }
712 }
int GetClientSheetPathsCount()
Definition: sch_screen.h:153
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
wxArrayString m_clientSheetPathList
the list of scheet paths sharing this screen used in some annotation calculations to update alternate...
Definition: sch_screen.h:83
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 170 of file sch_screen.cpp.

References DHEAD::DeleteAll(), and m_drawList.

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

171 {
173 }
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:44
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
const wxPoint& SCH_SCREEN::GetAuxOrigin ( ) const
inline

Definition at line 133 of file sch_screen.h.

References m_aux_origin.

Referenced by SCH_BASE_FRAME::GetAuxOrigin().

133 { 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:91
const EDA_RECT EDA_ITEM::GetBoundingBox ( ) const
virtualinherited

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

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

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

Definition at line 110 of file base_struct.cpp.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), CN_ITEM::BBox(), SCH_EDIT_FRAME::copyBlockItems(), MODULE::CoverageRatio(), LIB_ITEM::GetBoundingBox(), GetBoundingBoxes(), getRect(), getSheetBbox(), SCH_BASE_FRAME::HandleBlockBegin(), EDA_ITEM::HitTest(), and EDA_ITEM::ViewBBox().

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

Definition at line 468 of file sch_screen.h.

References GetLabel(), GetLine(), LAYER_BUS, SelectBlockItems(), SetComponentFootprint(), and UpdatePickList().

Referenced by IsTerminalPoint().

470  {
471  return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
472  }
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:965
virtual wxString SCH_SCREEN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from BASE_SCREEN.

Definition at line 121 of file sch_screen.h.

Referenced by GetConnection().

122  {
123  return wxT( "SCH_SCREEN" );
124  }
wxArrayString& SCH_SCREEN::GetClientSheetPaths ( )
inline

Definition at line 155 of file sch_screen.h.

References m_clientSheetPathList.

Referenced by SCH_SCREENS::BuildClientSheetPathList().

155 { 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:83
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 153 of file sch_screen.h.

Referenced by EnsureAlternateReferencesExist().

153 { 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:83
int SCH_SCREEN::GetConnection ( const wxPoint aPosition,
PICKED_ITEMS_LIST aList,
bool  aFullConnection 
)

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

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

Definition at line 1066 of file sch_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::DeleteConnection(), and Place().

1068 {
1069  SCH_ITEM* item;
1070  EDA_ITEM* tmp;
1071  EDA_ITEMS list;
1072 
1073  // Clear flags member for all items.
1075 
1076  if( GetNode( aPosition, list ) == 0 )
1077  return 0;
1078 
1079  for( size_t i = 0; i < list.size(); i++ )
1080  {
1081  item = (SCH_ITEM*) list[ i ];
1083 
1084  /* Put this structure in the picked list: */
1085  ITEM_PICKER picker( item, UR_DELETED );
1086  aList.PushItem( picker );
1087  }
1088 
1089  // Mark all wires, junctions, .. connected to the item(s) found.
1090  if( aFullConnection )
1091  {
1092  SCH_LINE* segment;
1093 
1094  for( item = m_drawList.begin(); item; item = item->Next() )
1095  {
1096  if( !(item->GetFlags() & SELECTEDNODE) )
1097  continue;
1098 
1099  if( item->Type() != SCH_LINE_T )
1100  continue;
1101 
1102  MarkConnections( (SCH_LINE*) item );
1103  }
1104 
1105  // Search all attached wires (i.e wire with one new dangling end )
1106  for( item = m_drawList.begin(); item; item = item->Next() )
1107  {
1108  bool noconnect = false;
1109 
1110  if( item->GetFlags() & STRUCT_DELETED )
1111  continue; // Already seen
1112 
1113  if( !(item->GetFlags() & CANDIDATE) )
1114  continue; // not a candidate
1115 
1116  if( item->Type() != SCH_LINE_T )
1117  continue;
1118 
1119  item->SetFlags( SKIP_STRUCT );
1120 
1121  segment = (SCH_LINE*) item;
1122 
1123  /* If the wire start point is connected to a wire that was already found
1124  * and now is not connected, add the wire to the list. */
1125  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1126  {
1127  // Ensure tmp is a previously deleted segment:
1128  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1129  continue;
1130 
1131  if( tmp->Type() != SCH_LINE_T )
1132  continue;
1133 
1134  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1135 
1136  // Test for segment connected to the previously deleted segment:
1137  if( testSegment->IsEndPoint( segment->GetStartPoint() ) )
1138  break;
1139  }
1140 
1141  // when tmp != NULL, segment is a new candidate:
1142  // put it in deleted list if
1143  // the start point is not connected to another item (like pin)
1144  if( tmp && !CountConnectedItems( segment->GetStartPoint(), true ) )
1145  noconnect = true;
1146 
1147  /* If the wire end point is connected to a wire that has already been found
1148  * and now is not connected, add the wire to the list. */
1149  for( tmp = m_drawList.begin(); tmp; tmp = tmp->Next() )
1150  {
1151  // Ensure tmp is a previously deleted segment:
1152  if( ( tmp->GetFlags() & STRUCT_DELETED ) == 0 )
1153  continue;
1154 
1155  if( tmp->Type() != SCH_LINE_T )
1156  continue;
1157 
1158  SCH_LINE* testSegment = (SCH_LINE*) tmp;
1159 
1160  // Test for segment connected to the previously deleted segment:
1161  if( testSegment->IsEndPoint( segment->GetEndPoint() ) )
1162  break;
1163  }
1164 
1165  // when tmp != NULL, segment is a new candidate:
1166  // put it in deleted list if
1167  // the end point is not connected to another item (like pin)
1168  if( tmp && !CountConnectedItems( segment->GetEndPoint(), true ) )
1169  noconnect = true;
1170 
1171  item->ClearFlags( SKIP_STRUCT );
1172 
1173  if( noconnect )
1174  {
1175  item->SetFlags( STRUCT_DELETED );
1176 
1177  ITEM_PICKER picker( item, UR_DELETED );
1178  aList.PushItem( picker );
1179 
1180  item = m_drawList.begin();
1181  }
1182  }
1183 
1184  for( item = m_drawList.begin(); item; item = item->Next() )
1185  {
1186  if( item->GetFlags() & STRUCT_DELETED )
1187  continue;
1188 
1189  if( item->Type() != SCH_LABEL_T )
1190  continue;
1191 
1192  tmp = GetWireOrBus( ( (SCH_TEXT*) item )->GetPosition() );
1193 
1194  if( tmp && ( tmp->GetFlags() & STRUCT_DELETED ) )
1195  {
1196  item->SetFlags( STRUCT_DELETED );
1197 
1198  ITEM_PICKER picker( item, UR_DELETED );
1199  aList.PushItem( picker );
1200  }
1201  }
1202  }
1203 
1205 
1206  return aList.GetCount();
1207 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
int CountConnectedItems(const wxPoint &aPos, bool aTestJunctions) const
Definition: sch_screen.cpp:661
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:258
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
#define SELECTEDNODE
flag indicating that the structure has already selected
Definition: base_struct.h:122
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:80
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
EDA_ITEM * Next() const
Definition: base_struct.h:209
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:124
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: base_struct.h:550
void MarkConnections(SCH_LINE *aSegment)
Add all wires and junctions connected to aSegment which are not connected any component pin to aItemL...
Definition: sch_screen.cpp:283
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
int GetNode(const wxPoint &aPosition, EDA_ITEMS &aList)
Return all the items at aPosition that form a node.
Definition: sch_screen.cpp:931
unsigned GetCount() const
Function GetCount.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:69
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
size_t i
Definition: json11.cpp:597
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
SCH_LINE * GetWireOrBus(const wxPoint &aPosition)
Return a wire or bus item located at aPosition.
Definition: sch_screen.cpp:950
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:561
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
LIB_ITEM* SCH_SCREEN::GetCurLibItem ( ) const
inline

Definition at line 197 of file sch_screen.h.

References BASE_SCREEN::GetCurItem().

Referenced by LIB_EDIT_FRAME::GetDrawItem(), and LIB_EDIT_FRAME::Process_Special_Functions().

197 { return (LIB_ITEM*) BASE_SCREEN::GetCurItem(); }
EDA_ITEM * GetCurItem() const
Definition: base_screen.h:233
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
DLIST< SCH_ITEM >& SCH_SCREEN::GetDrawList ( )
inline

Definition at line 119 of file sch_screen.h.

References m_drawList.

Referenced by SCH_EDIT_FRAME::SaveWireImage().

119 { return m_drawList; }
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 258 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

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

Return the grid object of the currently selected grid.

Returns
GRID_TYPE - The currently selected grid.

Definition at line 417 of file base_screen.h.

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

417 { return m_Grid; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
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 338 of file base_screen.cpp.

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

339 {
340  wxCHECK_MSG( !m_grids.empty() && aIndex < m_grids.size(), m_Grid,
341  wxT( "Cannot get grid object outside the bounds of the grid list." ) );
342 
343  return m_grids[ aIndex ];
344 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
int BASE_SCREEN::GetGridCmdId ( ) const
inlineinherited

Return the command ID of the currently selected grid.

Returns
int - Currently selected grid command ID.

Definition at line 403 of file base_screen.h.

References GRID_TYPE::m_CmdId.

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

403 { return m_Grid.m_CmdId; }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
int m_CmdId
Definition: base_screen.h:48
size_t BASE_SCREEN::GetGridCount ( ) const
inlineinherited

Function GetGridCount().

Return the size of the grid list.

Returns
- The size of the grid list.

Definition at line 457 of file base_screen.h.

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

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

Function GetGrids().

Returns the current list of grids.

Definition at line 472 of file base_screen.h.

Referenced by DIALOG_SET_GRID::DIALOG_SET_GRID(), PCB_BASE_FRAME::SetFastGrid1(), PCB_BASE_FRAME::SetFastGrid2(), and EDA_DRAW_FRAME::SetPresetGrid().

473  {
474  return m_grids;
475  }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
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 715 of file sch_screen.cpp.

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

Referenced by Place(), and SCH_SCREENS::ReplaceDuplicateTimeStamps().

716 {
717  SCH_ITEM* item = m_drawList.begin();
718 
719  while( item )
720  {
721  if( ( item->Type() == SCH_SHEET_T ) || ( item->Type() == SCH_COMPONENT_T ) )
722  aItems.push_back( item );
723 
724  item = item->Next();
725  }
726 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_ITEM * SCH_SCREEN::GetItem ( const wxPoint aPosition,
int  aAccuracy = 0,
KICAD_T  aType = NOT_USED 
) const

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

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

Definition at line 221 of file sch_screen.cpp.

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

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

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

Return a label item located at aPosition.

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

Definition at line 999 of file sch_screen.cpp.

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

Referenced by GetBus(), and IsTerminalPoint().

1000 {
1001  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1002  {
1003  switch( item->Type() )
1004  {
1005  case SCH_LABEL_T:
1006  case SCH_GLOBAL_LABEL_T:
1008  if( item->HitTest( aPosition, aAccuracy ) )
1009  return (SCH_TEXT*) item;
1010 
1011  default:
1012  ;
1013  }
1014  }
1015 
1016  return NULL;
1017 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
SCH_LINE * SCH_SCREEN::GetLine ( const wxPoint aPosition,
int  aAccuracy = 0,
int  aLayer = LAYER_NOTES,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)

Return a line item located at aPosition.

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

Definition at line 965 of file sch_screen.cpp.

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

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

967 {
968  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
969  {
970  if( item->Type() != SCH_LINE_T )
971  continue;
972 
973  if( item->GetLayer() != aLayer )
974  continue;
975 
976  if( !item->HitTest( aPosition, aAccuracy ) )
977  continue;
978 
979  switch( aSearchType )
980  {
981  case ENTIRE_LENGTH_T:
982  return (SCH_LINE*) item;
983 
985  if( !( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
986  return (SCH_LINE*) item;
987  break;
988 
989  case END_POINTS_ONLY_T:
990  if( ( (SCH_LINE*) item )->IsEndPoint( aPosition ) )
991  return (SCH_LINE*) item;
992  }
993  }
994 
995  return NULL;
996 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
double BASE_SCREEN::GetMaxAllowedZoom ( ) const
inlineinherited

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

Definition at line 361 of file base_screen.h.

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

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

Definition at line 311 of file base_screen.h.

References EDA_DRAW_FRAME::m_UndoRedoCountMax.

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

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

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

Returns
The menu image associated with the item.

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

Definition at line 280 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, KIGFX::operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

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

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

Definition at line 368 of file base_screen.h.

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

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

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

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

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

Definition at line 297 of file base_struct.h.

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

298  {
299  }
int SCH_SCREEN::GetNode ( const wxPoint aPosition,
EDA_ITEMS aList 
)

Return all the items at aPosition that form a node.

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

Definition at line 931 of file sch_screen.cpp.

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

Referenced by GetConnection(), and Place().

932 {
933  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
934  {
935  if( item->Type() == SCH_LINE_T && item->HitTest( aPosition )
936  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
937  {
938  aList.push_back( item );
939  }
940  else if( item->Type() == SCH_JUNCTION_T && item->HitTest( aPosition ) )
941  {
942  aList.push_back( item );
943  }
944  }
945 
946  return (int) aList.size();
947 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
LIB_PIN * SCH_SCREEN::GetPin ( const wxPoint aPosition,
SCH_COMPONENT **  aComponent = NULL,
bool  aEndPointOnly = false 
) const

Test the screen for a component pin item at aPosition.

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

Definition at line 568 of file sch_screen.cpp.

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

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

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

Definition at line 306 of file base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by BASE_SCREEN::PushCommandToRedoList().

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

Definition at line 144 of file sch_screen.h.

References m_refCount.

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

144 { return m_refCount; }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:74
double BASE_SCREEN::GetScalingFactor ( ) const
inherited

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

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

device coordinates = user coordinates * GetScalingFactor()

Definition at line 95 of file base_screen.cpp.

References BASE_SCREEN::GetZoom(), and scale.

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

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

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

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

Returns
The menu text string.

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

Definition at line 173 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), DRC_ITEM::SetData(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

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

Returns a sheet object pointer that is named aName.

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

Definition at line 624 of file sch_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::AppendSchematic(), and Place().

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

Test the screen if aPosition is a sheet label object.

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

Definition at line 641 of file sch_screen.cpp.

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

Referenced by IsTerminalPoint(), and Place().

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

Definition at line 253 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

253 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:164
timestamp_t EDA_ITEM::GetTimeStamp ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS().

207 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
const TITLE_BLOCK& SCH_SCREEN::GetTitleBlock ( ) const
inline
int BASE_SCREEN::GetUndoCommandCount ( ) const
inlineinherited

Definition at line 301 of file base_screen.h.

References UNDO_REDO_CONTAINER::m_CommandsList.

Referenced by BASE_SCREEN::PushCommandToUndoList().

302  {
303  return m_UndoList.m_CommandsList.size();
304  }
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
EDA_UNITS_T KIWAY_HOLDER::GetUserUnits ( ) const
inherited

Function GetUserUnits Allows participation in KEYWAY_PLAYER/DIALOG_SHIM userUnits inheritance.

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

Definition at line 40 of file kiway_holder.cpp.

References MILLIMETRES.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and KIWAY_HOLDER::Kiway().

41 {
42  return MILLIMETRES;
43 }
SCH_LINE* SCH_SCREEN::GetWire ( const wxPoint aPosition,
int  aAccuracy = 0,
SCH_LINE_TEST_T  aSearchType = ENTIRE_LENGTH_T 
)
inline

Definition at line 462 of file sch_screen.h.

References GetLine(), and LAYER_WIRE.

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

464  {
465  return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
466  }
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:965
SCH_LINE * SCH_SCREEN::GetWireOrBus ( const wxPoint aPosition)

Return a wire or bus item located at aPosition.

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

Definition at line 950 of file sch_screen.cpp.

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

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

951 {
952  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
953  {
954  if( (item->Type() == SCH_LINE_T) && item->HitTest( aPosition )
955  && (item->GetLayer() == LAYER_BUS || item->GetLayer() == LAYER_WIRE) )
956  {
957  return (SCH_LINE*) item;
958  }
959  }
960 
961  return NULL;
962 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
double BASE_SCREEN::GetZoom ( ) const
inlineinherited

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

A device unit is typically a pixel.

Definition at line 340 of file base_screen.h.

References EDA_DRAW_FRAME::SetNextZoom().

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

340 { return m_Zoom; }
double m_Zoom
Current zoom coefficient.
Definition: base_screen.h:95
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 347 of file base_screen.cpp.

References i, and BASE_SCREEN::m_grids.

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

348 {
349  // tests for grid command ID (not an index in grid list, but a wxID) exists in grid list.
350  for( unsigned i = 0; i < m_grids.size(); i++ )
351  {
352  if( m_grids[i].m_CmdId == aCommandId )
353  return true;
354  }
355 
356  return false;
357 }
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

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

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

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

Definition at line 308 of file base_struct.h.

References EDA_ITEM::Clone(), EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetClass(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_ITEM::IterateForward(), and EDA_ITEM::Visit().

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

309  {
310  return false; // derived classes should override this function
311  }
void SCH_SCREEN::IncRefCount ( )

Definition at line 131 of file sch_screen.cpp.

References m_refCount.

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

132 {
133  m_refCount++;
134 }
int m_refCount
Number of sheets referencing this screen.
Definition: sch_screen.h:74
void BASE_SCREEN::InitDataPoints ( const wxSize &  aPageSizeInternalUnits)
inherited

Definition at line 72 of file base_screen.cpp.

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

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

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

Definition at line 499 of file base_screen.h.

References BLOCK_SELECTOR::IsIdle().

Referenced by DrawPageOnClipboard(), findDialog(), SCH_EDIT_FRAME::OnCancelCurrentCommand(), SCH_DRAW_PANEL::OnMouseEvent(), EDA_DRAW_PANEL::OnMouseEvent(), PL_EDITOR_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), and LIB_EDIT_FRAME::OnRightClick().

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

Definition at line 227 of file base_struct.h.

References BRIGHTENED.

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

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

Definition at line 226 of file base_struct.h.

References HIGHLIGHTED.

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

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

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

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

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

Definition at line 325 of file sch_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::CheckListConnections(), SCH_EDIT_FRAME::EndSegment(), SCH_EDIT_FRAME::importFile(), Place(), and SCH_EDIT_FRAME::SchematicCleanUp().

326 {
327  bool has_nonparallel[2] = { false };
328  int end_count[2] = { 0 };
329  int pin_count = 0;
330 
331  std::vector<SCH_LINE*> lines[2];
332 
333  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
334  {
335  if( item->GetFlags() & STRUCT_DELETED )
336  continue;
337 
338  if( aNew && ( item->Type() == SCH_JUNCTION_T ) && ( item->HitTest( aPosition ) ) )
339  return false;
340 
341  if( ( item->Type() == SCH_LINE_T )
342  && ( item->HitTest( aPosition, 0 ) ) )
343  {
344  if( item->GetLayer() == LAYER_WIRE )
345  lines[0].push_back( (SCH_LINE*) item );
346  else if( item->GetLayer() == LAYER_BUS )
347  lines[1].push_back( (SCH_LINE*) item );
348  }
349 
350  if( ( item->Type() == SCH_COMPONENT_T )
351  && ( item->IsConnected( aPosition ) ) )
352  pin_count++;
353  }
354 
355  for( int i = 0; i < 2; i++ )
356  {
357  bool removed_overlapping = false;
358  end_count[i] = lines[i].size();
359 
360  for( auto line = lines[i].begin(); line < lines[i].end(); line++ )
361  {
362  // Consider ending on a line to be equivalent to two endpoints because
363  // we will want to split the line if anything else connects
364  if( !(*line)->IsEndPoint( aPosition ) )
365  end_count[i]++;
366 
367  for( auto second_line = lines[i].end() - 1; second_line > line; second_line-- )
368  {
369  if( !(*line)->IsParallel( *second_line ) )
370  has_nonparallel[i] = true;
371  else if( !removed_overlapping
372  && (*line)->IsSameQuadrant( *second_line, aPosition ) )
373  {
379  removed_overlapping = true;
380  end_count[i]--;
381  }
382  }
383  }
384  }
385 
386  //
387 
388  // If there are three or more endpoints
389  if( pin_count + end_count[0] > 2 )
390  return true;
391 
392  // If there is at least one segment that ends on a non-parallel line or
393  // junction of two other lines
394  if( has_nonparallel[0] && end_count[0] > 2 )
395  return true;
396 
397  // Check for bus - bus junction requirements
398  if( has_nonparallel[1] && end_count[1] > 2 )
399  return true;
400 
401  return false;
402 }
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
size_t i
Definition: json11.cpp:597
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

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

Definition at line 219 of file base_struct.h.

References IS_NEW.

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

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

Function IsReplaceable.

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

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

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

Definition at line 464 of file base_struct.h.

References EDA_ITEM::operator<().

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

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

Definition at line 225 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

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

Definition at line 329 of file base_screen.h.

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

Test if aPosition is a connection point on aLayer.

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

Definition at line 405 of file sch_screen.cpp.

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

Referenced by Place().

406 {
407  wxCHECK_MSG( aLayer == LAYER_NOTES || aLayer == LAYER_BUS || aLayer == LAYER_WIRE, false,
408  wxT( "Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
409 
410  SCH_SHEET_PIN* label;
411  SCH_TEXT* text;
412 
413  switch( aLayer )
414  {
415  case LAYER_BUS:
416 
417  if( GetBus( aPosition ) )
418  return true;
419 
420  label = GetSheetLabel( aPosition );
421 
422  if( label && IsBusLabel( label->GetText() ) && label->IsConnected( aPosition ) )
423  return true;
424 
425  text = GetLabel( aPosition );
426 
427  if( text && IsBusLabel( text->GetText() ) && text->IsConnected( aPosition )
428  && (text->Type() != SCH_LABEL_T) )
429  return true;
430 
431  break;
432 
433  case LAYER_NOTES:
434 
435  if( GetLine( aPosition ) )
436  return true;
437 
438  break;
439 
440  case LAYER_WIRE:
442  return true;
443 
444  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_BUS_BUS_ENTRY_T) )
445  return true;
446 
447  if( GetItem( aPosition, std::max( GetDefaultLineThickness(), 3 ), SCH_JUNCTION_T ) )
448  return true;
449 
450  if( GetPin( aPosition, NULL, true ) )
451  return true;
452 
453  if( GetWire( aPosition ) )
454  return true;
455 
456  text = GetLabel( aPosition );
457 
458  if( text && text->IsConnected( aPosition ) && !IsBusLabel( text->GetText() ) )
459  return true;
460 
461  label = GetSheetLabel( aPosition );
462 
463  if( label && label->IsConnected( aPosition ) && !IsBusLabel( label->GetText() ) )
464  return true;
465 
466  break;
467 
468  default:
469  break;
470  }
471 
472  return false;
473 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
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:965
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
SCH_SHEET_PIN * GetSheetLabel(const wxPoint &aPosition)
Test the screen if aPosition is a sheet label object.
Definition: sch_screen.cpp:641
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:61
SCH_LINE * GetWire(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:462
bool IsBusLabel(const wxString &aLabel)
Function IsBusLabel test if aLabel has a bus notation.
SCH_TEXT * GetLabel(const wxPoint &aPosition, int aAccuracy=0)
Return a label item located at aPosition.
Definition: sch_screen.cpp:999
SCH_ITEM * GetItem(const wxPoint &aPosition, int aAccuracy=0, KICAD_T aType=NOT_USED) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:221
#define max(a, b)
Definition: auxiliary.h:86
bool IsConnected(const wxPoint &aPoint) const
Function IsConnected tests the item to see if it is connected to aPoint.
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:568
SCH_LINE * GetBus(const wxPoint &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T)
Definition: sch_screen.h:468
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

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

Definition at line 266 of file base_struct.h.

References EOT.

267  {
268  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
269  {
270  if( m_StructType == *p )
271  return true;
272  }
273 
274  return false;
275  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
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
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

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

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

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

Definition at line 130 of file base_struct.cpp.

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

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

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

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 60 of file kiway_player.h.

References KIWAY_HOLDER::GetUserUnits(), KIWAY_HOLDER::m_kiway, KIWAY_HOLDER::Prj(), KIWAY_HOLDER::SetKiway(), and VTBL_ENTRY.

Referenced by TREEPROJECT_ITEM::Activate(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), 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::KiwayMailIn(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

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

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

Parameters
aSegmentThe segment to test for connections.

Definition at line 283 of file sch_screen.cpp.

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

Referenced by GetConnection(), and Place().

284 {
285  wxCHECK_RET( (aSegment) && (aSegment->Type() == SCH_LINE_T),
286  wxT( "Invalid object pointer." ) );
287 
288  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
289  {
290  if( item->GetFlags() & CANDIDATE )
291  continue;
292 
293  if( item->Type() == SCH_JUNCTION_T )
294  {
295  SCH_JUNCTION* junction = (SCH_JUNCTION*) item;
296 
297  if( aSegment->IsEndPoint( junction->GetPosition() ) )
298  item->SetFlags( CANDIDATE );
299 
300  continue;
301  }
302 
303  if( item->Type() != SCH_LINE_T )
304  continue;
305 
306  SCH_LINE* segment = (SCH_LINE*) item;
307 
308  if( aSegment->IsEndPoint( segment->GetStartPoint() )
309  && !GetPin( segment->GetStartPoint(), NULL, true ) )
310  {
311  item->SetFlags( CANDIDATE );
312  MarkConnections( segment );
313  }
314 
315  if( aSegment->IsEndPoint( segment->GetEndPoint() )
316  && !GetPin( segment->GetEndPoint(), NULL, true ) )
317  {
318  item->SetFlags( CANDIDATE );
319  MarkConnections( segment );
320  }
321  }
322 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
T * begin() const
Definition: dlist.h:218
wxPoint GetEndPoint() const
Definition: sch_line.h:80
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:124
SCH_ITEM * Next() const
wxPoint GetStartPoint() const
Definition: sch_line.h:76
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:103
void MarkConnections(SCH_LINE *aSegment)
Add all wires and junctions connected to aSegment which are not connected any component pin to aItemL...
Definition: sch_screen.cpp:283
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
bool IsEndPoint(const wxPoint &aPoint) const
Definition: sch_line.h:69
Segment description base class to describe items which have 2 end points (track, wire, draw line ...)
Definition: sch_line.h:41
LIB_PIN * GetPin(const wxPoint &aPosition, SCH_COMPONENT **aComponent=NULL, bool aEndPointOnly=false) const
Test the screen for a component pin item at aPosition.
Definition: sch_screen.cpp:568
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

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

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

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

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

Definition at line 420 of file base_struct.h.

References EDA_ITEM::Replace().

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

421  {
422  return false;
423  }
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 182 of file base_struct.cpp.

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

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

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

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

Reimplemented in PCB_SCREEN, GBR_SCREEN, and PL_EDITOR_SCREEN.

Definition at line 245 of file base_screen.h.

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

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

Test if another item is less than this object.

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

Definition at line 239 of file base_struct.cpp.

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

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

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

Plot all the schematic objects to aPlotter.

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

Definition at line 533 of file sch_screen.cpp.

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

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

534 {
535  // Ensure links are up to date, even if a library was reloaded for some reason:
537 
538  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
539  {
540  aPlotter->SetCurrentLineWidth( item->GetPenSize() );
541  item->Plot( aPlotter );
542  }
543 }
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:476
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
PICKED_ITEMS_LIST * BASE_SCREEN::PopCommandFromRedoList ( )
virtualinherited

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

Definition at line 460 of file base_screen.cpp.

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

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

461 {
462  return m_RedoList.PopCommand();
463 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
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 454 of file base_screen.cpp.

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

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

455 {
456  return m_UndoList.PopCommand();
457 }
PICKED_ITEMS_LIST * PopCommand()
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:142
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 439 of file base_screen.cpp.

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

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

440 {
441  m_RedoList.PushCommand( aNewitem );
442 
443  // Delete the extra items, if count max reached
444  if( m_UndoRedoCountMax > 0 )
445  {
446  int extraitems = GetRedoCommandCount() - m_UndoRedoCountMax;
447 
448  if( extraitems > 0 )
449  ClearUndoORRedoList( m_RedoList, extraitems );
450  }
451 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
UNDO_REDO_CONTAINER m_RedoList
Objects list for the redo command (old data)
Definition: base_screen.h:211
int GetRedoCommandCount() const
Definition: base_screen.h:306
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 424 of file base_screen.cpp.

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

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

425 {
426  m_UndoList.PushCommand( aNewitem );
427 
428  // Delete the extra items, if count max reached
429  if( m_UndoRedoCountMax > 0 )
430  {
431  int extraitems = GetUndoCommandCount() - m_UndoRedoCountMax;
432 
433  if( extraitems > 0 )
434  ClearUndoORRedoList( m_UndoList, extraitems );
435  }
436 }
int m_UndoRedoCountMax
undo/Redo command Max depth
Definition: base_screen.h:86
virtual void ClearUndoORRedoList(UNDO_REDO_CONTAINER &aList, int aItemCount=-1)=0
Function ClearUndoORRedoList (virtual).
void PushCommand(PICKED_ITEMS_LIST *aCommand)
int GetUndoCommandCount() const
Definition: base_screen.h:301
UNDO_REDO_CONTAINER m_UndoList
Objects list for the undo command (old data)
Definition: base_screen.h:210
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 176 of file sch_screen.cpp.

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

Referenced by Place(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_BASE_FRAME::RemoveFromScreen(), ReplaceWires(), and SCH_EDIT_FRAME::SaveWireImage().

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

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

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

Definition at line 209 of file base_struct.cpp.

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

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

210 {
211  wxCHECK_MSG( IsReplaceable(), false,
212  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
213 
214  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
215 
216  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
217  aSearchData.GetFindString() :
218  aSearchData.GetFindString().Upper() );
219 
220  if( result == wxNOT_FOUND )
221  return false;
222 
223  wxString prefix = aText.Left( result );
224  wxString suffix;
225 
226  if( aSearchData.GetFindString().length() + result < aText.length() )
227  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
228 
229  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
230  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
231  GetChars( suffix ) );
232 
233  aText = prefix + aSearchData.GetReplaceString() + suffix;
234 
235  return true;
236 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:464
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:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

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

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

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

Reimplemented in SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 452 of file base_struct.h.

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

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

Parameters
aWireListList of wires to replace the existing wires with.

Definition at line 257 of file sch_screen.cpp.

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

Referenced by Place().

258 {
259  SCH_ITEM* item;
260  SCH_ITEM* next_item;
261 
262  for( item = m_drawList.begin(); item; item = next_item )
263  {
264  next_item = item->Next();
265 
266  switch( item->Type() )
267  {
268  case SCH_JUNCTION_T:
269  case SCH_LINE_T:
270  Remove( item );
271  delete item;
272  break;
273 
274  default:
275  break;
276  }
277  }
278 
279  m_drawList.Append( aWireList );
280 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
void Append(T *aNewElement)
Function Append adds aNewElement to the end of the list.
Definition: dlist.h:177
T * begin() const
Definition: dlist.h:218
void Remove(SCH_ITEM *aItem)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:176
SCH_ITEM * Next() const
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
void SCH_SCREEN::SelectBlockItems ( )

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

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

Definition at line 729 of file sch_screen.cpp.

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

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

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

Definition at line 134 of file sch_screen.h.

Referenced by SCH_BASE_FRAME::SetAuxOrigin().

134 { 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:91
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 215 of file base_struct.h.

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

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

Definition at line 232 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

232 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
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 1020 of file sch_screen.cpp.

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

Referenced by GetBus(), and SCH_SHEET_PATH::SetComponentFootprint().

1022 {
1023  SCH_COMPONENT* component;
1024  bool found = false;
1025 
1026  for( SCH_ITEM* item = m_drawList.begin(); item; item = item->Next() )
1027  {
1028  if( item->Type() != SCH_COMPONENT_T )
1029  continue;
1030 
1031  component = (SCH_COMPONENT*) item;
1032 
1033  if( aReference.CmpNoCase( component->GetRef( aSheetPath ) ) == 0 )
1034  {
1035  // Found: Init Footprint Field
1036 
1037  /* Give a reasonable value to the field position and
1038  * orientation, if the text is empty at position 0, because
1039  * it is probably not yet initialized
1040  */
1041  SCH_FIELD * fpfield = component->GetField( FOOTPRINT );
1042  if( fpfield->GetText().IsEmpty()
1043  && ( fpfield->GetTextPos() == component->GetPosition() ) )
1044  {
1045  fpfield->SetTextAngle( component->GetField( VALUE )->GetTextAngle() );
1046  fpfield->SetTextPos( component->GetField( VALUE )->GetTextPos() );
1047  fpfield->SetTextSize( component->GetField( VALUE )->GetTextSize() );
1048 
1049  if( fpfield->GetTextAngle() == 0.0 )
1050  fpfield->Offset( wxPoint( 0, 100 ) );
1051  else
1052  fpfield->Offset( wxPoint( 100, 0 ) );
1053  }
1054 
1055  fpfield->SetText( aFootPrint );
1056  fpfield->SetVisible( aSetVisible );
1057 
1058  found = true;
1059  }
1060  }
1061 
1062  return found;
1063 }
void SetTextAngle(double aAngle)
Definition: eda_text.h:169
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:242
const wxPoint & GetTextPos() const
Definition: eda_text.h:237
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:236
void SetVisible(bool aVisible)
Definition: eda_text.h:188
T * begin() const
Definition: dlist.h:218
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:227
SCH_ITEM * Next() const
Field Name Module PCB, i.e. "16DIP300".
double GetTextAngle() const
Definition: eda_text.h:177
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
wxPoint GetPosition() const override
Function GetPosition.
const wxSize & GetTextSize() const
Definition: eda_text.h:228
#define VALUE
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
virtual void SetText(const wxString &aText)
Definition: eda_text.h:154
void SCH_SCREEN::SetCurItem ( SCH_ITEM aItem)
inline

Sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from SCH_ITEM

Definition at line 204 of file sch_screen.h.

References BASE_SCREEN::SetCurItem().

Referenced by AbortCreateNewLine(), abortMoveItem(), SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::DeleteCurrentSegment(), SCH_EDIT_FRAME::DeleteItemAtCrossHair(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), LIB_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::HandleBlockPlace(), SCH_EDIT_FRAME::LocateItem(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnEditItem(), SCH_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnOrient(), SCH_EDIT_FRAME::OnRotate(), SCH_FIELD::Place(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and UpdatePickList().

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

Function SetCurItem sets the currently selected object, m_CurrentItem.

Parameters
aItemAny object derived from EDA_ITEM

Definition at line 231 of file base_screen.h.

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

231 { m_CurrentItem = aItem; }
EDA_ITEM * m_CurrentItem
Currently selected object.
Definition: base_screen.h:82
void SCH_SCREEN::SetCurLibItem ( LIB_ITEM aItem)
inline

Definition at line 205 of file sch_screen.h.

References Clear(), FreeDrawList(), GetItem(), NOT_USED, and BASE_SCREEN::SetCurItem().

Referenced by LIB_EDIT_FRAME::SetDrawItem().

205 { BASE_SCREEN::SetCurItem( (EDA_ITEM*) aItem ); }
void SetCurItem(EDA_ITEM *aItem)
Function SetCurItem sets the currently selected object, m_CurrentItem.
Definition: base_screen.h:231
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
void SCH_SCREEN::SetFileName ( const wxString &  aFileName)
inline
bool BASE_SCREEN::SetFirstZoom ( )
inherited

Definition at line 111 of file base_screen.cpp.

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

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

Definition at line 256 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), addConnectedItemsToBlock(), PCB_BASE_FRAME::AddModuleToBoard(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), SCH_EDIT_FRAME::DeleteItem(), DrawMovingBlockOutlines(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), GetConnection(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockPlace(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), MarkConnections(), MarkItemsInBloc(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnSelectUnit(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

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

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

285 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:175
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 232 of file base_screen.cpp.

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

Referenced by SCH_EDIT_FRAME::AppendSchematic(), DIALOG_SET_GRID::DIALOG_SET_GRID(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GBR_SCREEN::GBR_SCREEN(), GERBVIEW_FRAME::GERBVIEW_FRAME(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_SCREEN::PCB_SCREEN(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PL_EDITOR_SCREEN::PL_EDITOR_SCREEN(), SCH_SCREEN(), EDA_DRAW_FRAME::SetPresetGrid(), and DIALOG_SET_GRID::TransferDataFromWindow().

233 {
234  wxASSERT( !m_grids.empty() );
235 
236  GRID_TYPE nearest_grid = m_grids[0];
237  int gridIdx = 0;
238 
239  for( unsigned i = 0; i < m_grids.size(); i++ )
240  {
241  if( m_grids[i].m_Size == size )
242  {
243  m_Grid = m_grids[i];
244  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
245  }
246 
247  // keep track of the nearest larger grid size, if the exact size is not found
248  if ( size.x < m_grids[i].m_Size.x )
249  {
250  gridIdx = m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
251  nearest_grid = m_grids[i];
252  }
253  }
254 
255  m_Grid = nearest_grid;
256 
257  wxLogWarning( _( "Grid size( %f, %f ) not in grid list, falling back "
258  "to grid size( %f, %f )." ),
259  size.x, size.y, m_Grid.m_Size.x, m_Grid.m_Size.y );
260 
261  return gridIdx;
262 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
Class GRID_TYPE is for grid arrays.
Definition: base_screen.h:45
size_t i
Definition: json11.cpp:597
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 265 of file base_screen.cpp.

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

266 {
267  wxASSERT( !m_grids.empty() );
268 
269  for( unsigned i = 0; i < m_grids.size(); i++ )
270  {
271  if( m_grids[i].m_CmdId == aCommandId )
272  {
273  m_Grid = m_grids[i];
274  return m_grids[i].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
275  }
276  }
277 
278  m_Grid = m_grids[0];
279 
280  wxLogWarning( _( "Grid ID %d not in grid list, falling back to "
281  "grid size( %g, %g )." ), aCommandId,
282  m_Grid.m_Size.x, m_Grid.m_Size.y );
283 
284  return m_grids[0].m_CmdId - ID_POPUP_GRID_LEVEL_1000;
285 }
GRID_TYPE m_Grid
Current grid selection.
Definition: base_screen.h:83
wxRealPoint m_Size
Definition: base_screen.h:49
GRIDS m_grids
List of valid grid sizes.
Definition: base_screen.h:79
size_t i
Definition: json11.cpp:597
void BASE_SCREEN::SetGridList ( GRIDS sizelist)
inherited

Definition at line 223 of file base_screen.cpp.

References BASE_SCREEN::m_grids.

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

Definition at line 231 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

231 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
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 47 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), InvokePcbLibTableEditor(), KIWAY_HOLDER::Kiway(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

48 {
49 #if defined(DEBUG)
50  // offer a trap point for debugging most any window
51  wxASSERT( aDest );
52  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
53  {
54  int breakhere=1;
55  (void) breakhere;
56  }
57 #endif
58 
59  (void) aDest;
60 
61  m_kiway = aKiway;
62 }
KIWAY * m_kiway
Definition: kiway_player.h:94
const char * name
Definition: DXF_plotter.cpp:61
bool BASE_SCREEN::SetLastZoom ( )
inherited

Definition at line 117 of file base_screen.cpp.

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

118 {
119  return SetZoom( GetMaxAllowedZoom() );
120 }
virtual bool SetZoom(double iu_per_du)
Function SetZoom adjusts the current zoom factor.
double GetMaxAllowedZoom() const
Function GetMaxAllowedZoom returns the maximum allowed zoom factor, which was established as the last...
Definition: base_screen.h:361
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 217 of file base_struct.h.

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

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

Definition at line 313 of file base_screen.h.

References ABS_MAX_UNDO_ITEMS, and DEFAULT_MAX_UNDO_ITEMS.

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

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

Definition at line 214 of file base_struct.h.

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

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

Definition at line 142 of file base_screen.cpp.

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

Referenced by EDA_DRAW_FRAME::SetNextZoom().

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

Definition at line 127 of file sch_screen.h.

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

127 { m_paper = aPageSettings; }
PAGE_INFO m_paper
The size of the paper to print or plot on.
Definition: sch_screen.h:86
bool BASE_SCREEN::SetPreviousZoom ( )
inherited

Definition at line 160 of file base_screen.cpp.

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

Referenced by EDA_DRAW_FRAME::SetPrevZoom().

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

Definition at line 326 of file base_screen.h.

Referenced by PCB_BASE_FRAME::OnModify().

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

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

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

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

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

Definition at line 102 of file base_screen.cpp.

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

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

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

Definition at line 230 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

230 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 206 of file base_struct.h.

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

206 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
void SCH_SCREEN::SetTitleBlock ( const TITLE_BLOCK aTitleBlock)
inline

Definition at line 138 of file sch_screen.h.

References DecRefCount(), and IncRefCount().

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

138 { m_titles = aTitleBlock; }
TITLE_BLOCK m_titles
Definition: sch_screen.h:88
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

229 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:256
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
bool BASE_SCREEN::SetZoom ( double  iu_per_du)
virtualinherited

Function SetZoom adjusts the current zoom factor.

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

Definition at line 123 of file base_screen.cpp.

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

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

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

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

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

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

Returns
True if any connection state changes were made.

Definition at line 910 of file sch_screen.cpp.

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

Referenced by abortMoveItem(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_SCREENS::GetCount(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), and Place().

911 {
912  SCH_ITEM* item;
913  std::vector< DANGLING_END_ITEM > endPoints;
914  bool hasStateChanged = false;
915 
916  for( item = m_drawList.begin(); item; item = item->Next() )
917  item->GetEndPoints( endPoints );
918 
919  for( item = m_drawList.begin(); item; item = item->Next() )
920  {
921  if( item->UpdateDanglingState( endPoints ) )
922  {
923  hasStateChanged = true;
924  }
925  }
926 
927  return hasStateChanged;
928 }
virtual void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList)
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points...
T * begin() const
Definition: dlist.h:218
SCH_ITEM * Next() const
virtual bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemList)
Function IsDanglingStateChanged tests the schematic item to aItemList to check if it&#39;s dangling state...
DLIST< SCH_ITEM > m_drawList
Object list for the screen.
Definition: sch_screen.h:93
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 201 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), SCH_EDIT_FRAME::addCurrentItemToScreen(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), CN_VISITOR::checkZoneItemConnection(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_TARGET::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), SCH_SCREENS::DeleteAllMarkers(), DeleteItem(), LIB_EDIT_FRAME::deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), SCH_EDIT_FRAME::DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), EditToolSelectionFilter(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_SHEET::HasUndefinedPins(), SELECTION_TOOL::highlight(), SCH_EDIT_FRAME::ImportSheetPin(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), LIB_EDIT_FRAME::OnEditComponentProperties(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingModules(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_BASE_FRAME::RefreshItem(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), ReplaceWires(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_TEXT::Rotate(), SCH_EDIT_FRAME::RotateField(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), PCB_TARGET::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(),