KiCad PCB EDA Suite
SCH_SHEET Class Reference

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

#include <sch_sheet.h>

Inheritance diagram for SCH_SHEET:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 SCH_SHEET (EDA_ITEM *aParent=nullptr, const wxPoint &pos=wxPoint(0, 0))
 
 SCH_SHEET (const SCH_SHEET &aSheet)
 Copy aSheet into a new object. More...
 
 ~SCH_SHEET ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
bool IsMovableFromAnchorPoint () override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor. More...
 
std::vector< SCH_FIELD > & GetFields ()
 
void SetFields (const std::vector< SCH_FIELD > &aFields)
 Set multiple schematic fields. More...
 
wxString GetName () const
 
SCH_SCREENGetScreen () const
 
wxSize GetSize ()
 
void SetSize (const wxSize &aSize)
 
int GetBorderWidth () const
 
void SetBorderWidth (int aWidth)
 
KIGFX::COLOR4D GetBorderColor () const
 
void SetBorderColor (KIGFX::COLOR4D aColor)
 
KIGFX::COLOR4D GetBackgroundColor () const
 
void SetBackgroundColor (KIGFX::COLOR4D aColor)
 
bool UsesDefaultStroke () const
 Test this sheet to see if the default stroke is used to draw the outline. More...
 
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
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
bool IsVerticalOrientation () const
 
void AddPin (SCH_SHEET_PIN *aSheetPin)
 Add aSheetPin to the sheet. More...
 
std::vector< SCH_SHEET_PIN * > & GetPins ()
 
std::vector< SCH_SHEET_PIN * > & GetPins () const
 
void RemovePin (SCH_SHEET_PIN *aSheetPin)
 Remove aSheetPin from the sheet. More...
 
void CleanupSheet ()
 Delete sheet label which do not have a corresponding hierarchical label. More...
 
SCH_SHEET_PINGetPin (const wxPoint &aPosition)
 Return the sheet pin item found at aPosition in the sheet. More...
 
bool HasPin (const wxString &aName)
 Checks if the sheet already has a sheet pin named aName. More...
 
bool HasPins ()
 
bool HasUndefinedPins ()
 Check all sheet labels against schematic for undefined hierarchical labels. More...
 
int GetMinWidth () const
 Return the minimum width of the sheet based on the widths of the sheet pin text. More...
 
int GetMinHeight () const
 Return the minimum height that the sheet can be resized based on the sheet pin positions. More...
 
int GetPenWidth () const override
 
void Print (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
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
wxPoint GetRotationCenter () const
 Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer than the edge it's on. More...
 
void SwapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item. More...
 
int SymbolCount () const
 Count our own components, without the power components. More...
 
bool SearchHierarchy (const wxString &aFilename, SCH_SCREEN **aScreen)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
bool LocatePathOfScreen (SCH_SCREEN *aScreen, SCH_SHEET_PATH *aList)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
int CountSheets () const
 Count the number of sheets found in "this" sheet including all of the subsheets. More...
 
wxString GetFileName () const
 Return the filename corresponding to this sheet. More...
 
void SetFileName (wxString aFilename)
 
void Move (const wxPoint &aMoveVector) override
 Move the item by aMoveVector to a new position. More...
 
void MirrorY (int aYaxis_position) override
 Mirror item relative to the Y axis about aYaxis_position. More...
 
void MirrorX (int aXaxis_position) override
 Mirror item relative to the X axis about aXaxis_position. More...
 
void Rotate (wxPoint aPosition) override
 Rotate the item around aPosition 90 degrees in the clockwise direction. More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool IsReplaceable () const override
 Function IsReplaceable. More...
 
void Resize (const wxSize &aSize)
 Resize this sheet to aSize and adjust all of the labels accordingly. More...
 
void AutoplaceFields (SCH_SCREEN *aScreen, bool aManual) override
 
void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList) override
 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
 Function Visit 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
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
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
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
void Plot (PLOTTER *aPlotter) override
 Plot the schematic item to aPlotter. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
const std::vector< SCH_SHEET_INSTANCEGetInstances () const
 
bool AddInstance (const KIID_PATH &aInstance)
 Add a new instance aSheetPath to the instance list. More...
 
wxString GetPageNumber (const SCH_SHEET_PATH &aInstance) const
 Return the sheet page number for aInstance. More...
 
void SetPageNumber (const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
 Set the page number for the sheet instance aInstance. More...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPoint & GetStoredPos ()
 
void SetStoredPos (wxPoint aPos)
 
SCHEMATICSchematic () const
 Searches the item hierarchy to find a SCHEMATIC. More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Set the 'lock' status to aLocked for of this item. More...
 
virtual bool IsHypertext () const
 Allows 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)
 Retrieves the set of items connected to this item on the given sheet. More...
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Adds a connection link between this item and another. More...
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Creates a new connection object associated with this object. More...
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Returns true if this item should propagate connection info to aItem. More...
 
bool IsConnectivityDirty ()
 
void SetConnectivityDirty (bool aDirty=true)
 
NETCLASSPTR NetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
FIELDS_AUTOPLACED GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed. More...
 
void ClearFieldsAutoplaced ()
 Set fields automatically placed flag false. More...
 
void AutoAutoplaceFields (SCH_SCREEN *aScreen)
 Autoplace fields only if correct to do so automatically. More...
 
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
 Function Type() 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 IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual const wxPoint GetFocusPosition () const
 Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual double ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
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 const wxString GetDefaultFieldName (int aFieldNdx)
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

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

Protected Attributes

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

Private Member Functions

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

Private Attributes

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

Friends

class SCH_SHEET_PIN
 

Detailed Description

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

Definition at line 219 of file sch_sheet.h.

Constructor & Destructor Documentation

◆ SCH_SHEET() [1/2]

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

Definition at line 71 of file sch_sheet.cpp.

