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...
 
std::vector< SCH_FIELD > & GetFields ()
 
void SetFields (const std::vector< SCH_FIELD > &aFields)
 Set multiple schematic fields. More...
 
wxString GetName () const
 
SCH_SCREENGetScreen ()
 
wxSize GetSize ()
 
void SetSize (const wxSize &aSize)
 
int GetBorderWidth () const
 
void SetBorderWidth (int aWidth)
 
KIGFX::COLOR4D GetBorderColor () const
 
void SetBorderColor (KIGFX::COLOR4D aColor)
 
KIGFX::COLOR4D GetBackgroundColor () const
 
void SetBackgroundColor (KIGFX::COLOR4D aColor)
 
bool UsesDefaultStroke () const
 Test this sheet to see if the default stroke is used to draw the outline. More...
 
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 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...
 
std::vector< SCH_SHEET_PIN * > & GetPins ()
 
std::vector< SCH_SHEET_PIN * > & GetPins () 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...
 
const EDA_RECT GetBodyBoundingBox () const
 Return a bounding box for the sheet body but not the fields. More...
 
const EDA_RECT 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 () const
 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 () const
 Return the filename corresponding to this sheet. More...
 
void SetFileName (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 IsReplaceable () const override
 Function IsReplaceable. More...
 
void Resize (const wxSize &aSize)
 Resize this sheet to aSize and adjust all of the labels accordingly. More...
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
 
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, const SCH_SHEET_PATH *aPath=nullptr) 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 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_SHEEToperator= (const SCH_ITEM &aSheet)
 
bool operator< (const SCH_ITEM &aItem) const override
 
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_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPointGetStoredPos ()
 
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 Note: the returned value can be nullptr. More...
 
ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, 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
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Function Type() More...
 
EDA_ITEMGetParent () const
 
void SetParent (EDA_ITEM *aParent)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual 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 const wxString GetDefaultFieldName (int aFieldNdx)
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

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
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, ITEM_SETm_connected_items
 Stores pointers to other items that are connected to this one, per sheet. 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_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

bool doIsConnected (const wxPoint &aPosition) const override
 Function doIsConnected provides the object specific test to see if it is connected to aPosition. More...
 

Private Attributes

SCH_SCREENm_screen
 Screen that contains the physical data for the sheet. More...
 
std::vector< SCH_SHEET_PIN * > m_pins
 The list of sheet connection points. More...
 
std::vector< SCH_FIELDm_fields
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_pos
 
wxSize m_size
 
int m_borderWidth
 
KIGFX::COLOR4D m_borderColor
 
KIGFX::COLOR4D m_backgroundColor
 

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 215 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 70 of file sch_sheet.cpp.

70  :
72 {
74  m_pos = pos;
75  m_size = wxSize( Mils2iu( MIN_SHEET_WIDTH ), Mils2iu( MIN_SHEET_HEIGHT ) );
76  m_screen = NULL;
77 
78  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
79  {
80  m_fields.emplace_back( pos, i, this, GetDefaultFieldName( i ) );
81  m_fields.back().SetVisible( true );
82 
83  if( i == SHEETNAME )
84  m_fields.back().SetLayer( LAYER_SHEETNAME );
85  else if( i == SHEETFILENAME )
86  m_fields.back().SetLayer( LAYER_SHEETFILENAME );
87  else
88  m_fields.back().SetLayer( LAYER_SHEETFIELDS );
89  }
90 
92 
96 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:152
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:70
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:308
#define NULL
int m_borderWidth
Definition: sch_sheet.h:232
static const wxString GetDefaultFieldName(int aFieldNdx)
Definition: sch_sheet.cpp:43
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:43
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:46

References FIELDS_AUTOPLACED_AUTO, GetDefaultFieldName(), GetDefaultLineThickness(), LAYER_SHEET, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETNAME, m_backgroundColor, m_borderColor, m_borderWidth, m_fields, m_fieldsAutoplaced, SCH_ITEM::m_Layer, m_pos, m_screen, m_size, MIN_SHEET_HEIGHT, MIN_SHEET_WIDTH, NULL, SHEET_MANDATORY_FIELDS, SHEETFILENAME, SHEETNAME, and KIGFX::COLOR4D::UNSPECIFIED.

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 99 of file sch_sheet.cpp.

99  :
100  SCH_ITEM( aSheet )
101 {
102  m_pos = aSheet.m_pos;
103  m_size = aSheet.m_size;
104  m_Layer = aSheet.m_Layer;
105  const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
106  m_fields = aSheet.m_fields;
108  m_screen = aSheet.m_screen;
109 
110  for( SCH_SHEET_PIN* pin : aSheet.m_pins )
111  {
112  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
113  m_pins.back()->SetParent( this );
114  }
115 
116  m_borderWidth = aSheet.m_borderWidth;
117  m_borderColor = aSheet.m_borderColor;
119 
120  if( m_screen )
122 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:152
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:217
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
int m_borderWidth
Definition: sch_sheet.h:232
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
const KIID m_Uuid
Definition: base_struct.h:169
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
void IncRefCount()
Definition: sch_screen.cpp:161
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:46

References SCH_SCREEN::IncRefCount(), m_backgroundColor, m_borderColor, m_borderWidth, m_fields, m_fieldsAutoplaced, SCH_ITEM::m_Layer, m_pins, m_pos, m_screen, m_size, EDA_ITEM::m_Uuid, and SCH_SHEET_PIN.

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 125 of file sch_sheet.cpp.

126 {
127  // also, look at the associated sheet & its reference count
128  // perhaps it should be deleted also.
129  if( m_screen )
130  {
132 
133  if( m_screen->GetRefCount() == 0 )
134  delete m_screen;
135  }
136 
137  // We own our pins; delete them
138  for( SCH_SHEET_PIN* pin : m_pins )
139  delete pin;
140 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
void DecRefCount()
Definition: sch_screen.cpp:167
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
int GetRefCount() const
Definition: sch_screen.h:170

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

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH aPath,
SCH_ITEM aItem 
)
inherited

Adds a connection link between this item and another.

Definition at line 144 of file sch_item.cpp.

145 {
146  m_connected_items[ aSheet ].insert( aItem );
147 }
std::unordered_map< SCH_SHEET_PATH, ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:159

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 230 of file sch_sheet.cpp.

231 {
232  wxASSERT( aSheetPin != NULL );
233  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
234 
235  m_pins.push_back( aSheetPin );
236  renumberPins();
237 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:771
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

Fields that have been moved by hand are not automatically placed.

Parameters
aScreenis the SCH_SCREEN associated with the current instance of the component.

Definition at line 419 of file sch_item.h.

420  {
421  if( GetFieldsAutoplaced() )
423  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:404
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:425

References SCH_ITEM::AutoplaceFields(), FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::GetFieldsAutoplaced().

Referenced by SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

void SCH_SHEET::AutoplaceFields ( SCH_SCREEN aScreen,
bool  aManual 
)
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 451 of file sch_sheet.cpp.

452 {
453  wxASSERT_MSG( !aManual, "manual autoplacement not currently supported for sheets" );
454 
455  wxSize textSize = m_fields[ SHEETNAME ].GetTextSize();
456  int margin = KiROUND( GetPenSize() / 2.0 + 4 + std::max( textSize.x, textSize.y ) * 0.5 );
457 
458  if( IsVerticalOrientation() )
459  {
460  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( -margin, m_size.y ) );
461  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
462  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
463  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_VERT );
464  }
465  else
466  {
467  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( 0, -margin ) );
468  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
469  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
470  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
471  }
472 
473  textSize = m_fields[ SHEETFILENAME ].GetTextSize();
474  margin = KiROUND( GetPenSize() / 2.0 + 4 + std::max( textSize.x, textSize.y ) * 0.4 );
475 
476  if( IsVerticalOrientation() )
477  {
478  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( m_size.x + margin, m_size.y ) );
479  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
480  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
481  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_VERT );
482  }
483  else
484  {
485  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( 0, m_size.y + margin ) );
486  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
487  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
488  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
489  }
490 
492 }
#define TEXT_ANGLE_HORIZ
#define TEXT_ANGLE_VERT
wxSize m_size
Definition: sch_sheet.h:230
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:445
wxPoint m_pos
Definition: sch_sheet.h:229
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:284
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227

