KiCad PCB EDA Suite
SCH_SHEET Class Reference

Sheet symbol placed in a schematic, and is the entry point for a sub schematic. More...

#include <sch_sheet.h>

Inheritance diagram for SCH_SHEET:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 SCH_SHEET (const wxPoint &pos=wxPoint(0, 0))
 
 SCH_SHEET (const SCH_SHEET &aSheet)
 Copy aSheet into a new object. More...
 
 ~SCH_SHEET ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool IsMovableFromAnchorPoint () override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
 
wxString GetName () const
 
void SetName (const wxString &aName)
 
int GetSheetNameSize () const
 
void SetSheetNameSize (int aSize)
 
int GetFileNameSize () const
 
void SetFileNameSize (int aSize)
 
SCH_SCREENGetScreen ()
 
wxSize GetSize ()
 
void SetSize (const wxSize &aSize)
 
SCH_SHEETGetRootSheet ()
 Return the root sheet of this SCH_SHEET object. More...
 
void SetScreen (SCH_SCREEN *aScreen)
 Set the SCH_SCREEN associated with this sheet to aScreen. More...
 
int GetScreenCount () const
 Return the number of times the associated screen for the sheet is being used. More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool IsVerticalOrientation () const
 
void AddPin (SCH_SHEET_PIN *aSheetPin)
 Add aSheetPin to the sheet. More...
 
SCH_SHEET_PINSGetPins ()
 
SCH_SHEET_PINSGetPins () const
 
void RemovePin (SCH_SHEET_PIN *aSheetPin)
 Remove aSheetPin from the sheet. More...
 
void CleanupSheet ()
 Delete sheet label which do not have a corresponding hierarchical label. More...
 
SCH_SHEET_PINGetPin (const wxPoint &aPosition)
 Return the sheet pin item found at aPosition in the sheet. More...
 
bool HasPin (const wxString &aName)
 Checks if the sheet already has a sheet pin named aName. More...
 
bool HasPins ()
 
bool HasUndefinedPins ()
 Check all sheet labels against schematic for undefined hierarchical labels. More...
 
int GetMinWidth () const
 Return the minimum width of the sheet based on the widths of the sheet pin text. More...
 
int GetMinHeight () const
 Return the minimum height that the sheet can be resized based on the sheet pin positions. More...
 
int GetPenSize () const override
 Function GetPenSize virtual pure. More...
 
void Print (wxDC *aDC, const wxPoint &aOffset) override
 Function Print Print a schematic item. More...
 
EDA_RECT const GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
wxPoint GetRotationCenter () const
 Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on. More...
 
void SwapData (SCH_ITEM *aItem) override
 Function SwapData swap the internal data structures aItem with the schematic item. More...
 
int ComponentCount ()
 Count our own components, without the power components. More...
 
bool SearchHierarchy (const wxString &aFilename, SCH_SCREEN **aScreen)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
bool LocatePathOfScreen (SCH_SCREEN *aScreen, SCH_SHEET_PATH *aList)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
int CountSheets ()
 Count the number of sheets found in "this" sheet includeing all of the subsheets. More...
 
wxString GetFileName (void) const
 Return the filename corresponding to this sheet. More...
 
void SetFileName (const wxString &aFilename)
 
bool ChangeFileName (SCH_EDIT_FRAME *aFrame, const wxString &aFileName)
 
void Move (const wxPoint &aMoveVector) override
 Function Move moves the item by aMoveVector to a new position. More...
 
void MirrorY (int aYaxis_position) override
 Function MirrorY mirrors item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Function MirrorX mirrors item relative to the X axis about aXaxis_position. More...
 
void Rotate (wxPoint aPosition) override
 Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL) override
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
bool IsReplaceable () const override
 Function IsReplaceable. More...
 
void Resize (const wxSize &aSize)
 Resize this sheet to aSize and adjust all of the labels accordingly. More...
 
wxPoint GetSheetNamePosition ()
 
wxPoint GetFileNamePosition ()
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 Function GetEndPoints adds the schematic item end points to aItemList if the item has end points. More...
 
bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemList) override
 Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state has changed. More...
 
bool IsConnectable () const override
 Function IsConnectable returns true if the schematic item can connect to another schematic item. More...
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
void GetConnectionPoints (std::vector< wxPoint > &aPoints) const override
 Function GetConnectionPoints add all the connection points for this item to aPoints. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 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...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
void GetNetListItem (NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
 Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems. More...
 
SCH_ITEMoperator= (const SCH_ITEM &aSheet)
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers returns the layers the item is drawn on (which may be more than its "home" layer) More...
 
wxPoint GetPosition () const override
 Function GetPosition. More...
 
void SetPosition (const wxPoint &aPosition) override
 Function SetPosition set the schematic item position to aPosition. More...
 
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. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Function Plot plots the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
SCH_ITEMNext () const
 
SCH_ITEMBack () const
 
SCH_ITEMDuplicate (bool doClone=false)
 Routine to create a new copy of given item. More...
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
SCH_LAYER_ID GetLayer () const
 Function GetLayer returns the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
virtual bool Load (LINE_READER &aLine, wxString &aErrorMsg)
 Function Load reads a schematic item from aLine in a .sch file. More...
 
virtual bool IsDangling () const
 
void ClearConnections ()
 Function ClearConnections clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Function IsConnected tests the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH &aPath) const
 Retrieves the connection associated with this object in the given sheet. More...
 
std::unordered_set< SCH_ITEM * > & ConnectedItems ()
 Retrieves the set of items connected to this item (schematic only) More...
 
