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 &aPos=wxPoint(0, 0), wxSize aSize=wxSize(Mils2iu(MIN_SHEET_WIDTH), Mils2iu(MIN_SHEET_HEIGHT)), FIELDS_AUTOPLACED aAutoplaceFields=FIELDS_AUTOPLACED_AUTO)
 
 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 (const 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 (const 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 inside or on the boundary of this item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects this 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_INSTANCE > & GetInstances () const
 
void SetInstances (const std::vector< SCH_SHEET_INSTANCE > &aInstances)
 
bool AddInstance (const SCH_SHEET_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 (const 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...
 
SCH_CONNECTIONGetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Return true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty () const
 
void SetConnectivityDirty (bool aDirty=true)
 
virtual void SetLastResolvedState (const SCH_ITEM *aItem)
 
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 (EDA_ITEM_FLAGS type) const
 
void SetState (EDA_ITEM_FLAGS type, bool state)
 
EDA_ITEM_FLAGS GetStatus () const
 
void SetStatus (EDA_ITEM_FLAGS aStatus)
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_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, bool aTranslated=true)
 
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
 
EDA_ITEM_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
EDA_ITEM_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 &  aPos = wxPoint( 0, 0 ),
wxSize  aSize = wxSize( Mils2iu( MIN_SHEET_WIDTH ), Mils2iu( MIN_SHEET_HEIGHT ) ),
FIELDS_AUTOPLACED  aAutoplaceFields = FIELDS_AUTOPLACED_AUTO 
)

Definition at line 90 of file sch_sheet.cpp.

91  :
92  SCH_ITEM( aParent, SCH_SHEET_T )
93 {
95  m_pos = aPos;
96  m_size = aSize;
97  m_screen = nullptr;
98 
99  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
100  {
101  m_fields.emplace_back( aPos, i, this, GetDefaultFieldName( i ) );
102  m_fields.back().SetVisible( true );
103 
104  if( i == SHEETNAME )
105  m_fields.back().SetLayer( LAYER_SHEETNAME );
106  else if( i == SHEETFILENAME )
107  m_fields.back().SetLayer( LAYER_SHEETFILENAME );
108  else
109  m_fields.back().SetLayer( LAYER_SHEETFIELDS );
110  }
111 
112  m_fieldsAutoplaced = aAutoplaceFields;
113  AutoAutoplaceFields( nullptr );
114 
115  m_borderWidth = 0;
116  m_borderColor = COLOR4D::UNSPECIFIED;
117  m_backgroundColor = COLOR4D::UNSPECIFIED;
118 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:478
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
void AutoAutoplaceFields(SCH_SCREEN *aScreen)
Autoplace fields only if correct to do so automatically.
Definition: sch_item.h:436
wxSize m_size
Definition: sch_sheet.h:476
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslated=true)
Definition: sch_sheet.cpp:53
wxPoint m_pos
Definition: sch_sheet.h:475
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
SCH_LAYER_ID m_layer
Definition: sch_item.h:487
int m_borderWidth
Definition: sch_sheet.h:477
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:479
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:44

References SCH_ITEM::AutoAutoplaceFields(), 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, 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 121 of file sch_sheet.cpp.

121  :
122  SCH_ITEM( aSheet )
123 {
124  m_pos = aSheet.m_pos;
125  m_size = aSheet.m_size;
126  m_layer = aSheet.m_layer;
127  const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
128  m_fields = aSheet.m_fields;
130  m_screen = aSheet.m_screen;
131 
132  for( SCH_SHEET_PIN* pin : aSheet.m_pins )
133  {
134  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
135  m_pins.back()->SetParent( this );
136  }
137 
138  for( SCH_FIELD& field : m_fields )
139  field.SetParent( this );
140 
141  m_borderWidth = aSheet.m_borderWidth;
142  m_borderColor = aSheet.m_borderColor;
144  m_instances = aSheet.m_instances;
145 
146  if( m_screen )
148 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:478
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:467
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
SCH_LAYER_ID m_layer
Definition: sch_item.h:487
int m_borderWidth
Definition: sch_sheet.h:477
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:474
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:479
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
void IncRefCount()
Definition: sch_screen.cpp:118
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:44

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

152 {
153  // also, look at the associated sheet & its reference count
154  // perhaps it should be deleted also.
155  if( m_screen )
156  {
158 
159  if( m_screen->GetRefCount() == 0 )
160  delete m_screen;
161  }
162 
163  // We own our pins; delete them
164  for( SCH_SHEET_PIN* pin : m_pins )
165  delete pin;
166 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
void DecRefCount()
Definition: sch_screen.cpp:124
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
int GetRefCount() const
Definition: sch_screen.h:162

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

184 {
185  SCH_ITEM_SET& set = m_connected_items[ aSheet ];
186 
187  // The vector elements are small, so reserve 1k at a time to prevent re-allocations
188  if( set.size() == set.capacity() )
189  set.reserve( set.size() + 4096 );
190 
191  set.emplace_back( aItem );
192 }
std::vector< SCH_ITEM * > SCH_ITEM_SET
Definition: sch_item.h:134
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:494

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ AddInstance()

bool SCH_SHEET::AddInstance ( const SCH_SHEET_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.

Warning
The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return false on release builds.
Parameters
[in]aInstanceis the SCH_SHEET_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 1165 of file sch_sheet.cpp.

1166 {
1167  wxCHECK( aSheetPath.IsFullPath(), false );
1168 
1169  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1170  {
1171  // if aSheetPath is found, nothing to do:
1172  if( instance.m_Path == aSheetPath.PathWithoutRootUuid() )
1173  return false;
1174  }
1175 
1176  wxLogTrace( traceSchSheetPaths, wxT( "Adding instance `%s` to sheet `%s`." ),
1177  aSheetPath.PathWithoutRootUuid().AsString(),
1178  ( GetName().IsEmpty() ) ? wxT( "root" ) : GetName() );
1179 
1180  SCH_SHEET_INSTANCE instance;
1181 
1182  instance.m_Path = aSheetPath.PathWithoutRootUuid();
1183 
1184  // This entry does not exist: add it with an empty page number.
1185  m_instances.emplace_back( instance );
1186  return true;
1187 }
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
wxString GetName() const
Definition: sch_sheet.h:100
A simple container for sheet instance information.

References KIID_PATH::AsString(), GetName(), SCH_SHEET_PATH::IsFullPath(), m_instances, SCH_SHEET_INSTANCE::m_Path, SCH_SHEET_PATH::PathWithoutRootUuid(), and traceSchSheetPaths.

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), 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 342 of file sch_sheet.cpp.

343 {
344  wxASSERT( aSheetPin != nullptr );
345  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
346 
347  aSheetPin->SetParent( this );
348  m_pins.push_back( aSheetPin );
349  renumberPins();
350 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:115
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:913
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

References m_pins, 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 436 of file sch_item.h.

437  {
438  if( GetFieldsAutoplaced() )
440  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:424
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:442

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(), SCH_SHEET(), and SCH_EDIT_FRAME::SelectUnit().

◆ AutoplaceFields()

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

Reimplemented from SCH_ITEM.

Definition at line 579 of file sch_sheet.cpp.

580 {
581  wxSize textSize = m_fields[ SHEETNAME ].GetTextSize();
582  int borderMargin = KiROUND( GetPenWidth() / 2.0 ) + 4;
583  int margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.5 );
584 
585  if( IsVerticalOrientation() )
586  {
587  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( -margin, m_size.y ) );
588  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
589  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
590  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_VERT );
591  }
592  else
593  {
594  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( 0, -margin ) );
595  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
596  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
597  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
598  }
599 
600  textSize = m_fields[ SHEETFILENAME ].GetTextSize();
601  margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.4 );
602 
603  if( IsVerticalOrientation() )
604  {
605  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( m_size.x + margin, m_size.y ) );
606  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
607  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
608  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_VERT );
609  }
610  else
611  {
612  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( 0, m_size.y + margin ) );
613  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
614  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
615  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
616  }
617 
619 }
#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:71
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
int GetPenWidth() const override
Definition: sch_sheet.cpp:567
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:394
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:73
#define TEXT_ANGLE_VERT
Definition: eda_text.h:72

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(), SCH_EAGLE_PLUGIN::loadSheet(), 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  || ( aItem->Type() == SCH_SYMBOL_T );
361  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:259
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

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