References FIELDS_AUTOPLACED_AUTO, GetPenSize(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, IsVerticalOrientation(), KiROUND(), m_fields, m_fieldsAutoplaced, m_pos, m_size, SHEETFILENAME, SHEETNAME, TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by SCH_DRAWING_TOOLS::DrawSheet(), Resize(), Rotate(), and EE_POINT_EDITOR::updateItem().

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 541 of file sch_sheet.h.

542  {
543  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
544  ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS ) ||
545  ( aItem->Type() == SCH_NO_CONNECT_T );
546  }
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:224
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

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 399 of file sch_item.h.

399 { return false; }

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ ClassOf()

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

Definition at line 247 of file sch_sheet.h.

248  {
249  return aItem && SCH_SHEET_T == aItem->Type();
250  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

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 407 of file sch_sheet.cpp.

408 {
409  auto i = m_pins.begin();
410 
411  while( i != m_pins.end() )
412  {
413  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
414  const SCH_HIERLABEL* HLabel = NULL;
415 
416  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
417  {
418  if( (*i)->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
419  {
420  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
421  break;
422  }
423  }
424 
425  if( HLabel == NULL ) // Hlabel not found: delete sheet label.
426  i = m_pins.erase( i );
427  else
428  ++i;
429  }
430 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147

References GetText(), SCH_SCREEN::Items(), m_pins, m_screen, NULL, EE_RTREE::OfType(), and SCH_HIER_LABEL_T.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 237 of file base_struct.h.

237 { 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:258

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), 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 356 of file sch_item.h.

356 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:153

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )
inlineinherited

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 409 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:154

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_MOVE_TOOL::moveItem(), and DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ ClearFlags()

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

Definition at line 258 of file base_struct.h.

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

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(), 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_SEXPR_PLUGIN_CACHE::savePin(), 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 236 of file base_struct.h.

236 { 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:258

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 270 of file base_struct.h.

271  {
273  }
#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:258
#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  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

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

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

◆ Clone()

EDA_ITEM * 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 143 of file sch_sheet.cpp.

144 {
145  return new SCH_SHEET( *this );
146 }
SCH_SHEET(const wxPoint &pos=wxPoint(0, 0))
Definition: sch_sheet.cpp:70

References SCH_SHEET().

◆ ComponentCount()

int SCH_SHEET::ComponentCount ( ) const

Count our own components, without the power components.

Returns
the component count.

Definition at line 562 of file sch_sheet.cpp.

563 {
564  int n = 0;
565 
566  if( m_screen )
567  {
568  for( auto aItem : m_screen->Items().OfType( SCH_COMPONENT_T ) )
569  {
570  SCH_COMPONENT* Cmp = (SCH_COMPONENT*) aItem;
571 
572  if( Cmp->GetField( VALUE )->GetText().GetChar( 0 ) != '#' )
573  n++;
574  }
575 
576  for( auto aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
577  n += static_cast<const SCH_SHEET*>( aItem )->ComponentCount();
578  }
579 
580  return n;
581 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define VALUE
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:99
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

References SCH_COMPONENT::GetField(), EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), SCH_COMPONENT_T, SCH_SHEET_T, and VALUE.

◆ ConnectedItems()

ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH aPath)
inherited

Retrieves the set of items connected to this item on the given sheet.

Definition at line 138 of file sch_item.cpp.

139 {
140  return m_connected_items[ aSheet ];
141 }
std::unordered_map< SCH_SHEET_PATH, ITEM_SET > m_connected_items
Stores pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:159

References SCH_ITEM::m_connected_items.

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

◆ 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 393 of file sch_item.h.

393 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ 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 646 of file sch_sheet.cpp.

647 {
648  int count = 1; //1 = this!!
649 
650  if( m_screen )
651  {
652  for( auto aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
653  count += static_cast<SCH_SHEET*>( aItem )->CountSheets();
654  }
655 
656  return count;
657 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221

References SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), and SCH_SHEET_T.

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

◆ doIsConnected()

bool SCH_SHEET::doIsConnected ( const wxPoint aPosition) const
overrideprivatevirtual

Function doIsConnected provides the object specific test to see if it is connected to aPosition.

Note
Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.
Parameters
aPositionA reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 272 of file sch_sheet.cpp.

273 {
274  for( SCH_SHEET_PIN* sheetPin : m_pins )
275  {
276  if( sheetPin->GetPosition() == aPosition )
277  return true;
278  }
279 
280  return false;
281 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins.

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool  doClone = false) const
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  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
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->GetSchPins() )
90 
91  for( SCH_FIELD* field : component->GetFields() )
92  field->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
93  }
94 
95  if( newItem->Type() == SCH_SHEET_T )
96  {
97  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
98 
99  for( SCH_FIELD& field : sheet->GetFields() )
101 
102  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
103  pin->ClearFlags( SELECTED | HIGHLIGHTED | BRIGHTENED );
104  }
105 
106  return newItem;
107 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
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.
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:268
#define SELECTED
Definition: base_struct.h:127
Definition: common.h:65
#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:84
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215
const KIID m_Uuid
Definition: base_struct.h:169
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:357
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:99
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:258
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
SCH_PIN_PTRS GetSchPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieves a list of the SCH_PINs for the given sheet path.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

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

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

◆ GetBackgroundColor()

KIGFX::COLOR4D SCH_SHEET::GetBackgroundColor ( ) const
inline

Definition at line 293 of file sch_sheet.h.

293 { return m_backgroundColor; }
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234

References m_backgroundColor.

Referenced by KIGFX::SCH_PAINTER::getRenderColor(), and DIALOG_SCH_SHEET_PROPS::TransferDataToWindow().

◆ GetBodyBoundingBox()

const EDA_RECT SCH_SHEET::GetBodyBoundingBox ( ) const

Return a bounding box for the sheet body but not the fields.

Definition at line 523 of file sch_sheet.cpp.

524 {
525  wxPoint end;
526  EDA_RECT box( m_pos, m_size );
527  int lineWidth = GetPenSize();
528  int textLength = 0;
529 
530  // Calculate bounding box X size:
531  end.x = std::max( m_size.x, textLength );
532 
533  // Calculate bounding box pos:
534  end.y = m_size.y;
535  end += m_pos;
536 
537  box.SetEnd( end );
538  box.Inflate( lineWidth / 2 );
539 
540  return box;
541 }
wxSize m_size
Definition: sch_sheet.h:230
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:445
wxPoint m_pos
Definition: sch_sheet.h:229
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetPenSize(), EDA_RECT::Inflate(), m_pos, m_size, EDA_RECT::SetEnd(), wxPoint::x, and wxPoint::y.

Referenced by GetBoundingBox(), and HitTest().

◆ GetBorderColor()

KIGFX::COLOR4D SCH_SHEET::GetBorderColor ( ) const
inline

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const
inline

Definition at line 287 of file sch_sheet.h.

287 { return m_borderWidth; }
int m_borderWidth
Definition: sch_sheet.h:232

References m_borderWidth.

Referenced by GetPenSize(), SCH_SEXPR_PLUGIN::saveSheet(), and DIALOG_SCH_SHEET_PROPS::TransferDataToWindow().

◆ 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 544 of file sch_sheet.cpp.

545 {
547 
548  for( const SCH_FIELD& field : m_fields )
549  box.Merge( field.GetBoundingBox() );
550 
551  return box;
552 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:523
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References GetBodyBoundingBox(), m_fields, and EDA_RECT::Merge().

Referenced by 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 252 of file sch_sheet.h.

253  {
254  return wxT( "SCH_SHEET" );
255  }

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 807 of file sch_sheet.cpp.

808 {
809  for( SCH_SHEET_PIN* sheetPin : m_pins )
810  aPoints.push_back( sheetPin->GetPosition() );
811 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins.

◆ GetDefaultFieldName()

const wxString SCH_SHEET::GetDefaultFieldName ( int  aFieldNdx)
static

Definition at line 43 of file sch_sheet.cpp.

44 {
45  static void* locale = nullptr;
46  static wxString sheetnameDefault;
47  static wxString sheetfilenameDefault;
48  static wxString fieldDefault;
49 
50  // Fetching translations can take a surprising amount of time when loading libraries,
51  // so only do it when necessary.
52  if( Pgm().GetLocale() != locale )
53  {
54  sheetnameDefault = _( "Sheet name" );
55  sheetfilenameDefault = _( "Sheet file" );
56  fieldDefault = _( "Field%d" );
57  locale = Pgm().GetLocale();
58  }
59 
60  // Fixed values for the mandatory fields
61  switch( aFieldNdx )
62  {
63  case SHEETNAME: return sheetnameDefault;
64  case SHEETFILENAME: return sheetfilenameDefault;
65  default: return wxString::Format( fieldDefault, aFieldNdx );
66  }
67 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:103
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
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), Pgm(), SHEETFILENAME, and SHEETNAME.

Referenced by SCH_FIELD::GetName(), FIELDS_GRID_TABLE< SCH_FIELD >::GetValue(), DIALOG_SCH_SHEET_PROPS::OnAddField(), and SCH_SHEET().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 262 of file base_struct.h.

263  {
267  return m_Flags & mask;
268  }
#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:157
#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:189
#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::editFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ 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 783 of file sch_sheet.cpp.

784 {
785  for( SCH_SHEET_PIN* sheetPin : m_pins )
786  {
787  wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
788  wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
789 
790  sheetPin->GetEndPoints( aItemList );
791  }
792 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins, and SCH_SHEET_PIN_T.

◆ GetFields()

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 404 of file sch_item.h.

404 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:154

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), and EE_POINT_EDITOR::updateItem().

◆ GetFileName()

◆ GetFlags()

◆ GetLayer()

◆ 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 858 of file sch_sheet.cpp.

859 {
861 }
const BITMAP_OPAQUE add_hierarchical_subsheet_xpm[1]

References add_hierarchical_subsheet_xpm.

◆ 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 368 of file sch_sheet.cpp.

369 {
370  int height = Mils2iu( MIN_SHEET_HEIGHT );
371 
372  for( size_t i = 0; i < m_pins.size(); i++ )
373  {
374  int edge = m_pins[i]->GetEdge();
375  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
376 
377  // Make sure pin is on top or bottom side of sheet.
378  if( edge == SHEET_RIGHT_SIDE || edge == SHEET_LEFT_SIDE )
379  {
380  if( height < pinRect.GetBottom() - m_pos.y )
381  height = pinRect.GetBottom() - m_pos.y;
382  }
383  else
384  {
385  if( height < pinRect.GetHeight() )
386  height = pinRect.GetHeight();
387 
388  for( size_t j = 0; j < m_pins.size(); j++ )
389  {
390  // Check for pin directly above or below the current pin.
391  if( (i == j) || (m_pins[i]->GetPosition().x != m_pins[j]->GetPosition().x) )
392  continue;
393 
394  if( height < pinRect.GetHeight() + m_pins[j]->GetBoundingBox().GetHeight() )
395  {
396  height = pinRect.GetHeight() + m_pins[j]->GetBoundingBox().GetHeight();
397  break;
398  }
399  }
400  }
401  }
402 
403  return height;
404 }
wxPoint m_pos
Definition: sch_sheet.h:229
int GetBottom() const
Definition: eda_rect.h:124
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
int GetHeight() const
Definition: eda_rect.h:120
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(), m_pins, m_pos, MIN_SHEET_HEIGHT, SHEET_LEFT_SIDE, SHEET_RIGHT_SIDE, and wxPoint::y.

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 328 of file sch_sheet.cpp.

329 {
330  int width = Mils2iu( MIN_SHEET_WIDTH );
331 
332  for( size_t i = 0; i < m_pins.size(); i++ )
333  {
334  int edge = m_pins[i]->GetEdge();
335  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
336 
337  wxASSERT( edge != SHEET_UNDEFINED_SIDE );
338 
339  if( edge == SHEET_TOP_SIDE || edge == SHEET_BOTTOM_SIDE )
340  {
341  if( width < pinRect.GetRight() - m_pos.x )
342  width = pinRect.GetRight() - m_pos.x;
343  }
344  else
345  {
346  if( width < pinRect.GetWidth() )
347  width = pinRect.GetWidth();
348 
349  for( size_t j = 0; j < m_pins.size(); j++ )
350  {
351  // Check for pin directly across from the current pin.
352  if( (i == j) || (m_pins[i]->GetPosition().y != m_pins[j]->GetPosition().y) )
353  continue;
354 
355  if( width < pinRect.GetWidth() + m_pins[j]->GetBoundingBox().GetWidth() )
356  {
357  width = pinRect.GetWidth() + m_pins[j]->GetBoundingBox().GetWidth();
358  break;
359  }
360  }
361  }
362  }
363 
364  return width;
365 }
int GetWidth() const
Definition: eda_rect.h:119
wxPoint m_pos
Definition: sch_sheet.h:229
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
int GetRight() const
Definition: eda_rect.h:121
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetMsgPanelInfo()

void SCH_SHEET::GetMsgPanelInfo ( EDA_UNITS  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 660 of file sch_sheet.cpp.

661 {
662  aList.emplace_back( _( "Sheet Name" ), m_fields[ SHEETNAME ].GetText(), CYAN );
663  aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText(), BROWN );
664 
665 #if 1 // Set to 1 to display the sheet UUID and hierarchical path
666  wxString msgU, msgL;
667  msgU << _( "UUID" ) << ": " << m_Uuid.AsString();
668  msgL << _( "Path" ) << ": " <<g_CurrentSheet->PathHumanReadable();
669 
670  aList.push_back( MSG_PANEL_ITEM( msgU, msgL, BLUE ) );
671 #endif
672 }
Definition: colors.h:57
wxString AsString() const
Definition: common.cpp:170
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
Definition: colors.h:59
const KIID m_Uuid
Definition: base_struct.h:169
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
#define _(s)
Definition: 3d_actions.cpp:33
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
wxString PathHumanReadable() const
Function PathHumanReadable returns the sheet path in a human readable form, i.e.
Definition: colors.h:62

References _, KIID::AsString(), BLUE, BROWN, CYAN, g_CurrentSheet, GetText(), m_fields, EDA_ITEM::m_Uuid, SCH_SHEET_PATH::PathHumanReadable(), SHEETFILENAME, and SHEETNAME.

◆ 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 887 of file sch_sheet.cpp.

888 {
889  SCH_SHEET_PATH sheetPath = *aSheetPath;
890  sheetPath.push_back( this );
891 
892  for( SCH_SHEET_PIN* sheetPin : m_pins )
893  {
894  NETLIST_OBJECT* item = new NETLIST_OBJECT();
895  item->m_SheetPathInclude = sheetPath;
896  item->m_SheetPath = *aSheetPath;
897  item->m_Comp = sheetPin;
898  item->m_Link = this;
900  item->m_Label = sheetPin->GetText();
901  item->m_Start = item->m_End = sheetPin->GetPosition();
902  aNetListItems.push_back( item );
903 
904  SCH_CONNECTION conn;
905  if( conn.IsBusLabel( sheetPin->GetText() ) )
906  item->ConvertBusToNetListItems( aNetListItems );
907  }
908 }
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
EDA_ITEM * m_Comp
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
SCH_SHEET_PATH.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
NETLIST_ITEM m_Type
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(), 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, SCH_SHEET_PATH::push_back(), and SHEETLABEL.

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

446 {
447  return GetBorderWidth();
448 }
int GetBorderWidth() const
Definition: sch_sheet.h:287

References GetBorderWidth().

Referenced by AutoplaceFields(), KIGFX::SCH_PAINTER::draw(), GetBodyBoundingBox(), 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 433 of file sch_sheet.cpp.

434 {
435  for( SCH_SHEET_PIN* pin : m_pins )
436  {
437  if( pin->HitTest( aPosition ) )
438  return pin;
439  }
440 
441  return NULL;
442 }
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins, and NULL.

◆ GetPins() [1/2]

std::vector<SCH_SHEET_PIN*>& SCH_SHEET::GetPins ( )
inline

Definition at line 357 of file sch_sheet.h.

357 { return m_pins; }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224

References m_pins.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SCH_SHEET_LIST::GetItem(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), EE_SELECTION_TOOL::selectMultiple(), and EE_POINT_EDITOR::updateItem().

◆ GetPins() [2/2]

std::vector<SCH_SHEET_PIN*>& SCH_SHEET::GetPins ( ) const
inline

Definition at line 359 of file sch_sheet.h.

360  {
361  return const_cast< std::vector<SCH_SHEET_PIN*>& >( m_pins );
362  }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224

References m_pins.

◆ GetPosition()

wxPoint SCH_SHEET::GetPosition ( ) const
inlineoverridevirtual

◆ 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 181 of file sch_sheet.cpp.

182 {
183  SCH_SHEET* sheet = dynamic_cast< SCH_SHEET* >( GetParent() );
184 
185  if( sheet == NULL )
186  return this;
187 
188  // Recurse until a sheet is found with no parent which is the root sheet.
189  return sheet->GetRootSheet();
190 }
SCH_SHEET * GetRootSheet()
Return the root sheet of this SCH_SHEET object.
Definition: sch_sheet.cpp:181
#define NULL
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215

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

Referenced by GetRootSheet(), SCH_SEXPR_PLUGIN::Load(), 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 555 of file sch_sheet.cpp.

556 {
557  EDA_RECT box( m_pos, m_size );
558  return box.GetCenter();
559 }
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
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 172 of file sch_sheet.cpp.

173 {
174  if( m_screen == NULL )
175  return 0;
176 
177  return m_screen->GetRefCount();
178 }
#define NULL
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
int GetRefCount() const
Definition: sch_screen.h:170

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

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ GetSelectMenuText()

wxString SCH_SHEET::GetSelectMenuText ( EDA_UNITS  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 852 of file sch_sheet.cpp.

853 {
854  return wxString::Format( _( "Hierarchical Sheet %s" ), m_fields[ SHEETNAME ].GetText() );
855 }
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
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
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), GetText(), m_fields, and SHEETNAME.

Referenced by Matches().

◆ GetSize()

wxSize SCH_SHEET::GetSize ( )
inline

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 241 of file base_struct.h.

242  {
243  return m_Status & type;
244  }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

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

254 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 205 of file sch_item.h.

205 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:155

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ HasFlag()

◆ 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 260 of file sch_sheet.cpp.

261 {
262  for( SCH_SHEET_PIN* pin : m_pins )
263  {
264  if( pin->GetText().CmpNoCase( aName ) == 0 )
265  return true;
266  }
267 
268  return false;
269 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins.

Referenced by SCH_EDIT_FRAME::ImportHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( )
inline

Definition at line 397 of file sch_sheet.h.

397 { return !m_pins.empty(); }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224

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 305 of file sch_sheet.cpp.

306 {
307  for( SCH_SHEET_PIN* pin : m_pins )
308  {
309  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
310  const SCH_HIERLABEL* HLabel = nullptr;
311  for( auto aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
312  {
313  if( !pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
314  {
315  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
316  break;
317  }
318  }
319 
320  if( HLabel == nullptr ) // Corresponding hierarchical label not found.
321  return true;
322  }
323 
324  return false;
325 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221

References GetText(), SCH_SCREEN::Items(), m_pins, m_screen, EE_RTREE::OfType(), and SCH_HIER_LABEL_T.

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 864 of file sch_sheet.cpp.

865 {
866  EDA_RECT rect = GetBodyBoundingBox();
867 
868  rect.Inflate( aAccuracy );
869 
870  return rect.Contains( aPosition );
871 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:523
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(), GetBodyBoundingBox(), 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 874 of file sch_sheet.cpp.

875 {
876  EDA_RECT rect = aRect;
877 
878  rect.Inflate( aAccuracy );
879 
880  if( aContained )
881  return rect.Contains( GetBodyBoundingBox() );
882 
883  return rect.Intersects( GetBodyBoundingBox() );
884 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:523
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(), GetBodyBoundingBox(), 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 150 of file sch_item.cpp.

151 {
152  if( Connection( aSheet ) )
153  {
154  Connection( aSheet )->Reset();
155  Connection( aSheet )->SetSheet( aSheet );
156  return Connection( aSheet );
157  }
158 
159  auto connection = new SCH_CONNECTION( this );
160  connection->SetSheet( aSheet );
161  m_connection_map.insert( std::make_pair( aSheet, connection ) );
162  return connection;
163 }
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:162
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieves the connection associated with this object in the given sheet Note: the returned value can ...
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 539 of file sch_sheet.h.

539 { 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:189
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:479

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

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 395 of file sch_item.h.

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

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 329 of file sch_item.h.

329 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

223 { 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:189

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

227 { 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:189

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), 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 212 of file sch_item.h.

212 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

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

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 266 of file sch_sheet.h.

266 { 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 523 of file sch_sheet.h.

523 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

226 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
#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[]) const
inlinevirtualinherited

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

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

Reimplemented in SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 286 of file base_struct.h.

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

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

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

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 284 of file sch_sheet.cpp.

285 {
286  int leftRight = 0;
287  int topBottom = 0;
288 
289  for( SCH_SHEET_PIN* pin : m_pins )
290  {
291  switch( pin->GetEdge() )
292  {
293  case SHEET_LEFT_SIDE: leftRight++; break;
294  case SHEET_RIGHT_SIDE: leftRight++; break;
295  case SHEET_TOP_SIDE: topBottom++; break;
296  case SHEET_BOTTOM_SIDE: topBottom++; break;
297  default: break;
298  }
299  }
300 
301  return topBottom > 0 && leftRight == 0;
302 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

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

Referenced by AutoplaceFields(), and SCH_SHEET_PIN::SCH_SHEET_PIN().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

224 { 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:189

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

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

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

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

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

Definition at line 399 of file base_struct.h.

403  {
404  for( auto it : aList )
405  {
406  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
408  return SEARCH_RESULT::QUIT;
409  }
410 
412  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

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

◆ IterateForward() [2/2]

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

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

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

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

Definition at line 420 of file base_struct.h.

422  {
423  for( auto it : aList )
424  {
425  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
427  return SEARCH_RESULT::QUIT;
428  }
429 
431  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ 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 291 of file sch_item.h.

291 { 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 620 of file sch_sheet.cpp.

621 {
622  if( m_screen )
623  {
624  aList->push_back( this );
625 
626  if( m_screen == aScreen )
627  return true;
628 
629  for( auto item : m_screen->Items().OfType( SCH_SHEET_T ) )
630  {
631  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
632 
633  if( sheet->LocatePathOfScreen( aScreen, aList ) )
634  {
635  return true;
636  }
637  }
638 
639  aList->pop_back();
640  }
641 
642  return false;
643 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
void pop_back()
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215
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:620
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221

References SCH_SCREEN::Items(), LocatePathOfScreen(), m_screen, EE_RTREE::OfType(), SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), and SCH_SHEET_T.

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 762 of file sch_sheet.cpp.

763 {
764  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
765 
766  // Sheets are searchable via the child field and pin item text.
767  return false;
768 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_sheet.cpp:852
const wxChar *const traceFindItem
Flag to enable find debug tracing.

References GetSelectMenuText(), 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 152 of file base_struct.cpp.

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

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 717 of file sch_sheet.cpp.

718 {
719  MIRROR( m_pos.y, aXaxis_position );
720  m_pos.y -= m_size.y;
721 
722  for( SCH_SHEET_PIN* sheetPin : m_pins )
723  sheetPin->MirrorX( aXaxis_position );
724 }
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:123
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins, m_pos, m_size, MIRROR(), and wxPoint::y.

◆ 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 727 of file sch_sheet.cpp.

728 {
729  MIRROR( m_pos.x, aYaxis_position );
730  m_pos.x -= m_size.x;
731 
732  for( SCH_SHEET_PIN* sheetPin : m_pins )
733  sheetPin->MirrorY( aYaxis_position );
734 }
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:123
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins, m_pos, m_size, MIRROR(), and wxPoint::x.

◆ 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 506 of file sch_sheet.h.

507  {
508  m_pos += aMoveVector;
509 
510  for( SCH_SHEET_PIN* pin : m_pins )
511  pin->Move( aMoveVector );
512 
513  for( SCH_FIELD& field : m_fields )
514  field.Move( aMoveVector );
515  }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
wxPoint m_pos
Definition: sch_sheet.h:229
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226

References m_fields, m_pins, and m_pos.

Referenced by SetPosition().

◆ operator<() [1/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 206 of file base_struct.cpp.

207 {
208  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
209  GetChars( GetClass() ) ) );
210 
211  return false;
212 }
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<() [2/2]

bool SCH_SHEET::operator< ( const SCH_ITEM aItem) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 975 of file sch_sheet.cpp.

976 {
977  if( Type() != aItem.Type() )
978  return Type() < aItem.Type();
979 
980  auto sheet = static_cast<const SCH_SHEET*>( &aItem );
981 
982  if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText())
983  return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
984 
985  if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText())
986  return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
987 
988  return false;
989 }
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References GetText(), m_fields, SHEETFILENAME, SHEETNAME, and EDA_ITEM::Type().

◆ operator=()

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

Definition at line 946 of file sch_sheet.cpp.

947 {
948  wxLogDebug( wxT( "Sheet assignment operator." ) );
949 
950  wxCHECK_MSG( Type() == aItem.Type(), *this,
951  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
952  GetClass() );
953 
954  if( &aItem != this )
955  {
956  SCH_ITEM::operator=( aItem );
957 
958  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
959 
960  m_pos = sheet->m_pos;
961  m_size = sheet->m_size;
962  m_fields = sheet->m_fields;
963 
964  for( SCH_SHEET_PIN* pin : sheet->m_pins )
965  {
966  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
967  m_pins.back()->SetParent( this );
968  }
969  }
970 
971  return *this;
972 }
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:217
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_sheet.h:252
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
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:215
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References SCH_ITEM::GetClass(), GetClass(), m_fields, m_pins, m_pos, m_size, EDA_ITEM::operator=(), SCH_SHEET_PIN, 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 911 of file sch_sheet.cpp.

912 {
913  wxString Text;
914  wxPoint pos;
915 
916  aPlotter->SetColor( aPlotter->ColorSettings()->GetColor( GetLayer() ) );
917 
918  int thickness = GetPenSize();
919  aPlotter->SetCurrentLineWidth( thickness );
920 
921  aPlotter->MoveTo( m_pos );
922  pos = m_pos;
923  pos.x += m_size.x;
924 
925  aPlotter->LineTo( pos );
926  pos.y += m_size.y;
927 
928  aPlotter->LineTo( pos );
929  pos = m_pos;
930  pos.y += m_size.y;
931 
932  aPlotter->LineTo( pos );
933  aPlotter->FinishTo( m_pos );
934 
935  for( SCH_FIELD field : m_fields )
936  field.Plot( aPlotter );
937 
938  aPlotter->SetColor( aPlotter->ColorSettings()->GetColor( GetLayer() ) );
939 
940  /* Draw texts : SheetLabel */
941  for( SCH_SHEET_PIN* sheetPin : m_pins )
942  sheetPin->Plot( aPlotter );
943 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual void SetColor(COLOR4D color)=0
wxSize m_size
Definition: sch_sheet.h:230
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:445
wxPoint m_pos
Definition: sch_sheet.h:229
void LineTo(const wxPoint &pos)
Definition: plotter.h:278
COLOR_SETTINGS * ColorSettings()
Definition: plotter.h:145
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:224
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
COLOR4D GetColor(int aLayer) const
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References PLOTTER::ColorSettings(), PLOTTER::FinishTo(), COLOR_SETTINGS::GetColor(), SCH_ITEM::GetLayer(), GetPenSize(), PLOTTER::LineTo(), m_fields, m_pins, m_pos, m_size, PLOTTER::MoveTo(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), wxPoint::x, and wxPoint::y.

◆ 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 505 of file sch_sheet.cpp.

506 {
507  wxString Text;
508  wxPoint pos = m_pos + aOffset;
509  int lineWidth = GetPenSize();
511 
512  GRRect( nullptr, aDC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, lineWidth, color );
513 
514  for( SCH_FIELD& field : m_fields )
515  field.Print( aDC, aOffset );
516 
517  /* Draw text : SheetLabel */
518  for( SCH_SHEET_PIN* sheetPin : m_pins )
519  sheetPin->Print( aDC, aOffset );
520 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
int color
Definition: DXF_plotter.cpp:61
wxSize m_size
Definition: sch_sheet.h:230
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:290
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_sheet.cpp:445
wxPoint m_pos
Definition: sch_sheet.h:229
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:844
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40

References color, GetBorderColor(), GetPenSize(), GRRect(), m_fields, m_pins, m_pos, m_size, wxPoint::x, and wxPoint::y.

◆ 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 240 of file sch_sheet.cpp.

241 {
242  wxASSERT( aSheetPin != NULL );
243  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
244 
245  for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
246  {
247  if( *i == aSheetPin )
248  {
249  m_pins.erase( i );
250  renumberPins();
251  return;
252  }
253  }
254 
255  wxLogDebug( wxT( "Fix me: attempt to remove label %s which is not in sheet %s." ),
256  aSheetPin->GetShownText(), m_fields[ SHEETNAME ].GetText() );
257 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:771
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
virtual wxString GetShownText() const
Return 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:212

References EDA_TEXT::GetShownText(), m_fields, m_pins, NULL, renumberPins(), SCH_SHEET_PIN_T, SHEETNAME, 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 771 of file sch_sheet.cpp.

772 {
773  int id = 2;
774 
775  for( SCH_SHEET_PIN* pin : m_pins )
776  {
777  pin->SetNumber( id );
778  id++;
779  }
780 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

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

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

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

Definition at line 179 of file base_struct.cpp.

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

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

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

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

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

Reimplemented in SCH_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 505 of file base_struct.h.

505 { return false; }

◆ 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 745 of file sch_sheet.cpp.

746 {
747  if( aSize == m_size )
748  return;
749 
750  m_size = aSize;
751 
752  // Move the fields if we're in autoplace mode
754  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
755 
756  // Move the sheet labels according to the new sheet size.
757  for( SCH_SHEET_PIN* sheetPin : m_pins )
758  sheetPin->ConstrainOnEdge( sheetPin->GetPosition() );
759 }
wxSize m_size
Definition: sch_sheet.h:230
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:451
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227

References AutoplaceFields(), FIELDS_AUTOPLACED_AUTO, m_fieldsAutoplaced, m_pins, m_size, and NULL.

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 675 of file sch_sheet.cpp.

676 {
677  wxPoint prev = m_pos;
678 
679  RotatePoint( &m_pos, aPosition, 900 );
680  RotatePoint( &m_size.x, &m_size.y, 900 );
681 
682  if( m_size.x < 0 )
683  {
684  m_pos.x += m_size.x;
685  m_size.x = -m_size.x;
686  }
687 
688  if( m_size.y < 0 )
689  {
690  m_pos.y += m_size.y;
691  m_size.y = -m_size.y;
692  }
693 
694  // Pins must be rotated first as that's how we determine vertical vs horizontal
695  // orientation for auto-placement
696  for( SCH_SHEET_PIN* sheetPin : m_pins )
697  sheetPin->Rotate( aPosition );
698 
700  {
701  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
702  }
703  else
704  {
705  // Move the fields to the new position because the component itself has moved.
706  for( SCH_FIELD& field : m_fields )
707  {
708  wxPoint pos = field.GetTextPos();
709  pos.x -= prev.x - m_pos.x;
710  pos.y -= prev.y - m_pos.y;
711  field.SetTextPos( pos );
712  }
713  }
714 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
wxSize m_size
Definition: sch_sheet.h:230
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_pos
Definition: sch_sheet.h:229
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:451
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227

References AutoplaceFields(), FIELDS_AUTOPLACED_AUTO, m_fields, m_fieldsAutoplaced, m_pins, m_pos, m_size, NULL, RotatePoint(), wxPoint::x, and wxPoint::y.

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 584 of file sch_sheet.cpp.

585 {
586  if( m_screen )
587  {
588  // Only check the root sheet once and don't recurse.
589  if( !GetParent() )
590  {
591  if( m_screen && m_screen->GetFileName().Cmp( aFilename ) == 0 )
592  {
593  *aScreen = m_screen;
594  return true;
595  }
596  }
597 
598  for( auto aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
599  {
600  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
601  SCH_SCREEN* screen = sheet->m_screen;
602 
603  // Must use the screen's path (which is always absolute) rather than the
604  // sheet's (which could be relative).
605  if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
606  {
607  *aScreen = screen;
608  return true;
609  }
610 
611  if( sheet->SearchHierarchy( aFilename, aScreen ) )
612  return true;
613  }
614  }
615 
616  return false;
617 }
const wxString & GetFileName() const
Definition: sch_screen.h:157
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:584
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
EDA_ITEM * GetParent() const
Definition: base_struct.h:217
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215
EE_RTREE & Items()
Definition: sch_screen.h:127
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221

References SCH_SCREEN::GetFileName(), EDA_ITEM::GetParent(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), SCH_SHEET_T, and SearchHierarchy().

Referenced by SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDITOR_CONTROL::Paste(), SearchHierarchy(), and DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetBackgroundColor()

void SCH_SHEET::SetBackgroundColor ( KIGFX::COLOR4D  aColor)
inline

Definition at line 294 of file sch_sheet.h.

294 { m_backgroundColor = aColor; }
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234

References m_backgroundColor.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetBorderColor()

void SCH_SHEET::SetBorderColor ( KIGFX::COLOR4D  aColor)
inline

Definition at line 291 of file sch_sheet.h.

291 { m_borderColor = aColor; }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233

References m_borderColor.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int  aWidth)
inline

Definition at line 288 of file sch_sheet.h.

288 { m_borderWidth = aWidth; }
int m_borderWidth
Definition: sch_sheet.h:232

References m_borderWidth.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 397 of file sch_item.h.

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

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetFields()

void SCH_SHEET::SetFields ( const std::vector< SCH_FIELD > &  aFields)
inline

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 275 of file sch_sheet.h.

276  {
277  m_fields = aFields; // vector copying, length is changed possibly
278  }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226

References m_fields.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetFileName()

void SCH_SHEET::SetFileName ( wxString  aFilename)
inline

Definition at line 497 of file sch_sheet.h.

498  {
499  // Filenames are stored using unix notation
500  aFilename.Replace( wxT("\\"), wxT("/") );
501  m_fields[ SHEETFILENAME ].SetText( aFilename );
502  }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226

References m_fields, and SHEETFILENAME.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 257 of file base_struct.h.

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

References EDA_ITEM::m_Flags.

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

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

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 232 of file base_struct.h.

232 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
#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 231 of file sch_item.h.

231 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:152

References SCH_ITEM::m_Layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_FIELD::SCH_FIELD(), and SCH_NO_CONNECT::SCH_NO_CONNECT().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 218 of file sch_item.h.

218 {}

◆ SetModified()

◆ 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 737 of file sch_sheet.cpp.

738 {
739  // Remember the sheet and all pin sheet positions must be
740  // modified. So use Move function to do that.
741  Move( aPosition - m_pos );
742 }
wxPoint m_pos
Definition: sch_sheet.h:229
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_sheet.h:506

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 149 of file sch_sheet.cpp.

150 {
151  if( aScreen == m_screen )
152  return;
153 
154  if( m_screen != NULL )
155  {
157 
158  if( m_screen->GetRefCount() == 0 )
159  {
160  delete m_screen;
161  m_screen = NULL;
162  }
163  }
164 
165  m_screen = aScreen;
166 
167  if( m_screen )
169 }
#define NULL
void DecRefCount()
Definition: sch_screen.cpp:167
SCH_SCREEN * m_screen
Screen that contains the physical data for the sheet.
Definition: sch_sheet.h:221
void IncRefCount()
Definition: sch_screen.cpp:161
int GetRefCount() const
Definition: sch_screen.h:170

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

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

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetSize()

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

Definition at line 285 of file sch_sheet.h.

285 { m_size = aSize; }
wxSize m_size
Definition: sch_sheet.h:230

References m_size.

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetState()

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

Definition at line 246 of file base_struct.h.

247  {
248  if( state )
249  m_Status |= type; // state = ON or OFF
250  else
251  m_Status &= ~type;
252  }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

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

255 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:179

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 206 of file sch_item.h.

206 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:155

References SCH_ITEM::m_storedPos.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 230 of file base_struct.h.

230 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:257
#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 536 of file base_struct.h.

536 { 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 203 of file sch_sheet.cpp.

204 {
205  wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
206  wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
207  GetChars( aItem->GetClass() ) ) );
208 
209  SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
210 
211  std::swap( m_pos, sheet->m_pos );
212  std::swap( m_size, sheet->m_size );
213  m_fields.swap( sheet->m_fields );
214  std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
215  m_pins.swap( sheet->m_pins );
216 
217  // Update parent pointers after swapping.
218  for( SCH_SHEET_PIN* sheetPin : m_pins )
219  sheetPin->SetParent( this );
220 
221  for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
222  sheetPin->SetParent( sheet );
223 
224  std::swap( m_borderWidth, sheet->m_borderWidth );
225  std::swap( m_borderColor, sheet->m_borderColor );
226  std::swap( m_backgroundColor, sheet->m_backgroundColor );
227 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:218
int m_borderWidth
Definition: sch_sheet.h:232
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:215
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
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
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:174
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References Format(), GetChars(), SCH_ITEM::GetClass(), m_backgroundColor, m_borderColor, m_borderWidth, m_fields, m_fieldsAutoplaced, m_pins, m_pos, 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 212 of file base_struct.h.

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

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(), SCH_SCREEN::Append(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), TRACK::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), MARKER_PCB::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_ITEM::compare(), LIB_PIN::compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), 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(), 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(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::DuplicateItem(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), SCH_FIELD::GetFullyQualifiedText(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_FIELD::GetParentPosition(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), operator=(), SCH_COMPONENT::operator=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), WS_PROXY_UNDO_ITEM::Restore(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), 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(), TEXTE_PCB::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), ARC::SwapData(), SwapData(), VIA::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ UpdateDanglingState()

bool SCH_SHEET::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList,
const SCH_SHEET_PATH aPath = nullptr 
)
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.

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overrided method can optionally use it to update sheet-local connectivity information

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

Reimplemented from SCH_ITEM.

Definition at line 795 of file sch_sheet.cpp.

797 {
798  bool changed = false;
799 
800  for( SCH_SHEET_PIN* sheetPin : m_pins )
801  changed |= sheetPin->UpdateDanglingState( aItemList );
802 
803  return changed;
804 }
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

References m_pins.

◆ UsesDefaultStroke()

bool SCH_SHEET::UsesDefaultStroke ( ) const

Test this sheet to see if the default stroke is used to draw the outline.

The default stroke is defined as follows:

Returns
True if the outline stroke meets the default criteria.

Definition at line 193 of file sch_sheet.cpp.

194 {
196  && ( m_borderColor == COLOR4D::UNSPECIFIED ) )
197  return true;
198 
199  return false;
200 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int m_borderWidth
Definition: sch_sheet.h:232

References GetDefaultLineThickness(), m_borderColor, and m_borderWidth.

Referenced by SCH_SEXPR_PLUGIN::saveSheet().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 227 of file base_struct.cpp.

228 {
229  // Basic fallback
230  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
231  VECTOR2I( GetBoundingBox().GetSize() ) );
232 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

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

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

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

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

Definition at line 116 of file view_item.h.

117  {}

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

◆ ViewGetLayers()

void 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 495 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 814 of file sch_sheet.cpp.

815 {
816  KICAD_T stype;
817 
818  for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
819  {
820  // If caller wants to inspect my type
821  if( stype == SCH_LOCATE_ANY_T || stype == Type() )
822  {
823  if( SEARCH_RESULT::QUIT == aInspector( this, NULL ) )
824  return SEARCH_RESULT::QUIT;
825  }
826 
827  if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T )
828  {
829  // Test the sheet fields.
830  for( SCH_FIELD& field : m_fields )
831  {
832  if( SEARCH_RESULT::QUIT == aInspector( &field, this ) )
833  return SEARCH_RESULT::QUIT;
834  }
835  }
836 
837  if( stype == SCH_LOCATE_ANY_T || stype == SCH_SHEET_PIN_T )
838  {
839  // Test the sheet labels.
840  for( SCH_SHEET_PIN* sheetPin : m_pins )
841  {
842  if( SEARCH_RESULT::QUIT == aInspector( sheetPin, this ) )
843  return SEARCH_RESULT::QUIT;
844  }
845  }
846  }
847 
849 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
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
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
The list of sheet connection points.
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212

References CONTINUE, EOT, m_fields, m_pins, NULL, QUIT, SCH_FIELD_T, SCH_LOCATE_ANY_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Friends And Related Function Documentation

◆ SCH_SHEET_PIN

friend class SCH_SHEET_PIN
friend

Definition at line 217 of file sch_sheet.h.

Referenced by operator=(), and SCH_SHEET().

Member Data Documentation

◆ m_backgroundColor

KIGFX::COLOR4D SCH_SHEET::m_backgroundColor
private

Definition at line 234 of file sch_sheet.h.

Referenced by GetBackgroundColor(), SCH_SHEET(), SetBackgroundColor(), and SwapData().

◆ m_borderColor

KIGFX::COLOR4D SCH_SHEET::m_borderColor
private

Definition at line 233 of file sch_sheet.h.

Referenced by GetBorderColor(), SCH_SHEET(), SetBorderColor(), SwapData(), and UsesDefaultStroke().

◆ m_borderWidth

int SCH_SHEET::m_borderWidth
private

Definition at line 232 of file sch_sheet.h.

Referenced by GetBorderWidth(), SCH_SHEET(), SetBorderWidth(), SwapData(), and UsesDefaultStroke().

◆ m_connected_items

std::unordered_map<SCH_SHEET_PATH, ITEM_SET> SCH_ITEM::m_connected_items
protectedinherited

Stores pointers to other items that are connected to this one, per sheet.

Definition at line 159 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 162 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

Definition at line 153 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 165 of file sch_item.h.

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

◆ m_fields

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_SHEET::m_fieldsAutoplaced
private

Definition at line 227 of file sch_sheet.h.

Referenced by AutoplaceFields(), Resize(), Rotate(), SCH_SHEET(), 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 186 of file base_struct.h.

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

◆ m_Layer

◆ 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 221 of file sch_sheet.h.

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

◆ m_size

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

Definition at line 155 of file sch_item.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 169 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), Diagnose(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_EDIT_FRAME::Exchange_Module(), PCB_BASE_FRAME::FocusOnItem(), SCH_BASE_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), GetMsgPanelInfo(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET(), RC_ITEM::SetData(), SwapItemData(), TestMultiunitFootprints(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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