void AddConnectionTo (SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
virtual bool CanIncrementLabel () const
 
virtual bool operator< (const SCH_ITEM &aItem) const
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Protected Member Functions

void renumberPins ()
 Renumber the sheet pins in the sheet. More...
 
bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

SCH_LAYER_ID m_Layer
 
EDA_ITEMS m_connections
 List of items connected to this item. More...
 
wxPoint m_storedPos
 a temporary variable used in some move commands

to store a initial pos (of the item or mouse cursor)

More...
 
std::unordered_set< SCH_ITEM * > m_connected_items
 Stores pointers to other items that are connected to this one (schematic only) More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Stores connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 True if connectivity info might be out of date. More...
 
EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Attributes

SCH_SCREENm_screen
 Screen that contains the physical data for the sheet. More...
 
SCH_SHEET_PINS m_pins
 The list of sheet connection points. More...
 
wxString m_fileName
 The file name is also in the SCH_SCREEN object associated with the sheet. More...
 
wxString m_name
 This is equivalent to the reference designator for components and is stored in F0 sheet pin in the schematic file. More...
 
int m_sheetNameSize
 The height of the text used to draw the sheet name. More...
 
int m_fileNameSize
 The height of the text used to draw the file name. More...
 
wxPoint m_pos
 The position of the sheet. More...
 
wxSize m_size
 The size of the sheet. More...
 

Friends

class SCH_SHEET_PIN
 

Detailed Description

Sheet symbol placed in a schematic, and is the entry point for a sub schematic.

Definition at line 209 of file sch_sheet.h.

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

SCH_SHEET::SCH_SHEET ( const wxPoint &  pos = wxPoint( 0, 0 ))

Definition at line 47 of file sch_sheet.cpp.

47  :
48  SCH_ITEM( NULL, SCH_SHEET_T )
49 {
51  m_pos = pos;
56  m_screen = NULL;
57  m_name.Printf( wxT( "Sheet%8.8lX" ), (long) m_TimeStamp );
58  m_fileName.Printf( wxT( "file%8.8lX.sch" ), (long) m_TimeStamp );
59 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:119
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:181
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:43
int GetDefaultTextSize()
Default size for text in general.
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:215
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:46

References GetDefaultTextSize(), GetNewTimeStamp(), LAYER_SHEET, m_fileName, m_fileNameSize, SCH_ITEM::m_Layer, m_name, m_pos, m_screen, m_sheetNameSize, m_size, EDA_ITEM::m_TimeStamp, MIN_SHEET_HEIGHT, MIN_SHEET_WIDTH, and EDA_ITEM::SetTimeStamp().

Referenced by Clone().

◆ SCH_SHEET() [2/2]

SCH_SHEET::SCH_SHEET ( const SCH_SHEET aSheet)

Copy aSheet into a new object.

All sheet pins are copied as is except and the SCH_SHEET_PIN's m_Parent pointers are set to the new copied parent object.

Definition at line 62 of file sch_sheet.cpp.

62  :
63  SCH_ITEM( aSheet )
64 {
65  m_pos = aSheet.m_pos;
66  m_size = aSheet.m_size;
67  m_Layer = aSheet.m_Layer;
68  SetTimeStamp( aSheet.m_TimeStamp );
71  m_screen = aSheet.m_screen;
72  m_name = aSheet.m_name;
73  m_fileName = aSheet.m_fileName;
74  m_pins = aSheet.m_pins;
75 
76  for( size_t i = 0; i < m_pins.size(); i++ )
77  m_pins[i].SetParent( this );
78 
79  if( m_screen )
81 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:119
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:181
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:225
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
size_t i
Definition: json11.cpp:649
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
void IncRefCount()
Definition: sch_screen.cpp:145
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:215
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:46

References i, SCH_SCREEN::IncRefCount(), m_fileName, m_fileNameSize, SCH_ITEM::m_Layer, m_name, m_pins, m_pos, m_screen, m_sheetNameSize, m_size, EDA_ITEM::m_TimeStamp, EDA_ITEM::SetParent(), and EDA_ITEM::SetTimeStamp().

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 84 of file sch_sheet.cpp.

85 {
86  // also, look at the associated sheet & its reference count
87  // perhaps it should be deleted also.
88  if( m_screen )
89  {
91 
92  if( m_screen->GetRefCount() == 0 )
93  delete m_screen;
94  }
95 }
void DecRefCount()
Definition: sch_screen.cpp:151
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
int GetRefCount() const
Definition: sch_screen.h:136

References SCH_SCREEN::DecRefCount(), SCH_SCREEN::GetRefCount(), and m_screen.

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( SCH_ITEM aItem)
inherited

Adds a connection link between this item and another.

Definition at line 143 of file sch_item.cpp.

144 {
145  m_connected_items.insert( aItem );
146 }
std::unordered_set< SCH_ITEM * > m_connected_items
Stores pointers to other items that are connected to this one (schematic only)
Definition: sch_item.h:125

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AddPin()

void SCH_SHEET::AddPin ( SCH_SHEET_PIN aSheetPin)

Add aSheetPin to the sheet.

Note: Once a sheet pin is added to the sheet, it is owned by the sheet. Do not delete the sheet pin object or you will likely get a segfault when the sheet is destroyed.

Parameters
aSheetPinThe sheet pin item to add to the sheet.

Definition at line 177 of file sch_sheet.cpp.

178 {
179  wxASSERT( aSheetPin != NULL );
180  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
181 
182  m_pins.push_back( aSheetPin );
183  renumberPins();
184 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:777
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References m_pins, renumberPins(), SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

◆ Back()

SCH_ITEM* SCH_ITEM::Back ( ) const
inlineinherited

Definition at line 154 of file sch_item.h.

154 { return static_cast<SCH_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:177

References EDA_ITEM::Pback.

Referenced by SCH_SHEET_PATH::FindPreviousItem(), and SCH_SHEET_LIST::FindPreviousItem().

◆ CanConnect()

bool SCH_SHEET::CanConnect ( const SCH_ITEM aItem) const
inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 521 of file sch_sheet.h.

522  {
523  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
524  ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS ) ||
525  ( aItem->Type() == SCH_NO_CONNECT_T );
526  }
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_ITEM::GetLayer(), LAYER_BUS, LAYER_WIRE, SCH_LINE_T, SCH_NO_CONNECT_T, and EDA_ITEM::Type().

◆ CanIncrementLabel()

virtual bool SCH_ITEM::CanIncrementLabel ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT.

Definition at line 359 of file sch_item.h.

359 { return false; }

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ ChangeFileName()

bool SCH_SHEET::ChangeFileName ( SCH_EDIT_FRAME aFrame,
const wxString &  aFileName 
)

◆ ClassOf()

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

Definition at line 251 of file sch_sheet.h.

252  {
253  return aItem && SCH_SHEET_T == aItem->Type();
254  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_SHEET_T, and EDA_ITEM::Type().

◆ CleanupSheet()

void SCH_SHEET::CleanupSheet ( )

Delete sheet label which do not have a corresponding hierarchical label.

Note: Make sure you save a copy of the sheet in the undo list before calling CleanupSheet() otherwise any unreferenced sheet labels will be lost.

Definition at line 350 of file sch_sheet.cpp.

351 {
352  SCH_SHEET_PINS::iterator i = m_pins.begin();
353 
354  while( i != m_pins.end() )
355  {
356  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
357  EDA_ITEM* DrawStruct = m_screen->GetDrawItems();
358  const SCH_HIERLABEL* HLabel = NULL;
359 
360  for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
361  {
362  if( DrawStruct->Type() != SCH_HIER_LABEL_T )
363  continue;
364 
365  HLabel = static_cast<SCH_HIERLABEL*>( DrawStruct );
366 
367  if( i->GetText().CmpNoCase( HLabel->GetText() ) == 0 )
368  break; // Found!
369 
370  HLabel = NULL;
371  }
372 
373  if( HLabel == NULL ) // Hlabel not found: delete sheet label.
374  i = m_pins.erase( i );
375  else
376  ++i;
377  }
378 }
EDA_ITEM * Next() const
Definition: base_struct.h:218
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
size_t i
Definition: json11.cpp:649
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References SCH_SCREEN::GetDrawItems(), EDA_TEXT::GetText(), i, m_pins, m_screen, EDA_ITEM::Next(), SCH_HIER_LABEL_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 245 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Function ClearConnections clears all of the connection items from the list.

The vector release method is used to prevent the item pointers from being deleted. Do not use the vector erase method on the connection list.

Definition at line 317 of file sch_item.h.

317 { m_connections.clear(); }
EDA_ITEMS m_connections
List of items connected to this item.
Definition: sch_item.h:120

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 266 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

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

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 244 of file base_struct.h.

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

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 278 of file base_struct.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

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

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_SHEET::Clone ( ) const
overridevirtual

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 from EDA_ITEM.

Definition at line 98 of file sch_sheet.cpp.

99 {
100  return new SCH_SHEET( *this );
101 }
SCH_SHEET(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_sheet.cpp:47

References SCH_SHEET().

◆ ComponentCount()

int SCH_SHEET::ComponentCount ( )

Count our own components, without the power components.

Returns
the component count.

Definition at line 529 of file sch_sheet.cpp.

530 {
531  int n = 0;
532 
533  if( m_screen )
534  {
535  EDA_ITEM* bs;
536 
537  for( bs = m_screen->GetDrawItems(); bs != NULL; bs = bs->Next() )
538  {
539  if( bs->Type() == SCH_COMPONENT_T )
540  {
541  SCH_COMPONENT* Cmp = (SCH_COMPONENT*) bs;
542 
543  if( Cmp->GetField( VALUE )->GetText().GetChar( 0 ) != '#' )
544  n++;
545  }
546 
547  if( bs->Type() == SCH_SHEET_T )
548  {
549  SCH_SHEET* sheet = (SCH_SHEET*) bs;
550  n += sheet->ComponentCount();
551  }
552  }
553  }
554 
555  return n;
556 }
int ComponentCount()
Count our own components, without the power components.
Definition: sch_sheet.cpp:529
EDA_ITEM * Next() const
Definition: base_struct.h:218
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define VALUE
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References ComponentCount(), SCH_SCREEN::GetDrawItems(), SCH_COMPONENT::GetField(), EDA_TEXT::GetText(), m_screen, EDA_ITEM::Next(), SCH_COMPONENT_T, SCH_SHEET_T, EDA_ITEM::Type(), and VALUE.

Referenced by ComponentCount().

◆ ConnectedItems()

std::unordered_set< SCH_ITEM * > & SCH_ITEM::ConnectedItems ( )
inherited

Retrieves the set of items connected to this item (schematic only)

Definition at line 137 of file sch_item.cpp.

138 {
139  return m_connected_items;
140 }
std::unordered_set< SCH_ITEM * > m_connected_items
Stores pointers to other items that are connected to this one (schematic only)
Definition: sch_item.h:125

References SCH_ITEM::m_connected_items.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), and CONNECTION_GRAPH::buildConnectionGraph().

◆ Connection()

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM aItem) const
inlinevirtualinherited

Returns true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY.

Definition at line 353 of file sch_item.h.

353 { return true; }

◆ CountSheets()

int SCH_SHEET::CountSheets ( )

Count the number of sheets found in "this" sheet includeing all of the subsheets.

Returns
the full count of sheets+subsheets contained by "this"

Definition at line 640 of file sch_sheet.cpp.

641 {
642  int count = 1; //1 = this!!
643 
644  if( m_screen )
645  {
646  EDA_ITEM* strct = m_screen->GetDrawItems();
647 
648  for( ; strct; strct = strct->Next() )
649  {
650  if( strct->Type() == SCH_SHEET_T )
651  {
652  SCH_SHEET* subsheet = (SCH_SHEET*) strct;
653  count += subsheet->CountSheets();
654  }
655  }
656  }
657  return count;
658 }
int CountSheets()
Count the number of sheets found in "this" sheet includeing all of the subsheets.
Definition: sch_sheet.cpp:640
EDA_ITEM * Next() const
Definition: base_struct.h:218
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References CountSheets(), SCH_SCREEN::GetDrawItems(), m_screen, EDA_ITEM::Next(), SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by CountSheets(), SCH_PRINTOUT::GetPageInfo(), SCH_PRINTOUT::HasPage(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), and DIALOG_PRINT_USING_PRINTER::TransferDataFromWindow().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool  doClone = false)
inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters
doClone(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 75 of file sch_item.cpp.

76 {
77  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
78 
79  if( doClone )
80  newItem->SetTimeStamp( GetTimeStamp() );
81 
82  newItem->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
83 
84  if( newItem->Type() == SCH_COMPONENT_T )
85  {
86  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
87 
88  for( SCH_PIN& pin : component->GetPins() )
90 
91  std::vector<SCH_FIELD*> fields;
92  component->GetFields( fields, false );
93 
94  for( SCH_FIELD* field : fields )
95  field->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
96  }
97 
98  if( newItem->Type() == SCH_SHEET_T )
99  {
100  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
101 
102  for( SCH_SHEET_PIN& pin : sheet->GetPins() )
104  }
105 
106  return newItem;
107 }
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
SCH_SHEET_PINS & GetPins()
Definition: sch_sheet.h:335
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
#define SELECTED
Definition: base_struct.h:127
timestamp_t GetTimeStamp() const
Definition: base_struct.h:216
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
void GetPins(std::vector< LIB_PIN * > &aPinsList)
Populate a vector with all the pins from the library object.
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:266
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:215

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), SCH_COMPONENT::GetFields(), GetPins(), SCH_COMPONENT::GetPins(), EDA_ITEM::GetTimeStamp(), HIGHLIGHTED, SCH_COMPONENT_T, SCH_SHEET_T, SELECTED, EDA_ITEM::SetTimeStamp(), and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::Duplicate(), SCH_DRAWING_TOOLS::PlaceComponent(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ GetBoundingBox()

const EDA_RECT SCH_SHEET::GetBoundingBox ( ) const
overridevirtual

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 from EDA_ITEM.

Definition at line 488 of file sch_sheet.cpp.

489 {
490  wxPoint end;
491  EDA_RECT box( m_pos, m_size );
492  int lineWidth = GetPenSize();
493 
494  // Determine length of texts
495  wxString text = wxT( "Sheet: " ) + m_name;
496  int textlen = GraphicTextWidth( text, wxSize( m_sheetNameSize, m_sheetNameSize ),
497  false, false );
498 
499  text = wxT( "File: " ) + m_fileName;
500  int textlen2 = GraphicTextWidth( text, wxSize( m_fileNameSize, m_fileNameSize ),
501  false, false );
502 
503  // Calculate bounding box X size:
504  textlen = std::max( textlen, textlen2 );
505  end.x = std::max( m_size.x, textlen );
506 
507  // Calculate bounding box pos:
508  end.y = m_size.y;
509  end += m_pos;
510 
511  // Move upper and lower limits to include texts:
512  box.SetY( box.GetY() - ( KiROUND( m_sheetNameSize * 1.3 ) + 8 ) );
513  end.y += KiROUND( m_fileNameSize * 1.3 ) + 8;
514 
515  box.SetEnd( end );
516  box.Inflate( lineWidth / 2 );
517 
518  return box;
519 }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
int GraphicTextWidth(const wxString &aText, const wxSize &aSize, bool aItalic, bool aBold)
Function GraphicTextWidth.
Definition: gr_text.cpp:90
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:393
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References GetPenSize(), EDA_RECT::GetY(), GraphicTextWidth(), EDA_RECT::Inflate(), KiROUND(), m_fileName, m_fileNameSize, m_name, m_pos, m_sheetNameSize, m_size, max, EDA_RECT::SetEnd(), and EDA_RECT::SetY().

Referenced by HitTest(), SCH_EDIT_TOOL::Mirror(), and SCH_EDIT_TOOL::Rotate().

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 256 of file sch_sheet.h.

257  {
258  return wxT( "SCH_SHEET" );
259  }

Referenced by operator=().

◆ GetConnectionPoints()

void SCH_SHEET::GetConnectionPoints ( std::vector< wxPoint > &  aPoints) const
overridevirtual

Function GetConnectionPoints add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 814 of file sch_sheet.cpp.

815 {
816  for( size_t i = 0; i < GetPins().size(); i++ )
817  aPoints.push_back( GetPins()[i].GetPosition() );
818 }
SCH_SHEET_PINS & GetPins()
Definition: sch_sheet.h:335
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_sheet.h:543
size_t i
Definition: json11.cpp:649

References GetPins(), GetPosition(), and i.

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 270 of file base_struct.h.

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

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

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), BOARD::Print(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

◆ GetEndPoints()

void SCH_SHEET::GetEndPoints ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Function GetEndPoints adds the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 789 of file sch_sheet.cpp.

790 {
791  for( unsigned ii = 0; ii < GetPins().size(); ii++ )
792  {
793  SCH_SHEET_PIN &pinsheet = GetPins()[ii];
794 
795  wxCHECK2_MSG( pinsheet.Type() == SCH_SHEET_PIN_T, continue,
796  wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
797 
798  pinsheet.GetEndPoints( aItemList );
799  }
800 }
SCH_SHEET_PINS & GetPins()
Definition: sch_sheet.h:335
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_SHEET_PIN::GetEndPoints(), GetPins(), SCH_SHEET_PIN_T, and EDA_ITEM::Type().

◆ GetFileName()

◆ GetFileNamePosition()

wxPoint SCH_SHEET::GetFileNamePosition ( )
Returns
the position of the anchor of filename text

Definition at line 418 of file sch_sheet.cpp.

419 {
420  wxPoint pos = m_pos;
421  int margin = KiROUND( GetPenSize() / 2.0 + 4 + m_fileNameSize * 0.4 );
422 
423  if( IsVerticalOrientation() )
424  {
425  pos.x += m_size.x + margin;
426  pos.y += m_size.y;
427  }
428  else
429  {
430  pos.y += m_size.y + margin;
431  }
432 
433  return pos;
434 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:393
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:221
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References GetPenSize(), IsVerticalOrientation(), KiROUND(), m_fileNameSize, m_pos, and m_size.

Referenced by KIGFX::SCH_PAINTER::draw(), and Print().

◆ GetFileNameSize()

int SCH_SHEET::GetFileNameSize ( ) const
inline

Definition at line 278 of file sch_sheet.h.

278 { return m_fileNameSize; }
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232

References m_fileNameSize.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_LEGACY_PLUGIN::saveSheet(), and DIALOG_SCH_SHEET_PROPS::TransferDataToWindow().

◆ GetFlags()

◆ GetLayer()

◆ GetList()

DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

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

References EDA_ITEM::m_List.

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

◆ GetMenuImage()

BITMAP_DEF SCH_SHEET::GetMenuImage ( ) const
overridevirtual

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 from EDA_ITEM.

Definition at line 855 of file sch_sheet.cpp.

856 {
857  return add_hierarchical_subsheet_xpm;
858 }

◆ GetMinHeight()

int SCH_SHEET::GetMinHeight ( ) const

Return the minimum height that the sheet can be resized based on the sheet pin positions.

The minimum width of a sheet is determined by the Y axis location of the bottom most sheet pin. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns
The minimum height the sheet can be resized.

Definition at line 311 of file sch_sheet.cpp.

312 {
313  int height = MIN_SHEET_HEIGHT;
314 
315  for( size_t i = 0; i < m_pins.size(); i++ )
316  {
317  int edge = m_pins[i].GetEdge();
318  EDA_RECT pinRect = m_pins[i].GetBoundingBox();
319 
320  // Make sure pin is on top or bottom side of sheet.
321  if( edge == SHEET_RIGHT_SIDE || edge == SHEET_LEFT_SIDE )
322  {
323  if( height < pinRect.GetBottom() - m_pos.y )
324  height = pinRect.GetBottom() - m_pos.y;
325  }
326  else
327  {
328  if( height < pinRect.GetHeight() )
329  height = pinRect.GetHeight();
330 
331  for( size_t j = 0; j < m_pins.size(); j++ )
332  {
333  // Check for pin directly above or below the current pin.
334  if( (i == j) || (m_pins[i].GetPosition().x != m_pins[j].GetPosition().x) )
335  continue;
336 
337  if( height < pinRect.GetHeight() + m_pins[j].GetBoundingBox().GetHeight() )
338  {
339  height = pinRect.GetHeight() + m_pins[j].GetBoundingBox().GetHeight();
340  break;
341  }
342  }
343  }
344  }
345 
346  return height;
347 }
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
int GetBottom() const
Definition: eda_rect.h:124
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
int GetHeight() const
Definition: eda_rect.h:120
size_t i
Definition: json11.cpp:649
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:43

References EDA_RECT::GetBottom(), EDA_RECT::GetHeight(), i, m_pins, m_pos, MIN_SHEET_HEIGHT, SHEET_LEFT_SIDE, and SHEET_RIGHT_SIDE.

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( ) const

Return the minimum width of the sheet based on the widths of the sheet pin text.

The minimum sheet width is determined by the width of the bounding box of each hierarchical sheet pin. If two pins are horizontally adjacent ( same Y position ) to each other, the sum of the bounding box widths is used. If at some point in the future sheet objects can be rotated or pins can be placed in the vertical orientation, this function will need to be changed.

Returns
The minimum width the sheet can be resized.

Definition at line 271 of file sch_sheet.cpp.

272 {
273  int width = MIN_SHEET_WIDTH;
274 
275  for( size_t i = 0; i < m_pins.size(); i++ )
276  {
277  int edge = m_pins[i].GetEdge();
278  EDA_RECT pinRect = m_pins[i].GetBoundingBox();
279 
280  wxASSERT( edge != SHEET_UNDEFINED_SIDE );
281 
282  if( edge == SHEET_TOP_SIDE || edge == SHEET_BOTTOM_SIDE )
283  {
284  if( width < pinRect.GetRight() - m_pos.x )
285  width = pinRect.GetRight() - m_pos.x;
286  }
287  else
288  {
289  if( width < pinRect.GetWidth() )
290  width = pinRect.GetWidth();
291 
292  for( size_t j = 0; j < m_pins.size(); j++ )
293  {
294  // Check for pin directly across from the current pin.
295  if( (i == j) || (m_pins[i].GetPosition().y != m_pins[j].GetPosition().y) )
296  continue;
297 
298  if( width < pinRect.GetWidth() + m_pins[j].GetBoundingBox().GetWidth() )
299  {
300  width = pinRect.GetWidth() + m_pins[j].GetBoundingBox().GetWidth();
301  break;
302  }
303  }
304  }
305  }
306 
307  return width;
308 }
int GetWidth() const
Definition: eda_rect.h:119
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
int GetRight() const
Definition: eda_rect.h:121
size_t i
Definition: json11.cpp:649
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References EDA_RECT::GetRight(), EDA_RECT::GetWidth(), i, m_pins, m_pos, MIN_SHEET_WIDTH, SHEET_BOTTOM_SIDE, SHEET_TOP_SIDE, and SHEET_UNDEFINED_SIDE.

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetMsgPanelInfo()

void SCH_SHEET::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

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 from EDA_ITEM.

Definition at line 667 of file sch_sheet.cpp.

668 {
669  aList.push_back( MSG_PANEL_ITEM( _( "Sheet Name" ), m_name, CYAN ) );
670  aList.push_back( MSG_PANEL_ITEM( _( "File Name" ), m_fileName, BROWN ) );
671 
672 #if 0 // Set to 1 to display the sheet time stamp (mainly for test)
673  wxString msg;
674  msg.Printf( wxT( "%.8X" ), m_TimeStamp );
675  aList.push_back( MSG_PANEL_ITEM( _( "Time Stamp" ), msg, BLUE ) );
676 #endif
677 }
Definition: colors.h:57
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:181
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
Definition: colors.h:59
#define _(s)
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
Definition: colors.h:62

References _, BLUE, BROWN, CYAN, m_fileName, m_name, and EDA_ITEM::m_TimeStamp.

◆ GetName()

wxString SCH_SHEET::GetName ( void  ) const
inline

◆ GetNetListItem()

void SCH_SHEET::GetNetListItem ( NETLIST_OBJECT_LIST aNetListItems,
SCH_SHEET_PATH aSheetPath 
)
overridevirtual

Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetListItems.

Not all schematic objects have net list items associated with them. This method only needs to be overridden for those schematic objects that have net list objects associated with them.

Reimplemented from SCH_ITEM.

Definition at line 884 of file sch_sheet.cpp.

886 {
887  SCH_SHEET_PATH sheetPath = *aSheetPath;
888  sheetPath.push_back( this );
889 
890  for( size_t i = 0; i < m_pins.size(); i++ )
891  {
892  NETLIST_OBJECT* item = new NETLIST_OBJECT();
893  item->m_SheetPathInclude = sheetPath;
894  item->m_SheetPath = *aSheetPath;
895  item->m_Comp = &m_pins[i];
896  item->m_Link = this;
897  item->m_Type = NET_SHEETLABEL;
898  item->m_Label = m_pins[i].GetText();
899  item->m_Start = item->m_End = m_pins[i].GetPosition();
900  aNetListItems.push_back( item );
901 
902  SCH_CONNECTION conn;
903  if( conn.IsBusLabel( m_pins[i].GetText() ) )
904  item->ConvertBusToNetListItems( aNetListItems );
905  }
906 }
SCH_SHEET_PATH m_SheetPathInclude
static bool IsBusLabel(const wxString &aLabel)
Test if aLabel has a bus notation.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
SCH_SHEET_PATH m_SheetPath
NETLIST_ITEM_T m_Type
EDA_ITEM * m_Comp
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Class SCH_SHEET_PATH.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
size_t i
Definition: json11.cpp:649
SCH_ITEM * m_Link
void ConvertBusToNetListItems(NETLIST_OBJECT_LIST &aNetListItems)
Function ConvertBusToNetListItems breaks the text of a bus label type net list object into as many me...

References NETLIST_OBJECT::ConvertBusToNetListItems(), i, SCH_CONNECTION::IsBusLabel(), NETLIST_OBJECT::m_Comp, NETLIST_OBJECT::m_End, NETLIST_OBJECT::m_Label, NETLIST_OBJECT::m_Link, m_pins, NETLIST_OBJECT::m_SheetPath, NETLIST_OBJECT::m_SheetPathInclude, NETLIST_OBJECT::m_Start, NETLIST_OBJECT::m_Type, NET_SHEETLABEL, and SCH_SHEET_PATH::push_back().

◆ GetParent()

◆ GetPenSize()

int SCH_SHEET::GetPenSize ( ) const
overridevirtual

Function GetPenSize virtual pure.

Returns
the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 393 of file sch_sheet.cpp.

394 {
395  return GetDefaultLineThickness();
396 }
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....

References GetDefaultLineThickness().

Referenced by KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), GetFileNamePosition(), GetSheetNamePosition(), Plot(), and Print().

◆ GetPin()

SCH_SHEET_PIN * SCH_SHEET::GetPin ( const wxPoint &  aPosition)

Return the sheet pin item found at aPosition in the sheet.

Parameters
aPositionThe position to check for a sheet pin.
Returns
The sheet pin found at aPosition or NULL if no sheet pin is found.

Definition at line 381 of file sch_sheet.cpp.

382 {
383  for( SCH_SHEET_PIN& pin : m_pins )
384  {
385  if( pin.HitTest( aPosition ) )
386  return &pin;
387  }
388 
389  return NULL;
390 }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins.

Referenced by SCH_SCREEN::GetItem(), and SCH_SCREEN::GetSheetLabel().

◆ GetPins() [1/2]

◆ GetPins() [2/2]

SCH_SHEET_PINS& SCH_SHEET::GetPins ( ) const
inline

Definition at line 337 of file sch_sheet.h.

338  {
339  return const_cast< SCH_SHEET_PINS& >( m_pins );
340  }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218

References m_pins.

◆ GetPosition()

wxPoint SCH_SHEET::GetPosition ( ) const
inlineoverridevirtual

Function GetPosition.

Returns
A wxPoint object containing the schematic item position.

Implements SCH_ITEM.

Definition at line 543 of file sch_sheet.h.

543 { return m_pos; }
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235

References m_pos.

Referenced by KIGFX::SCH_PAINTER::draw(), GetConnectionPoints(), EDIT_POINTS_FACTORY::Make(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_DRAWING_TOOLS::sizeSheet(), and EE_POINT_EDITOR::updatePoints().

◆ GetRootSheet()

SCH_SHEET * SCH_SHEET::GetRootSheet ( )

Return the root sheet of this SCH_SHEET object.

The root (top level) sheet can be found by walking up the parent links until the only sheet that has no parent is found. The root sheet can be found from any sheet without having to maintain a global root sheet pointer.

Returns
a SCH_SHEET pointer to the root sheet.

Definition at line 136 of file sch_sheet.cpp.

137 {
138  SCH_SHEET* sheet = dynamic_cast< SCH_SHEET* >( GetParent() );
139 
140  if( sheet == NULL )
141  return this;
142 
143  // Recurse until a sheet is found with no parent which is the root sheet.
144  return sheet->GetRootSheet();
145 }
SCH_SHEET * GetRootSheet()
Return the root sheet of this SCH_SHEET object.
Definition: sch_sheet.cpp:136
EDA_ITEM * GetParent() const
Definition: base_struct.h:220
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209

References EDA_ITEM::GetParent(), and GetRootSheet().

Referenced by GetRootSheet(), SCH_EAGLE_PLUGIN::Load(), and SCH_LEGACY_PLUGIN::Load().

◆ GetRotationCenter()

wxPoint SCH_SHEET::GetRotationCenter ( ) const

Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on.

Use this instead, which always returns the center of the sheet itself.

Definition at line 522 of file sch_sheet.cpp.

523 {
524  EDA_RECT box( m_pos, m_size );
525  return box.GetCenter();
526 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References EDA_RECT::GetCenter(), m_pos, and m_size.

Referenced by SCH_EDIT_TOOL::Rotate().

◆ GetScreen()

◆ GetScreenCount()

int SCH_SHEET::GetScreenCount ( ) const

Return the number of times the associated screen for the sheet is being used.

If no screen is associated with the sheet, then zero is returned.

Definition at line 127 of file sch_sheet.cpp.

128 {
129  if( m_screen == NULL )
130  return 0;
131 
132  return m_screen->GetRefCount();
133 }
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
int GetRefCount() const
Definition: sch_screen.h:136

References SCH_SCREEN::GetRefCount(), and m_screen.

Referenced by SCH_EDIT_FRAME::EditSheet().

◆ GetSelectMenuText()

wxString SCH_SHEET::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

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 from EDA_ITEM.

Definition at line 849 of file sch_sheet.cpp.

850 {
851  return wxString::Format( _( "Hierarchical Sheet %s" ), m_name );
852 }
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References _, Format(), and m_name.

Referenced by Matches().

◆ GetSheetNamePosition()

wxPoint SCH_SHEET::GetSheetNamePosition ( )
Returns
the position of the anchor of sheet name text

Definition at line 399 of file sch_sheet.cpp.

400 {
401  wxPoint pos = m_pos;
402  int margin = KiROUND( GetPenSize() / 2.0 + 4 + m_sheetNameSize * 0.3 );
403 
404  if( IsVerticalOrientation() )
405  {
406  pos.x -= margin;
407  pos.y += m_size.y;
408  }
409  else
410  {
411  pos.y -= margin;
412  }
413 
414  return pos;
415 }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:393
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:221
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References GetPenSize(), IsVerticalOrientation(), KiROUND(), m_pos, m_sheetNameSize, and m_size.

Referenced by KIGFX::SCH_PAINTER::draw(), and Print().

◆ GetSheetNameSize()

int SCH_SHEET::GetSheetNameSize ( ) const
inline

Definition at line 275 of file sch_sheet.h.

275 { return m_sheetNameSize; }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229

References m_sheetNameSize.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_LEGACY_PLUGIN::saveSheet(), and DIALOG_SCH_SHEET_PROPS::TransferDataToWindow().

◆ GetSize()

wxSize SCH_SHEET::GetSize ( )
inline

Definition at line 283 of file sch_sheet.h.

283 { return m_size; }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238

References m_size.

Referenced by KIGFX::SCH_PAINTER::draw(), EDIT_POINTS_FACTORY::Make(), SCH_LEGACY_PLUGIN::saveSheet(), and EE_POINT_EDITOR::updatePoints().

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 249 of file base_struct.h.

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

References EDA_ITEM::m_Status.

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

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 262 of file base_struct.h.

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

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 174 of file sch_item.h.

174 { return m_storedPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor)
Definition: sch_item.h:121

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetTimeStamp()

◆ HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS  aFlag)
inlineinherited

◆ HasPin()

bool SCH_SHEET::HasPin ( const wxString &  aName)

Checks if the sheet already has a sheet pin named aName.

Parameters
aNameName of the sheet pin to search for.
Returns
True if sheet pin with aName is found, otherwise false.

Definition at line 209 of file sch_sheet.cpp.

210 {
211  for( const SCH_SHEET_PIN& pin : m_pins )
212  {
213  if( pin.GetText().CmpNoCase( aName ) == 0 )
214  return true;
215  }
216 
217  return false;
218 }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins.

Referenced by SCH_EDIT_FRAME::ImportHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( )
inline

Definition at line 375 of file sch_sheet.h.

375 { return !m_pins.empty(); }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218

References m_pins.

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( )

Check all sheet labels against schematic for undefined hierarchical labels.

Returns
True if there are any undefined labels.

Definition at line 242 of file sch_sheet.cpp.

243 {
244  for( const SCH_SHEET_PIN& pin : m_pins )
245  {
246  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
247  EDA_ITEM* DrawStruct = m_screen->GetDrawItems();
248  const SCH_HIERLABEL* HLabel = NULL;
249 
250  for( ; DrawStruct != NULL; DrawStruct = DrawStruct->Next() )
251  {
252  if( DrawStruct->Type() != SCH_HIER_LABEL_T )
253  continue;
254 
255  HLabel = static_cast<SCH_HIERLABEL*>( DrawStruct );
256 
257  if( pin.GetText().CmpNoCase( HLabel->GetText() ) == 0 )
258  break; // Found!
259 
260  HLabel = NULL;
261  }
262 
263  if( HLabel == NULL ) // Corresponding hierarchical label not found.
264  return true;
265  }
266 
267  return false;
268 }
EDA_ITEM * Next() const
Definition: base_struct.h:218
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References SCH_SCREEN::GetDrawItems(), EDA_TEXT::GetText(), m_pins, m_screen, EDA_ITEM::Next(), SCH_HIER_LABEL_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ HitTest() [1/2]

bool SCH_SHEET::HitTest ( const wxPoint &  aPosition,
int  aAccuracy 
) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 861 of file sch_sheet.cpp.

862 {
863  EDA_RECT rect = GetBoundingBox();
864 
865  rect.Inflate( aAccuracy );
866 
867  return rect.Contains( aPosition );
868 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT const GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_sheet.cpp:488
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), GetBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool SCH_SHEET::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 871 of file sch_sheet.cpp.

872 {
873  EDA_RECT rect = aRect;
874 
875  rect.Inflate( aAccuracy );
876 
877  if( aContained )
878  return rect.Contains( GetBoundingBox() );
879 
880  return rect.Intersects( GetBoundingBox() );
881 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT const GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: sch_sheet.cpp:488
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection ( const SCH_SHEET_PATH aPath)
inherited

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 149 of file sch_item.cpp.

150 {
151  if( Connection( aSheet ) )
152  {
153  Connection( aSheet )->Reset();
154  Connection( aSheet )->SetSheet( aSheet );
155  return Connection( aSheet );
156  }
157 
158  auto connection = new SCH_CONNECTION( this );
159  connection->SetSheet( aSheet );
160  m_connection_map.insert( std::make_pair( aSheet, connection ) );
161  return connection;
162 }
void SetSheet(SCH_SHEET_PATH aSheet)
void Reset()
Clears connectivity information.
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:128
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieves the connection associated with this object in the given sheet.
Definition: sch_item.cpp:128
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), and SCH_CONNECTION::SetSheet().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsConnectable()

bool SCH_SHEET::IsConnectable ( ) const
inlineoverridevirtual

Function IsConnectable returns true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 519 of file sch_sheet.h.

519 { return true; }

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint &  aPoint) const
inherited

Function IsConnected tests the item to see if it is connected to aPoint.

Parameters
aPointA reference to a wxPoint object containing the coordinates to test.
Returns
True if connection to aPoint exists.

Definition at line 119 of file sch_item.cpp.

120 {
121  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
122  return false;
123 
124  return doIsConnected( aPosition );
125 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:129
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:187
virtual bool doIsConnected(const wxPoint &aPosition) const
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:413

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_Flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by SCH_SCREEN::CountConnectedItems(), and SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 355 of file sch_item.h.

355 { return m_connectivity_dirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:131

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, SCH_TEXT, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 290 of file sch_item.h.

290 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 231 of file base_struct.h.

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

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 235 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

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

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Definition at line 181 of file sch_item.h.

181 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

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

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET::IsMovableFromAnchorPoint ( )
inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.

Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, compoments)

Returns
false for a hierarchical sheet

Reimplemented from SCH_ITEM.

Definition at line 270 of file sch_sheet.h.

270 { return false; }

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

bool SCH_SHEET::IsReplaceable ( ) const
inlineoverridevirtual

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 from EDA_ITEM.

Definition at line 496 of file sch_sheet.h.

496 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 234 of file base_struct.h.

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

References IS_RESIZED, and EDA_ITEM::m_Flags.

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

◆ IsSelected()

◆ IsType()

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

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

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

Reimplemented in SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 294 of file base_struct.h.

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

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_SCREEN::GetItem(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 221 of file sch_sheet.cpp.

222 {
223  int leftRight = 0;
224  int topBottom = 0;
225 
226  for( const SCH_SHEET_PIN& pin : m_pins )
227  {
228  switch( pin.GetEdge() )
229  {
230  case SHEET_LEFT_SIDE: leftRight++; break;
231  case SHEET_RIGHT_SIDE: leftRight++; break;
232  case SHEET_TOP_SIDE: topBottom++; break;
233  case SHEET_BOTTOM_SIDE: topBottom++; break;
234  default: break;
235  }
236  }
237 
238  return topBottom > 0 && leftRight == 0;
239 }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, SHEET_BOTTOM_SIDE, SHEET_LEFT_SIDE, SHEET_RIGHT_SIDE, and SHEET_TOP_SIDE.

Referenced by KIGFX::SCH_PAINTER::draw(), GetFileNamePosition(), GetSheetNamePosition(), Plot(), Print(), and SCH_SHEET_PIN::SCH_SHEET_PIN().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 232 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/3]

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

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

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

Definition at line 418 of file base_struct.h.

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

References EDA_ITEM::Pnext, SEARCH_CONTINUE, and SEARCH_QUIT.

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

◆ IterateForward() [2/3]

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

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

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

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

Definition at line 439 of file base_struct.h.

443  {
444  for( auto it : aList )
445  {
446  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes ) == SEARCH_QUIT )
447  return SEARCH_QUIT;
448  }
449 
450  return SEARCH_CONTINUE;
451  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

◆ IterateForward() [3/3]

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

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

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

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

Definition at line 459 of file base_struct.h.

461  {
462  for( auto it : aList )
463  {
464  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
465  == SEARCH_QUIT )
466  return SEARCH_QUIT;
467  }
468 
469  return SEARCH_CONTINUE;
470  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

◆ Load()

virtual bool SCH_ITEM::Load ( LINE_READER aLine,
wxString &  aErrorMsg 
)
inlinevirtualinherited

Function Load reads a schematic item from aLine in a .sch file.

Parameters
aLine- Essentially this is file to read the object from.
aErrorMsg- Description of the error if an error occurs while loading the object.
Returns
True if the object loaded successfully.

Definition at line 260 of file sch_item.h.

260 { return false; }

◆ LocatePathOfScreen()

bool SCH_SHEET::LocatePathOfScreen ( SCH_SCREEN aScreen,
SCH_SHEET_PATH aList 
)

Search the existing hierarchy for an instance of screen loaded from aFileName.

Don't bother looking at the root sheet, it must be unique. No other references to its m_screen otherwise there would be loops in the hierarchy.

Parameters
aScreen= the SCH_SCREEN* screen that we search for
aList= the SCH_SHEET_PATH* that must be used
Returns
true if found

Definition at line 609 of file sch_sheet.cpp.

610 {
611  if( m_screen )
612  {
613  aList->push_back( this );
614 
615  if( m_screen == aScreen )
616  return true;
617 
618  EDA_ITEM* strct = m_screen->GetDrawItems();
619 
620  while( strct )
621  {
622  if( strct->Type() == SCH_SHEET_T )
623  {
624  SCH_SHEET* ss = (SCH_SHEET*) strct;
625 
626  if( ss->LocatePathOfScreen( aScreen, aList ) )
627  return true;
628  }
629 
630  strct = strct->Next();
631  }
632 
633  aList->pop_back();
634  }
635 
636  return false;
637 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
void pop_back()
Forwarded method from std::vector.
EDA_ITEM * Next() const
Definition: base_struct.h:218
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
bool LocatePathOfScreen(SCH_SCREEN *aScreen, SCH_SHEET_PATH *aList)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:609
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References SCH_SCREEN::GetDrawItems(), LocatePathOfScreen(), m_screen, EDA_ITEM::Next(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by LocatePathOfScreen().

◆ Matches() [1/2]

bool SCH_SHEET::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
overridevirtual

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

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 751 of file sch_sheet.cpp.

752 {
753  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( MILLIMETRES ) );
754 
755  // Ignore the sheet file name if searching to replace.
756  if( !(aSearchData.GetFlags() & FR_SEARCH_REPLACE)
757  && SCH_ITEM::Matches( m_fileName, aSearchData ) )
758  {
759  return true;
760  }
761 
762  if( SCH_ITEM::Matches( m_name, aSearchData ) )
763  {
764  return true;
765  }
766 
767  return false;
768 }
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
const wxChar *const traceFindItem
Flag to enable find debug tracing.
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_sheet.cpp:849
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:512

References FR_SEARCH_REPLACE, GetSelectMenuText(), m_fileName, m_name, EDA_ITEM::Matches(), MILLIMETRES, and traceFindItem.

◆ Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 156 of file base_struct.cpp.

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

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

◆ MirrorX()

void SCH_SHEET::MirrorX ( int  aXaxis_position)
overridevirtual

Function MirrorX mirrors item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 704 of file sch_sheet.cpp.

705 {
706  MIRROR( m_pos.y, aXaxis_position );
707  m_pos.y -= m_size.y;
708 
709  for( SCH_SHEET_PIN& sheetPin : m_pins )
710  {
711  sheetPin.MirrorX( aXaxis_position );
712  }
713 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:123
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, m_pos, m_size, and MIRROR().

◆ MirrorY()

void SCH_SHEET::MirrorY ( int  aYaxis_position)
overridevirtual

Function MirrorY mirrors item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 716 of file sch_sheet.cpp.

717 {
718  MIRROR( m_pos.x, aYaxis_position );
719  m_pos.x -= m_size.x;
720 
721  for( SCH_SHEET_PIN& label : m_pins )
722  {
723  label.MirrorY( aYaxis_position );
724  }
725 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:123
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, m_pos, m_size, and MIRROR().

◆ Move()

void SCH_SHEET::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtual

Function Move moves the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 478 of file sch_sheet.h.

479  {
480  m_pos += aMoveVector;
481 
482  for( SCH_SHEET_PIN& pin : m_pins )
483  {
484  pin.Move( aMoveVector );
485  }
486  }
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, and m_pos.

Referenced by SetPosition().

◆ Next()

SCH_ITEM* SCH_ITEM::Next ( ) const
inlineinherited

Definition at line 153 of file sch_item.h.

153 { return static_cast<SCH_ITEM*>( Pnext ); }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:176

References EDA_ITEM::Pnext.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::BreakSegments(), SCH_EDIT_FRAME::BreakSegmentsOnJunctions(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), NETLIST_OBJECT_LIST::BuildNetListInfo(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_SCREEN::CheckIfOnDrawList(), SCH_SCREEN::ClearAnnotation(), SCH_SCREEN::ClearDrawingState(), SCH_SCREEN::CountConnectedItems(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_SCREENS::DeleteAllMarkers(), SCH_EDIT_FRAME::DeleteJunction(), DIALOG_ERC::DisplayERC_MarkersList(), KIGFX::SCH_VIEW::DisplaySheet(), SCH_SCREEN::EnsureAlternateReferencesExist(), SCH_EDITOR_CONTROL::FindComponentAndItem(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_SHEET_PATH::FirstDrawList(), SCH_EDIT_FRAME::FixupJunctions(), SCH_LEGACY_PLUGIN::Format(), get_components(), AUTOPLACER::get_possible_colliders(), SCH_SHEET_PATH::GetComponents(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREEN::GetItem(), SCH_SCREEN::GetLabel(), SCH_SCREENS::GetLibNicknames(), SCH_SCREEN::GetLine(), SCH_SCREENS::GetMarkerCount(), SCH_SHEET_PATH::GetMultiUnitComponents(), SCH_SCREEN::GetPin(), SCH_SCREEN::GetSheet(), getSheetBbox(), SCH_SCREEN::GetSheetLabel(), SCH_LINE_WIRE_BUS_TOOL::getSheetPin(), SCH_SCREEN::GetWireOrBus(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_EDIT_FRAME::ImportHierLabel(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), SCH_SCREEN::IsJunctionNeeded(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), SCH_EAGLE_PLUGIN::moveLabels(), DIALOG_ERC::OnLeftClickMarkersList(), SCH_EDITOR_CONTROL::Paste(), SCH_SCREEN::Plot(), SCH_SCREEN::Print(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_SCREEN::ReplaceWires(), SCH_EDIT_FRAME::SchematicCleanUp(), EE_SELECTION_TOOL::SelectConnection(), SCH_SCREEN::SetComponentFootprint(), SCH_SCREEN::TestDanglingEnds(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), SCH_EDIT_FRAME::TrimWire(), and SCH_EDIT_TOOL::UpdateFields().

◆ operator<() [1/2]

bool SCH_ITEM::operator< ( const SCH_ITEM aItem) const
virtualinherited

Reimplemented in SCH_COMPONENT, and SCH_LINE.

Definition at line 171 of file sch_item.cpp.

172 {
173  wxCHECK_MSG( false, this->Type() < aItem.Type(),
174  wxT( "Less than operator not defined for " ) + GetClass() );
175 }
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:140
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_ITEM::GetClass(), and EDA_ITEM::Type().

◆ operator<() [2/2]

bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

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

Definition at line 210 of file base_struct.cpp.

211 {
212  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
213  GetChars( GetClass() ) ) );
214 
215  return false;
216 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

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

◆ operator=()

SCH_ITEM & SCH_SHEET::operator= ( const SCH_ITEM aSheet)

Definition at line 987 of file sch_sheet.cpp.

988 {
989  wxLogDebug( wxT( "Sheet assignment operator." ) );
990 
991  wxCHECK_MSG( Type() == aItem.Type(), *this,
992  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
993  GetClass() );
994 
995  if( &aItem != this )
996  {
997  SCH_ITEM::operator=( aItem );
998 
999  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
1000 
1001  m_pos = sheet->m_pos;
1002  m_size = sheet->m_size;
1003  m_name = sheet->m_name;
1005  m_fileNameSize = sheet->m_fileNameSize;
1006  m_pins = sheet->m_pins;
1007 
1008  // Ensure sheet labels have their #m_Parent member pointing really on their
1009  // parent, after assigning.
1010  for( SCH_SHEET_PIN& sheetPin : m_pins )
1011  {
1012  sheetPin.SetParent( this );
1013  }
1014  }
1015 
1016  return *this;
1017 }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_sheet.h:256
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SCH_ITEM::GetClass(), GetClass(), m_fileNameSize, m_name, m_pins, m_pos, m_sheetNameSize, m_size, EDA_ITEM::operator=(), and EDA_ITEM::Type().

◆ Plot()

void SCH_SHEET::Plot ( PLOTTER aPlotter)
overridevirtual

Function Plot plots the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 909 of file sch_sheet.cpp.

910 {
911  COLOR4D txtcolor = COLOR4D::UNSPECIFIED;
912  wxSize size;
913  wxString Text;
914  int name_orientation;
915  wxPoint pos_sheetname, pos_filename;
916  wxPoint pos;
917 
918  aPlotter->SetColor( GetLayerColor( GetLayer() ) );
919 
920  int thickness = GetPenSize();
921  aPlotter->SetCurrentLineWidth( thickness );
922 
923  aPlotter->MoveTo( m_pos );
924  pos = m_pos;
925  pos.x += m_size.x;
926 
927  aPlotter->LineTo( pos );
928  pos.y += m_size.y;
929 
930  aPlotter->LineTo( pos );
931  pos = m_pos;
932  pos.y += m_size.y;
933 
934  aPlotter->LineTo( pos );
935  aPlotter->FinishTo( m_pos );
936 
937  if( IsVerticalOrientation() )
938  {
939  pos_sheetname = wxPoint( m_pos.x - 8, m_pos.y + m_size.y );
940  pos_filename = wxPoint( m_pos.x + m_size.x + 4, m_pos.y + m_size.y );
941  name_orientation = TEXT_ANGLE_VERT;
942  }
943  else
944  {
945  pos_sheetname = wxPoint( m_pos.x, m_pos.y - 4 );
946  pos_filename = wxPoint( m_pos.x, m_pos.y + m_size.y + 4 );
947  name_orientation = TEXT_ANGLE_HORIZ;
948  }
949 
950  /* Draw texts: SheetName */
951  Text = m_name;
952  size = wxSize( m_sheetNameSize, m_sheetNameSize );
953 
954  //pos = m_pos; pos.y -= 4;
955  thickness = GetDefaultLineThickness();
956  thickness = Clamp_Text_PenSize( thickness, size, false );
957 
958  aPlotter->SetColor( GetLayerColor( LAYER_SHEETNAME ) );
959 
960  bool italic = false;
961  aPlotter->Text( pos_sheetname, txtcolor, wxT( "Sheet: " ) + Text, name_orientation, size,
963  thickness, italic, false );
964 
965  /*Draw texts : FileName */
966  Text = GetFileName();
967  size = wxSize( m_fileNameSize, m_fileNameSize );
968  thickness = GetDefaultLineThickness();
969  thickness = Clamp_Text_PenSize( thickness, size, false );
970 
972 
973  aPlotter->Text( pos_filename, txtcolor, wxT( "File: " ) + Text, name_orientation, size,
975  thickness, italic, false );
976 
977  aPlotter->SetColor( GetLayerColor( GetLayer() ) );
978 
979  /* Draw texts : SheetLabel */
980  for( size_t i = 0; i < m_pins.size(); i++ )
981  {
982  m_pins[i].Plot( aPlotter );
983  }
984 }
#define TEXT_ANGLE_HORIZ
void FinishTo(const wxPoint &pos)
Definition: plotter.h:264
#define TEXT_ANGLE_VERT
virtual void SetColor(COLOR4D color)=0
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:393
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: gr_text.cpp:215
void LineTo(const wxPoint &pos)
Definition: plotter.h:259
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:64
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
wxString GetFileName(void) const
Return the filename corresponding to this sheet.
Definition: sch_sheet.cpp:661
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
void MoveTo(const wxPoint &pos)
Definition: plotter.h:254
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:221
size_t i
Definition: json11.cpp:649
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References Clamp_Text_PenSize(), PLOTTER::FinishTo(), GetDefaultLineThickness(), GetFileName(), SCH_ITEM::GetLayer(), GetLayerColor(), GetPenSize(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, i, IsVerticalOrientation(), LAYER_SHEETFILENAME, LAYER_SHEETNAME, PLOTTER::LineTo(), m_fileNameSize, m_name, m_pins, m_pos, m_sheetNameSize, m_size, PLOTTER::MoveTo(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), PLOTTER::Text(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

◆ Print()

void SCH_SHEET::Print ( wxDC *  aDC,
const wxPoint &  aOffset 
)
overridevirtual

Function Print Print a schematic item.

Each schematic item should have its own method

Parameters
aDCDevice Context (can be null)
aOffsetdrawing Offset (usually wxPoint(0,0), but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 447 of file sch_sheet.cpp.

448 {
449  wxString Text;
450  int name_orientation;
451  wxPoint pos_sheetname,pos_filename;
452  wxPoint pos = m_pos + aOffset;
453  int lineWidth = GetPenSize();
454  int textWidth;
455  wxSize textSize;
457 
458  GRRect( nullptr, aDC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, lineWidth, color );
459 
460  pos_sheetname = GetSheetNamePosition() + aOffset;
461  pos_filename = GetFileNamePosition() + aOffset;
462 
463  if( IsVerticalOrientation() )
464  name_orientation = TEXT_ANGLE_VERT;
465  else
466  name_orientation = TEXT_ANGLE_HORIZ;
467 
468  /* Draw text : SheetName */
469  Text = wxT( "Sheet: " ) + m_name;
470  textSize = wxSize( m_sheetNameSize, m_sheetNameSize );
471  textWidth = Clamp_Text_PenSize( lineWidth, textSize, false );
472  GRText( aDC, pos_sheetname, GetLayerColor( LAYER_SHEETNAME ), Text, name_orientation,
473  textSize, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, textWidth, false, false );
474 
475  /* Draw text : FileName */
476  Text = wxT( "File: " ) + m_fileName;
477  textSize = wxSize( m_fileNameSize, m_fileNameSize );
478  textWidth = Clamp_Text_PenSize( lineWidth, textSize, false );
479  GRText( aDC, pos_filename, GetLayerColor( LAYER_SHEETFILENAME ), Text, name_orientation,
480  textSize, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_TOP, textWidth, false, false );
481 
482  /* Draw text : SheetLabel */
483  for( SCH_SHEET_PIN& sheetPin : m_pins )
484  sheetPin.Print( aDC, aOffset );
485 }
#define TEXT_ANGLE_HORIZ
SCH_LAYER_ID m_Layer
Definition: sch_item.h:119
#define TEXT_ANGLE_VERT
int color
Definition: DXF_plotter.cpp:62
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:393
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:843
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:64
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
wxPoint GetFileNamePosition()
Definition: sch_sheet.cpp:418
void GRText(wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Function GRText Draw a graphic text (like module texts)
Definition: gr_text.cpp:126
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:221
wxPoint GetSheetNamePosition()
Definition: sch_sheet.cpp:399
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References Clamp_Text_PenSize(), color, GetFileNamePosition(), GetLayerColor(), GetPenSize(), GetSheetNamePosition(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, GRRect(), GRText(), IsVerticalOrientation(), LAYER_SHEETFILENAME, LAYER_SHEETNAME, m_fileName, m_fileNameSize, SCH_ITEM::m_Layer, m_name, m_pins, m_pos, m_sheetNameSize, m_size, TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

◆ RemovePin()

void SCH_SHEET::RemovePin ( SCH_SHEET_PIN aSheetPin)

Remove aSheetPin from the sheet.

Parameters
aSheetPinThe sheet pin item to remove from the sheet.

Definition at line 187 of file sch_sheet.cpp.

188 {
189  wxASSERT( aSheetPin != NULL );
190  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
191 
192  SCH_SHEET_PINS::iterator i;
193 
194  for( i = m_pins.begin(); i < m_pins.end(); ++i )
195  {
196  if( *i == aSheetPin )
197  {
198  m_pins.erase( i );
199  renumberPins();
200  return;
201  }
202  }
203 
204  wxLogDebug( wxT( "Fix me: attempt to remove label %s which is not in sheet %s." ),
205  GetChars( aSheetPin->GetShownText() ), GetChars( m_name ) );
206 }
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:777
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
size_t i
Definition: json11.cpp:649
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:129
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References GetChars(), EDA_TEXT::GetShownText(), i, m_name, m_pins, renumberPins(), SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by SCH_SCREEN::DeleteItem(), and SCH_EDIT_TOOL::DoDelete().

◆ renumberPins()

void SCH_SHEET::renumberPins ( )
protected

Renumber the sheet pins in the sheet.

This method is used internally by SCH_SHEET to update the pin numbering when the pin list changes. Make sure you call this method any time a sheet pin is added or removed.

Definition at line 777 of file sch_sheet.cpp.

778 {
779  int id = 2;
780 
781  for( SCH_SHEET_PIN& pin : m_pins )
782  {
783  pin.SetNumber( id );
784  id++;
785  }
786 }
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

bool SCH_SHEET::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
overridevirtual

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 from EDA_ITEM.

Definition at line 771 of file sch_sheet.cpp.

772 {
773  return EDA_ITEM::Replace( aSearchData, m_name );
774 }
static bool Replace(wxFindReplaceData &aSearchData, wxString &aText)
Helper function used in search and replace dialog Function Replace performs a text replace on aText u...
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226

References m_name, and EDA_ITEM::Replace().

◆ Replace() [2/2]

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

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

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

Definition at line 183 of file base_struct.cpp.

184 {
185  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
186 
187  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
188  aSearchData.GetFindString() :
189  aSearchData.GetFindString().Upper() );
190 
191  if( result == wxNOT_FOUND )
192  return false;
193 
194  wxString prefix = aText.Left( result );
195  wxString suffix;
196 
197  if( aSearchData.GetFindString().length() + result < aText.length() )
198  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
199 
200  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
201  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
202  GetChars( suffix ) );
203 
204  aText = prefix + aSearchData.GetReplaceString() + suffix;
205 
206  return true;
207 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References GetChars(), and traceFindReplace.

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

◆ Resize()

void SCH_SHEET::Resize ( const wxSize &  aSize)

Resize this sheet to aSize and adjust all of the labels accordingly.

Parameters
aSize- The new size for this sheet.

Definition at line 736 of file sch_sheet.cpp.

737 {
738  if( aSize == m_size )
739  return;
740 
741  m_size = aSize;
742 
743  /* Move the sheet labels according to the new sheet size. */
744  for( SCH_SHEET_PIN& label : m_pins )
745  {
746  label.ConstrainOnEdge( label.GetPosition() );
747  }
748 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, and m_size.

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ Rotate()

void SCH_SHEET::Rotate ( wxPoint  aPosition)
overridevirtual

Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to rotate around.

Implements SCH_ITEM.

Definition at line 680 of file sch_sheet.cpp.

681 {
682  RotatePoint( &m_pos, aPosition, 900 );
683  RotatePoint( &m_size.x, &m_size.y, 900 );
684 
685  if( m_size.x < 0 )
686  {
687  m_pos.x += m_size.x;
688  m_size.x = -m_size.x;
689  }
690 
691  if( m_size.y < 0 )
692  {
693  m_pos.y += m_size.y;
694  m_size.y = -m_size.y;
695  }
696 
697  for( SCH_SHEET_PIN& sheetPin : m_pins )
698  {
699  sheetPin.Rotate( aPosition );
700  }
701 }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:206
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References m_pins, m_pos, m_size, and RotatePoint().

Referenced by SCH_EDIT_TOOL::Rotate().

◆ SearchHierarchy()

bool SCH_SHEET::SearchHierarchy ( const wxString &  aFilename,
SCH_SCREEN **  aScreen 
)

Search the existing hierarchy for an instance of screen loaded from aFileName.

Parameters
aFilename= the filename to find (MUST be absolute, and in wxPATH_NATIVE encoding)
aScreen= a location to return a pointer to the screen (if found)
Returns
bool if found, and a pointer to the screen

Definition at line 559 of file sch_sheet.cpp.

560 {
561  SCH_SHEET* sheet = nullptr;
562  SCH_SCREEN* screen = nullptr;
563 
564  if( m_screen )
565  {
566  // Only check the root sheet once and don't recurse.
567  if( !GetParent() )
568  {
569  sheet = this;
570  screen = m_screen;
571 
572  if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
573  {
574  *aScreen = screen;
575  return true;
576  }
577  }
578 
579  EDA_ITEM* item = m_screen->GetDrawItems();
580 
581  while( item )
582  {
583  if( item->Type() == SCH_SHEET_T )
584  {
585  // Must use the screen's path (which is always absolute) rather than the
586  // sheet's (which could be relative).
587  sheet = static_cast< SCH_SHEET* >( item );
588  screen = sheet->m_screen;
589 
590  if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
591  {
592  *aScreen = screen;
593  return true;
594  }
595  else if( sheet->SearchHierarchy( aFilename, aScreen ) )
596  {
597  return true;
598  }
599  }
600 
601  item = item->Next();
602  }
603  }
604 
605  return false;
606 }
const wxString & GetFileName() const
Definition: sch_screen.h:123
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:559
EDA_ITEM * Next() const
Definition: base_struct.h:218
EDA_ITEM * GetParent() const
Definition: base_struct.h:220
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:152

References SCH_SCREEN::GetDrawItems(), SCH_SCREEN::GetFileName(), EDA_ITEM::GetParent(), m_screen, EDA_ITEM::Next(), SCH_SHEET_T, SearchHierarchy(), and EDA_ITEM::Type().

Referenced by SCH_EDIT_FRAME::EditSheet(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDITOR_CONTROL::Paste(), and SearchHierarchy().

◆ SetBack()

void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 224 of file base_struct.h.

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

References EDA_ITEM::Pback.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 241 of file base_struct.h.

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

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool  aDirty = true)
inlineinherited

Definition at line 357 of file sch_item.h.

357 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
True if connectivity info might be out of date.
Definition: sch_item.h:131

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetFileName()

void SCH_SHEET::SetFileName ( const wxString &  aFilename)
inline

Definition at line 467 of file sch_sheet.h.

468  {
469  m_fileName = aFilename;
470  // Filenames are stored using unix notation
471  m_fileName.Replace( wxT("\\"), wxT("/") );
472  }
wxString m_fileName
The file name is also in the SCH_SCREEN object associated with the sheet.
Definition: sch_sheet.h:222

References m_fileName.

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

◆ SetFileNameSize()

void SCH_SHEET::SetFileNameSize ( int  aSize)
inline

Definition at line 279 of file sch_sheet.h.

279 { m_fileNameSize = aSize; }
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232

References m_fileNameSize.

Referenced by SCH_EDIT_FRAME::EditSheet().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 265 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 316 of file base_struct.h.

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

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 240 of file base_struct.h.

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

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Function SetLayer sets the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 200 of file sch_item.h.

200 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:119

References SCH_ITEM::m_Layer.

Referenced by SCH_COMPONENT::Init(), SCH_FIELD::SCH_FIELD(), and SCH_NO_CONNECT::SCH_NO_CONNECT().

◆ SetList()

void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 226 of file base_struct.h.

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

References EDA_ITEM::m_List.

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

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Function SetLocked modifies 'lock' status for of the item.

Definition at line 187 of file sch_item.h.

187 {}

◆ SetModified()

◆ SetName()

void SCH_SHEET::SetName ( const wxString &  aName)
inline

Definition at line 273 of file sch_sheet.h.

273 { m_name = aName; }
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226

References m_name.

Referenced by SCH_EDIT_TOOL::Duplicate(), SCH_EDIT_FRAME::EditSheet(), SCH_EDIT_FRAME::LoadSheetFromFile(), and SCH_EDITOR_CONTROL::Paste().

◆ SetNext()

void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 223 of file base_struct.h.

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

References EDA_ITEM::Pnext.

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

◆ SetParent()

◆ SetPosition()

void SCH_SHEET::SetPosition ( const wxPoint &  aPosition)
overridevirtual

Function SetPosition set the schematic item position to aPosition.

Parameters
aPositionA reference to a wxPoint object containing the new position.

Implements SCH_ITEM.

Definition at line 727 of file sch_sheet.cpp.

728 {
729  // Remember the sheet and all pin sheet positions must be
730  // modified. So use Move function to do that.
731  Move( aPosition - m_pos );
732 }
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_sheet.h:478

References m_pos, and Move().

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetScreen()

void SCH_SHEET::SetScreen ( SCH_SCREEN aScreen)

Set the SCH_SCREEN associated with this sheet to aScreen.

The screen reference counting is performed by SetScreen. If aScreen is not the same as the current screen, the current screen reference count is decremented and aScreen becomes the screen for the sheet. If the current screen reference count reaches zero, the current screen is deleted. NULL is a valid value for aScreen.

Parameters
aScreenThe new screen to associate with the sheet.

Definition at line 104 of file sch_sheet.cpp.

105 {
106  if( aScreen == m_screen )
107  return;
108 
109  if( m_screen != NULL )
110  {
112 
113  if( m_screen->GetRefCount() == 0 )
114  {
115  delete m_screen;
116  m_screen = NULL;
117  }
118  }
119 
120  m_screen = aScreen;
121 
122  if( m_screen )
124 }
void DecRefCount()
Definition: sch_screen.cpp:151
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:215
void IncRefCount()
Definition: sch_screen.cpp:145
int GetRefCount() const
Definition: sch_screen.h:136

References SCH_SCREEN::DecRefCount(), SCH_SCREEN::GetRefCount(), SCH_SCREEN::IncRefCount(), and m_screen.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_FRAME::EditSheet(), SCH_EDIT_FRAME::InitSheet(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), and SCH_EDITOR_CONTROL::Paste().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetSheetNameSize()

void SCH_SHEET::SetSheetNameSize ( int  aSize)
inline

Definition at line 276 of file sch_sheet.h.

276 { m_sheetNameSize = aSize; }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229

References m_sheetNameSize.

Referenced by SCH_EDIT_FRAME::EditSheet().

◆ SetSize()

void SCH_SHEET::SetSize ( const wxSize &  aSize)
inline

Definition at line 284 of file sch_sheet.h.

284 { m_size = aSize; }
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238

References m_size.

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetState()

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

Definition at line 254 of file base_struct.h.

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

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 263 of file base_struct.h.

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

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 175 of file sch_item.h.

175 { m_storedPos = aPos; }
wxPoint m_storedPos
a temporary variable used in some move commands to store a initial pos (of the item or mouse cursor)
Definition: sch_item.h:121

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::moveItem().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 215 of file base_struct.h.

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

References EDA_ITEM::m_TimeStamp.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 238 of file base_struct.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 575 of file base_struct.h.

575 { return *aLeft < *aRight; }

◆ SwapData()

void SCH_SHEET::SwapData ( SCH_ITEM aItem)
overridevirtual

Function SwapData swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me

Parameters
aItemThe item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 148 of file sch_sheet.cpp.

149 {
150  wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
151  wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
152  GetChars( aItem->GetClass() ) ) );
153 
154  SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
155 
156  std::swap( m_pos, sheet->m_pos );
157  std::swap( m_size, sheet->m_size );
158  std::swap( m_name, sheet->m_name );
159  std::swap( m_sheetNameSize, sheet->m_sheetNameSize );
160  std::swap( m_fileNameSize, sheet->m_fileNameSize );
161  m_pins.swap( sheet->m_pins );
162 
163  // Ensure sheet labels have their .m_Parent member pointing really on their
164  // parent, after swapping.
165  for( SCH_SHEET_PIN& sheetPin : m_pins )
166  {
167  sheetPin.SetParent( this );
168  }
169 
170  for( SCH_SHEET_PIN& sheetPin : sheet->m_pins )
171  {
172  sheetPin.SetParent( sheet );
173  }
174 }
int m_sheetNameSize
The height of the text used to draw the sheet name.
Definition: sch_sheet.h:229
wxSize m_size
The size of the sheet.
Definition: sch_sheet.h:238
wxString m_name
This is equivalent to the reference designator for components and is stored in F0 sheet pin in the sc...
Definition: sch_sheet.h:226
wxPoint m_pos
The position of the sheet.
Definition: sch_sheet.h:235
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:225
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:209
int m_fileNameSize
The height of the text used to draw the file name.
Definition: sch_sheet.h:232
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
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
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:140
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References Format(), GetChars(), SCH_ITEM::GetClass(), m_fileNameSize, m_name, m_pins, m_pos, m_sheetNameSize, m_size, SCH_SHEET_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 210 of file base_struct.h.

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

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_NO_CONNECT::ClassOf(), TEXTE_PCB::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), ZONE_CONTAINER::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_TEXT::ClassOf(), SCH_SCREEN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), D_PAD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_LABEL::ClassOf(), ClassOf(), SCH_GLOBALLABEL::ClassOf(), VIA::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), CleanupSheet(), EE_COLLECTOR::Collect(), LIB_RECTANGLE::compare(), LIB_CIRCLE::compare(), LIB_BEZIER::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), ComponentCount(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_EDIT_FRAME::ConvertTextType(), SCH_SCREEN::CountConnectedItems(), CountSheets(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), D_PAD::D_PAD(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_ERC::DisplayERC_MarkersList(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckLabels(), SCH_EDITOR_CONTROL::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), EDIT_TOOL::FootprintFilter(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), GetEndPoints(), SCH_SCREEN::GetHierarchicalItems(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), HasUndefinedPins(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), LocatePathOfScreen(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_SCREEN::ReplaceWires(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), VIA::SwapData(), SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TestDuplicateSheetNames(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UpdateDanglingState()

bool SCH_SHEET::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList)
overridevirtual

Function IsDanglingStateChanged tests the schematic item to aItemList to check if it's dangling state has changed.

Note that the return value only true when the state of the test has changed. Use the IsDangling() method to get the current dangling state of the item. Some of the schematic objects cannot be tested for a dangling state, the default method always returns false. Only override the method if the item can be tested for a dangling state.

Parameters
aItemList- List of items to test item against.
Returns
True if the dangling state has changed from it's current setting.

Reimplemented from SCH_ITEM.

Definition at line 803 of file sch_sheet.cpp.

804 {
805  bool changed = false;
806 
807  for( SCH_SHEET_PIN& pinsheet : GetPins() )
808  changed |= pinsheet.UpdateDanglingState( aItemList );
809 
810  return changed;
811 }
SCH_SHEET_PINS & GetPins()
Definition: sch_sheet.h:335
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75

References GetPins().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 236 of file base_struct.cpp.

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

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

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

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

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

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

Definition at line 116 of file view_item.h.

117  {}

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

◆ ViewGetLayers()

void SCH_SHEET::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtual

Function ViewGetLayers returns the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 437 of file sch_sheet.cpp.

References LAYER_HIERLABEL, LAYER_SELECTION_SHADOWS, LAYER_SHEET, and LAYER_SHEET_BACKGROUND.

◆ ViewGetLOD()

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

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

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

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

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

Definition at line 140 of file view_item.h.

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

Referenced by KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

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

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 821 of file sch_sheet.cpp.

822 {
823  KICAD_T stype;
824 
825  for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
826  {
827  // If caller wants to inspect my type
828  if( stype == SCH_LOCATE_ANY_T || stype == Type() )
829  {
830  if( SEARCH_QUIT == aInspector( this, NULL ) )
831  return SEARCH_QUIT;
832  }
833 
834  if( stype == SCH_LOCATE_ANY_T || stype == SCH_SHEET_PIN_T )
835  {
836  // Test the sheet labels.
837  for( size_t i = 0; i < m_pins.size(); i++ )
838  {
839  if( SEARCH_QUIT == aInspector( &m_pins[ i ], this ) )
840  return SEARCH_QUIT;
841  }
842  }
843  }
844 
845  return SEARCH_CONTINUE;
846 }
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
SCH_SHEET_PINS m_pins
The list of sheet connection points.
Definition: sch_sheet.h:218
size_t i
Definition: json11.cpp:649
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References EOT, i, m_pins, SCH_LOCATE_ANY_T, SCH_SHEET_PIN_T, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

Friends And Related Function Documentation

◆ SCH_SHEET_PIN

friend class SCH_SHEET_PIN
friend

Definition at line 211 of file sch_sheet.h.

Member Data Documentation

◆ m_connected_items

std::unordered_set<SCH_ITEM*> SCH_ITEM::m_connected_items
protectedinherited

Stores pointers to other items that are connected to this one (schematic only)

Definition at line 125 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ConnectedItems(), SCH_LINE::GetMsgPanelInfo(), SCH_LABEL::IsType(), and SCH_TEXT::UpdateDanglingState().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map
protectedinherited

Stores connectivity information, per sheet.

Definition at line 128 of file sch_item.h.

Referenced by SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), and SCH_ITEM::~SCH_ITEM().

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections
protectedinherited

List of items connected to this item.

Definition at line 120 of file sch_item.h.

Referenced by SCH_ITEM::ClearConnections(), and SCH_ITEM::~SCH_ITEM().

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty
protectedinherited

True if connectivity info might be out of date.

Definition at line 131 of file sch_item.h.

Referenced by SCH_ITEM::IsConnectivityDirty(), SCH_ITEM::SCH_ITEM(), and SCH_ITEM::SetConnectivityDirty().

◆ m_fileName

wxString SCH_SHEET::m_fileName
private

The file name is also in the SCH_SCREEN object associated with the sheet.

It is also needed here for loading after reading the sheet description from file.

Definition at line 222 of file sch_sheet.h.

Referenced by GetBoundingBox(), GetFileName(), GetMsgPanelInfo(), Matches(), Print(), SCH_SHEET(), and SetFileName().

◆ m_fileNameSize

int SCH_SHEET::m_fileNameSize
private

The height of the text used to draw the file name.

Definition at line 232 of file sch_sheet.h.

Referenced by GetBoundingBox(), GetFileNamePosition(), GetFileNameSize(), operator=(), Plot(), Print(), SCH_SHEET(), SetFileNameSize(), and SwapData().

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 184 of file base_struct.h.

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

◆ m_Layer

◆ m_List

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 178 of file base_struct.h.

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

◆ m_name

wxString SCH_SHEET::m_name
private

This is equivalent to the reference designator for components and is stored in F0 sheet pin in the schematic file.

Definition at line 226 of file sch_sheet.h.

Referenced by GetBoundingBox(), GetMsgPanelInfo(), GetName(), GetSelectMenuText(), Matches(), operator=(), Plot(), Print(), RemovePin(), Replace(), SCH_SHEET(), SetName(), and SwapData().

◆ m_Parent

◆ m_pins

◆ m_pos

◆ m_screen

SCH_SCREEN* SCH_SHEET::m_screen
private

Screen that contains the physical data for the sheet.

In complex hierarchies multiple sheets can share a common screen.

Definition at line 215 of file sch_sheet.h.

Referenced by CleanupSheet(), ComponentCount(), CountSheets(), GetScreen(), GetScreenCount(), HasUndefinedPins(), LocatePathOfScreen(), SCH_SHEET(), SearchHierarchy(), SetScreen(), and ~SCH_SHEET().

◆ m_sheetNameSize

int SCH_SHEET::m_sheetNameSize
private

The height of the text used to draw the sheet name.

Definition at line 229 of file sch_sheet.h.

Referenced by GetBoundingBox(), GetSheetNamePosition(), GetSheetNameSize(), operator=(), Plot(), Print(), SCH_SHEET(), SetSheetNameSize(), and SwapData().

◆ m_size

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

a temporary variable used in some move commands

to store a initial pos (of the item or mouse cursor)

Definition at line 121 of file sch_item.h.

Referenced by SCH_ITEM::GetStoredPos(), and SCH_ITEM::SetStoredPos().

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ Pback

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

◆ Pnext


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