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 INSPECTABLE

Public Member Functions

 SCH_SHEET (EDA_ITEM *aParent=nullptr, 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
 Return the class name. More...
 
bool IsMovableFromAnchorPoint () const 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 ()
 
const std::vector< SCH_FIELD > & GetFields () const
 
void SetFields (const std::vector< SCH_FIELD > &aFields)
 Set multiple schematic fields. More...
 
wxString GetName () const
 
SCH_SCREENGetScreen () const
 
wxSize GetSize () const
 
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...
 
bool IsRootSheet () const
 
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 GetContextualTextVars (wxArrayString *aVars) const
 Return the list of system text vars & fields for this sheet. More...
 
bool ResolveTextVar (wxString *token, int aDepth=0) const
 Resolve any references to system tokens supported by the sheet. More...
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate 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 ()
 
const std::vector< SCH_SHEET_PIN * > & GetPins () const
 
void RemovePin (const 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) const
 Checks if the sheet already has a sheet pin named aName. More...
 
bool HasPins () const
 
bool HasUndefinedPins () const
 Check all sheet labels against schematic for undefined hierarchical labels. More...
 
int GetMinWidth (bool aFromLeft) const
 Return the minimum width of the sheet based on the widths of the sheet pin text. More...
 
int GetMinHeight (bool aFromTop) const
 Return the minimum height that the sheet can be resized based on the sheet pin positions. More...
 
int GetPenWidth () const override
 
void Print (const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
 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
 Return 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
 Swap the internal data structures aItem with the schematic item. More...
 
int SymbolCount () const
 Count our own symbols, without the power symbols. 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 () const
 Count the number of sheets found in "this" sheet including 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
 Move the item by aMoveVector to a new position. More...
 
void MirrorHorizontally (int aCenter) override
 Mirror item horizontally about aCenter. More...
 
void MirrorVertically (int aCenter) override
 Mirror item vertically about aCenter. More...
 
void Rotate (wxPoint aCenter) override
 Rotate the item around aCenter 90 degrees in the clockwise direction. More...
 
bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const override
 Compare the item against the search criteria in aSearchData. More...
 
bool IsReplaceable () const override
 Override this method in any derived object that supports test find and replace. 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
 Add 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
 Test the schematic item to aItemList to check if it's dangling state has changed. More...
 
bool IsConnectable () const override
 
bool CanConnect (const SCH_ITEM *aItem) const override
 
std::vector< wxPoint > GetConnectionPoints () const override
 Add all the connection points for this item to aPoints. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction) override
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
SCH_SHEEToperator= (const SCH_ITEM &aSheet)
 
bool operator< (const SCH_ITEM &aItem) const override
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the layers the item is drawn on (which may be more than its "home" layer) More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPosition) override
 
bool HitTest (const wxPoint &aPosition, int aAccuracy) const override
 Test 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
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) const override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
const std::vector< SCH_SHEET_INSTANCEGetInstances () const
 
bool AddInstance (const KIID_PATH &aInstance)
 Add a new instance aSheetPath to the instance list. More...
 
wxString GetPageNumber (const SCH_SHEET_PATH &aInstance) const
 Return the sheet page number for aInstance. More...
 
void SetPageNumber (const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
 Set the page number for the sheet instance aInstance. More...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
virtual bool IsHypertext () const
 Allow items to support hypertext actions when hovered/clicked. More...
 
virtual void DoHypertextMenu (EDA_DRAW_FRAME *aFrame)
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on. More...
 
void SetLayer (SCH_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
virtual bool IsDangling () const
 
virtual bool IsPointClickableAnchor (const wxPoint &aPos) const
 
void ClearConnections ()
 Clears all of the connection items from the list. More...
 
bool IsConnected (const wxPoint &aPoint) const
 Test the item to see if it is connected to aPoint. More...
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet. More...
 
SCH_ITEM_SETConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieve the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Add a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Create a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Return true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void SetFieldsAutoplaced ()
 
void ClearFieldsAutoplaced ()
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties. More...
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, bool 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) const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Check whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform 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
 Return the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Return the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static int ComparePageNum (const wxString &aPageNumberA, const wxString aPageNumberB)
 Compares page numbers of schematic sheets. More...
 
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[])
 This changes first parameter to avoid the DList and use the main queue instead. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Change first parameter to avoid the DList and use std::vector instead. More...
 
static bool Replace (const wxFindReplaceData &aSearchData, wxString &aText)
 Perform 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)
 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, const wxFindReplaceData &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 

Protected Attributes

SCH_LAYER_ID m_layer
 
EDA_ITEMS m_connections
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_storedPos
 
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SETm_connected_items
 Store pointers to other items that are connected to this one, per sheet. More...
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Store connectivity information, per sheet. More...
 
bool m_connectivity_dirty
 
STATUS_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_flags
 

Private Member Functions

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

Private Attributes

SCH_SCREENm_screen
 
std::vector< SCH_SHEET_PIN * > m_pins
 
std::vector< SCH_FIELDm_fields
 
wxPoint m_pos
 
wxSize m_size
 
int m_borderWidth
 
KIGFX::COLOR4D m_borderColor
 
KIGFX::COLOR4D m_backgroundColor
 
std::vector< SCH_SHEET_INSTANCEm_instances
 

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

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

SCH_SHEET::SCH_SHEET ( EDA_ITEM aParent = nullptr,
const wxPoint &  pos = wxPoint( 0, 0 ) 
)

Definition at line 73 of file sch_sheet.cpp.

73  :
74  SCH_ITEM( aParent, SCH_SHEET_T )
75 {
77  m_pos = pos;
78  m_size = wxSize( Mils2iu( MIN_SHEET_WIDTH ), Mils2iu( MIN_SHEET_HEIGHT ) );
79  m_screen = NULL;
80 
81  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
82  {
83  m_fields.emplace_back( pos, i, this, GetDefaultFieldName( i ) );
84  m_fields.back().SetVisible( true );
85 
86  if( i == SHEETNAME )
87  m_fields.back().SetLayer( LAYER_SHEETNAME );
88  else if( i == SHEETFILENAME )
89  m_fields.back().SetLayer( LAYER_SHEETFILENAME );
90  else
91  m_fields.back().SetLayer( LAYER_SHEETFIELDS );
92  }
93 
95 
96  m_borderWidth = 0;
97  m_borderColor = COLOR4D::UNSPECIFIED;
98  m_backgroundColor = COLOR4D::UNSPECIFIED;
99 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:457
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:37
SCH_LAYER_ID m_layer
Definition: sch_item.h:496
#define NULL
int m_borderWidth
Definition: sch_sheet.h:456
static const wxString GetDefaultFieldName(int aFieldNdx)
Definition: sch_sheet.cpp:46
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:458
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:38
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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

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

102  :
103  SCH_ITEM( aSheet )
104 {
105  m_pos = aSheet.m_pos;
106  m_size = aSheet.m_size;
107  m_layer = aSheet.m_layer;
108  const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
109  m_fields = aSheet.m_fields;
111  m_screen = aSheet.m_screen;
112 
113  for( SCH_SHEET_PIN* pin : aSheet.m_pins )
114  {
115  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
116  m_pins.back()->SetParent( this );
117  }
118 
119  for( SCH_FIELD& field : m_fields )
120  field.SetParent( this );
121 
122  m_borderWidth = aSheet.m_borderWidth;
123  m_borderColor = aSheet.m_borderColor;
125  m_instances = aSheet.m_instances;
126 
127  if( m_screen )
129 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:457
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:446
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
SCH_LAYER_ID m_layer
Definition: sch_item.h:496
int m_borderWidth
Definition: sch_sheet.h:456
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
const KIID m_Uuid
Definition: eda_item.h:525
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:458
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
void IncRefCount()
Definition: sch_screen.cpp:106
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 132 of file sch_sheet.cpp.

133 {
134  // also, look at the associated sheet & its reference count
135  // perhaps it should be deleted also.
136  if( m_screen )
137  {
139 
140  if( m_screen->GetRefCount() == 0 )
141  delete m_screen;
142  }
143 
144  // We own our pins; delete them
145  for( SCH_SHEET_PIN* pin : m_pins )
146  delete pin;
147 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
void DecRefCount()
Definition: sch_screen.cpp:112
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
int GetRefCount() const
Definition: sch_screen.h:144

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

Member Function Documentation

◆ AddConnectionTo()

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

Add a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

171 {
172  m_connected_items[ aSheet ].insert( aItem );
173 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:503

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AddInstance()

bool SCH_SHEET::AddInstance ( const KIID_PATH aInstance)

Add a new instance aSheetPath to the instance list.

If aSheetPath does not already exist, it is added to the list. If already exists in the list, do nothing. Sheet instances allow for the sharing in complex hierarchies which allows for per instance data such as page number for sheets to stored.

Parameters
[in]aInstanceis the KIID_PATH of the sheet instance to the instance list.
Returns
false if the instance already exists, true if the instance was added.

Definition at line 1093 of file sch_sheet.cpp.

1094 {
1095  // a empty sheet path is illegal:
1096  wxCHECK( aSheetPath.size() > 0, false );
1097 
1098  wxString path;
1099 
1100  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1101  {
1102  // if aSheetPath is found, nothing to do:
1103  if( instance.m_Path == aSheetPath )
1104  return false;
1105  }
1106 
1107  SCH_SHEET_INSTANCE instance;
1108 
1109  instance.m_Path = aSheetPath;
1110 
1111  // This entry does not exist: add it with an empty page number.
1112  m_instances.emplace_back( instance );
1113  return true;
1114 }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
A simple container for sheet instance information.

References m_instances, SCH_SHEET_INSTANCE::m_Path, and path.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_SHEET_LIST::SetInitialPageNumbers(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), and SCH_SHEET_LIST::UpdateSheetInstances().

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

300 {
301  wxASSERT( aSheetPin != NULL );
302  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
303 
304  aSheetPin->SetParent( this );
305  m_pins.push_back( aSheetPin );
306  renumberPins();
307 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:166
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:829
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), and CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins().

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

Definition at line 445 of file sch_item.h.

446  {
447  if( GetFieldsAutoplaced() )
449  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:433
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:451

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

516 {
517  wxSize textSize = m_fields[ SHEETNAME ].GetTextSize();
518  int borderMargin = KiROUND( GetPenWidth() / 2.0 ) + 4;
519  int margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.5 );
520 
521  if( IsVerticalOrientation() )
522  {
523  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( -margin, m_size.y ) );
524  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
525  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
526  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_VERT );
527  }
528  else
529  {
530  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( 0, -margin ) );
531  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
532  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
533  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
534  }
535 
536  textSize = m_fields[ SHEETFILENAME ].GetTextSize();
537  margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.4 );
538 
539  if( IsVerticalOrientation() )
540  {
541  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( m_size.x + margin, m_size.y ) );
542  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
543  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
544  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_VERT );
545  }
546  else
547  {
548  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( 0, m_size.y + margin ) );
549  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
550  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
551  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
552  }
553 
555 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
int GetPenWidth() const override
Definition: sch_sheet.cpp:509
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:351
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:68
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51

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

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_DRAWING_TOOLS::DrawSheet(), Resize(), Rotate(), and EE_POINT_EDITOR::updateParentItem().

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 355 of file sch_sheet.h.