◆ ClassOf()

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

Definition at line 69 of file sch_sheet.h.

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

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

530 {
531  std::vector<SCH_SHEET_PIN*> pins = m_pins;
532 
533  m_pins.clear();
534 
535  for( SCH_SHEET_PIN* pin : pins )
536  {
537  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
538  const SCH_HIERLABEL* HLabel = nullptr;
539 
540  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
541  {
542  if( pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
543  {
544  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
545  break;
546  }
547  }
548 
549  if( HLabel )
550  m_pins.push_back( pin );
551  }
552 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

References SCH_SCREEN::Items(), m_pins, m_screen, EE_RTREE::OfType(), pin, 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 372 of file sch_item.h.

372 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:488

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

◆ ClearFlags()

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

Definition at line 153 of file eda_item.h.

153 { m_flags &= ~aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480

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(), EE_SELECTION_TOOL::selectMultiple(), 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 165 of file eda_item.h.

166  {
168  DO_NOT_DRAW );
169  }
#define DO_NOT_DRAW
Used to disable draw function.
#define STARTPOINT
When a line is selected, these flags indicate which.
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define CANDIDATE
flag indicating that the structure is connected
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:153
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define TEMP_SELECTED
flag indicating that the structure has already selected

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 143 of file view_item.h.

144  {
145  m_viewPrivData = nullptr;
146  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:151

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

170 {
171  return new SCH_SHEET( *this );
172 }
SCH_SHEET(EDA_ITEM *aParent=nullptr, const wxPoint &aPos=wxPoint(0, 0), wxSize aSize=wxSize(Mils2iu(MIN_SHEET_WIDTH), Mils2iu(MIN_SHEET_HEIGHT)), FIELDS_AUTOPLACED aAutoplaceFields=FIELDS_AUTOPLACED_AUTO)
Definition: sch_sheet.cpp:90

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

1228 {
1229  if( aPageNumberA == aPageNumberB )
1230  return 0; // A == B
1231 
1232  // First sort numerically if the page numbers are integers
1233  long pageA, pageB;
1234  bool isIntegerPageA = aPageNumberA.ToLong( &pageA );
1235  bool isIntegerPageB = aPageNumberB.ToLong( &pageB );
1236 
1237  if( isIntegerPageA && isIntegerPageB )
1238  {
1239  if( pageA < pageB )
1240  return -1; //A < B
1241  else
1242  return 1; // A > B
1243  }
1244 
1245  // Numerical page numbers always before strings
1246  if( isIntegerPageA )
1247  return -1; //A < B
1248  else if( isIntegerPageB )
1249  return 1; // A > B
1250 
1251  // If not numeric, then sort as strings using natural sort
1252  int result = StrNumCmp( aPageNumberA, aPageNumberB );
1253 
1254  result = result / std::abs( result );
1255 
1256  return result;
1257 }
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.

References StrNumCmp().

Referenced by SCH_SHEET_PATH::ComparePageNum().

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

178 {
179  return m_connected_items[ aSheet ];
180 }
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:494

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

139 {
140  if( !IsConnectable() )
141  return nullptr;
142 
143  wxCHECK_MSG( !IsConnectivityDirty(), nullptr,
144  wxT( "Shouldn't be asking for connection if connectivity is dirty!" ) );
145 
146  if( !aSheet )
147  aSheet = &Schematic()->CurrentSheet();
148 
149  auto it = m_connection_map.find( *aSheet );
150 
151  if( it == m_connection_map.end() )
152  return nullptr;
153  else
154  return it->second;
155 }
virtual bool IsConnectable() const
Definition: sch_item.h:349
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
bool IsConnectivityDirty() const
Definition: sch_item.h:413
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:497
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:121

References SCHEMATIC::CurrentSheet(), SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), 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(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_TEXT::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), SCH_EDIT_FRAME::RecalculateConnections(), 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_LINE, SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 411 of file sch_item.h.

411 { 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 755 of file sch_sheet.cpp.

756 {
757  int count = 1; //1 = this!!
758 
759  if( m_screen )
760  {
761  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
762  count += static_cast<SCH_SHEET*>( aItem )->CountSheets();
763  }
764 
765  return count;
766 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

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

254 { }

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

383 {
384  for( SCH_SHEET_PIN* sheetPin : m_pins )
385  {
386  if( sheetPin->GetPosition() == aPosition )
387  return true;
388  }
389 
390  return false;
391 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 85 of file sch_item.cpp.

86 {
87  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
88 
89  if( !doClone )
90  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
91 
92  newItem->ClearFlags( SELECTED | BRIGHTENED );
93 
94  newItem->RunOnChildren(
95  []( SCH_ITEM* aChild )
96  {
97  aChild->ClearFlags( SELECTED | BRIGHTENED );
98  } );
99 
100  return newItem;
101 }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:83
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
Definition: sch_item.h:444
Definition: kiid.h:44
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:153
#define SELECTED
const KIID m_Uuid
Definition: eda_item.h:474
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
#define BRIGHTENED
item is drawn with a bright contour

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

Referenced by SCH_EDIT_FRAME::BreakSegment(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ 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 = T();
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 632 of file sch_sheet.cpp.

633 {
634  wxPoint end;
635  EDA_RECT box( m_pos, m_size );
636  int lineWidth = GetPenWidth();
637  int textLength = 0;
638 
639  // Calculate bounding box X size:
640  end.x = std::max( m_size.x, textLength );
641 
642  // Calculate bounding box pos:
643  end.y = m_size.y;
644  end += m_pos;
645 
646  box.SetEnd( end );
647  box.Inflate( lineWidth / 2 );
648 
649  return box;
650 }
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
int GetPenWidth() const override
Definition: sch_sheet.cpp:567
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(), HitTest(), and SCH_EDIT_TOOL::Rotate().

◆ GetBorderColor()

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const
inline

Definition at line 107 of file sch_sheet.h.

107 { return m_borderWidth; }
int m_borderWidth
Definition: sch_sheet.h:477

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

654 {
656 
657  for( const SCH_FIELD& field : m_fields )
658  box.Merge( field.GetBoundingBox() );
659 
660  return box;
661 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void Merge(const EDA_RECT &aRect)
Modify the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:432
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:632
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by SCH_EDIT_TOOL::Mirror().

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Reimplemented from SCH_ITEM.

Definition at line 74 of file sch_sheet.h.

75  {
76  return wxT( "SCH_SHEET" );
77  }

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

950 {
951  std::vector<wxPoint> retval;
952 
953  for( SCH_SHEET_PIN* sheetPin : m_pins )
954  retval.push_back( sheetPin->GetPosition() );
955 
956  return retval;
957 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 215 of file sch_sheet.cpp.

216 {
217  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
218  aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
219 
220  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
221  aVars->push_back( m_fields[i].GetName() );
222 
223  aVars->push_back( wxT( "#" ) );
224  aVars->push_back( wxT( "##" ) );
226 }
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:156
static void GetContextualTextVars(wxArrayString *aVars)
Definition: title_block.cpp:73
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469

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

Referenced by DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), and DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded().

◆ GetDefaultFieldName()

const wxString SCH_SHEET::GetDefaultFieldName ( int  aFieldNdx,
bool  aTranslated = true 
)
static

Definition at line 53 of file sch_sheet.cpp.

54 {
55  static void* locale = nullptr;
56  static wxString sheetnameDefault;
57  static wxString sheetfilenameDefault;
58  static wxString userFieldDefault;
59 
60  if( !aTranslated )
61  {
62  switch( aFieldNdx )
63  {
64  case SHEETNAME: return SHEET_NAME_CANONICAL;
66  default: return wxString::Format( USER_FIELD_CANONICAL, aFieldNdx );
67  }
68  }
69 
70  // Fetching translations can take a surprising amount of time when loading libraries,
71  // so only do it when necessary.
72  if( Pgm().GetLocale() != locale )
73  {
74  sheetnameDefault = _( SHEET_NAME_CANONICAL );
75  sheetfilenameDefault = _( SHEET_FILE_CANONICAL );
76  userFieldDefault = _( USER_FIELD_CANONICAL );
77  locale = Pgm().GetLocale();
78  }
79 
80  // Fixed values for the mandatory fields
81  switch( aFieldNdx )
82  {
83  case SHEETNAME: return sheetnameDefault;
84  case SHEETFILENAME: return sheetfilenameDefault;
85  default: return wxString::Format( userFieldDefault, aFieldNdx );
86  }
87 }
#define USER_FIELD_CANONICAL
Definition: sch_sheet.cpp:50
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define SHEET_FILE_CANONICAL
Definition: sch_sheet.cpp:49
#define _(s)
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 SHEET_NAME_CANONICAL
Definition: sch_sheet.cpp:48

References _, Format(), Pgm(), SHEET_FILE_CANONICAL, SHEET_NAME_CANONICAL, SHEETFILENAME, SHEETNAME, and USER_FIELD_CANONICAL.

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

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 157 of file eda_item.h.

158  {
159  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
161 
162  return m_flags & mask;
163  }
#define IS_NEW
New item, just created.
#define IS_RESIZING
Item being resized.
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_MOVING
Item being moved.
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, 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_SYMBOL::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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_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 925 of file sch_sheet.cpp.

926 {
927  for( SCH_SHEET_PIN* sheetPin : m_pins )
928  {
929  wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
930  wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
931 
932  sheetPin->GetEndPoints( aItemList );
933  }
934 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 91 of file sch_sheet.h.

91 { return m_fields; }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473

References m_fields.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 424 of file sch_item.h.

424 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489

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_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

258 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetInstances()

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

Definition at line 392 of file sch_sheet.h.

392 { return m_instances; }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481

References m_instances.

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const
inlineinherited

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

496 {
497  int pinsTop = m_pos.y + m_size.y;
498  int pinsBottom = m_pos.y;
499 
500  for( size_t i = 0; i < m_pins.size(); i++ )
501  {
502  SHEET_SIDE edge = m_pins[i]->GetSide();
503 
504  if( edge == SHEET_SIDE::RIGHT || edge == SHEET_SIDE::LEFT )
505  {
506  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
507 
508  pinsTop = std::min( pinsTop, pinRect.GetTop() );
509  pinsBottom = std::max( pinsBottom, pinRect.GetBottom() );
510  }
511  }
512 
513  pinsTop = bumpToNextGrid( pinsTop, -1 );
514  pinsBottom = bumpToNextGrid( pinsBottom, 1 );
515 
516  int pinMinHeight;
517 
518  if( pinsTop >= pinsBottom )
519  pinMinHeight = 0;
520  else if( aFromTop )
521  pinMinHeight = pinsBottom - m_pos.y;
522  else
523  pinMinHeight = m_pos.y + m_size.y - pinsTop;
524 
525  return std::max( pinMinHeight, Mils2iu( MIN_SHEET_HEIGHT ) );
526 }
int GetTop() const
Definition: eda_rect.h:122
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
int GetBottom() const
Definition: eda_rect.h:123
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Handle the component boundary box.
Definition: eda_rect.h:42
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:38
SHEET_SIDE
Define the edge of the sheet that the sheet pin is positioned.
Definition: sch_sheet_pin.h:45
int bumpToNextGrid(const int aVal, const int aDirection)
Definition: sch_sheet.cpp:439

References bumpToNextGrid(), EDA_RECT::GetBottom(), EDA_RECT::GetTop(), LEFT, m_pins, m_pos, m_size, MIN_SHEET_HEIGHT, and RIGHT.

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

462 {
463  int pinsLeft = m_pos.x + m_size.x;
464  int pinsRight = m_pos.x;
465 
466  for( size_t i = 0; i < m_pins.size(); i++ )
467  {
468  SHEET_SIDE edge = m_pins[i]->GetSide();
469 
470  if( edge == SHEET_SIDE::TOP || edge == SHEET_SIDE::BOTTOM )
471  {
472  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
473 
474  pinsLeft = std::min( pinsLeft, pinRect.GetLeft() );
475  pinsRight = std::max( pinsRight, pinRect.GetRight() );
476  }
477  }
478 
479  pinsLeft = bumpToNextGrid( pinsLeft, -1 );
480  pinsRight = bumpToNextGrid( pinsRight, 1 );
481 
482  int pinMinWidth;
483 
484  if( pinsLeft >= pinsRight )
485  pinMinWidth = 0;
486  else if( aFromLeft )
487  pinMinWidth = pinsRight - m_pos.x;
488  else
489  pinMinWidth = m_pos.x + m_size.x - pinsLeft;
490 
491  return std::max( pinMinWidth, Mils2iu( MIN_SHEET_WIDTH ) );
492 }
int GetLeft() const
Definition: eda_rect.h:121
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:37
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
int GetRight() const
Definition: eda_rect.h:120
Handle the component boundary box.
Definition: eda_rect.h:42
SHEET_SIDE
Define the edge of the sheet that the sheet pin is positioned.
Definition: sch_sheet_pin.h:45
int bumpToNextGrid(const int aVal, const int aDirection)
Definition: sch_sheet.cpp:439

References BOTTOM, bumpToNextGrid(), EDA_RECT::GetLeft(), EDA_RECT::GetRight(), m_pins, m_pos, m_size, MIN_SHEET_WIDTH, and TOP.

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

770 {
771  aList.emplace_back( _( "Sheet Name" ), m_fields[ SHEETNAME ].GetText() );
772 
773  if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
774  {
775  SCH_SHEET_PATH path = schframe->GetCurrentSheet();
776  path.push_back( this );
777 
778  aList.emplace_back( _( "Hierarchical Path" ), path.PathHumanReadable( false ) );
779  }
780 
781  aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText() );
782 }
Schematic editor (Eeschema) main window.
#define _(s)
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:473

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

◆ GetName()

wxString SCH_SHEET::GetName ( void  ) const
inline

◆ GetOrInitConnection()

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

Definition at line 218 of file sch_item.cpp.

220 {
221  if( !IsConnectable() )
222  return nullptr;
223 
224  SetConnectivityDirty( false );
225 
226  SCH_CONNECTION* connection = Connection( &aSheet );
227 
228  if( connection )
229  return connection;
230  else
231  return InitializeConnection( aSheet, aGraph );
232 }
virtual bool IsConnectable() const
Definition: sch_item.h:349
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:138
SCH_CONNECTION * InitializeConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Create a new connection object associated with this object.
Definition: sch_item.cpp:195
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void SetConnectivityDirty(bool aDirty=true)
Definition: sch_item.h:415

References SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), SCH_ITEM::IsConnectable(), and SCH_ITEM::SetConnectivityDirty().

◆ GetPageNumber()

wxString SCH_SHEET::GetPageNumber ( const SCH_SHEET_PATH aInstance) const

Return the sheet page number for aInstance.

Warning
The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return an empty page number on release builds.
Returns
the page number for the requested sheet instance.

Definition at line 1190 of file sch_sheet.cpp.

1191 {
1192  wxCHECK( aSheetPath.IsFullPath(), wxEmptyString );
1193 
1194  wxString pageNumber;
1195  KIID_PATH path = aSheetPath.PathWithoutRootUuid();
1196 
1197  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1198  {
1199  if( instance.m_Path == path )
1200  {
1201  pageNumber = instance.m_PageNumber;
1202  break;
1203  }
1204  }
1205 
1206  return pageNumber;
1207 }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
A simple container for sheet instance information.

References SCH_SHEET_PATH::IsFullPath(), m_instances, path, and SCH_SHEET_PATH::PathWithoutRootUuid().

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

568 {
569  if( GetBorderWidth() > 0 )
570  return GetBorderWidth();
571 
572  if( Schematic() )
574 
575  return Mils2iu( DEFAULT_LINE_WIDTH_MILS );
576 }
#define DEFAULT_LINE_WIDTH_MILS
The default wire width in mils. (can be changed in preference menu)
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
int GetBorderWidth() const
Definition: sch_sheet.h:107

References DEFAULT_LINE_WIDTH_MILS, GetBorderWidth(), SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

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

556 {
557  for( SCH_SHEET_PIN* pin : m_pins )
558  {
559  if( pin->HitTest( aPosition ) )
560  return pin;
561  }
562 
563  return nullptr;
564 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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_SCREEN::GetSheetPin().

◆ GetPins() [1/2]

◆ GetPins() [2/2]

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

Definition at line 185 of file sch_sheet.h.

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

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

665 {
666  EDA_RECT box( m_pos, m_size );
667  return box.GetCenter();
668 }
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
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 102 of file sch_sheet.h.

102 { return m_screen; }
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469

References m_screen.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), 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(), SCH_EAGLE_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EAGLE_PLUGIN::loadSegments(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::moveLabels(), 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::ParseNote(), 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::ParseTextFrame(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_SHEET_PATH::PathHumanReadable(), SCH_EDIT_TOOL::Properties(), SCHEMATIC::RootScreen(), SCH_SEXPR_PLUGIN::Save(), SCH_LEGACY_PLUGIN::Save(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveSchematicFile(), 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 198 of file sch_sheet.cpp.

199 {
200  if( m_screen == nullptr )
201  return 0;
202 
203  return m_screen->GetRefCount();
204 }
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
int GetRefCount() const
Definition: sch_screen.h:162

References SCH_SCREEN::GetRefCount(), and m_screen.

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

1009 {
1010  return wxString::Format( _( "Hierarchical Sheet %s" ),
1011  m_fields[ SHEETNAME ].GetText() );
1012 }
#define _(s)
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:473

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

Referenced by Matches().

◆ GetSize()

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type) const
inlineinherited

Definition at line 136 of file eda_item.h.

137  {
138  return m_status & type;
139  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:477

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 149 of file eda_item.h.

149 { return m_status; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:477

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 222 of file sch_item.h.

222 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:490

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

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

Referenced by DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow().

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

453 { 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 370 of file sch_sheet.cpp.

371 {
372  for( SCH_SHEET_PIN* pin : m_pins )
373  {
374  if( pin->GetText().CmpNoCase( aName ) == 0 )
375  return true;
376  }
377 
378  return false;
379 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 222 of file sch_sheet.h.

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

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

416 {
417  for( SCH_SHEET_PIN* pin : m_pins )
418  {
419  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
420  const SCH_HIERLABEL* HLabel = nullptr;
421 
422  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
423  {
424  if( !pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
425  {
426  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
427  break;
428  }
429  }
430 
431  if( HLabel == nullptr ) // Corresponding hierarchical label not found.
432  return true;
433  }
434 
435  return false;
436 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

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

Referenced by SCH_EDIT_TOOL::CleanupSheetPins(), and SCH_EDIT_TOOL::Init().

◆ HitTest() [1/2]

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

Test if aPosition is inside or on the boundary of this 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 1021 of file sch_sheet.cpp.

1022 {
1023  EDA_RECT rect = GetBodyBoundingBox();
1024 
1025  rect.Inflate( aAccuracy );
1026 
1027  return rect.Contains( aPosition );
1028 }
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:632
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:364

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

1032 {
1033  EDA_RECT rect = aRect;
1034 
1035  rect.Inflate( aAccuracy );
1036 
1037  if( aContained )
1038  return rect.Contains( GetBodyBoundingBox() );
1039 
1040  return rect.Intersects( GetBodyBoundingBox() );
1041 }
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:632
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:364

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

197 {
198  SetConnectivityDirty( false );
199 
200  SCH_CONNECTION* connection = Connection( &aSheet );
201 
202  if( connection )
203  {
204  connection->Reset();
205  }
206  else
207  {
208  connection = new SCH_CONNECTION( this );
209  m_connection_map.insert( std::make_pair( aSheet, connection ) );
210  }
211 
212  connection->SetGraph( aGraph );
213  connection->SetSheet( aSheet );
214  return connection;
215 }
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:138
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:497
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void SetConnectivityDirty(bool aDirty=true)
Definition: sch_item.h:415

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

Referenced by SCH_ITEM::GetOrInitConnection().

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

130 {
131  if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
132  return false;
133 
134  return doIsConnected( aPosition );
135 }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:484

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

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

◆ IsConnectivityDirty()

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 342 of file sch_item.h.

342 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_DRAGGING; }
#define IS_DRAGGING
Item being dragged.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & ENTERED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480
#define ENTERED
indicates a group has been entered

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 205 of file eda_item.h.

205 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:479

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

252 { return false; }

◆ IsLocked()

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

Definition at line 242 of file sch_item.h.

242 { return false; }

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 117 of file eda_item.h.

117 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480

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

88 { 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_SYMBOL, SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_SHEET_PIN, SCH_JUNCTION, and SCH_PIN.

Definition at line 355 of file sch_item.h.

355 { return false; }

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

124 { return m_flags & IS_RESIZING; }
#define IS_RESIZING
Item being resized.
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRootSheet()

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

Definition at line 207 of file sch_sheet.cpp.

208 {
209  wxCHECK_MSG( Schematic(), false, wxT( "Can't call IsRootSheet without setting a schematic" ) );
210 
211  return &Schematic()->Root() == this;
212 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:104
SCH_SHEET & Root() const
Definition: schematic.h:92

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

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & SELECTED; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480
#define SELECTED

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(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::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(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ 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 PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

183  {
184  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
185  return true;
186 
187  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
188  {
189  if( m_structType == *p )
190  return true;
191  }
192 
193  return false;
194  }
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:487

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), 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(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_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 394 of file sch_sheet.cpp.

395 {
396  int leftRight = 0;
397  int topBottom = 0;
398 
399  for( SCH_SHEET_PIN* pin : m_pins )
400  {
401  switch( pin->GetSide() )
402  {
403  case SHEET_SIDE::LEFT: leftRight++; break;
404  case SHEET_SIDE::RIGHT: leftRight++; break;
405  case SHEET_SIDE::TOP: topBottom++; break;
406  case SHEET_SIDE::BOTTOM: topBottom++; break;
407  default: break;
408  }
409  }
410 
411  return topBottom > 0 && leftRight == 0;
412 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65

References BOTTOM, LEFT, m_pins, pin, RIGHT, and TOP.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_WIRE_IMAGE; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

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

298  {
299  for( auto it : aList )
300  {
301  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
303  return SEARCH_RESULT::QUIT;
304  }
305 
307  }
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:93

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

315  {
316  for( auto it : aList )
317  {
318  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
320  return SEARCH_RESULT::QUIT;
321  }
322 
324  }
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:93

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

730 {
731  if( m_screen )
732  {
733  aList->push_back( this );
734 
735  if( m_screen == aScreen )
736  return true;
737 
738  for( auto item : m_screen->Items().OfType( SCH_SHEET_T ) )
739  {
740  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
741 
742  if( sheet->LocatePathOfScreen( aScreen, aList ) )
743  {
744  return true;
745  }
746  }
747 
748  aList->pop_back();
749  }
750 
751  return false;
752 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
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:729
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469

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

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

905 {
906  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
907 
908  // Sheets are searchable via the child field and pin item text.
909  return false;
910 }
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:1008
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 118 of file eda_item.cpp.

119 {
120  wxString text = aText;
121  int flags = aSearchData.GetFlags();
122  wxString searchText = aSearchData.GetFindString();
123 
124  // Don't match if searching for replaceable item and the item doesn't support text replace.
125  if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
126  return false;
127 
128  if( !( flags & wxFR_MATCHCASE ) )
129  {
130  text.MakeUpper();
131  searchText.MakeUpper();
132  }
133 
134  if( flags & wxFR_WHOLEWORD )
135  {
136  int ii = 0;
137 
138  while( ii < (int) text.length() )
139  {
140  int next = text.find( searchText, ii );
141 
142  if( next == wxNOT_FOUND )
143  return false;
144 
145  ii = next;
146  next += searchText.length();
147 
148  bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
149  bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
150 
151  if( startOK && endOK )
152  return true;
153  else
154  ii++;
155  }
156 
157  return false;
158  }
159  else if( flags & FR_MATCH_WILDCARD )
160  {
161  return text.Matches( searchText );
162  }
163  else
164  {
165  return text.Find( searchText ) != wxNOT_FOUND;
166  }
167 }
CITER next(CITER it)
Definition: ptree.cpp:126
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:402

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

◆ MirrorHorizontally()

void SCH_SHEET::MirrorHorizontally ( int  aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Implements SCH_ITEM.

Definition at line 859 of file sch_sheet.cpp.

860 {
861  int dx = m_pos.x;
862 
863  MIRROR( m_pos.x, aCenter );
864  m_pos.x -= m_size.x;
865  dx -= m_pos.x; // dx,0 is the move vector for this transform
866 
867  for( SCH_SHEET_PIN* sheetPin : m_pins )
868  sheetPin->MirrorHorizontally( aCenter );
869 
870  for( SCH_FIELD& field : m_fields )
871  {
872  wxPoint pos = field.GetTextPos();
873  pos.x -= dx;
874  field.SetTextPos( pos );
875  }
876 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
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:472
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:473

References m_fields, 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 839 of file sch_sheet.cpp.

840 {
841  int dy = m_pos.y;
842 
843  MIRROR( m_pos.y, aCenter );
844  m_pos.y -= m_size.y;
845  dy -= m_pos.y; // 0,dy is the move vector for this transform
846 
847  for( SCH_SHEET_PIN* sheetPin : m_pins )
848  sheetPin->MirrorVertically( aCenter );
849 
850  for( SCH_FIELD& field : m_fields )
851  {
852  wxPoint pos = field.GetTextPos();
853  pos.y -= dy;
854  field.SetTextPos( pos );
855  }
856 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
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:472
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:473

References m_fields, 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 785 of file sch_sheet.cpp.

786 {
787  m_pos += aMoveVector;
788 
789  for( SCH_SHEET_PIN* pin : m_pins )
790  pin->Move( aMoveVector );
791 
792  for( SCH_FIELD& field : m_fields )
793  field.Move( aMoveVector );
794 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxPoint m_pos
Definition: sch_sheet.h:475
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473

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

159 {
160  if( m_connection_map.size() )
161  {
162  SCH_CONNECTION* connection = Connection( aSheet );
163 
164  if( connection )
165  {
166  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
167  const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
168 
169  return netSettings.m_NetClasses.Find( netclassName );
170  }
171  }
172 
173  return nullptr;
174 }
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:104
NET_SETTINGS & NetSettings()
Definition: project_file.h:96
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:138
NETCLASSES m_NetClasses
Definition: net_settings.h:40
wxString Name(bool aIgnoreSheet=false) const
NET_SETTINGS stores various net-related settings in a project context.
Definition: net_settings.h:32
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition: sch_item.h:497
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 1148 of file sch_sheet.cpp.

1149 {
1150  if( Type() != aItem.Type() )
1151  return Type() < aItem.Type();
1152 
1153  auto sheet = static_cast<const SCH_SHEET*>( &aItem );
1154 
1155  if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText() )
1156  return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
1157 
1158  if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText() )
1159  return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
1160 
1161  return false;
1162 }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

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

235 {
236  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
237  GetClass() ) );
238 
239  return false;
240 }
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 1118 of file sch_sheet.cpp.

1119 {
1120  wxCHECK_MSG( Type() == aItem.Type(), *this,
1121  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1122  GetClass() );
1123 
1124  if( &aItem != this )
1125  {
1126  SCH_ITEM::operator=( aItem );
1127 
1128  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
1129 
1130  m_pos = sheet->m_pos;
1131  m_size = sheet->m_size;
1132  m_fields = sheet->m_fields;
1133 
1134  for( SCH_SHEET_PIN* pin : sheet->m_pins )
1135  {
1136  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
1137  m_pins.back()->SetParent( this );
1138  }
1139 
1140  for( const SCH_SHEET_INSTANCE& instance : sheet->m_instances )
1141  m_instances.emplace_back( instance );
1142  }
1143 
1144  return *this;
1145 }
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:467
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
wxString GetClass() const override
Return the class name.
Definition: sch_sheet.h:74
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
A simple container for sheet instance information.
SCH_ITEM & operator=(const SCH_ITEM &aPin)
Definition: sch_item.cpp:62
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

References GetClass(), SCH_ITEM::GetClass(), m_fields, m_instances, m_pins, m_pos, m_size, SCH_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 1044 of file sch_sheet.cpp.

1045 {
1046  wxString msg;
1047  wxPoint pos;
1048  auto* settings = dynamic_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
1049  bool override = settings ? settings->m_OverrideItemColors : false;
1050  COLOR4D borderColor = GetBorderColor();
1051  COLOR4D backgroundColor = GetBackgroundColor();
1052 
1053  if( override || borderColor == COLOR4D::UNSPECIFIED )
1054  borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
1055 
1056  if( override || backgroundColor == COLOR4D::UNSPECIFIED )
1057  backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
1058 
1059  // Do not fill shape in B&W mode, otherwise texts are unreadable
1060  bool fill = aPlotter->GetColorMode();
1061 
1062  if( fill )
1063  {
1064  aPlotter->SetColor( backgroundColor );
1065  aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::FILLED_SHAPE, 1 );
1066  }
1067 
1068  aPlotter->SetColor( borderColor );
1069 
1070  int penWidth = std::max( GetPenWidth(), aPlotter->RenderSettings()->GetMinPenWidth() );
1071  aPlotter->Rect( m_pos, m_pos + m_size, FILL_T::NO_FILL, penWidth );
1072 
1073  // Plot sheet pins
1074  for( SCH_SHEET_PIN* sheetPin : m_pins )
1075  sheetPin->Plot( aPlotter );
1076 
1077  // Plot the fields
1078  for( const SCH_FIELD& field : m_fields )
1079  field.Plot( aPlotter );
1080 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxSize m_size
Definition: sch_sheet.h:476
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:110
wxPoint m_pos
Definition: sch_sheet.h:475
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:113
int GetPenWidth() const override
Definition: sch_sheet.cpp:567
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:65
virtual void SetColor(const COLOR4D &color)=0
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:156
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103
bool GetColorMode() const
Definition: plotter.h:153

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

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

1084 {
1085  wxDC* DC = aSettings->GetPrintDC();
1086  wxPoint pos = m_pos + aOffset;
1087  int lineWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
1088  const auto* settings = dynamic_cast<const KIGFX::SCH_RENDER_SETTINGS*>( aSettings );
1089  bool override = settings && settings->m_OverrideItemColors;
1090  COLOR4D border = GetBorderColor();
1091  COLOR4D background = GetBackgroundColor();
1092 
1093  if( override || border == COLOR4D::UNSPECIFIED )
1094  border = aSettings->GetLayerColor( LAYER_SHEET );
1095 
1096  if( override || background == COLOR4D::UNSPECIFIED )
1097  background = aSettings->GetLayerColor( LAYER_SHEET_BACKGROUND );
1098 
1099  if( GetGRForceBlackPenState() ) // printing in black & white
1100  background = COLOR4D::UNSPECIFIED;
1101 
1102  if( background != COLOR4D::UNSPECIFIED )
1103  {
1104  GRFilledRect( nullptr, DC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, 0,
1105  background, background );
1106  }
1107 
1108  GRRect( nullptr, DC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, lineWidth, border );
1109 
1110  for( SCH_FIELD& field : m_fields )
1111  field.Print( aSettings, aOffset );
1112 
1113  for( SCH_SHEET_PIN* sheetPin : m_pins )
1114  sheetPin->Print( aSettings, aOffset );
1115 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, const COLOR4D &Color, const COLOR4D &BgColor)
Definition: gr_basic.cpp:712
wxSize m_size
Definition: sch_sheet.h:476
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:110
void GRRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, const COLOR4D &Color)
Definition: gr_basic.cpp:705
wxPoint m_pos
Definition: sch_sheet.h:475
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:113
int GetPenWidth() const override
Definition: sch_sheet.cpp:567
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473
int GetDefaultPenWidth() const
bool GetGRForceBlackPenState(void)
Definition: gr_basic.cpp:191
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

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

354 {
355  wxASSERT( aSheetPin != nullptr );
356  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
357 
358  for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
359  {
360  if( *i == aSheetPin )
361  {
362  m_pins.erase( i );
363  renumberPins();
364  return;
365  }
366  }
367 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:913
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

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

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

◆ renumberPins()

void SCH_SHEET::renumberPins ( )
protected

Renumber the sheet pins in the sheet.

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

Definition at line 913 of file sch_sheet.cpp.

914 {
915  int id = 2;
916 
917  for( SCH_SHEET_PIN* pin : m_pins )
918  {
919  pin->SetNumber( id );
920  id++;
921  }
922 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 170 of file eda_item.cpp.

171 {
172  wxString text = aText;
173  int flags = aSearchData.GetFlags();
174  wxString searchText = aSearchData.GetFindString();
175  wxString result;
176  bool replaced = false;
177 
178  if( flags & wxFR_MATCHCASE )
179  {
180  text = text.Upper();
181  searchText = searchText.Upper();
182  }
183 
184  int ii = 0;
185 
186  while( ii < (int) text.length() )
187  {
188  int next = text.find( searchText, ii );
189 
190  if( next == wxNOT_FOUND )
191  {
192  result += aText.Mid( ii, wxString::npos );
193  break;
194  }
195 
196  if( next > ii )
197  result += aText.Mid( ii, next - ii );
198 
199  ii = next;
200  next += searchText.length();
201 
202  bool startOK;
203  bool endOK;
204 
205  if( flags & wxFR_WHOLEWORD )
206  {
207  startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
208  endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
209  }
210  else
211  {
212  startOK = true;
213  endOK = true;
214  }
215 
216  if( startOK && endOK )
217  {
218  result += aSearchData.GetReplaceString();
219  replaced = true;
220  ii = next;
221  }
222  else
223  {
224  result += aText.GetChar( ii );
225  ii++;
226  }
227  }
228 
229  aText = result;
230  return replaced;
231 }
CITER next(CITER it)
Definition: ptree.cpp:126

References next(), and text.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), 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 391 of file eda_item.h.

392  {
393  return false;
394  }

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

888 {
889  if( aSize == m_size )
890  return;
891 
892  m_size = aSize;
893 
894  // Move the fields if we're in autoplace mode
896  AutoplaceFields( /* aScreen */ nullptr, /* aManual */ false );
897 
898  // Move the sheet labels according to the new sheet size.
899  for( SCH_SHEET_PIN* sheetPin : m_pins )
900  sheetPin->ConstrainOnEdge( sheetPin->GetPosition() );
901 }
wxSize m_size
Definition: sch_sheet.h:476
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:579

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

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

230 {
231  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
232  {
233  if( token->IsSameAs( m_fields[i].GetCanonicalName().Upper() ) )
234  {
235  *token = m_fields[i].GetShownText( aDepth + 1 );
236  return true;
237  }
238  }
239 
240  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
241  {
242  if( token->IsSameAs( m_fields[i].GetName() ) )
243  {
244  *token = m_fields[i].GetShownText( aDepth + 1 );
245  return true;
246  }
247  }
248 
249  PROJECT *project = &Schematic()->Prj();
250 
251  // We cannot resolve text variables initially on load as we need to first load the screen and
252  // then parse the hierarchy. So skip the resolution if the screen isn't set yet
254  {
255  return true;
256  }
257 
258  if( token->IsSameAs( wxT( "#" ) ) )
259  {
260  for( const SCH_SHEET_PATH& sheet : Schematic()->GetSheets() )
261  {
262  if( sheet.Last() == this ) // Current sheet path found
263  {
264  *token = wxString::Format( wxT( "%s" ), sheet.GetPageNumber() );
265  return true;
266  }
267  }
268  }
269  else if( token->IsSameAs( wxT( "##" ) ) )
270  {
271  SCH_SHEET_LIST sheetList = Schematic()->GetSheets();
272  *token = wxString::Format( wxT( "%d" ), (int) sheetList.size() );
273  return true;
274  }
275 
276  return false;
277 }
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:104
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:156
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:473
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:469
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 ( const wxPoint &  aCenter)
overridevirtual

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

Implements SCH_ITEM.

Definition at line 797 of file sch_sheet.cpp.

798 {
799  wxPoint prev = m_pos;
800 
801  RotatePoint( &m_pos, aCenter, 900 );
802  RotatePoint( &m_size.x, &m_size.y, 900 );
803 
804  if( m_size.x < 0 )
805  {
806  m_pos.x += m_size.x;
807  m_size.x = -m_size.x;
808  }
809 
810  if( m_size.y < 0 )
811  {
812  m_pos.y += m_size.y;
813  m_size.y = -m_size.y;
814  }
815 
816  // Pins must be rotated first as that's how we determine vertical vs horizontal
817  // orientation for auto-placement
818  for( SCH_SHEET_PIN* sheetPin : m_pins )
819  sheetPin->Rotate( aCenter );
820 
822  {
823  AutoplaceFields( /* aScreen */ nullptr, /* aManual */ false );
824  }
825  else
826  {
827  // Move the fields to the new position because the parent itself has moved.
828  for( SCH_FIELD& field : m_fields )
829  {
830  wxPoint pos = field.GetTextPos();
831  pos.x -= prev.x - m_pos.x;
832  pos.y -= prev.y - m_pos.y;
833  field.SetTextPos( pos );
834  }
835  }
836 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
wxSize m_size
Definition: sch_sheet.h:476
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
wxPoint m_pos
Definition: sch_sheet.h:475
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:579

References AutoplaceFields(), FIELDS_AUTOPLACED_AUTO, m_fields, SCH_ITEM::m_fieldsAutoplaced, m_pins, m_pos, m_size, 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 998 of file sch_sheet.cpp.

999 {
1000  for( SCH_FIELD& field : m_fields )
1001  aFunction( &field );
1002 
1003  for( SCH_SHEET_PIN* pin : m_pins )
1004  aFunction( pin );
1005 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473

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

105 {
106  EDA_ITEM* parent = GetParent();
107 
108  while( parent )
109  {
110  if( parent->Type() == SCHEMATIC_T )
111  return static_cast<SCHEMATIC*>( parent );
112  else
113  parent = parent->GetParent();
114  }
115 
116  return nullptr;
117 }
EDA_ITEM * GetParent() const
Definition: eda_item.h:114
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:99
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

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

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextMenu(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_TEXT::GetLabelBoxExpansion(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_LINE::GetPenWidth(), GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_PIN::HitTest(), SCH_GLOBALLABEL::HitTest(), inheritNetclass(), IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_GLOBALLABEL::Plot(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_FIELD_PROPERTIES::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 693 of file sch_sheet.cpp.

694 {
695  if( m_screen )
696  {
697  // Only check the root sheet once and don't recurse.
698  if( !GetParent() )
699  {
700  if( m_screen && m_screen->GetFileName().Cmp( aFilename ) == 0 )
701  {
702  *aScreen = m_screen;
703  return true;
704  }
705  }
706 
707  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
708  {
709  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( aItem );
710  SCH_SCREEN* screen = sheet->m_screen;
711 
712  // Must use the screen's path (which is always absolute) rather than the
713  // sheet's (which could be relative).
714  if( screen && screen->GetFileName().Cmp( aFilename ) == 0 )
715  {
716  *aScreen = screen;
717  return true;
718  }
719 
720  if( sheet->SearchHierarchy( aFilename, aScreen ) )
721  return true;
722  }
723  }
724 
725  return false;
726 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
const wxString & GetFileName() const
Definition: sch_screen.h:145
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:693
EDA_ITEM * GetParent() const
Definition: eda_item.h:114
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

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

Referenced by SCH_SEXPR_PLUGIN::loadHierarchy(), 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().

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

◆ SetConnectivityDirty()

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

◆ SetFields()

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

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 320 of file sch_sheet.cpp.

321 {
322  m_fields = aFields;
323  int next_id = SHEET_MANDATORY_FIELDS;
324 
325  for( int ii = 0; ii < int( m_fields.size() ); )
326  {
327  if( m_fields[ii].GetId() < 0 || m_fields[ii].GetId() >= ssize_t( m_fields.size() ) )
328  m_fields[ii].SetId( next_id++ );
329 
330  if( m_fields[ii].GetId() != ii )
331  std::swap( m_fields[ii], m_fields[m_fields[ii].GetId()]);
332 
333  if( m_fields[ii].GetId() == ii )
334  ++ii;
335  }
336 
337  // Make sure that we get the UNIX variant of the file path
338  SetFileName( m_fields[SHEETFILENAME].GetText() );
339 }
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:47
void SetFileName(const wxString &aFilename)
Definition: sch_sheet.h:320
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:473

References m_fields, SetFileName(), SHEET_MANDATORY_FIELDS, and SHEETFILENAME.

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

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

◆ SetFileName()

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

Definition at line 320 of file sch_sheet.h.

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

References m_fields, and SHEETFILENAME.

Referenced by SCH_EDIT_FRAME::importFile(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet(), SCH_EDIT_FRAME::SaveProject(), and SetFields().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask)
inlineinherited

Definition at line 152 of file eda_item.h.

152 { m_flags |= aMask; }
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:480

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::cleanupShapes(), 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(), 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::ParseLabel(), 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(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), 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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_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 203 of file eda_item.h.

203 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:479

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetInstances()

void SCH_SHEET::SetInstances ( const std::vector< SCH_SHEET_INSTANCE > &  aInstances)
inline

Definition at line 394 of file sch_sheet.h.

395  {
396  m_instances = aInstances;
397  }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481

References m_instances.

◆ SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM aItem)
inlinevirtualinherited

Reimplemented in SCH_LINE, SCH_JUNCTION, and SCH_BUS_ENTRY_BASE.

Definition at line 417 of file sch_item.h.

417 { }

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 247 of file sch_item.h.

247 {}

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

Warning
The SCH_SHEET_PATH object must be a full hierarchical path which means the SCH_SHEET object at index 0 must be the root sheet. A partial sheet path will raise an assertion on debug builds and silently fail and return on release builds.
Parameters
[in]aInstanceis the hierarchical path of the sheet.
[in]aReferenceis the new page number for the sheet.

Definition at line 1210 of file sch_sheet.cpp.

1211 {
1212  wxCHECK( aSheetPath.IsFullPath(), /* void */ );
1213 
1214  KIID_PATH path = aSheetPath.PathWithoutRootUuid();
1215 
1216  for( SCH_SHEET_INSTANCE& instance : m_instances )
1217  {
1218  if( instance.m_Path == path )
1219  {
1220  instance.m_PageNumber = aPageNumber;
1221  break;
1222  }
1223  }
1224 }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
A simple container for sheet instance information.

References SCH_SHEET_PATH::IsFullPath(), m_instances, path, and SCH_SHEET_PATH::PathWithoutRootUuid().

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), 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 PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

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

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), 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::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), FOOTPRINT::operator=(), LIB_SYMBOL::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_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

◆ SetPosition()

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

Reimplemented from EDA_ITEM.

Definition at line 879 of file sch_sheet.cpp.

880 {
881  // Remember the sheet and all pin sheet positions must be
882  // modified. So use Move function to do that.
883  Move( aPosition - m_pos );
884 }
wxPoint m_pos
Definition: sch_sheet.h:475
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_sheet.cpp:785

References m_pos, and Move().

Referenced by TEST_EE_ITEM_FIXTURE::TEST_EE_ITEM_FIXTURE(), and 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 175 of file sch_sheet.cpp.

176 {
177  if( aScreen == m_screen )
178  return;
179 
180  if( m_screen != nullptr )
181  {
183 
184  if( m_screen->GetRefCount() == 0 )
185  {
186  delete m_screen;
187  m_screen = nullptr;
188  }
189  }
190 
191  m_screen = aScreen;
192 
193  if( m_screen )
195 }
void DecRefCount()
Definition: sch_screen.cpp:124
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
void IncRefCount()
Definition: sch_screen.cpp:118
int GetRefCount() const
Definition: sch_screen.h:162

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

Referenced by SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_FRAME::InitSheet(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_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 ( EDA_ITEM_FLAGS  type,
bool  state 
)
inlineinherited

Definition at line 141 of file eda_item.h.

142  {
143  if( state )
144  m_status |= type; // state = ON or OFF
145  else
146  m_status &= ~type;
147  }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:477

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus)
inlineinherited

Definition at line 150 of file eda_item.h.

150 { m_status = aStatus; }
EDA_ITEM_FLAGS m_status
Definition: eda_item.h:477

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const wxPoint &  aPos)
inlineinherited

Definition at line 223 of file sch_item.h.

223 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:490

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

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 127 of file eda_item.h.

127 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:152
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.

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

420 { 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 286 of file sch_sheet.cpp.

287 {
288  wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
289  wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
290  aItem->GetClass() ) );
291 
292  SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
293 
294  std::swap( m_pos, sheet->m_pos );
295  std::swap( m_size, sheet->m_size );
296  m_fields.swap( sheet->m_fields );
297  std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
298  m_pins.swap( sheet->m_pins );
299 
300  // Update parent pointers after swapping.
301  for( SCH_SHEET_PIN* sheetPin : m_pins )
302  sheetPin->SetParent( this );
303 
304  for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
305  sheetPin->SetParent( sheet );
306 
307  for( SCH_FIELD& field : m_fields )
308  field.SetParent( this );
309 
310  for( SCH_FIELD& field : sheet->m_fields )
311  field.SetParent( sheet );
312 
313  std::swap( m_borderWidth, sheet->m_borderWidth );
314  std::swap( m_borderColor, sheet->m_borderColor );
315  std::swap( m_backgroundColor, sheet->m_backgroundColor );
316  std::swap( m_instances, sheet->m_instances );
317 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:478
wxSize m_size
Definition: sch_sheet.h:476
wxPoint m_pos
Definition: sch_sheet.h:475
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:489
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:481
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:115
int m_borderWidth
Definition: sch_sheet.h:477
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:479
virtual wxString GetClass() const override
Return the class name.
Definition: sch_item.h:193
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

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

672 {
673  int n = 0;
674 
675  if( m_screen )
676  {
677  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SYMBOL_T ) )
678  {
679  SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem;
680 
681  if( symbol->GetField( VALUE_FIELD )->GetText().GetChar( 0 ) != '#' )
682  n++;
683  }
684 
685  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_SHEET_T ) )
686  n += static_cast<const SCH_SHEET*>( aItem )->SymbolCount();
687  }
688 
689  return n;
690 }
EE_TYPE OfType(KICAD_T aType) const
Definition: sch_rtree.h:230
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:705
Field Value of part, i.e. "3.3K".
Schematic symbol object.
Definition: sch_symbol.h:78
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:110
SCH_SCREEN * m_screen
Definition: sch_sheet.h:469
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:154

References SCH_SYMBOL::GetField(), EDA_TEXT::GetText(), SCH_SCREEN::Items(), m_screen, EE_RTREE::OfType(), SCH_SHEET_T, SCH_SYMBOL_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 112 of file eda_item.h.

112 { 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:487

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(), SCH_MOVE_TOOL::AlignElements(), 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(), calcIsInsideArea(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), PCB_TEXT::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), PCB_MARKER::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), FOOTPRINT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), CONNECTION_GRAPH::collectAllDriverValues(), LIB_TEXT::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), LIB_SYMBOL::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), 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::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::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItems(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::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(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), BOARD_ITEM::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_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(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), CONNECTIVITY_DATA::IsConnectedOnLayer(), 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(), PCB_TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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(), CONVERT_TOOL::makePolysFromSegs(), 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(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), LIB_ITEM::operator<(), SCH_LINE::operator<(), operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), operator=(), SCH_SYMBOL::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_EDITOR_CONTROL::PageSettings(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), 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_SYMBOL::RemoveDrawItem(), RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), 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(), 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(), 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(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::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_GROUP::SwapData(), PCB_TEXT::SwapData(), PCB_TRACK::SwapData(), SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), PAD::SwapData(), FOOTPRINT::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_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), 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_FIELD_PROPERTIES::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(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), 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 937 of file sch_sheet.cpp.

939 {
940  bool changed = false;
941 
942  for( SCH_SHEET_PIN* sheetPin : m_pins )
943  changed |= sheetPin->UpdateDanglingState( aItemList );
944 
945  return changed;
946 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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 280 of file sch_sheet.cpp.

281 {
282  return m_borderWidth == 0 && m_borderColor == COLOR4D::UNSPECIFIED;
283 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:478
int m_borderWidth
Definition: sch_sheet.h:477

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, PCB_DIM_CENTER, EDIT_POINTS, PCB_DIMENSION_BASE, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, PCB_SHAPE, DS_PROXY_VIEW_ITEM, PCB_MARKER, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, RATSNEST_VIEW_ITEM, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 257 of file eda_item.cpp.

258 {
259  // Basic fallback
260  EDA_RECT bbox = GetBoundingBox();
261 
262  return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
263 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:506
const wxPoint GetOrigin() const
Definition: eda_rect.h:110
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:75
const wxSize GetSize() const
Definition: eda_rect.h:100

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

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), PCB_SHAPE::ViewBBox(), and PCB_DIMENSION_BASE::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::PREVIEW::SELECTION_AREA, KIGFX::VIEW_GROUP, 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 106 of file view_item.h.

107  {}

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

623 {
624  aCount = 4;
625  aLayers[0] = LAYER_HIERLABEL;
626  aLayers[1] = LAYER_SHEET;
627  aLayers[2] = LAYER_SHEET_BACKGROUND;
628  aLayers[3] = LAYER_SELECTION_SHADOWS;
629 }

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, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 132 of file view_item.h.

133  {
134  // By default always show the item
135  return 0.0;
136  }

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

961 {
962  KICAD_T stype;
963 
964  for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
965  {
966  // If caller wants to inspect my type
967  if( stype == SCH_LOCATE_ANY_T || stype == Type() )
968  {
969  if( SEARCH_RESULT::QUIT == aInspector( this, nullptr ) )
970  return SEARCH_RESULT::QUIT;
971  }
972 
973  if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T )
974  {
975  // Test the sheet fields.
976  for( SCH_FIELD& field : m_fields )
977  {
978  if( SEARCH_RESULT::QUIT == aInspector( &field, this ) )
979  return SEARCH_RESULT::QUIT;
980  }
981  }
982 
983  if( stype == SCH_LOCATE_ANY_T || stype == SCH_SHEET_PIN_T )
984  {
985  // Test the sheet labels.
986  for( SCH_SHEET_PIN* sheetPin : m_pins )
987  {
988  if( SEARCH_RESULT::QUIT == aInspector( sheetPin, this ) )
989  return SEARCH_RESULT::QUIT;
990  }
991  }
992  }
993 
995 }
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:49
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
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:472
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:473
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

References CONTINUE, EOT, m_fields, m_pins, 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 467 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 479 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 478 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 477 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 494 of file sch_item.h.

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

◆ 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 497 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 488 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

◆ m_layer

◆ m_parent

◆ m_pins

◆ m_pos

◆ m_screen

◆ m_size

◆ m_status

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

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

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_FIXTURE_TEST_CASE(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::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(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), SCH_SEXPR_PLUGIN::Format(), PCB_PLUGIN::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_SCREEN::GetSheets(), 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(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_EDITOR_CONTROL::nextMatch(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), PAD::PAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveJunction(), 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_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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