71  :
72  SCH_ITEM( aParent, SCH_SHEET_T )
73 {
75  m_pos = pos;
76  m_size = wxSize( Mils2iu( MIN_SHEET_WIDTH ), Mils2iu( MIN_SHEET_HEIGHT ) );
77  m_screen = NULL;
78 
79  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
80  {
81  m_fields.emplace_back( pos, i, this, GetDefaultFieldName( i ) );
82  m_fields.back().SetVisible( true );
83 
84  if( i == SHEETNAME )
85  m_fields.back().SetLayer( LAYER_SHEETNAME );
86  else if( i == SHEETFILENAME )
87  m_fields.back().SetLayer( LAYER_SHEETFILENAME );
88  else
89  m_fields.back().SetLayer( LAYER_SHEETFIELDS );
90  }
91 
93 
94  m_borderWidth = 0;
95  m_borderColor = COLOR4D::UNSPECIFIED;
96  m_backgroundColor = COLOR4D::UNSPECIFIED;
97 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:71
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:43
SCH_LAYER_ID m_layer
Definition: sch_item.h:199
#define NULL
int m_borderWidth
Definition: sch_sheet.h:232
static const wxString GetDefaultFieldName(int aFieldNdx)
Definition: sch_sheet.cpp:44
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:44
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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

Referenced by Clone().

◆ SCH_SHEET() [2/2]

SCH_SHEET::SCH_SHEET ( const SCH_SHEET aSheet)

Copy aSheet into a new object.

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

Definition at line 100 of file sch_sheet.cpp.

100  :
101  SCH_ITEM( aSheet )
102 {
103  m_pos = aSheet.m_pos;
104  m_size = aSheet.m_size;
105  m_layer = aSheet.m_layer;
106  const_cast<KIID&>( m_Uuid ) = aSheet.m_Uuid;
107  m_fields = aSheet.m_fields;
109  m_screen = aSheet.m_screen;
110 
111  for( SCH_SHEET_PIN* pin : aSheet.m_pins )
112  {
113  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
114  m_pins.back()->SetParent( this );
115  }
116 
117  m_borderWidth = aSheet.m_borderWidth;
118  m_borderColor = aSheet.m_borderColor;
120  m_instances = aSheet.m_instances;
121 
122  if( m_screen )
124 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:221
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
SCH_LAYER_ID m_layer
Definition: sch_item.h:199
int m_borderWidth
Definition: sch_sheet.h:232
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
const KIID m_Uuid
Definition: eda_item.h:151
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
void IncRefCount()
Definition: sch_screen.cpp:107
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:47

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

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 127 of file sch_sheet.cpp.

128 {
129  // also, look at the associated sheet & its reference count
130  // perhaps it should be deleted also.
131  if( m_screen )
132  {
134 
135  if( m_screen->GetRefCount() == 0 )
136  delete m_screen;
137  }
138 
139  // We own our pins; delete them
140  for( SCH_SHEET_PIN* pin : m_pins )
141  delete pin;
142 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
void DecRefCount()
Definition: sch_screen.cpp:113
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
int GetRefCount() const
Definition: sch_screen.h:197

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

Member Function Documentation

◆ AddConnectionTo()

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

Adds a connection link between this item and another.

Definition at line 170 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

Referenced by SCH_TEXT::UpdateDanglingState().

◆ AddInstance()

bool SCH_SHEET::AddInstance ( const KIID_PATH aInstance)

Add a new instance aSheetPath to the instance list.

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

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

Definition at line 1050 of file sch_sheet.cpp.

1051 {
1052  // a empty sheet path is illegal:
1053  wxCHECK( aSheetPath.size() > 0, false );
1054 
1055  wxString path;
1056 
1057  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1058  {
1059  // if aSheetPath is found, nothing to do:
1060  if( instance.m_Path == aSheetPath )
1061  return false;
1062  }
1063 
1064  SCH_SHEET_INSTANCE instance;
1065 
1066  instance.m_Path = aSheetPath;
1067 
1068  // This entry does not exist: add it with an empty page number.
1069  m_instances.emplace_back( instance );
1070  return true;
1071 }
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
A simple container for sheet instance infromation.

References m_instances, and SCH_SHEET_INSTANCE::m_Path.

Referenced by SCH_SHEET_LIST::SetInitialPageNumbers(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), 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 280 of file sch_sheet.cpp.

281 {
282  wxASSERT( aSheetPin != NULL );
283  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
284 
285  aSheetPin->SetParent( this );
286  m_pins.push_back( aSheetPin );
287  renumberPins();
288 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:184
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:819
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

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

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

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

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

Definition at line 467 of file sch_item.h.

468  {
469  if( GetFieldsAutoplaced() )
471  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:453
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:473

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

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

◆ AutoplaceFields()

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

Reimplemented from SCH_ITEM.

Definition at line 499 of file sch_sheet.cpp.

500 {
501  wxSize textSize = m_fields[ SHEETNAME ].GetTextSize();
502  int borderMargin = KiROUND( GetPenWidth() / 2.0 ) + 4;
503  int margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.5 );
504 
505  if( IsVerticalOrientation() )
506  {
507  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( -margin, m_size.y ) );
508  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
509  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
510  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_VERT );
511  }
512  else
513  {
514  m_fields[ SHEETNAME ].SetTextPos( m_pos + wxPoint( 0, -margin ) );
515  m_fields[ SHEETNAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
516  m_fields[ SHEETNAME ].SetVertJustify(GR_TEXT_VJUSTIFY_BOTTOM );
517  m_fields[ SHEETNAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
518  }
519 
520  textSize = m_fields[ SHEETFILENAME ].GetTextSize();
521  margin = borderMargin + KiROUND( std::max( textSize.x, textSize.y ) * 0.4 );
522 
523  if( IsVerticalOrientation() )
524  {
525  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( m_size.x + margin, m_size.y ) );
526  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
527  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
528  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_VERT );
529  }
530  else
531  {
532  m_fields[ SHEETFILENAME ].SetTextPos( m_pos + wxPoint( 0, m_size.y + margin ) );
533  m_fields[ SHEETFILENAME ].SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
534  m_fields[ SHEETFILENAME ].SetVertJustify(GR_TEXT_VJUSTIFY_TOP );
535  m_fields[ SHEETFILENAME ].SetTextAngle( TEXT_ANGLE_HORIZ );
536  }
537 
539 }
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: eda_text.h:50
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
int GetPenWidth() const override
Definition: sch_sheet.cpp:493
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:332
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
#define TEXT_ANGLE_VERT
Definition: eda_text.h:51

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

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

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 548 of file sch_sheet.h.

549  {
550  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
551  ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS ) ||
552  ( aItem->Type() == SCH_NO_CONNECT_T );
553  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:285
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

◆ ClassOf()

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

Definition at line 249 of file sch_sheet.h.

250  {
251  return aItem && SCH_SHEET_T == aItem->Type();
252  }
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

References SCH_SHEET_T, and EDA_ITEM::Type().

◆ CleanupSheet()

void SCH_SHEET::CleanupSheet ( )

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

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

Definition at line 455 of file sch_sheet.cpp.

456 {
457  auto i = m_pins.begin();
458 
459  while( i != m_pins.end() )
460  {
461  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
462  const SCH_HIERLABEL* HLabel = NULL;
463 
464  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
465  {
466  if( (*i)->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
467  {
468  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
469  break;
470  }
471  }
472 
473  if( HLabel == NULL ) // Hlabel not found: delete sheet label.
474  i = m_pins.erase( i );
475  else
476  ++i;
477  }
478 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
EE_RTREE & Items()
Definition: sch_screen.h:159
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194

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

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearConnections()

void SCH_ITEM::ClearConnections ( )
inlineinherited

Clears all of the connection items from the list.

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

Definition at line 405 of file sch_item.h.

405 { m_connections.clear(); }
EDA_ITEMS m_connections
Definition: sch_item.h:200

References SCH_ITEM::m_connections.

◆ ClearEditFlags()

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )
inlineinherited

Set fields automatically placed flag false.

Definition at line 458 of file sch_item.h.

FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_MOVE_TOOL::moveItem(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ ClearFlags()

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

Definition at line 221 of file eda_item.h.

221 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:164

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(), LIB_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 233 of file eda_item.h.

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

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

155  {
157  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:162
#define NULL

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

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

◆ Clone()

EDA_ITEM * SCH_SHEET::Clone ( ) const
overridevirtual

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

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

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 145 of file sch_sheet.cpp.

146 {
147  return new SCH_SHEET( *this );
148 }
SCH_SHEET(EDA_ITEM *aParent=nullptr, const wxPoint &pos=wxPoint(0, 0))
Definition: sch_sheet.cpp:71

References SCH_SHEET().

Referenced by SCH_DRAWING_TOOLS::DrawSheet().

◆ ConnectedItems()

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

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

Definition at line 164 of file sch_item.cpp.

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

References SCH_ITEM::m_connected_items.

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

◆ Connection()

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

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

Note
The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

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

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

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

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 442 of file sch_item.h.

442 { 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 693 of file sch_sheet.cpp.

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

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

280 { }

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

Reimplemented from SCH_ITEM.

Definition at line 320 of file sch_sheet.cpp.

321 {
322  for( SCH_SHEET_PIN* sheetPin : m_pins )
323  {
324  if( sheetPin->GetPosition() == aPosition )
325  return true;
326  }
327 
328  return false;
329 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

References m_pins.

◆ Duplicate()

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

Routine to create a new copy of given item.

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

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

Definition at line 78 of file sch_item.cpp.

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

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

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

85  {
87  TYPE_ID thisType = TYPE_HASH( *this );
88  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
89  return object ? aProperty->getter( object ) : wxAny();
90  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual wxAny getter(void *aObject) const =0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

Referenced by 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 93 of file inspectable.h.

94  {
96  TYPE_ID thisType = TYPE_HASH( *this );
97  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
98  return object ? aProperty->get<T>( object ) : T();
99  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns 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 102 of file inspectable.h.

103  {
105  TYPE_ID thisType = TYPE_HASH( *this );
106  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
107  boost::optional<T> ret;
108 
109  if( prop )
110  {
111  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
112 
113  if( object )
114  ret = prop->get<T>( object );
115  }
116 
117  return ret;
118  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
T get(void *aObject)
Definition: property.h:275
virtual size_t OwnerHash() const =0
Returns 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()

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

◆ GetBodyBoundingBox()

const EDA_RECT SCH_SHEET::GetBodyBoundingBox ( ) const

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

Definition at line 570 of file sch_sheet.cpp.

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

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

Referenced by GetBoundingBox(), and HitTest().

◆ GetBorderColor()

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const
inline

Definition at line 289 of file sch_sheet.h.

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

References m_borderWidth.

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

◆ GetBoundingBox()

const EDA_RECT SCH_SHEET::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 591 of file sch_sheet.cpp.

592 {
594 
595  for( const SCH_FIELD& field : m_fields )
596  box.Merge( field.GetBoundingBox() );
597 
598  return box;
599 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
Definition: eda_rect.cpp:431
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:570
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

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

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 254 of file sch_sheet.h.

255  {
256  return wxT( "SCH_SHEET" );
257  }

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
aPointsList of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 855 of file sch_sheet.cpp.

856 {
857  std::vector<wxPoint> retval;
858 
859  for( SCH_SHEET_PIN* sheetPin : m_pins )
860  retval.push_back( sheetPin->GetPosition() );
861 
862  return retval;
863 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

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

192 {
193  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
194  aVars->push_back( m_fields[i].GetCanonicalName().Upper() );
195 
196  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
197  aVars->push_back( m_fields[i].GetName() );
198 
199  aVars->push_back( wxT( "#" ) );
200  aVars->push_back( wxT( "##" ) );
201 }
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:71
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References m_fields, and SHEET_MANDATORY_FIELDS.

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

◆ GetDefaultFieldName()

const wxString SCH_SHEET::GetDefaultFieldName ( int  aFieldNdx)
static

Definition at line 44 of file sch_sheet.cpp.

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

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

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

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 225 of file eda_item.h.

226  {
227  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
229 
230  return m_flags & mask;
231  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
#define IS_MOVED
Item being moved.
Definition: eda_item.h:105
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:119
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:164
#define IS_NEW
New item, just created.
Definition: eda_item.h:106

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ 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
aItemList- List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 831 of file sch_sheet.cpp.

832 {
833  for( SCH_SHEET_PIN* sheetPin : m_pins )
834  {
835  wxCHECK2_MSG( sheetPin->Type() == SCH_SHEET_PIN_T, continue,
836  wxT( "Invalid item in schematic sheet pin list. Bad programmer!" ) );
837 
838  sheetPin->GetEndPoints( aItemList );
839  }
840 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

References m_pins, and SCH_SHEET_PIN_T.

◆ GetFields()

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 453 of file sch_item.h.

453 { return m_fieldsAutoplaced; }
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201

References SCH_ITEM::m_fieldsAutoplaced.

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

◆ GetFileName()

◆ GetFlags()

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 333 of file eda_item.h.

333 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: eda_item.h:325

References EDA_ITEM::GetPosition().

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

◆ GetInstances()

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

◆ GetLayer()

◆ GetMenuImage()

BITMAP_DEF SCH_SHEET::GetMenuImage ( ) const
overridevirtual

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

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

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 921 of file sch_sheet.cpp.

922 {
924 }
const BITMAP_OPAQUE add_hierarchical_subsheet_xpm[1]

References add_hierarchical_subsheet_xpm.

◆ GetMinHeight()

int SCH_SHEET::GetMinHeight ( ) const

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

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

Returns
The minimum height the sheet can be resized.

Definition at line 416 of file sch_sheet.cpp.

417 {
418  int height = Mils2iu( MIN_SHEET_HEIGHT );
419 
420  for( size_t i = 0; i < m_pins.size(); i++ )
421  {
422  int edge = m_pins[i]->GetEdge();
423  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
424 
425  // Make sure pin is on top or bottom side of sheet.
426  if( edge == SHEET_RIGHT_SIDE || edge == SHEET_LEFT_SIDE )
427  {
428  if( height < pinRect.GetBottom() - m_pos.y )
429  height = pinRect.GetBottom() - m_pos.y;
430  }
431  else
432  {
433  if( height < pinRect.GetHeight() )
434  height = pinRect.GetHeight();
435 
436  for( size_t j = 0; j < m_pins.size(); j++ )
437  {
438  // Check for pin directly above or below the current pin.
439  if( (i == j) || (m_pins[i]->GetPosition().x != m_pins[j]->GetPosition().x) )
440  continue;
441 
442  if( height < pinRect.GetHeight() + m_pins[j]->GetBoundingBox().GetHeight() )
443  {
444  height = pinRect.GetHeight() + m_pins[j]->GetBoundingBox().GetHeight();
445  break;
446  }
447  }
448  }
449  }
450 
451  return height;
452 }
wxPoint m_pos
Definition: sch_sheet.h:230
int GetBottom() const
Definition: eda_rect.h:124
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
int GetHeight() const
Definition: eda_rect.h:120
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:44

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

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( ) const

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

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

Returns
The minimum width the sheet can be resized.

Definition at line 376 of file sch_sheet.cpp.

377 {
378  int width = Mils2iu( MIN_SHEET_WIDTH );
379 
380  for( size_t i = 0; i < m_pins.size(); i++ )
381  {
382  int edge = m_pins[i]->GetEdge();
383  EDA_RECT pinRect = m_pins[i]->GetBoundingBox();
384 
385  wxASSERT( edge != SHEET_UNDEFINED_SIDE );
386 
387  if( edge == SHEET_TOP_SIDE || edge == SHEET_BOTTOM_SIDE )
388  {
389  if( width < pinRect.GetRight() - m_pos.x )
390  width = pinRect.GetRight() - m_pos.x;
391  }
392  else
393  {
394  if( width < pinRect.GetWidth() )
395  width = pinRect.GetWidth();
396 
397  for( size_t j = 0; j < m_pins.size(); j++ )
398  {
399  // Check for pin directly across from the current pin.
400  if( (i == j) || (m_pins[i]->GetPosition().y != m_pins[j]->GetPosition().y) )
401  continue;
402 
403  if( width < pinRect.GetWidth() + m_pins[j]->GetBoundingBox().GetWidth() )
404  {
405  width = pinRect.GetWidth() + m_pins[j]->GetBoundingBox().GetWidth();
406  break;
407  }
408  }
409  }
410  }
411 
412  return width;
413 }
int GetWidth() const
Definition: eda_rect.h:119
wxPoint m_pos
Definition: sch_sheet.h:230
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:43
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
int GetRight() const
Definition: eda_rect.h:121
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ GetMsgPanelInfo()

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

Function GetMsgPanelInfo populates 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 707 of file sch_sheet.cpp.

708 {
709  aList.emplace_back( _( "Sheet Name" ), m_fields[ SHEETNAME ].GetText(), CYAN );
710 
711  if( SCH_EDIT_FRAME* schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
712  {
713  SCH_SHEET_PATH path = schframe->GetCurrentSheet();
714  path.push_back( this );
715 
716  aList.emplace_back( _( "Hierarchical Path" ), path.PathHumanReadable( false ), BLUE );
717  }
718 
719  aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText(), BROWN );
720 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
wxString PathHumanReadable(bool aUseShortRootName=true) const
Return the sheet path in a human readable form made from thesheet names.
Definition: color4d.h:62
Schematic editor (Eeschema) main window.
Definition: color4d.h:59
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:228
Definition: color4d.h:57
#define _(s)
Definition: 3d_actions.cpp:33

References _, BLUE, BROWN, CYAN, m_fields, SCH_SHEET_PATH::PathHumanReadable(), SCH_SHEET_PATH::push_back(), SHEETFILENAME, and SHEETNAME.

◆ GetName()

wxString SCH_SHEET::GetName ( void  ) const
inline

Definition at line 282 of file sch_sheet.h.

282 { return m_fields[ SHEETNAME ].GetText(); }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References m_fields, and SHEETNAME.

Referenced by SCH_EDIT_FRAME::GetUniqueFilenameForCurrentSheet(), SCH_SHEET_LIST::NameExists(), SCH_EDIT_FRAME::SaveProject(), and ERC_TESTER::TestDuplicateSheetNames().

◆ GetPageNumber()

wxString SCH_SHEET::GetPageNumber ( const SCH_SHEET_PATH aInstance) const

Return the sheet page number for aInstance.

Returns
the page number for the requested sheet instance.

Definition at line 1074 of file sch_sheet.cpp.

1075 {
1076  wxString pageNumber;
1077  KIID_PATH path = aInstance.Path();
1078 
1079  for( const SCH_SHEET_INSTANCE& instance : m_instances )
1080  {
1081  if( instance.m_Path == path )
1082  {
1083  pageNumber = instance.m_PageNumber;
1084  break;
1085  }
1086  }
1087 
1088  return pageNumber;
1089 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
A simple container for sheet instance infromation.

References m_instances, and SCH_SHEET_PATH::Path().

Referenced by SCH_SHEET_LIST::AllSheetPageNumbersEmpty(), SCH_SEXPR_PLUGIN::Format(), SCH_SHEET_PATH::GetPageNumber(), 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 493 of file sch_sheet.cpp.

494 {
495  return std::max( GetBorderWidth(), 1 );
496 }
int GetBorderWidth() const
Definition: sch_sheet.h:289

References GetBorderWidth().

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

◆ GetPin()

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

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

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

Definition at line 481 of file sch_sheet.cpp.

482 {
483  for( SCH_SHEET_PIN* pin : m_pins )
484  {
485  if( pin->HitTest( aPosition ) )
486  return pin;
487  }
488 
489  return NULL;
490 }
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

References m_pins, and NULL.

◆ GetPins() [1/2]

◆ GetPins() [2/2]

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

Definition at line 366 of file sch_sheet.h.

367  {
368  return const_cast< std::vector<SCH_SHEET_PIN*>& >( m_pins );
369  }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227

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

603 {
604  EDA_RECT box( m_pos, m_size );
605  return box.GetCenter();
606 }
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by SCH_EDIT_TOOL::Rotate().

◆ GetScreen()

SCH_SCREEN* SCH_SHEET::GetScreen ( ) const
inline

Definition at line 284 of file sch_sheet.h.

284 { return m_screen; }
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224

References m_screen.

Referenced by SCH_SCREENS::buildScreenList(), SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), KIGFX::SCH_VIEW::DisplaySheet(), 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_LEGACY_PLUGIN::loadComponent(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_ALTIUM_PLUGIN::Parse(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_ALTIUM_PLUGIN::ParseSheet(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SCH_SHEET_PATH::PathHumanReadable(), SCH_EDIT_TOOL::Properties(), SCHEMATIC::RootScreen(), SCH_EDIT_FRAME::SaveEEFile(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and SCH_EDITOR_CONTROL::updatePastedInstances().

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

175 {
176  if( m_screen == NULL )
177  return 0;
178 
179  return m_screen->GetRefCount();
180 }
#define NULL
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
int GetRefCount() const
Definition: sch_screen.h:197

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

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged().

◆ GetSelectMenuText()

wxString SCH_SHEET::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 914 of file sch_sheet.cpp.

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

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

Referenced by Matches().

◆ GetSize()

wxSize SCH_SHEET::GetSize ( )
inline

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 204 of file eda_item.h.

205  {
206  return m_status & type;
207  }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 217 of file eda_item.h.

217 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 249 of file sch_item.h.

249 { return m_storedPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 486 of file sch_item.h.

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

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

484 { return false; }

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

◆ HasPin()

bool SCH_SHEET::HasPin ( const wxString &  aName)

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

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

Definition at line 308 of file sch_sheet.cpp.

309 {
310  for( SCH_SHEET_PIN* pin : m_pins )
311  {
312  if( pin->GetText().CmpNoCase( aName ) == 0 )
313  return true;
314  }
315 
316  return false;
317 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

References m_pins.

Referenced by SCH_DRAWING_TOOLS::importHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( )
inline

Definition at line 404 of file sch_sheet.h.

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

References m_pins.

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( )

Check all sheet labels against schematic for undefined hierarchical labels.

Returns
True if there are any undefined labels.

Definition at line 353 of file sch_sheet.cpp.

354 {
355  for( SCH_SHEET_PIN* pin : m_pins )
356  {
357  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
358  const SCH_HIERLABEL* HLabel = nullptr;
359  for( auto aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
360  {
361  if( !pin->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) )
362  {
363  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
364  break;
365  }
366  }
367 
368  if( HLabel == nullptr ) // Corresponding hierarchical label not found.
369  return true;
370  }
371 
372  return false;
373 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
EE_RTREE & Items()
Definition: sch_screen.h:159
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224

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

Referenced by SCH_EDIT_TOOL::CleanupSheetPins().

◆ HitTest() [1/2]

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 927 of file sch_sheet.cpp.

928 {
929  EDA_RECT rect = GetBodyBoundingBox();
930 
931  rect.Inflate( aAccuracy );
932 
933  return rect.Contains( aPosition );
934 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
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:570
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

◆ HitTest() [2/2]

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 937 of file sch_sheet.cpp.

938 {
939  EDA_RECT rect = aRect;
940 
941  rect.Inflate( aAccuracy );
942 
943  if( aContained )
944  return rect.Contains( GetBodyBoundingBox() );
945 
946  return rect.Intersects( GetBodyBoundingBox() );
947 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
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:570
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
Definition: eda_rect.cpp:150
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

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

◆ InitializeConnection()

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

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 176 of file sch_item.cpp.

178 {
179  SCH_CONNECTION* connection = Connection( &aSheet );
180 
181  if( connection )
182  {
183  connection->Reset();
184  }
185  else
186  {
187  connection = new SCH_CONNECTION( this );
188  m_connection_map.insert( std::make_pair( aSheet, connection ) );
189  connection->SetGraph( aGraph );
190  }
191 
192  connection->SetSheet( aSheet );
193  return connection;
194 }
void SetSheet(SCH_SHEET_PATH aSheet)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:131
void Reset()
Clears connectivity information.
void SetGraph(CONNECTION_GRAPH *aGraph)
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

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

546 { return true; }

◆ IsConnected()

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

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

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

Definition at line 122 of file sch_item.cpp.

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

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

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )
inlineinherited

Definition at line 444 of file sch_item.h.

444 { return m_connectivity_dirty; }
bool m_connectivity_dirty
Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_TEXT, SCH_LINE, SCH_BUS_ENTRY_BASE, and SCH_PIN.

Definition at line 376 of file sch_item.h.

376 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 189 of file eda_item.h.

189 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 274 of file eda_item.h.

274 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

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

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allows items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 278 of file sch_item.h.

278 { return false; }

◆ IsLocked()

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

Definition at line 268 of file sch_item.h.

268 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 186 of file eda_item.h.

186 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_SHEET::IsMovableFromAnchorPoint ( )
inlineoverridevirtual

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

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

Returns
false for a hierarchical sheet

Reimplemented from SCH_ITEM.

Definition at line 268 of file sch_sheet.h.

268 { 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_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_SHEET_PIN, SCH_JUNCTION, and SCH_PIN.

Definition at line 388 of file sch_item.h.

388 { return false; }

Referenced by EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ IsReplaceable()

bool SCH_SHEET::IsReplaceable ( ) const
inlineoverridevirtual

Function IsReplaceable.

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

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

Reimplemented from EDA_ITEM.

Definition at line 530 of file sch_sheet.h.

530 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 192 of file eda_item.h.

192 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsRootSheet()

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

Definition at line 183 of file sch_sheet.cpp.

184 {
185  wxCHECK_MSG( Schematic(), false, "Can't call IsRootSheet without setting a schematic" );
186 
187  return &Schematic()->Root() == this;
188 }
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
SCH_SHEET & Root() const
Definition: schematic.h:102

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

Referenced by SCH_SEXPR_PLUGIN::Format().

◆ IsSelected()

◆ IsType()

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

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

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

Reimplemented in VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 250 of file eda_item.h.

251  {
252  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
253  return true;
254 
255  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
256  {
257  if( m_structType == *p )
258  return true;
259  }
260 
261  return false;
262  }
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:158

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 332 of file sch_sheet.cpp.

333 {
334  int leftRight = 0;
335  int topBottom = 0;
336 
337  for( SCH_SHEET_PIN* pin : m_pins )
338  {
339  switch( pin->GetEdge() )
340  {
341  case SHEET_LEFT_SIDE: leftRight++; break;
342  case SHEET_RIGHT_SIDE: leftRight++; break;
343  case SHEET_TOP_SIDE: topBottom++; break;
344  case SHEET_BOTTOM_SIDE: topBottom++; break;
345  default: break;
346  }
347  }
348 
349  return topBottom > 0 && leftRight == 0;
350 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

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

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

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

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

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

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

Definition at line 372 of file eda_item.h.

376  {
377  for( auto it : aList )
378  {
379  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
381  return SEARCH_RESULT::QUIT;
382  }
383 
385  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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

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

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

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

Definition at line 393 of file eda_item.h.

395  {
396  for( auto it : aList )
397  {
398  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
400  return SEARCH_RESULT::QUIT;
401  }
402 
404  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Definition: eda_item.cpp:107

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
aScreen= the SCH_SCREEN* screen that we search for
aList= the SCH_SHEET_PATH* that must be used
Returns
true if found

Definition at line 667 of file sch_sheet.cpp.

668 {
669  if( m_screen )
670  {
671  aList->push_back( this );
672 
673  if( m_screen == aScreen )
674  return true;
675 
676  for( auto item : m_screen->Items().OfType( SCH_SHEET_T ) )
677  {
678  SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
679 
680  if( sheet->LocatePathOfScreen( aScreen, aList ) )
681  {
682  return true;
683  }
684  }
685 
686  aList->pop_back();
687  }
688 
689  return false;
690 }
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
void pop_back()
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
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:667
EE_RTREE & Items()
Definition: sch_screen.h:159
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224

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

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LocatePathOfScreen(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseParameter(), and SCH_ALTIUM_PLUGIN::ParsePowerPort().

◆ Matches() [1/2]

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

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 810 of file sch_sheet.cpp.

811 {
812  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
813 
814  // Sheets are searchable via the child field and pin item text.
815  return false;
816 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_sheet.cpp:914
const wxChar *const traceFindItem
Flag to enable find debug tracing.

References GetSelectMenuText(), MILLIMETRES, and traceFindItem.

◆ Matches() [2/2]

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

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

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

Definition at line 132 of file eda_item.cpp.

133 {
134  wxString text = aText;
135  wxString searchText = aSearchData.GetFindString();
136 
137  // Don't match if searching for replaceable item and the item doesn't support text replace.
138  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
139  return false;
140 
141  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
142  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
143 
144  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
145  {
146  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
147  return text.Matches( searchText );
148 
149  return text.MakeUpper().Matches( searchText.MakeUpper() );
150  }
151 
152  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
153  return aText.Find( searchText ) != wxNOT_FOUND;
154 
155  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
156 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: eda_item.h:490

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

◆ MirrorX()

void SCH_SHEET::MirrorX ( int  aXaxis_position)
overridevirtual

Mirror item relative to the X axis about aXaxis_position.

Parameters
aXaxis_positionThe X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 765 of file sch_sheet.cpp.

766 {
767  MIRROR( m_pos.y, aXaxis_position );
768  m_pos.y -= m_size.y;
769 
770  for( SCH_SHEET_PIN* sheetPin : m_pins )
771  sheetPin->MirrorX( aXaxis_position );
772 }
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
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:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

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

◆ MirrorY()

void SCH_SHEET::MirrorY ( int  aYaxis_position)
overridevirtual

Mirror item relative to the Y axis about aYaxis_position.

Parameters
aYaxis_positionThe Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 775 of file sch_sheet.cpp.

776 {
777  MIRROR( m_pos.x, aYaxis_position );
778  m_pos.x -= m_size.x;
779 
780  for( SCH_SHEET_PIN* sheetPin : m_pins )
781  sheetPin->MirrorY( aYaxis_position );
782 }
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
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:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

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

◆ Move()

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

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 513 of file sch_sheet.h.

514  {
515  m_pos += aMoveVector;
516 
517  for( SCH_SHEET_PIN* pin : m_pins )
518  pin->Move( aMoveVector );
519 
520  for( SCH_FIELD& field : m_fields )
521  field.Move( aMoveVector );
522  }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
wxPoint m_pos
Definition: sch_sheet.h:230
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References m_fields, m_pins, and m_pos.

Referenced by SetPosition().

◆ NetClass()

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

Definition at line 145 of file sch_item.cpp.

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

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

186 {
187  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
188  GetClass() ) );
189 
190  return false;
191 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Function GetClass returns the class name.

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

◆ operator<() [2/2]

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

Reimplemented from SCH_ITEM.

Definition at line 1033 of file sch_sheet.cpp.

1034 {
1035  if( Type() != aItem.Type() )
1036  return Type() < aItem.Type();
1037 
1038  auto sheet = static_cast<const SCH_SHEET*>( &aItem );
1039 
1040  if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText() )
1041  return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
1042 
1043  if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText() )
1044  return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
1045 
1046  return false;
1047 }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

◆ operator=()

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

Definition at line 1003 of file sch_sheet.cpp.

1004 {
1005  wxCHECK_MSG( Type() == aItem.Type(), *this,
1006  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1007  GetClass() );
1008 
1009  if( &aItem != this )
1010  {
1011  SCH_ITEM::operator=( aItem );
1012 
1013  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
1014 
1015  m_pos = sheet->m_pos;
1016  m_size = sheet->m_size;
1017  m_fields = sheet->m_fields;
1018 
1019  for( SCH_SHEET_PIN* pin : sheet->m_pins )
1020  {
1021  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
1022  m_pins.back()->SetParent( this );
1023  }
1024 
1025  for( const SCH_SHEET_INSTANCE& instance : sheet->m_instances )
1026  m_instances.emplace_back( instance );
1027  }
1028 
1029  return *this;
1030 }
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:221
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_sheet.h:254
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
Definition: eda_item.cpp:193
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
A simple container for sheet instance infromation.
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

◆ Plot()

void SCH_SHEET::Plot ( PLOTTER aPlotter)
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 950 of file sch_sheet.cpp.

951 {
952  wxString Text;
953  wxPoint pos;
954 
955  bool override = false;
956 
957  if( KIGFX::SCH_RENDER_SETTINGS* settings =
958  dynamic_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() ) )
959  override = settings->m_OverrideItemColors;
960 
961  COLOR4D borderColor = GetBorderColor();
962  COLOR4D backgroundColor = GetBackgroundColor();
963 
964  if( override || borderColor == COLOR4D::UNSPECIFIED )
965  borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
966 
967  if( override || backgroundColor == COLOR4D::UNSPECIFIED )
968  backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
969 
970  aPlotter->SetColor( backgroundColor );
971  // Do not fill shape in B&W mode, otherwise texts are unreadable
972  bool fill = aPlotter->GetColorMode();
973  aPlotter->Rect( m_pos, m_pos + m_size, fill ? FILL_TYPE::FILLED_SHAPE : FILL_TYPE::NO_FILL, 1.0 );
974 
975  aPlotter->SetColor( borderColor );
976 
977  int penWidth = std::max( GetPenWidth(), aPlotter->RenderSettings()->GetMinPenWidth() );
978  aPlotter->SetCurrentLineWidth( penWidth );
979 
980  aPlotter->MoveTo( m_pos );
981  pos = m_pos;
982  pos.x += m_size.x;
983 
984  aPlotter->LineTo( pos );
985  pos.y += m_size.y;
986 
987  aPlotter->LineTo( pos );
988  pos = m_pos;
989  pos.y += m_size.y;
990 
991  aPlotter->LineTo( pos );
992  aPlotter->FinishTo( m_pos );
993 
994  for( SCH_FIELD field : m_fields )
995  field.Plot( aPlotter );
996 
997  /* Draw texts : SheetLabel */
998  for( SCH_SHEET_PIN* sheetPin : m_pins )
999  sheetPin->Plot( aPlotter );
1000 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:277
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
virtual void SetColor(COLOR4D color)=0
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0
wxSize m_size
Definition: sch_sheet.h:231
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:292
wxPoint m_pos
Definition: sch_sheet.h:230
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:295
void LineTo(const wxPoint &pos)
Definition: plotter.h:272
int GetPenWidth() const override
Definition: sch_sheet.cpp:493
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
void MoveTo(const wxPoint &pos)
Definition: plotter.h:267
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:165
SCH_RENDER_SETTINGS Stores schematic-specific render settings.
Definition: sch_painter.h:70
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100
bool GetColorMode() const
Definition: plotter.h:162

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

◆ Print()

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

Print a schematic item.

Each schematic item should have its own method

Parameters
aOffsetdrawing offset (usually {0,0} but can be different when moving an object)

Implements SCH_ITEM.

Definition at line 552 of file sch_sheet.cpp.

553 {
554  wxDC* DC = aSettings->GetPrintDC();
555  wxPoint pos = m_pos + aOffset;
556  int lineWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() );
558 
559  GRRect( nullptr, DC, pos.x, pos.y, pos.x + m_size.x, pos.y + m_size.y, lineWidth, color );
560 
561  for( SCH_FIELD& field : m_fields )
562  field.Print( aSettings, aOffset );
563 
564  /* Draw text : SheetLabel */
565  for( SCH_SHEET_PIN* sheetPin : m_pins )
566  sheetPin->Print( aSettings, aOffset );
567 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
int color
Definition: DXF_plotter.cpp:60
wxSize m_size
Definition: sch_sheet.h:231
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:292
wxPoint m_pos
Definition: sch_sheet.h:230
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:842
int GetPenWidth() const override
Definition: sch_sheet.cpp:493
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
int GetDefaultPenWidth() const
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References color, GetBorderColor(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRRect(), m_fields, m_pins, m_pos, and m_size.

◆ RemovePin()

void SCH_SHEET::RemovePin ( SCH_SHEET_PIN aSheetPin)

Remove aSheetPin from the sheet.

Parameters
aSheetPinThe sheet pin item to remove from the sheet.

Definition at line 291 of file sch_sheet.cpp.

292 {
293  wxASSERT( aSheetPin != NULL );
294  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
295 
296  for( auto i = m_pins.begin(); i < m_pins.end(); ++i )
297  {
298  if( *i == aSheetPin )
299  {
300  m_pins.erase( i );
301  renumberPins();
302  return;
303  }
304  }
305 }
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:819
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

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

◆ renumberPins()

void SCH_SHEET::renumberPins ( )
protected

Renumber the sheet pins in the sheet.

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

Definition at line 819 of file sch_sheet.cpp.

820 {
821  int id = 2;
822 
823  for( SCH_SHEET_PIN* pin : m_pins )
824  {
825  pin->SetNumber( id );
826  id++;
827  }
828 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

References m_pins.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

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

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

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

Definition at line 159 of file eda_item.cpp.

160 {
161  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
162 
163  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
164  aSearchData.GetFindString() :
165  aSearchData.GetFindString().Upper() );
166 
167  if( result == wxNOT_FOUND )
168  return false;
169 
170  wxString prefix = aText.Left( result );
171  wxString suffix;
172 
173  if( aSearchData.GetFindString().length() + result < aText.length() )
174  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
175 
176  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
177  aText, prefix, aSearchData.GetReplaceString(), suffix );
178 
179  aText = prefix + aSearchData.GetReplaceString() + suffix;
180 
181  return true;
182 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

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

Reimplemented in SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 478 of file eda_item.h.

478 { return false; }

◆ Resize()

void SCH_SHEET::Resize ( const wxSize &  aSize)

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

Parameters
aSize- The new size for this sheet.

Definition at line 793 of file sch_sheet.cpp.

794 {
795  if( aSize == m_size )
796  return;
797 
798  m_size = aSize;
799 
800  // Move the fields if we're in autoplace mode
802  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
803 
804  // Move the sheet labels according to the new sheet size.
805  for( SCH_SHEET_PIN* sheetPin : m_pins )
806  sheetPin->ConstrainOnEdge( sheetPin->GetPosition() );
807 }
wxSize m_size
Definition: sch_sheet.h:231
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:499

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

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ ResolveTextVar()

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

Resolve any references to system tokens supported by the sheet.

Parameters
aDeptha counter to limit recursion and circular references.

Definition at line 204 of file sch_sheet.cpp.

205 {
206  for( int i = 0; i < SHEET_MANDATORY_FIELDS; ++i )
207  {
208  if( token->IsSameAs( m_fields[i].GetCanonicalName().Upper() ) )
209  {
210  *token = m_fields[i].GetShownText( aDepth + 1 );
211  return true;
212  }
213  }
214 
215  for( size_t i = SHEET_MANDATORY_FIELDS; i < m_fields.size(); ++i )
216  {
217  if( token->IsSameAs( m_fields[i].GetName() ) )
218  {
219  *token = m_fields[i].GetShownText( aDepth + 1 );
220  return true;
221  }
222  }
223 
224  if( token->IsSameAs( wxT( "#" ) ) )
225  {
226  for( const SCH_SHEET_PATH& sheet : Schematic()->GetSheets() )
227  {
228  if( sheet.Last() == this ) // Current sheet path found
229  {
230  *token = wxString::Format( "%s", sheet.GetPageNumber() );
231  return true;
232  }
233  }
234  }
235  else if( token->IsSameAs( wxT( "##" ) ) )
236  {
237  SCH_SHEET_LIST sheetList = Schematic()->GetSheets();
238  *token = wxString::Format( wxT( "%d" ), (int) sheetList.size() );
239  return true;
240  }
241 
242  return false;
243 }
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
SCH_SHEET_LIST GetSheets() const
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:97
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:71
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:97
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References Format(), SCHEMATIC::GetSheets(), m_fields, SCH_ITEM::Schematic(), and SHEET_MANDATORY_FIELDS.

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

◆ Rotate()

void SCH_SHEET::Rotate ( wxPoint  aPosition)
overridevirtual

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

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

Implements SCH_ITEM.

Definition at line 723 of file sch_sheet.cpp.

724 {
725  wxPoint prev = m_pos;
726 
727  RotatePoint( &m_pos, aPosition, 900 );
728  RotatePoint( &m_size.x, &m_size.y, 900 );
729 
730  if( m_size.x < 0 )
731  {
732  m_pos.x += m_size.x;
733  m_size.x = -m_size.x;
734  }
735 
736  if( m_size.y < 0 )
737  {
738  m_pos.y += m_size.y;
739  m_size.y = -m_size.y;
740  }
741 
742  // Pins must be rotated first as that's how we determine vertical vs horizontal
743  // orientation for auto-placement
744  for( SCH_SHEET_PIN* sheetPin : m_pins )
745  sheetPin->Rotate( aPosition );
746 
748  {
749  AutoplaceFields( /* aScreen */ NULL, /* aManual */ false );
750  }
751  else
752  {
753  // Move the fields to the new position because the component itself has moved.
754  for( SCH_FIELD& field : m_fields )
755  {
756  wxPoint pos = field.GetTextPos();
757  pos.x -= prev.x - m_pos.x;
758  pos.y -= prev.y - m_pos.y;
759  field.SetTextPos( pos );
760  }
761  }
762 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
wxSize m_size
Definition: sch_sheet.h:231
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
wxPoint m_pos
Definition: sch_sheet.h:230
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
Definition: sch_sheet.cpp:499

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

Referenced by SCH_EDIT_TOOL::Rotate().

◆ RunOnChildren()

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

Reimplemented from SCH_ITEM.

Definition at line 904 of file sch_sheet.cpp.

905 {
906  for( SCH_FIELD& field : m_fields )
907  aFunction( &field );
908 
909  for( SCH_SHEET_PIN* pin : m_pins )
910  aFunction( pin );
911 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References m_fields, and m_pins.

◆ 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 that this hierarchy is not the same as the sheet hierarchy!

Returns
the parent schematic this item lives on, or nullptr

Definition at line 97 of file sch_item.cpp.

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

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

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

◆ SearchHierarchy()

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

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

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

Definition at line 631 of file sch_sheet.cpp.

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

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

Referenced by SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), and SearchHierarchy().

◆ Set() [1/3]

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

Definition at line 40 of file inspectable.h.

41  {
43  TYPE_ID thisType = TYPE_HASH( *this );
44  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
45 
46  if( object )
47  aProperty->setter( object, aValue );
48 
49  return object != nullptr;
50  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provides class metadata.
Definition: property_mgr.h:61
virtual size_t OwnerHash() const =0
Returns 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 53 of file inspectable.h.

54  {
56  TYPE_ID thisType = TYPE_HASH( *this );
57  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
58 
59  if( object )
60  aProperty->set<T>( object, aValue );
61 
62  return object != nullptr;
63  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns 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 66 of file inspectable.h.

67  {
69  TYPE_ID thisType = TYPE_HASH( *this );
70  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71  void* object = nullptr;
72 
73  if( prop )
74  {
75  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76 
77  if( object )
78  prop->set<T>( object, aValue );
79  }
80 
81  return object != nullptr;
82  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:64
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:55
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:41
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Casts a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Returns a property for a specific type.
Provides class metadata.
Definition: property_mgr.h:61
void set(void *aObject, T aValue)
Definition: property.h:268
virtual size_t OwnerHash() const =0
Returns type-id of the Owner class.

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

◆ SetBackgroundColor()

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

◆ SetBorderColor()

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

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int  aWidth)
inline

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetConnectivityDirty()

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

Definition at line 446 of file sch_item.h.

446 { m_connectivity_dirty = aDirty; }
bool m_connectivity_dirty
Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetFields()

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

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 277 of file sch_sheet.h.

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

References m_fields.

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

◆ SetFileName()

void SCH_SHEET::SetFileName ( wxString  aFilename)
inline

Definition at line 504 of file sch_sheet.h.

505  {
506  // Filenames are stored using unix notation
507  aFilename.Replace( wxT("\\"), wxT("/") );
508  m_fields[ SHEETFILENAME ].SetText( aFilename );
509  }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228

References m_fields, and SHEETFILENAME.

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 220 of file eda_item.h.

220 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:164

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_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(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

Definition at line 272 of file eda_item.h.

272 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLayer()

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 273 of file sch_item.h.

273 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 79 of file eda_item.cpp.

80 {
82 
83  // If this a child object, then the parent modification state also needs to be set.
84  if( m_parent )
86 }
void SetModified()
Definition: eda_item.cpp:79
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:162
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: eda_item.h:102
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:220

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

◆ SetPageNumber()

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

Set the page number for the sheet instance aInstance.

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

Definition at line 1092 of file sch_sheet.cpp.

1093 {
1094  KIID_PATH path = aInstance.Path();
1095 
1096  for( SCH_SHEET_INSTANCE& instance : m_instances )
1097  {
1098  if( instance.m_Path == path )
1099  {
1100  instance.m_PageNumber = aPageNumber;
1101  break;
1102  }
1103  }
1104 }
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
A simple container for sheet instance infromation.

References m_instances, and SCH_SHEET_PATH::Path().

Referenced by SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_SHEET_LIST::SetInitialPageNumbers(), SCH_SHEET_PATH::SetPageNumber(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and SCH_SHEET_LIST::UpdateSheetInstances().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 184 of file eda_item.h.

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

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

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

Reimplemented from EDA_ITEM.

Definition at line 785 of file sch_sheet.cpp.

786 {
787  // Remember the sheet and all pin sheet positions must be
788  // modified. So use Move function to do that.
789  Move( aPosition - m_pos );
790 }
wxPoint m_pos
Definition: sch_sheet.h:230
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_sheet.h:513

References m_pos, and Move().

Referenced by EE_POINT_EDITOR::updateParentItem().

◆ SetScreen()

void SCH_SHEET::SetScreen ( SCH_SCREEN aScreen)

Set the SCH_SCREEN associated with this sheet to aScreen.

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

Parameters
aScreenThe new screen to associate with the sheet.

Definition at line 151 of file sch_sheet.cpp.

152 {
153  if( aScreen == m_screen )
154  return;
155 
156  if( m_screen != NULL )
157  {
159 
160  if( m_screen->GetRefCount() == 0 )
161  {
162  delete m_screen;
163  m_screen = NULL;
164  }
165  }
166 
167  m_screen = aScreen;
168 
169  if( m_screen )
171 }
#define NULL
void DecRefCount()
Definition: sch_screen.cpp:113
SCH_SCREEN * m_screen
Definition: sch_sheet.h:224
void IncRefCount()
Definition: sch_screen.cpp:107
int GetRefCount() const
Definition: sch_screen.h:197

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

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

◆ SetSelected()

◆ SetSize()

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

Definition at line 287 of file sch_sheet.h.

287 { m_size = aSize; }
wxSize m_size
Definition: sch_sheet.h:231

References m_size.

Referenced by SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), and EE_POINT_EDITOR::updateParentItem().

◆ SetState()

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

Definition at line 209 of file eda_item.h.

210  {
211  if( state )
212  m_status |= type; // state = ON or OFF
213  else
214  m_status &= ~type;
215  }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 218 of file eda_item.h.

218 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 250 of file sch_item.h.

250 { m_storedPos = aPos; }
wxPoint m_storedPos
Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

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

◆ SetStroke()

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

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 488 of file sch_item.h.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 195 of file eda_item.h.

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

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

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

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

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

Definition at line 509 of file eda_item.h.

509 { 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 252 of file sch_sheet.cpp.

253 {
254  wxCHECK_RET( aItem->Type() == SCH_SHEET_T,
255  wxString::Format( wxT( "SCH_SHEET object cannot swap data with %s object." ),
256  aItem->GetClass() ) );
257 
258  SCH_SHEET* sheet = ( SCH_SHEET* ) aItem;
259 
260  std::swap( m_pos, sheet->m_pos );
261  std::swap( m_size, sheet->m_size );
262  m_fields.swap( sheet->m_fields );
263  std::swap( m_fieldsAutoplaced, sheet->m_fieldsAutoplaced );
264  m_pins.swap( sheet->m_pins );
265 
266  // Update parent pointers after swapping.
267  for( SCH_SHEET_PIN* sheetPin : m_pins )
268  sheetPin->SetParent( this );
269 
270  for( SCH_SHEET_PIN* sheetPin : sheet->m_pins )
271  sheetPin->SetParent( sheet );
272 
273  std::swap( m_borderWidth, sheet->m_borderWidth );
274  std::swap( m_borderColor, sheet->m_borderColor );
275  std::swap( m_backgroundColor, sheet->m_backgroundColor );
276  std::swap( m_instances, sheet->m_instances );
277 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
wxSize m_size
Definition: sch_sheet.h:231
wxPoint m_pos
Definition: sch_sheet.h:230
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_item.h:201
std::vector< SCH_SHEET_INSTANCE > m_instances
Definition: sch_sheet.h:236
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:184
int m_borderWidth
Definition: sch_sheet.h:232
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:219
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
virtual wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_item.h:220
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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 components, without the power components.

Returns
the component count.

Definition at line 609 of file sch_sheet.cpp.

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

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 181 of file eda_item.h.

181 { 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:158

References EDA_ITEM::m_structType.

Referenced by FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeTextType(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), PCB_TEXT::ClassOf(), PCB_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), FP_SHAPE::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), PCB_GROUP::ClassOf(), PCB_TARGET::ClassOf(), SCH_PIN::ClassOf(), SCH_LINE::ClassOf(), FP_TEXT::ClassOf(), SCH_FIELD::ClassOf(), PCB_SHAPE::ClassOf(), ZONE::ClassOf(), PAD::ClassOf(), SCH_BITMAP::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), FOOTPRINT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_TEXT::ClassOf(), BOARD::ClassOf(), ClassOf(), ARC::ClassOf(), SCH_LABEL::ClassOf(), ALIGNED_DIMENSION::ClassOf(), VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), SCH_HIERLABEL::ClassOf(), LEADER::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanup(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), LIB_ITEM::compare(), EE_GRID_HELPER::computeAnchors(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), ZONE_CREATE_HELPER::createNewZone(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::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(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRulesForItems(), EDIT_TOOL::FilletTracks(), NETLIST_EXPORTER_BASE::findNextSymbol(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), CONNECTION_GRAPH::getDefaultConnection(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), getShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), BOARD::GroupLegalOps(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), PCB_INSPECTION_TOOL::HighlightItem(), PCB_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), isNetTie(), TRACK::IsNull(), PNS_KICAD_IFACE::IsOnLayer(), SCH_LINE::IsParallel(), SCH_FIELD::IsReplaceable(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SELECTION_TOOL::itemPassesFilter(), CONVERT_TOOL::LinesToPoly(), CLIPBOARD_IO::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), 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(), APPEARANCE_CONTROLS::OnBoardItemAdded(), APPEARANCE_CONTROLS::OnBoardItemChanged(), APPEARANCE_CONTROLS::OnBoardItemRemoved(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_TEXT::operator<(), SCH_ITEM::operator<(), operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), operator=(), SCH_COMPONENT::operator=(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), CONVERT_TOOL::PolyToLines(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCHEMATIC::ResolveCrossReference(), CONNECTION_SUBGRAPH::ResolveDrivers(), PCB_PARSER::resolveGroups(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_SEXPR_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), PCB_GROUP::SwapData(), SCH_SHEET_PIN::SwapData(), PCB_TEXT::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SwapData(), LEADER::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), CENTER_DIMENSION::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(), PCB_GROUP::TopLevelGroup(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), PL_POINT_EDITOR::updateItem(), 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::updatePastedInstances(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), PCB_GROUP::WithinScope(), 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 overrided method can optionally use it to update sheet-local connectivity information

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

Reimplemented from SCH_ITEM.

Definition at line 843 of file sch_sheet.cpp.

845 {
846  bool changed = false;
847 
848  for( SCH_SHEET_PIN* sheetPin : m_pins )
849  changed |= sheetPin->UpdateDanglingState( aItemList );
850 
851  return changed;
852 }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85

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

247 {
248  return m_borderWidth == 0 && m_borderColor == COLOR4D::UNSPECIFIED;
249 }
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
int m_borderWidth
Definition: sch_sheet.h:232

References m_borderColor, and m_borderWidth.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 206 of file eda_item.cpp.

207 {
208  // Basic fallback
209  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
210  VECTOR2I( GetBoundingBox().GetSize() ) );
211 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:522
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: eda_item.cpp:89

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

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

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

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

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

Definition at line 117 of file view_item.h.

118  {}

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

References LAYER_HIERLABEL, LAYER_SELECTION_SHADOWS, LAYER_SHEET, and LAYER_SHEET_BACKGROUND.

◆ ViewGetLOD()

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

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

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

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

Reimplemented in FP_ZONE, PAD, FOOTPRINT, VIA, GERBER_DRAW_ITEM, TRACK, FP_TEXT, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 141 of file view_item.h.

142  {
143  // By default always show the item
144  return 0.0;
145  }

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

◆ viewPrivData()

◆ Visit()

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

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 866 of file sch_sheet.cpp.

867 {
868  KICAD_T stype;
869 
870  for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p )
871  {
872  // If caller wants to inspect my type
873  if( stype == SCH_LOCATE_ANY_T || stype == Type() )
874  {
875  if( SEARCH_RESULT::QUIT == aInspector( this, NULL ) )
876  return SEARCH_RESULT::QUIT;
877  }
878 
879  if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T )
880  {
881  // Test the sheet fields.
882  for( SCH_FIELD& field : m_fields )
883  {
884  if( SEARCH_RESULT::QUIT == aInspector( &field, this ) )
885  return SEARCH_RESULT::QUIT;
886  }
887  }
888 
889  if( stype == SCH_LOCATE_ANY_T || stype == SCH_SHEET_PIN_T )
890  {
891  // Test the sheet labels.
892  for( SCH_SHEET_PIN* sheetPin : m_pins )
893  {
894  if( SEARCH_RESULT::QUIT == aInspector( sheetPin, this ) )
895  return SEARCH_RESULT::QUIT;
896  }
897  }
898  }
899 
901 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:51
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:227
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:85
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:228
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181

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

Friends And Related Function Documentation

◆ SCH_SHEET_PIN

friend class SCH_SHEET_PIN
friend

Definition at line 221 of file sch_sheet.h.

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

Member Data Documentation

◆ m_backgroundColor

KIGFX::COLOR4D SCH_SHEET::m_backgroundColor
private

Definition at line 234 of file sch_sheet.h.

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

◆ m_borderColor

KIGFX::COLOR4D SCH_SHEET::m_borderColor
private

Definition at line 233 of file sch_sheet.h.

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

◆ m_borderWidth

int SCH_SHEET::m_borderWidth
private

Definition at line 232 of file sch_sheet.h.

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

◆ m_connected_items

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

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

Definition at line 206 of file sch_item.h.

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

◆ m_connection_map

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

Stores connectivity information, per sheet.

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

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

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty
protectedinherited

◆ m_fields

◆ m_fieldsAutoplaced

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_instances

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

Definition at line 236 of file sch_sheet.h.

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

◆ m_layer

◆ m_parent

◆ m_pins

◆ m_pos

◆ m_screen

◆ m_size

◆ m_status

STATUS_FLAGS EDA_ITEM::m_status
protectedinherited

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

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

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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