356  {
357  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
358  ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS ) ||
359  ( aItem->Type() == SCH_NO_CONNECT_T );
360  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

◆ ClassOf()

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

Definition at line 67 of file sch_sheet.h.

68  {
69  return aItem && SCH_SHEET_T == aItem->Type();
70  }
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadNets().

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

472 {
473  auto i = m_pins.begin();
474 
475  while( i != m_pins.end() )
476  {
477  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
478  const SCH_HIERLABEL* HLabel = NULL;
479 
480  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
481  {
482  if( (*i)->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
483  {
484  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
485  break;
486  }
487  }
488 
489  if( HLabel == NULL ) // Hlabel not found: delete sheet label.
490  i = m_pins.erase( i );
491  else
492  ++i;
493  }
494 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

References 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

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

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

385 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:497

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 204 of file eda_item.h.

204 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 216 of file eda_item.h.

217  {
219  DO_NOT_DRAW );
220  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:115
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: eda_item.h:104
#define CANDIDATE
flag indicating that the structure is connected
Definition: eda_item.h:117
#define DO_NOT_DRAW
Used to disable draw function.
Definition: eda_item.h:119
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:112
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:113
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * SCH_SHEET::Clone ( ) const
overridevirtual

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

151 {
152  return new SCH_SHEET( *this );
153 }
SCH_SHEET(EDA_ITEM *aParent=nullptr, const wxPoint &pos=wxPoint(0, 0))
Definition: sch_sheet.cpp:73

References SCH_SHEET().

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ ComparePageNum()

int SCH_SHEET::ComparePageNum ( const wxString &  aPageNumberA,
const wxString  aPageNumberB 
)
static

Compares page numbers of schematic sheets.

Returns
0 if the page numbers are equal, -1 if aPageNumberA < aPageNumberB, 1 otherwise

Definition at line 1150 of file sch_sheet.cpp.

1151 {
1152  if( aPageNumberA == aPageNumberB )
1153  return 0; // A == B
1154 
1155  // First sort numerically if the page numbers are integers
1156  long pageA, pageB;
1157  bool isIntegerPageA = aPageNumberA.ToLong( &pageA );
1158  bool isIntegerPageB = aPageNumberB.ToLong( &pageB );
1159 
1160  if( isIntegerPageA && isIntegerPageB )
1161  {
1162  if( pageA < pageB )
1163  return -1; //A < B
1164  else
1165  return 1; // A > B
1166  }
1167 
1168  // Numerical page numbers always before strings
1169  if( isIntegerPageA )
1170  return -1; //A < B
1171  else if( isIntegerPageB )
1172  return 1; // A > B
1173 
1174  // If not numeric, then sort as strings
1175  int result = aPageNumberA.Cmp( aPageNumberB );
1176 
1177  if( result > 0 )
1178  return 1; // A > B
1179 
1180  return -1; //A < B
1181 }

Referenced by SCH_SHEET_PATH::ComparePageNumAndName().

◆ ConnectedItems()

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

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

Definition at line 164 of file sch_item.cpp.

165 {
166  return m_connected_items[ aSheet ];
167 }
std::unordered_map< SCH_SHEET_PATH, SCH_ITEM_SET > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition: sch_item.h:503

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Retrieve the connection associated with this object in the given sheet.

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

132 {
133  if( !aSheet )
134  aSheet = &Schematic()->CurrentSheet();
135 
136  auto it = m_connection_map.find( *aSheet );
137 
138  if( it == m_connection_map.end() )
139  return nullptr;
140  else
141  return it->second;
142 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:506
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:119

References SCHEMATIC::CurrentSheet(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_EDIT_FRAME::OnModify(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 422 of file sch_item.h.

422 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ CountSheets()

int SCH_SHEET::CountSheets ( ) const

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

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

Definition at line 691 of file sch_sheet.cpp.

692 {
693  int count = 1; //1 = this!!
694 
695  if( m_screen )
696  {
697  for( auto aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
698  count += static_cast<SCH_SHEET*>( aItem )->CountSheets();
699  }
700 
701  return count;
702 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

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

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME aFrame)
inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 267 of file sch_item.h.

267 { }

◆ doIsConnected()

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

Provide 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
aPositionis a reference to a wxPoint object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented from SCH_ITEM.

Definition at line 339 of file sch_sheet.cpp.

340 {
341  for( SCH_SHEET_PIN* sheetPin : m_pins )
342  {
343  if( sheetPin->GetPosition() == aPosition )
344  return true;
345  }
346 
347  return false;
348 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

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 78 of file sch_item.cpp.

79 {
80  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
81 
82  if( !doClone )
83  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
84 
85  newItem->ClearFlags( SELECTED | BRIGHTENED );
86 
87  newItem->RunOnChildren(
88  []( SCH_ITEM* aChild )
89  {
90  aChild->ClearFlags( SELECTED | BRIGHTENED );
91  } );
92 
93  return newItem;
94 }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:81
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
Definition: sch_item.h:453
Definition: kiid.h:44
#define BRIGHTENED
item is drawn with a bright contour
Definition: eda_item.h:131
#define SELECTED
Definition: eda_item.h:114
const KIID m_Uuid
Definition: eda_item.h:525
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 86 of file inspectable.h.

87  {
89  TYPE_ID thisType = TYPE_HASH( *this );
90  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
91  return object ? aProperty->getter( object ) : wxAny();
92  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >
T INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 95 of file inspectable.h.

96  {
98  TYPE_ID thisType = TYPE_HASH( *this );
99  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
100  return object ? aProperty->get<T>( object ) : T();
101  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >
boost::optional<T> INSPECTABLE::Get ( const wxString &  aProperty)
inlineinherited

Definition at line 104 of file inspectable.h.

105  {
107  TYPE_ID thisType = TYPE_HASH( *this );
108  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
109  boost::optional<T> ret;
110 
111  if( prop )
112  {
113  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
114 
115  if( object )
116  ret = prop->get<T>( object );
117  }
118 
119  return ret;
120  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
T get(void *aObject)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetBackgroundColor()

◆ GetBodyBoundingBox()

const EDA_RECT SCH_SHEET::GetBodyBoundingBox ( ) const

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

Definition at line 568 of file sch_sheet.cpp.

569 {
570  wxPoint end;
571  EDA_RECT box( m_pos, m_size );
572  int lineWidth = GetPenWidth();
573  int textLength = 0;
574 
575  // Calculate bounding box X size:
576  end.x = std::max( m_size.x, textLength );
577 
578  // Calculate bounding box pos:
579  end.y = m_size.y;
580  end += m_pos;
581 
582  box.SetEnd( end );
583  box.Inflate( lineWidth / 2 );
584 
585  return box;
586 }
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
int GetPenWidth() const override
Definition: sch_sheet.cpp:509
Handle the component boundary box.
Definition: eda_rect.h:42

References GetPenWidth(), EDA_RECT::Inflate(), m_pos, m_size, and EDA_RECT::SetEnd().

Referenced by GetBoundingBox(), and HitTest().

◆ GetBorderColor()

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const
inline

Definition at line 108 of file sch_sheet.h.

108 { return m_borderWidth; }
int m_borderWidth
Definition: sch_sheet.h:456

References m_borderWidth.

Referenced by GetPenWidth(), SCH_SEXPR_PLUGIN::saveSheet(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetBoundingBox()

const EDA_RECT SCH_SHEET::GetBoundingBox ( ) const
overridevirtual

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

590 {
592 
593  for( const SCH_FIELD& field : m_fields )
594  box.Merge( field.GetBoundingBox() );
595 
596  return box;
597 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:431
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:568
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
Handle the component boundary box.
Definition: eda_rect.h:42

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

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 72 of file sch_sheet.h.

73  {
74  return wxT( "SCH_SHEET" );
75  }

Referenced by operator=().

◆ GetConnectionPoints()

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

Add all the connection points for this item to aPoints.

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

Parameters
aPointsis the list of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 865 of file sch_sheet.cpp.

866 {
867  std::vector<wxPoint> retval;
868 
869  for( SCH_SHEET_PIN* sheetPin : m_pins )
870  retval.push_back( sheetPin->GetPosition() );
871 
872  return retval;
873 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins.

◆ GetContextualTextVars()

void SCH_SHEET::GetContextualTextVars ( wxArrayString *  aVars) const

Return the list of system text vars & fields for this sheet.

Definition at line 196 of file sch_sheet.cpp.

197 {
198  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
199  aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
200 
201  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
202  aVars->push_back( m_fields[i].GetName() );
203 
204  aVars->push_back( wxT( "#" ) );
205  aVars->push_back( wxT( "##" ) );
207 }
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:138
static void GetContextualTextVars(wxArrayString *aVars)
Definition: title_block.cpp:73
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

References TITLE_BLOCK::GetContextualTextVars(), SCH_SCREEN::GetTitleBlock(), m_fields, m_screen, and SHEET_MANDATORY_FIELDS.

Referenced by DIALOG_LABEL_EDITOR::onScintillaCharAdded(), and DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded().

◆ GetDefaultFieldName()

const wxString SCH_SHEET::GetDefaultFieldName ( int  aFieldNdx)
static

Definition at line 46 of file sch_sheet.cpp.

47 {
48  static void* locale = nullptr;
49  static wxString sheetnameDefault;
50  static wxString sheetfilenameDefault;
51  static wxString fieldDefault;
52 
53  // Fetching translations can take a surprising amount of time when loading libraries,
54  // so only do it when necessary.
55  if( Pgm().GetLocale() != locale )
56  {
57  sheetnameDefault = _( "Sheet name" );
58  sheetfilenameDefault = _( "Sheet file" );
59  fieldDefault = _( "Field%d" );
60  locale = Pgm().GetLocale();
61  }
62 
63  // Fixed values for the mandatory fields
64  switch( aFieldNdx )
65  {
66  case SHEETNAME: return sheetnameDefault;
67  case SHEETFILENAME: return sheetfilenameDefault;
68  default: return wxString::Format( fieldDefault, aFieldNdx );
69  }
70 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#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_SHEET_PROPERTIES::OnAddField(), SCH_SEXPR_PLUGIN::saveField(), and SCH_SHEET().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 208 of file eda_item.h.

209  {
210  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
212 
213  return m_flags & mask;
214  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
#define IS_MOVED
Item being moved.
Definition: eda_item.h:106
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:120
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531
#define IS_NEW
New item, just created.
Definition: eda_item.h:107

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ GetEndPoints()

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

Add 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
aItemListis the list of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 841 of file sch_sheet.cpp.

842 {
843  for( SCH_SHEET_PIN* sheetPin : m_pins )
844  {
845  wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
846  wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
847 
848  sheetPin->GetEndPoints( aItemList );
849  }
850 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins, and SCH_SHEET_PIN_T.

◆ GetFields() [1/2]

◆ GetFields() [2/2]

const std::vector<SCH_FIELD>& SCH_SHEET::GetFields ( ) const
inline

Definition at line 89 of file sch_sheet.h.

89 { return m_fields; }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452

References m_fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 433 of file sch_item.h.

433 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), and EE_POINT_EDITOR::updateParentItem().

◆ GetFileName()

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 309 of file eda_item.h.

309 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:302

References EDA_ITEM::GetPosition().

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

◆ GetInstances()

const std::vector<SCH_SHEET_INSTANCE> SCH_SHEET::GetInstances ( ) const
Returns
the list of SCH_SHEET_INSTANCE objects for this sheet.

◆ GetLayer()

◆ GetMenuImage()

BITMAPS SCH_SHEET::GetMenuImage ( ) const
overridevirtual

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

References add_hierarchical_subsheet.

◆ GetMinHeight()

int SCH_SHEET::GetMinHeight ( bool  aFromTop) 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 437 of file sch_sheet.cpp.

438 {
439  int pinsTop = m_pos.y + m_size.y;
440  int pinsBottom = m_pos.y;
441 
442  for( size_t i = 0; i < m_pins.size(); i++ )
443  {
444  int edge = m_pins[i]->GetEdge();
445 
446  if( edge == SHEET_RIGHT_SIDE || edge == SHEET_LEFT_SIDE )
447  {
448  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
449 
450  pinsTop = std::min( pinsTop, pinRect.GetTop() );
451  pinsBottom = std::max( pinsBottom, pinRect.GetBottom() );
452  }
453  }
454 
455  pinsTop = bumpToNextGrid( pinsTop, -1 );
456  pinsBottom = bumpToNextGrid( pinsBottom, 1 );
457 
458  int pinMinHeight;
459 
460  if( pinsTop >= pinsBottom )
461  pinMinHeight = 0;
462  else if( aFromTop )
463  pinMinHeight = pinsBottom - m_pos.y;
464  else
465  pinMinHeight = m_pos.y + m_size.y - pinsTop;
466 
467  return std::max( pinMinHeight, Mils2iu( MIN_SHEET_HEIGHT ) );
468 }
int GetTop() const
Definition: eda_rect.h:118
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
int GetBottom() const
Definition: eda_rect.h:119
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Handle the component boundary box.
Definition: eda_rect.h:42
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:38
int bumpToNextGrid(const int aVal, const int aDirection)
Definition: sch_sheet.cpp:395

References bumpToNextGrid(), EDA_RECT::GetBottom(), EDA_RECT::GetTop(), m_pins, m_pos, m_size, MIN_SHEET_HEIGHT, SHEET_LEFT_SIDE, and SHEET_RIGHT_SIDE.

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( bool  aFromLeft) 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 403 of file sch_sheet.cpp.

404 {
405  int pinsLeft = m_pos.x + m_size.x;
406  int pinsRight = m_pos.x;
407 
408  for( size_t i = 0; i < m_pins.size(); i++ )
409  {
410  int edge = m_pins[i]->GetEdge();
411 
412  if( edge == SHEET_TOP_SIDE || edge == SHEET_BOTTOM_SIDE )
413  {
414  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
415 
416  pinsLeft = std::min( pinsLeft, pinRect.GetLeft() );
417  pinsRight = std::max( pinsRight, pinRect.GetRight() );
418  }
419  }
420 
421  pinsLeft = bumpToNextGrid( pinsLeft, -1 );
422  pinsRight = bumpToNextGrid( pinsRight, 1 );
423 
424  int pinMinWidth;
425 
426  if( pinsLeft >= pinsRight )
427  pinMinWidth = 0;
428  else if( aFromLeft )
429  pinMinWidth = pinsRight - m_pos.x;
430  else
431  pinMinWidth = m_pos.x + m_size.x - pinsLeft;
432 
433  return std::max( pinMinWidth, Mils2iu( MIN_SHEET_WIDTH ) );
434 }
int GetLeft() const
Definition: eda_rect.h:117
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:37
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
int GetRight() const
Definition: eda_rect.h:116
Handle the component boundary box.
Definition: eda_rect.h:42
int bumpToNextGrid(const int aVal, const int aDirection)
Definition: sch_sheet.cpp:395

References bumpToNextGrid(), EDA_RECT::GetLeft(), EDA_RECT::GetRight(), m_pins, m_pos, m_size, MIN_SHEET_WIDTH, SHEET_BOTTOM_SIDE, and SHEET_TOP_SIDE.

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMsgPanelInfo()

void SCH_SHEET::GetMsgPanelInfo ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 705 of file sch_sheet.cpp.

706 {
707  aList.emplace_back( _( "Sheet Name" ), m_fields[ SHEETNAME ].GetText() );
708 
709  if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
710  {
711  SCH_SHEET_PATH path = schframe->GetCurrentSheet();
712  path.push_back( this );
713 
714  aList.emplace_back( _( "Hierarchical Path" ), path.PathHumanReadable( false ) );
715  }
716 
717  aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText() );
718 }
Schematic editor (Eeschema) main window.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
#define _(s)
Definition: 3d_actions.cpp:33

References _, m_fields, path, SHEETFILENAME, and SHEETNAME.

◆ GetName()

wxString SCH_SHEET::GetName ( void  ) const
inline

◆ GetPageNumber()

wxString SCH_SHEET::GetPageNumber ( const SCH_SHEET_PATH aInstance) const

Return the sheet page number for aInstance.

Returns
the page number for the requested sheet instance.

Definition at line 1117 of file sch_sheet.cpp.

1118 {
1119  wxString pageNumber;
1120  KIID_PATH path = aInstance.Path();
1121 
1122  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1123  {
1124  if( instance.m_Path == path )
1125  {
1126  pageNumber = instance.m_PageNumber;
1127  break;
1128  }
1129  }
1130 
1131  return pageNumber;
1132 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
A simple container for sheet instance information.

References m_instances, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_SHEET_LIST::AllSheetPageNumbersEmpty(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_PATH::GetPageNumber(), HIERARCHY_NAVIG_DLG::getRootString(), SCH_SHEET_LIST::GetSheetInstances(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ GetParent()

◆ GetPenWidth()

int SCH_SHEET::GetPenWidth ( ) const
overridevirtual
Returns
the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 509 of file sch_sheet.cpp.

510 {
511  return std::max( GetBorderWidth(), 1 );
512 }
int GetBorderWidth() const
Definition: sch_sheet.h:108

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

498 {
499  for( SCH_SHEET_PIN* pin : m_pins )
500  {
501  if( pin->HitTest( aPosition ) )
502  return pin;
503  }
504 
505  return NULL;
506 }
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins, NULL, and pin.

◆ GetPins() [1/2]

◆ GetPins() [2/2]

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

Definition at line 186 of file sch_sheet.h.

187  {
188  return m_pins;
189  }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451

References m_pins.

◆ GetPosition()

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

601 {
602  EDA_RECT box( m_pos, m_size );
603  return box.GetCenter();
604 }
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by SCH_EDIT_TOOL::Rotate().

◆ GetScreen()

SCH_SCREEN* SCH_SHEET::GetScreen ( ) const
inline

Definition at line 103 of file sch_sheet.h.

103 { return m_screen; }
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

References m_screen.

Referenced by SCH_SCREENS::buildScreenList(), SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), SCH_EDITOR_CONTROL::doCopy(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), SCHEMATIC::GetFileName(), getSheetBbox(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_EDIT_FRAME::InitSheet(), SCH_SHEET_PATH::LastScreen(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), SCH_ALTIUM_PLUGIN::ParseImage(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseSheet(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_SHEET_PATH::PathHumanReadable(), SCH_EDIT_TOOL::Properties(), SCHEMATIC::RootScreen(), SCH_EDIT_FRAME::SaveEEFile(), SCH_EDIT_FRAME::SaveProject(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and SCH_EDITOR_CONTROL::updatePastedSheet().

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

180 {
181  if( m_screen == NULL )
182  return 0;
183 
184  return m_screen->GetRefCount();
185 }
#define NULL
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
int GetRefCount() const
Definition: sch_screen.h:144

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

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged().

◆ GetSelectMenuText()

wxString SCH_SHEET::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

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

925 {
926  return wxString::Format( _( "Hierarchical Sheet %s" ),
927  m_fields[ SHEETNAME ].GetText() );
928 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
#define _(s)
Definition: 3d_actions.cpp:33

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

Referenced by Matches().

◆ GetSize()

wxSize SCH_SHEET::GetSize ( ) const
inline

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 187 of file eda_item.h.

188  {
189  return m_status & type;
190  }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 200 of file eda_item.h.

200 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 235 of file sch_item.h.

235 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:499

References SCH_ITEM::m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 464 of file sch_item.h.

464 { wxCHECK( false, STROKE_PARAMS() ); }
Simple container to manage line stroke parameters.
Definition: sch_item.h:155

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also
STROKE_PARAMS
Returns
true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 462 of file sch_item.h.

462 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), and SCH_EDIT_TOOL::Properties().

◆ HasPin()

bool SCH_SHEET::HasPin ( const wxString &  aName) const

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

328 {
329  for( SCH_SHEET_PIN* pin : m_pins )
330  {
331  if( pin->GetText().CmpNoCase( aName ) == 0 )
332  return true;
333  }
334 
335  return false;
336 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins, and pin.

Referenced by SCH_DRAWING_TOOLS::importHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( ) const
inline

Definition at line 223 of file sch_sheet.h.

223 { return !m_pins.empty(); }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451

References m_pins.

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( ) const

Check all sheet labels against schematic for undefined hierarchical labels.

Returns
True if there are any undefined labels.

Definition at line 372 of file sch_sheet.cpp.

373 {
374  for( SCH_SHEET_PIN* pin : m_pins )
375  {
376  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
377  const SCH_HIERLABEL* HLabel = nullptr;
378  for( auto aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
379  {
380  if( !pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
381  {
382  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
383  break;
384  }
385  }
386 
387  if( HLabel == nullptr ) // Corresponding hierarchical label not found.
388  return true;
389  }
390 
391  return false;
392 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

References SCH_SCREEN::Items(), m_pins, m_screen, EE_RTREE::OfType(), pin, 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

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

938 {
939  EDA_RECT rect = GetBodyBoundingBox();
940 
941  rect.Inflate( aAccuracy );
942 
943  return rect.Contains( aPosition );
944 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:568
Handle the component boundary box.
Definition: eda_rect.h:42
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

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

948 {
949  EDA_RECT rect = aRect;
950 
951  rect.Inflate( aAccuracy );
952 
953  if( aContained )
954  return rect.Contains( GetBodyBoundingBox() );
955 
956  return rect.Intersects( GetBodyBoundingBox() );
957 }
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:568
Handle the component boundary box.
Definition: eda_rect.h:42
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection ( const SCH_SHEET_PATH aPath,
CONNECTION_GRAPH aGraph 
)
inherited

Create a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize.

Definition at line 176 of file sch_item.cpp.

178 {
179  SCH_CONNECTION* connection = Connection( &aSheet );
180 
181  if( connection )
182  {
183  connection->Reset();
184  }
185  else
186  {
187  connection = new SCH_CONNECTION( this );
188  m_connection_map.insert( std::make_pair( aSheet, connection ) );
189  }
190 
191  connection->SetGraph( aGraph );
192  connection->SetSheet( aSheet );
193  return connection;
194 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:506
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(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

◆ IsBrightened()

◆ IsConnectable()

bool SCH_SHEET::IsConnectable ( ) const
inlineoverridevirtual
Returns
true if the schematic item can connect to another schematic item.

Reimplemented from SCH_ITEM.

Definition at line 353 of file sch_sheet.h.

353 { return true; }

◆ IsConnected()

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

Test the item to see if it is connected to aPoint.

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

Definition at line 122 of file sch_item.cpp.

123 {
124  if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
125  return false;
126 
127  return doIsConnected( aPosition );
128 }
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:116
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:493
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:118
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

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

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 424 of file sch_item.h.

424 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:508

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

355 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:109
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered
Definition: eda_item.h:138
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 256 of file eda_item.h.

256 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 265 of file sch_item.h.

265 { return false; }

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const
inlinevirtualinherited
Returns
true if the object is locked, else false.

Definition at line 255 of file sch_item.h.

255 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 168 of file eda_item.h.

168 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:103
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET::IsMovableFromAnchorPoint ( ) const
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, symbols).

Returns
false for a hierarchical sheet.

Reimplemented from SCH_ITEM.

Definition at line 86 of file sch_sheet.h.

86 { return false; }

◆ IsMoving()

◆ IsNew()

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const wxPoint &  aPos) const
inlinevirtualinherited
Returns
true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented in SCH_COMPONENT, SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_SHEET_PIN, SCH_JUNCTION, and SCH_PIN.

Definition at line 368 of file sch_item.h.

368 { return false; }

Referenced by EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ IsReplaceable()

bool SCH_SHEET::IsReplaceable ( ) const
inlineoverridevirtual

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

337 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 175 of file eda_item.h.

175 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References IS_RESIZED, and EDA_ITEM::m_flags.

◆ IsRootSheet()

bool SCH_SHEET::IsRootSheet ( ) const
Returns
true if this sheet is the root sheet.

Definition at line 188 of file sch_sheet.cpp.

189 {
190  wxCHECK_MSG( Schematic(), false, "Can't call IsRootSheet without setting a schematic" );
191 
192  return &Schematic()->Root() == this;
193 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
SCH_SHEET & Root() const
Definition: schematic.h:92

References SCHEMATIC::Root(), and SCH_ITEM::Schematic().

Referenced by SCH_SEXPR_PLUGIN::Format(), and SCH_EDIT_FRAME::SaveProject().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & SELECTED; }
#define SELECTED
Definition: eda_item.h:114
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

◆ IsType()

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

Check 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 VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, FP_TEXT, SCH_LINE, FP_SHAPE, and PCB_TEXT.

Definition at line 233 of file eda_item.h.

234  {
235  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
236  return true;
237 
238  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
239  {
240  if( m_structType == *p )
241  return true;
242  }
243 
244  return false;
245  }
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:538

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 351 of file sch_sheet.cpp.

352 {
353  int leftRight = 0;
354  int topBottom = 0;
355 
356  for( SCH_SHEET_PIN* pin : m_pins )
357  {
358  switch( pin->GetEdge() )
359  {
360  case SHEET_LEFT_SIDE: leftRight++; break;
361  case SHEET_RIGHT_SIDE: leftRight++; break;
362  case SHEET_TOP_SIDE: topBottom++; break;
363  case SHEET_BOTTOM_SIDE: topBottom++; break;
364  default: break;
365  }
366  }
367 
368  return topBottom > 0 && leftRight == 0;
369 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins, pin, 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 172 of file eda_item.h.

172 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111
STATUS_FLAGS m_flags
Definition: eda_item.h:531

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

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

Definition at line 345 of file eda_item.h.

349  {
350  for( auto it : aList )
351  {
352  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
354  return SEARCH_RESULT::QUIT;
355  }
356 
358  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91

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

Referenced by GERBER_FILE_IMAGE::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

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 364 of file eda_item.h.

366  {
367  for( auto it : aList )
368  {
369  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
371  return SEARCH_RESULT::QUIT;
372  }
373 
375  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:91

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

◆ 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
[in]aScreenThe SCH_SCREEN* screen that we search for.
[in]aListThe SCH_SHEET_PATH* that must be used.
Returns
true if found.

Definition at line 665 of file sch_sheet.cpp.

666 {
667  if( m_screen )
668  {
669  aList->push_back( this );
670 
671  if( m_screen == aScreen )
672  return true;
673 
674  for( auto item : m_screen->Items().OfType( SCH_SHEET_T ) )
675  {
676  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
677 
678  if( sheet->LocatePathOfScreen( aScreen, aList ) )
679  {
680  return true;
681  }
682  }
683 
684  aList->pop_back();
685  }
686 
687  return false;
688 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
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:54
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:665
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

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 CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LocatePathOfScreen(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseParameter(), and SCH_ALTIUM_PLUGIN::ParsePowerPort().

◆ Matches() [1/2]

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

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

821 {
822  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
823 
824  // Sheets are searchable via the child field and pin item text.
825  return false;
826 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: sch_sheet.cpp:924
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,
const wxFindReplaceData &  aSearchData 
) const
protectedinherited

Compare 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 116 of file eda_item.cpp.

117 {
118  wxString text = aText;
119  wxString searchText = aSearchData.GetFindString();
120 
121  // Don't match if searching for replaceable item and the item doesn't support text replace.
122  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
123  return false;
124 
125  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
126  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
127 
128  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
129  {
130  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
131  return text.Matches( searchText );
132 
133  return text.MakeUpper().Matches( searchText.MakeUpper() );
134  }
135 
136  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
137  return aText.Find( searchText ) != wxNOT_FOUND;
138 
139  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
140 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:453

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

◆ MirrorHorizontally()

void SCH_SHEET::MirrorHorizontally ( int  aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 785 of file sch_sheet.cpp.

786 {
787  MIRROR( m_pos.x, aCenter );
788  m_pos.x -= m_size.x;
789 
790  for( SCH_SHEET_PIN* sheetPin : m_pins )
791  sheetPin->MirrorHorizontally( aCenter );
792 }
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

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

◆ MirrorVertically()

void SCH_SHEET::MirrorVertically ( int  aCenter)
overridevirtual

Mirror item vertically about aCenter.

Implements SCH_ITEM.

Definition at line 775 of file sch_sheet.cpp.

776 {
777  MIRROR( m_pos.y, aCenter );
778  m_pos.y -= m_size.y;
779 
780  for( SCH_SHEET_PIN* sheetPin : m_pins )
781  sheetPin->MirrorVertically( aCenter );
782 }
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:40
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

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

◆ Move()

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

Move the item by aMoveVector to a new position.

Implements SCH_ITEM.

Definition at line 721 of file sch_sheet.cpp.

722 {
723  m_pos += aMoveVector;
724 
725  for( SCH_SHEET_PIN* pin : m_pins )
726  pin->Move( aMoveVector );
727 
728  for( SCH_FIELD& field : m_fields )
729  field.Move( aMoveVector );
730 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
wxPoint m_pos
Definition: sch_sheet.h:454
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452

References m_fields, m_pins, m_pos, and pin.

Referenced by SetPosition().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH aSheet = nullptr) const
inherited

Definition at line 145 of file sch_item.cpp.

146 {
147  if( m_connection_map.size() )
148  {
149  SCH_CONNECTION* connection = Connection( aSheet );
150 
151  if( connection )
152  {
153  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
154  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
155 
156  return netSettings.m_NetClasses.Find( netclassName );
157  }
158  }
159 
160  return nullptr;
161 }
NETCLASSPTR Find(const wxString &aName) const
Search this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
const wxString & GetNetclassName(const wxString &aNetName) const
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
NET_SETTINGS & NetSettings()
Definition: project_file.h:94
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
NETCLASSES m_NetClasses
Definition: net_settings.h:39
wxString Name(bool aIgnoreSheet=false) const
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:31
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:506
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:75
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ operator<() [1/2]

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

Reimplemented from SCH_ITEM.

Definition at line 1076 of file sch_sheet.cpp.

1077 {
1078  if( Type() != aItem.Type() )
1079  return Type() < aItem.Type();
1080 
1081  auto sheet = static_cast<const SCH_SHEET*>( &aItem );
1082 
1083  if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText() )
1084  return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
1085 
1086  if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText() )
1087  return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
1088 
1089  return false;
1090 }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

◆ operator<() [2/2]

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

Test if another item is less than this object.

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

Definition at line 169 of file eda_item.cpp.

170 {
171  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
172  GetClass() ) );
173 
174  return false;
175 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

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

◆ operator=()

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

Definition at line 1046 of file sch_sheet.cpp.

1047 {
1048  wxCHECK_MSG( Type() == aItem.Type(), *this,
1049  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1050  GetClass() );
1051 
1052  if( &aItem != this )
1053  {
1054  SCH_ITEM::operator=( aItem );
1055 
1056  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
1057 
1058  m_pos = sheet->m_pos;
1059  m_size = sheet->m_size;
1060  m_fields = sheet->m_fields;
1061 
1062  for( SCH_SHEET_PIN* pin : sheet->m_pins )
1063  {
1064  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
1065  m_pins.back()->SetParent( this );
1066  }
1067 
1068  for( const SCH_SHEET_INSTANCE& instance : sheet->m_instances )
1069  m_instances.emplace_back( instance );
1070  }
1071 
1072  return *this;
1073 }
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:446
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
wxString GetClass() const override
Return the class name.
Definition: sch_sheet.h:72
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:177
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
A simple container for sheet instance information.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References GetClass(), SCH_ITEM::GetClass(), m_fields, m_instances, m_pins, m_pos, m_size, EDA_ITEM::operator=(), pin, SCH_SHEET_PIN, and EDA_ITEM::Type().

◆ Plot()

void SCH_SHEET::Plot ( PLOTTER aPlotter) const
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotteris the PLOTTER object to plot to.

Reimplemented from SCH_ITEM.

Definition at line 960 of file sch_sheet.cpp.

961 {
962  wxString msg;
963  wxPoint pos;
964  auto* settings = dynamic_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
965  bool override = settings ? settings->m_OverrideItemColors : false;
966  COLOR4D borderColor = GetBorderColor();
967  COLOR4D backgroundColor = GetBackgroundColor();
968 
969  if( override || borderColor == COLOR4D::UNSPECIFIED )
970  borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
971 
972  if( override || backgroundColor == COLOR4D::UNSPECIFIED )
973  backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
974 
975  aPlotter->SetColor( backgroundColor );
976  // Do not fill shape in B&W mode, otherwise texts are unreadable
977  bool fill = aPlotter->GetColorMode();
978 
980  1.0 );
981 
982  aPlotter->SetColor( borderColor );
983 
984  int penWidth = std::max( GetPenWidth(), aPlotter->RenderSettings()->GetMinPenWidth() );
985  aPlotter->SetCurrentLineWidth( penWidth );
986 
987  aPlotter->MoveTo( m_pos );
988  pos = m_pos;
989  pos.x += m_size.x;
990 
991  aPlotter->LineTo( pos );
992  pos.y += m_size.y;
993 
994  aPlotter->LineTo( pos );
995  pos = m_pos;
996  pos.y += m_size.y;
997 
998  aPlotter->LineTo( pos );
999  aPlotter->FinishTo( m_pos );
1000 
1001  for( SCH_FIELD field : m_fields )
1002  field.Plot( aPlotter );
1003 
1004  /* Draw texts : SheetLabel */
1005  for( SCH_SHEET_PIN* sheetPin : m_pins )
1006  sheetPin->Plot( aPlotter );
1007 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
virtual void SetColor(COLOR4D color)=0
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0
wxSize m_size
Definition: sch_sheet.h:455
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:111
wxPoint m_pos
Definition: sch_sheet.h:454
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:114
void LineTo(const wxPoint &pos)
Definition: plotter.h:262
int GetPenWidth() const override
Definition: sch_sheet.cpp:509
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:155
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98
bool GetColorMode() const
Definition: plotter.h:152

References FILLED_SHAPE, PLOTTER::FinishTo(), GetBackgroundColor(), GetBorderColor(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetPenWidth(), LAYER_SHEET, LAYER_SHEET_BACKGROUND, PLOTTER::LineTo(), m_fields, m_pins, m_pos, m_size, PLOTTER::MoveTo(), NO_FILL, PLOTTER::Rect(), PLOTTER::RenderSettings(), PLOTTER::SetColor(), and PLOTTER::SetCurrentLineWidth().

◆ Print()

void SCH_SHEET::Print ( const RENDER_SETTINGS aSettings,
const wxPoint &  aOffset 
)
overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters
aOffsetis the drawing offset (usually {0,0} but can be different when moving an object).

Implements SCH_ITEM.

Definition at line 1010 of file sch_sheet.cpp.

1011 {
1012  wxDC* DC = aSettings->GetPrintDC();
1013  wxPoint pos = m_pos + aOffset;
1014  int lineWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
1015  const auto* settings = dynamic_cast<const KIGFX::SCH_RENDER_SETTINGS*>( aSettings );
1016  bool override = settings && settings->m_OverrideItemColors;
1017  COLOR4D border = GetBorderColor();
1018  COLOR4D background = GetBackgroundColor();
1019 
1020  if( override || border == COLOR4D::UNSPECIFIED )
1021  border = aSettings->GetLayerColor( LAYER_SHEET );
1022 
1023  if( override || background == COLOR4D::UNSPECIFIED )
1024  background = aSettings->GetLayerColor( LAYER_SHEET_BACKGROUND );
1025 
1026  if( GetGRForceBlackPenState() ) // printing in black & white
1027  background = COLOR4D::UNSPECIFIED;
1028 
1029  if( background != COLOR4D::UNSPECIFIED )
1030  {
1031  GRFilledRect( nullptr, DC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, 0,
1032  background, background );
1033  }
1034 
1035  GRRect( nullptr, DC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, lineWidth, border );
1036 
1037  for( SCH_FIELD& field : m_fields )
1038  field.Print( aSettings, aOffset );
1039 
1040  /* Draw text : SheetLabel */
1041  for( SCH_SHEET_PIN* sheetPin : m_pins )
1042  sheetPin->Print( aSettings, aOffset );
1043 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:882
wxSize m_size
Definition: sch_sheet.h:455
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:111
wxPoint m_pos
Definition: sch_sheet.h:454
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:114
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:842
int GetPenWidth() const override
Definition: sch_sheet.cpp:509
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
wxDC * GetPrintDC() const
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
int GetDefaultPenWidth() const
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:209
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98

References GetBackgroundColor(), GetBorderColor(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRFilledRect(), GRRect(), LAYER_SHEET, LAYER_SHEET_BACKGROUND, m_fields, m_pins, m_pos, and m_size.

◆ RemovePin()

void SCH_SHEET::RemovePin ( const SCH_SHEET_PIN aSheetPin)

Remove aSheetPin from the sheet.

Parameters
aSheetPinThe sheet pin item to remove from the sheet.

Definition at line 310 of file sch_sheet.cpp.

311 {
312  wxASSERT( aSheetPin != NULL );
313  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
314 
315  for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
316  {
317  if( *i == aSheetPin )
318  {
319  m_pins.erase( i );
320  renumberPins();
321  return;
322  }
323  }
324 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:829
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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

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

◆ renumberPins()

void SCH_SHEET::renumberPins ( )
protected

Renumber the sheet pins in the sheet.

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

Definition at line 829 of file sch_sheet.cpp.

830 {
831  int id = 2;
832 
833  for( SCH_SHEET_PIN* pin : m_pins )
834  {
835  pin->SetNumber( id );
836  id++;
837  }
838 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References m_pins, and pin.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

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

Perform 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 143 of file eda_item.cpp.

144 {
145  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
146 
147  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
148  aSearchData.GetFindString() :
149  aSearchData.GetFindString().Upper() );
150 
151  if( result == wxNOT_FOUND )
152  return false;
153 
154  wxString prefix = aText.Left( result );
155  wxString suffix;
156 
157  if( aSearchData.GetFindString().length() + result < aText.length() )
158  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
159 
160  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
161  aText, prefix, aSearchData.GetReplaceString(), suffix );
162 
163  aText = prefix + aSearchData.GetReplaceString() + suffix;
164 
165  return true;
166 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

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

◆ Replace() [2/2]

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

Perform 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_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 442 of file eda_item.h.

443  {
444  return false;
445  }

◆ Resize()

void SCH_SHEET::Resize ( const wxSize &  aSize)

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

Parameters
[in]aSizeThe new size for this sheet.

Definition at line 803 of file sch_sheet.cpp.

804 {
805  if( aSize == m_size )
806  return;
807 
808  m_size = aSize;
809 
810  // Move the fields if we're in autoplace mode
812  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
813 
814  // Move the sheet labels according to the new sheet size.
815  for( SCH_SHEET_PIN* sheetPin : m_pins )
816  sheetPin->ConstrainOnEdge( sheetPin->GetPosition() );
817 }
wxSize m_size
Definition: sch_sheet.h:455
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:515

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

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ ResolveTextVar()

bool SCH_SHEET::ResolveTextVar ( wxString *  token,
int  aDepth = 0 
) const

Resolve any references to system tokens supported by the sheet.

Parameters
aDepthis a counter to limit recursion and circular references.

Definition at line 210 of file sch_sheet.cpp.

211 {
212  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
213  {
214  if( token->IsSameAs( m_fields[i].GetCanonicalName().Upper() ) )
215  {
216  *token = m_fields[i].GetShownText( aDepth + 1 );
217  return true;
218  }
219  }
220 
221  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
222  {
223  if( token->IsSameAs( m_fields[i].GetName() ) )
224  {
225  *token = m_fields[i].GetShownText( aDepth + 1 );
226  return true;
227  }
228  }
229 
230  PROJECT *project = &Schematic()->Prj();
231 
232  if( m_screen->GetTitleBlock().TextVarResolver( token, project ) )
233  {
234  return true;
235  }
236 
237  if( token->IsSameAs( wxT( "#" ) ) )
238  {
239  for( const SCH_SHEET_PATH& sheet : Schematic()->GetSheets() )
240  {
241  if( sheet.Last() == this ) // Current sheet path found
242  {
243  *token = wxString::Format( "%s", sheet.GetPageNumber() );
244  return true;
245  }
246  }
247  }
248  else if( token->IsSameAs( wxT( "##" ) ) )
249  {
250  SCH_SHEET_LIST sheetList = Schematic()->GetSheets();
251  *token = wxString::Format( wxT( "%d" ), (int) sheetList.size() );
252  return true;
253  }
254 
255  return false;
256 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Container for project specific data.
Definition: project.h:62
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:138
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:75
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:87
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
bool TextVarResolver(wxString *aToken, const PROJECT *aProject) const
Definition: title_block.cpp:91

References Format(), SCHEMATIC::GetSheets(), SCH_SCREEN::GetTitleBlock(), m_fields, m_screen, SCHEMATIC::Prj(), project, SCH_ITEM::Schematic(), SHEET_MANDATORY_FIELDS, and TITLE_BLOCK::TextVarResolver().

Referenced by SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), and SCHEMATIC::ResolveCrossReference().

◆ Rotate()

void SCH_SHEET::Rotate ( wxPoint  aCenter)
overridevirtual

Rotate the item around aCenter 90 degrees in the clockwise direction.

Implements SCH_ITEM.

Definition at line 733 of file sch_sheet.cpp.

734 {
735  wxPoint prev = m_pos;
736 
737  RotatePoint( &m_pos, aCenter, 900 );
738  RotatePoint( &m_size.x, &m_size.y, 900 );
739 
740  if( m_size.x < 0 )
741  {
742  m_pos.x += m_size.x;
743  m_size.x = -m_size.x;
744  }
745 
746  if( m_size.y < 0 )
747  {
748  m_pos.y += m_size.y;
749  m_size.y = -m_size.y;
750  }
751 
752  // Pins must be rotated first as that's how we determine vertical vs horizontal
753  // orientation for auto-placement
754  for( SCH_SHEET_PIN* sheetPin : m_pins )
755  sheetPin->Rotate( aCenter );
756 
758  {
759  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
760  }
761  else
762  {
763  // Move the fields to the new position because the parent itself has moved.
764  for( SCH_FIELD& field : m_fields )
765  {
766  wxPoint pos = field.GetTextPos();
767  pos.x -= prev.x - m_pos.x;
768  pos.y -= prev.y - m_pos.y;
769  field.SetTextPos( pos );
770  }
771  }
772 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
wxSize m_size
Definition: sch_sheet.h:455
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
wxPoint m_pos
Definition: sch_sheet.h:454
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:515

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

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

void SCH_SHEET::RunOnChildren ( const std::function< void(SCH_ITEM *)> &  aFunction)
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 914 of file sch_sheet.cpp.

915 {
916  for( SCH_FIELD& field : m_fields )
917  aFunction( &field );
918 
919  for( SCH_SHEET_PIN* pin : m_pins )
920  aFunction( pin );
921 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452

References m_fields, m_pins, and pin.

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note
This hierarchy is not the same as the sheet hierarchy!
Returns
the parent schematic this item lives on, or nullptr.

Definition at line 97 of file sch_item.cpp.

98 {
99  EDA_ITEM* parent = GetParent();
100 
101  while( parent )
102  {
103  if( parent->Type() == SCHEMATIC_T )
104  return static_cast<SCHEMATIC*>( parent );
105  else
106  parent = parent->GetParent();
107  }
108 
109  return nullptr;
110 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:165
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:150
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References EDA_ITEM::GetParent(), SCHEMATIC_T, and EDA_ITEM::Type().

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), inheritNetclass(), IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), ResolveTextVar(), SCH_COMPONENT::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ SearchHierarchy()

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

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

Parameters
aFilenameThe filename to find (MUST be absolute, and in wxPATH_NATIVE encoding).
aScreenA location to return a pointer to the screen (if found).
Returns
true if found, and a pointer to the screen

Definition at line 629 of file sch_sheet.cpp.

630 {
631  if( m_screen )
632  {
633  // Only check the root sheet once and don't recurse.
634  if( !GetParent() )
635  {
636  if( m_screen && m_screen->GetFileName().Cmp( aFilename ) == 0 )
637  {
638  *aScreen = m_screen;
639  return true;
640  }
641  }
642 
643  for( auto aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
644  {
645  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
646  SCH_SCREEN* screen = sheet->m_screen;
647 
648  // Must use the screen's path (which is always absolute) rather than the
649  // sheet's (which could be relative).
650  if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
651  {
652  *aScreen = screen;
653  return true;
654  }
655 
656  if( sheet->SearchHierarchy( aFilename, aScreen ) )
657  return true;
658  }
659  }
660 
661  return false;
662 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
const wxString & GetFileName() const
Definition: sch_screen.h:133
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:629
EDA_ITEM * GetParent() const
Definition: eda_item.h:165
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
EE_RTREE & Items()
Definition: sch_screen.h:103
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448

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(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), and SearchHierarchy().

◆ Set() [1/3]

bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
wxAny &  aValue 
)
inlineinherited

Definition at line 42 of file inspectable.h.

43  {
45  TYPE_ID thisType = TYPE_HASH( *this );
46  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
47 
48  if( object )
49  aProperty->setter( object, aValue );
50 
51  return object != nullptr;
52  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by isCoupledDiffPair().

◆ Set() [2/3]

template<typename T >
bool INSPECTABLE::Set ( PROPERTY_BASE aProperty,
aValue 
)
inlineinherited

Definition at line 55 of file inspectable.h.

56  {
58  TYPE_ID thisType = TYPE_HASH( *this );
59  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
60 
61  if( object )
62  aProperty->set<T>( object, aValue );
63 
64  return object != nullptr;
65  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

template<typename T >
bool INSPECTABLE::Set ( const wxString &  aProperty,
aValue 
)
inlineinherited

Definition at line 68 of file inspectable.h.

69  {
71  TYPE_ID thisType = TYPE_HASH( *this );
72  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
73  void* object = nullptr;
74 
75  if( prop )
76  {
77  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
78 
79  if( object )
80  prop->set<T>( object, aValue );
81  }
82 
83  return object != nullptr;
84  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:42
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
void set(void *aObject, T aValue)
Definition: property.h:261
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ SetBackgroundColor()

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

◆ SetBorderColor()

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

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int  aWidth)
inline

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 426 of file sch_item.h.

426 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:508

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

97  {
98  m_fields = aFields; // vector copying, length is changed possibly
99  }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452

References m_fields.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )
inlineinherited

Definition at line 435 of file sch_item.h.

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFileName()

void SCH_SHEET::SetFileName ( wxString  aFilename)
inline

Definition at line 321 of file sch_sheet.h.

322  {
323  // Filenames are stored using unix notation
324  aFilename.Replace( wxT("\\"), wxT("/") );
325  m_fields[ SHEETFILENAME ].SetText( aFilename );
326  }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452

References m_fields, and SHEETFILENAME.

Referenced by SCH_EDIT_FRAME::importFile(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_EDIT_FRAME::SaveEEFile(), and SCH_EDIT_FRAME::SaveProject().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 203 of file eda_item.h.

203 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:531

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Set and clear 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 254 of file eda_item.h.

254 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:530

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLayer()

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 260 of file sch_item.h.

260 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

◆ SetPageNumber()

void SCH_SHEET::SetPageNumber ( const SCH_SHEET_PATH aInstance,
const wxString &  aPageNumber 
)

Set the page number for the sheet instance aInstance.

Parameters
[in]aInstanceis the hierarchical path of the sheet.
[in]aReferenceis the new page number for the sheet.

Definition at line 1135 of file sch_sheet.cpp.

1136 {
1137  KIID_PATH path = aInstance.Path();
1138 
1139  for( SCH_SHEET_INSTANCE& instance : m_instances )
1140  {
1141  if( instance.m_Path == path )
1142  {
1143  instance.m_PageNumber = aPageNumber;
1144  break;
1145  }
1146  }
1147 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
A simple container for sheet instance information.

References m_instances, SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_SHEET_LIST::SetInitialPageNumbers(), SCH_SHEET_PATH::SetPageNumber(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), and SCH_SHEET_LIST::UpdateSheetInstances().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 166 of file eda_item.h.

166 { m_parent = aParent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:529

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

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

Reimplemented from EDA_ITEM.

Definition at line 795 of file sch_sheet.cpp.

796 {
797  // Remember the sheet and all pin sheet positions must be
798  // modified. So use Move function to do that.
799  Move( aPosition - m_pos );
800 }
wxPoint m_pos
Definition: sch_sheet.h:454
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_sheet.cpp:721

References m_pos, and Move().

Referenced by EE_POINT_EDITOR::updateParentItem().

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

157 {
158  if( aScreen == m_screen )
159  return;
160 
161  if( m_screen != NULL )
162  {
164 
165  if( m_screen->GetRefCount() == 0 )
166  {
167  delete m_screen;
168  m_screen = NULL;
169  }
170  }
171 
172  m_screen = aScreen;
173 
174  if( m_screen )
176 }
#define NULL
void DecRefCount()
Definition: sch_screen.cpp:112
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
void IncRefCount()
Definition: sch_screen.cpp:106
int GetRefCount() const
Definition: sch_screen.h:144

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

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_FRAME::InitSheet(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), and SCH_EDITOR_CONTROL::Paste().

◆ SetSelected()

◆ SetSize()

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

◆ SetState()

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

Definition at line 192 of file eda_item.h.

193  {
194  if( state )
195  m_status |= type; // state = ON or OFF
196  else
197  m_status &= ~type;
198  }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 201 of file eda_item.h.

201 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:528

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 236 of file sch_item.h.

236 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:499

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS aStroke)
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 466 of file sch_item.h.

466 { wxCHECK( false, /* void */ ); }

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 178 of file eda_item.h.

178 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:111

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

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

471 { return *aLeft < *aRight; }

◆ SwapData()

void SCH_SHEET::SwapData ( SCH_ITEM aItem)
overridevirtual

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

266 {
267  wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
268  wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
269  aItem->GetClass() ) );
270 
271  SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
272 
273  std::swap( m_pos, sheet->m_pos );
274  std::swap( m_size, sheet->m_size );
275  m_fields.swap( sheet->m_fields );
276  std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
277  m_pins.swap( sheet->m_pins );
278 
279  // Update parent pointers after swapping.
280  for( SCH_SHEET_PIN* sheetPin : m_pins )
281  sheetPin->SetParent( this );
282 
283  for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
284  sheetPin->SetParent( sheet );
285 
286  for( SCH_FIELD& field : m_fields )
287  field.SetParent( this );
288 
289  for( SCH_FIELD& field : sheet->m_fields )
290  field.SetParent( sheet );
291 
292  std::swap( m_borderWidth, sheet->m_borderWidth );
293  std::swap( m_borderColor, sheet->m_borderColor );
294  std::swap( m_backgroundColor, sheet->m_backgroundColor );
295  std::swap( m_instances, sheet->m_instances );
296 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:457
wxSize m_size
Definition: sch_sheet.h:455
wxPoint m_pos
Definition: sch_sheet.h:454
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:498
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:460
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:166
int m_borderWidth
Definition: sch_sheet.h:456
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:458
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:206
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

References Format(), SCH_ITEM::GetClass(), m_backgroundColor, m_borderColor, m_borderWidth, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_instances, m_pins, m_pos, m_size, SCH_SHEET_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ SymbolCount()

int SCH_SHEET::SymbolCount ( ) const

Count our own symbols, without the power symbols.

Definition at line 607 of file sch_sheet.cpp.

608 {
609  int n = 0;
610 
611  if( m_screen )
612  {
613  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_COMPONENT_T ) )
614  {
615  SCH_COMPONENT* symbol = (SCH_COMPONENT*) aItem;
616 
617  if( symbol->GetField( VALUE_FIELD )->GetText().GetChar( 0 ) != '#' )
618  n++;
619  }
620 
621  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
622  n += static_cast<const SCH_SHEET*>( aItem )->SymbolCount();
623  }
624 
625  return n;
626 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:216
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:665
Field Value of part, i.e. "3.3K".
EE_RTREE & Items()
Definition: sch_screen.h:103
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN * m_screen
Definition: sch_sheet.h:448
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:133

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns
the type of object.

Definition at line 163 of file eda_item.h.

163 { return m_structType; }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:538

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_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(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_COMPONENT::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_PIN::ClassOf(), PCB_TEXT::ClassOf(), PCB_MARKER::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), ClassOf(), NETINFO_ITEM::ClassOf(), PCB_SHAPE::ClassOf(), SCH_SHEET_PIN::ClassOf(), ZONE::ClassOf(), SCH_BITMAP::ClassOf(), PAD::ClassOf(), TRACK::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), FOOTPRINT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), VIA::ClassOf(), ALIGNED_DIMENSION::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), LEADER::ClassOf(), SCH_HIERLABEL::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_RECTANGLE::compare(), LIB_CIRCLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_PART::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrack(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), 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::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), 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(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TRACK::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFootprintCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), EE_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), operator=(), SCH_COMPONENT::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), 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::saveField(), 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(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_TEXT::SwapData(), PCB_GROUP::SwapData(), TRACK::SwapData(), SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SCH_COMPONENT::SwapData(), LEADER::SwapData(), VIA::SwapData(), CENTER_DIMENSION::SwapData(), FOOTPRINT::SwapData(), PAD::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), Visit(), SCH_GLOBALLABEL::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ UpdateDanglingState()

bool SCH_SHEET::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > &  aItemList,
const SCH_SHEET_PATH aPath = nullptr 
)
overridevirtual

Test 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 overridden method can optionally use it to update sheet-local connectivity information

Parameters
aItemListis the list of items to test item against.
aSheetis the 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 853 of file sch_sheet.cpp.

855 {
856  bool changed = false;
857 
858  for( SCH_SHEET_PIN* sheetPin : m_pins )
859  changed |= sheetPin->UpdateDanglingState( aItemList );
860 
861  return changed;
862 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

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

260 {
261  return m_borderWidth == 0 && m_borderColor == COLOR4D::UNSPECIFIED;
262 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:457
int m_borderWidth
Definition: sch_sheet.h:456

References m_borderColor, and m_borderWidth.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns
the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, CENTER_DIMENSION, EDIT_POINTS, PCB_SHAPE, DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, TRACK, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, PCB_MARKER, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, RATSNEST_VIEW_ITEM, KIGFX::PREVIEW::RULER_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 190 of file eda_item.cpp.

191 {
192  // Basic fallback
193  EDA_RECT bbox = GetBoundingBox();
194 
195  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
196 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
const wxPoint GetOrigin() const
Definition: eda_rect.h:106
Handle the component boundary box.
Definition: eda_rect.h:42
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:73
const wxSize GetSize() const
Definition: eda_rect.h:96

References EDA_ITEM::GetBoundingBox(), EDA_RECT::GetOrigin(), and EDA_RECT::GetSize().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), DIMENSION_BASE::ViewBBox(), and PCB_SHAPE::ViewBBox().

◆ ViewDraw()

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

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects 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
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.

Reimplemented in EDIT_POINTS, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, and RATSNEST_VIEW_ITEM.

Definition at line 111 of file view_item.h.

112  {}

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

◆ ViewGetLayers()

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

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

Reimplemented from SCH_ITEM.

Definition at line 558 of file sch_sheet.cpp.

References LAYER_HIERLABEL, LAYER_SELECTION_SHADOWS, LAYER_SHEET, and LAYER_SHEET_BACKGROUND.

◆ ViewGetLOD()

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

Return 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
aLayeris the current drawing layer.
aViewis a pointer 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 FP_ZONE, PAD, FOOTPRINT, VIA, GERBER_DRAW_ITEM, FP_TEXT, TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 137 of file view_item.h.

138  {
139  // By default always show the item
140  return 0.0;
141  }

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

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

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

877 {
878  KICAD_T stype;
879 
880  for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
881  {
882  // If caller wants to inspect my type
883  if( stype == SCH_LOCATE_ANY_T || stype == Type() )
884  {
885  if( SEARCH_RESULT::QUIT == aInspector( this, NULL ) )
886  return SEARCH_RESULT::QUIT;
887  }
888 
889  if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T )
890  {
891  // Test the sheet fields.
892  for( SCH_FIELD& field : m_fields )
893  {
894  if( SEARCH_RESULT::QUIT == aInspector( &field, this ) )
895  return SEARCH_RESULT::QUIT;
896  }
897  }
898 
899  if( stype == SCH_LOCATE_ANY_T || stype == SCH_SHEET_PIN_T )
900  {
901  // Test the sheet labels.
902  for( SCH_SHEET_PIN* sheetPin : m_pins )
903  {
904  if( SEARCH_RESULT::QUIT == aInspector( sheetPin, this ) )
905  return SEARCH_RESULT::QUIT;
906  }
907  }
908  }
909 
911 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:50
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:451
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:452
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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 446 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 458 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 457 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 456 of file sch_sheet.h.

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

◆ m_connected_items

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

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

Definition at line 503 of file sch_item.h.

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

◆ m_connection_map

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

Store connectivity information, per sheet.

Definition at line 506 of file sch_item.h.

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

◆ m_connections

EDA_ITEMS SCH_ITEM::m_connections
protectedinherited

Definition at line 497 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

◆ m_fields

◆ m_fieldsAutoplaced

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_instances

std::vector<SCH_SHEET_INSTANCE> SCH_SHEET::m_instances
private

Definition at line 460 of file sch_sheet.h.

Referenced by AddInstance(), GetPageNumber(), operator=(), SCH_SHEET(), SetPageNumber(), and SwapData().

◆ m_layer

◆ m_parent

◆ m_pins

◆ m_pos

◆ m_screen

◆ m_size

◆ m_status

STATUS_FLAGS EDA_ITEM::m_status
protectedinherited

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

Definition at line 499 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 525 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_PART::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), SCH_SEXPR_PARSER::parseSchSheetInstances(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicatesInSelection(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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