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 ComponentCount () const
 Count our own components, without the power components. More...
 
bool SearchHierarchy (const wxString &aFilename, SCH_SCREEN **aScreen)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
bool LocatePathOfScreen (SCH_SCREEN *aScreen, SCH_SHEET_PATH *aList)
 Search the existing hierarchy for an instance of screen loaded from aFileName. More...
 
int CountSheets () 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< wxPointGetConnectionPoints () 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...
 
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...
 
SCH_ITEMDuplicate (bool doClone=false) const
 Routine to create a new copy of given item. More...
 
wxPointGetStoredPos ()
 
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...
 
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
 
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 &aPath) 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
 
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
 
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
 True if connectivity info might be out of date. More...
 
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
 
FIELDS_AUTOPLACED m_fieldsAutoplaced
 
wxPoint m_pos
 
wxSize m_size
 
int m_borderWidth
 
KIGFX::COLOR4D m_borderColor
 
KIGFX::COLOR4D m_backgroundColor
 

Friends

class SCH_SHEET_PIN
 

Detailed Description

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

Definition at line 216 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 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
Definition: sch_sheet.h:70
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
#define MIN_SHEET_WIDTH
Definition: sch_sheet.h:42
#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:226
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221
#define MIN_SHEET_HEIGHT
Definition: sch_sheet.h:43
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

References FIELDS_AUTOPLACED_AUTO, GetDefaultFieldName(), LAYER_SHEET, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETNAME, m_backgroundColor, m_borderColor, m_borderWidth, m_fields, m_fieldsAutoplaced, SCH_ITEM::m_Layer, m_pos, m_screen, m_size, MIN_SHEET_HEIGHT, MIN_SHEET_WIDTH, NULL, SHEET_MANDATORY_FIELDS, SHEETFILENAME, 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 
121  if( m_screen )
123 }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199
KIGFX::COLOR4D m_borderColor
Definition: sch_sheet.h:233
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:218
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
int m_borderWidth
Definition: sch_sheet.h:232
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
const KIID m_Uuid
Definition: base_struct.h:162
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KIGFX::COLOR4D m_backgroundColor
Definition: sch_sheet.h:234
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221
void IncRefCount()
Definition: sch_screen.cpp:109
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType)
Definition: sch_item.cpp:50

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

◆ ~SCH_SHEET()

SCH_SHEET::~SCH_SHEET ( )

Definition at line 126 of file sch_sheet.cpp.

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

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

185 {
186  m_connected_items[ aSheet ].insert( aItem );
187 }
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().

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

279 {
280  wxASSERT( aSheetPin != NULL );
281  wxASSERT( aSheetPin->Type() == SCH_SHEET_PIN_T );
282 
283  aSheetPin->SetParent( this );
284  m_pins.push_back( aSheetPin );
285  renumberPins();
286 }
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
void renumberPins()
Renumber the sheet pins in the sheet.
Definition: sch_sheet.cpp:822
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN aScreen)
inlineinherited

Autoplace fields only if correct to do so automatically.

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

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

Definition at line 457 of file sch_item.h.

458  {
459  if( GetFieldsAutoplaced() )
461  }
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition: sch_item.h:442
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
Definition: sch_item.h:463

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

498 {
499  wxASSERT_MSG( !aManual, "manual autoplacement not currently supported for sheets" );
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: common.h:185
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
#define TEXT_ANGLE_VERT
Definition: common.h:186
int GetPenWidth() const override
Definition: sch_sheet.cpp:491
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
bool IsVerticalOrientation() const
Definition: sch_sheet.cpp:330
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
FIELDS_AUTOPLACED m_fieldsAutoplaced
Definition: sch_sheet.h:227

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

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

◆ CanConnect()

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

Reimplemented from SCH_ITEM.

Definition at line 546 of file sch_sheet.h.

547  {
548  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
549  ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS ) ||
550  ( aItem->Type() == SCH_NO_CONNECT_T );
551  }
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:279
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

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

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

454 {
455  auto i = m_pins.begin();
456 
457  while( i != m_pins.end() )
458  {
459  /* Search the schematic for a hierarchical label corresponding to this sheet label. */
460  const SCH_HIERLABEL* HLabel = NULL;
461 
462  for( SCH_ITEM* aItem : m_screen->Items().OfType( SCH_HIER_LABEL_T ) )
463  {
464  if( (*i)->GetText().CmpNoCase( static_cast<SCH_HIERLABEL*>( aItem )->GetText() ) == 0 )
465  {
466  HLabel = static_cast<SCH_HIERLABEL*>( aItem );
467  break;
468  }
469  }
470 
471  if( HLabel == NULL ) // Hlabel not found: delete sheet label.
472  i = m_pins.erase( i );
473  else
474  ++i;
475  }
476 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
#define NULL
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
EE_RTREE & Items()
Definition: sch_screen.h:158
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221
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 394 of file sch_item.h.

394 { 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 447 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_SCH_SHEET_PROPS::TransferDataFromWindow(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

◆ ClearFlags()

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

Definition at line 233 of file base_struct.h.

233 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), 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::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 245 of file base_struct.h.

246  {
248  DO_NOT_DRAW );
249  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:114
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:125
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:127
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:123
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:129
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:122

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

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

References SCH_SHEET().

◆ ComponentCount()

int SCH_SHEET::ComponentCount ( ) 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* comp = (SCH_COMPONENT*) aItem;
618 
619  if( comp->GetField( VALUE )->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 )->ComponentCount();
625  }
626 
627  return n;
628 }
EE_TYPE OfType(KICAD_T aType)
Definition: sch_rtree.h:219
SCH_FIELD * GetField(int aFieldNdx)
Returns a field in this symbol.
Field Value of part, i.e. "3.3K".
EE_RTREE & Items()
Definition: sch_screen.h:158
Schematic symbol object.
Definition: sch_component.h:80
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221
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:127

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

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

179 {
180  return m_connected_items[ aSheet ];
181 }
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_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::buildConnectionGraph(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ Connection()

◆ ConnectionPropagatesTo()

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

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

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 431 of file sch_item.h.

431 { 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:158
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221

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

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

◆ doIsConnected()

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

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

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

References m_pins.

◆ Duplicate()

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

Routine to create a new copy of given item.

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

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

Definition at line 81 of file sch_item.cpp.

82 {
83  SCH_ITEM* newItem = (SCH_ITEM*) Clone();
84 
85  if( !doClone )
86  const_cast<KIID&>( newItem->m_Uuid ) = KIID();
87 
88  newItem->ClearFlags( SELECTED | BRIGHTENED );
89 
90  if( newItem->Type() == SCH_COMPONENT_T )
91  {
92  SCH_COMPONENT* component = (SCH_COMPONENT*) newItem;
93 
94  for( SCH_PIN* pin : component->GetPins() )
95  pin->ClearFlags( SELECTED | BRIGHTENED );
96 
97  for( SCH_FIELD& field : component->GetFields() )
98  field.ClearFlags( SELECTED | BRIGHTENED );
99  }
100 
101  if( newItem->Type() == SCH_SHEET_T )
102  {
103  SCH_SHEET* sheet = (SCH_SHEET*) newItem;
104 
105  for( SCH_FIELD& field : sheet->GetFields() )
106  field.ClearFlags( SELECTED | BRIGHTENED );
107 
108  for( SCH_SHEET_PIN* pin : sheet->GetPins() )
109  pin->ClearFlags( SELECTED | BRIGHTENED );
110  }
111 
112  return newItem;
113 }
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populates a std::vector with SCH_FIELDs.
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:268
#define SELECTED
Definition: base_struct.h:124
Definition: common.h:68
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:139
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieves a list of the SCH_PINs for the given sheet path.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
const KIID m_Uuid
Definition: base_struct.h:162
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:362
Schematic symbol object.
Definition: sch_component.h:80
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

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

◆ 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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
T get(void *aObject)
Definition: property.h:273
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
T get(void *aObject)
Definition: property.h:273
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:230
wxPoint m_pos
Definition: sch_sheet.h:229
int GetPenWidth() const override
Definition: sch_sheet.cpp:491
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by GetBoundingBox(), and HitTest().

◆ GetBorderColor()

◆ GetBorderWidth()

int SCH_SHEET::GetBorderWidth ( ) const
inline

Definition at line 287 of file sch_sheet.h.

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

References m_borderWidth.

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

◆ GetBoundingBox()

const EDA_RECT SCH_SHEET::GetBoundingBox ( ) const
overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 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:52
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp:570
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

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

◆ GetClass()

wxString SCH_SHEET::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Reimplemented from SCH_ITEM.

Definition at line 252 of file sch_sheet.h.

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

Referenced by operator=().

◆ GetConnectionPoints()

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

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

References m_pins.

◆ GetContextualTextVars()

void SCH_SHEET::GetContextualTextVars ( wxArrayString *  aVars) const

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

Definition at line 190 of file sch_sheet.cpp.

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

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:104
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 237 of file base_struct.h.

238  {
239  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
241 
242  return m_Flags & mask;
243  }
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: base_struct.h:130
#define IS_MOVED
Item being moved.
Definition: base_struct.h:116

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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEndPoints()

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

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

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

References m_pins, and SCH_SHEET_PIN_T.

◆ GetFields()

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

Return whether the fields have been automatically placed.

Definition at line 442 of file sch_item.h.

442 { 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::updateItem().

◆ 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 DRAWSEGMENT, and TRACK.

Definition at line 345 of file base_struct.h.

345 { return GetPosition(); }
virtual wxPoint GetPosition() const
Definition: base_struct.h:337

References EDA_ITEM::GetPosition().

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

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

915 {
917 }
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 414 of file sch_sheet.cpp.

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

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

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetMinWidth()

int SCH_SHEET::GetMinWidth ( ) const

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

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

Returns
The minimum width the sheet can be resized.

Definition at line 374 of file sch_sheet.cpp.

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

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

Referenced by EE_POINT_EDITOR::updateItem().

◆ GetMsgPanelInfo()

void SCH_SHEET::GetMsgPanelInfo ( EDA_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  aList.emplace_back( _( "File Name" ), m_fields[ SHEETFILENAME ].GetText(), BROWN );
711 
712 #if 1 // Set to 1 to display the sheet UUID and hierarchical path
713 
714  if( auto schframe = dynamic_cast<SCH_EDIT_FRAME*>( aFrame ) )
715  {
716  wxString msgU, msgL;
717  msgU << _( "UUID" ) << ": " << m_Uuid.AsString();
718  msgL << _( "Path" ) << ": " << schframe->GetCurrentSheet().PathHumanReadable();
719 
720  aList.push_back( MSG_PANEL_ITEM( msgU, msgL, BLUE ) );
721  }
722 #endif
723 }
Definition: color4d.h:61
wxString AsString() const
Definition: common.cpp:165
Definition: color4d.h:58
const KIID m_Uuid
Definition: base_struct.h:162
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
Definition: color4d.h:56
#define _(s)
Definition: 3d_actions.cpp:33
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53

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

◆ GetName()

wxString SCH_SHEET::GetName ( void  ) const
inline

Definition at line 280 of file sch_sheet.h.

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

References m_fields, and SHEETNAME.

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

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

492 {
493  return std::max( GetBorderWidth(), 1 );
494 }
int GetBorderWidth() const
Definition: sch_sheet.h:287

References GetBorderWidth().

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

◆ GetPin()

SCH_SHEET_PIN * SCH_SHEET::GetPin ( const wxPoint aPosition)

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

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

Definition at line 479 of file sch_sheet.cpp.

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

References m_pins, and NULL.

◆ GetPins() [1/2]

◆ GetPins() [2/2]

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

Definition at line 364 of file sch_sheet.h.

365  {
366  return const_cast< std::vector<SCH_SHEET_PIN*>& >( m_pins );
367  }
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224

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:230
wxPoint m_pos
Definition: sch_sheet.h:229
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by SCH_EDIT_TOOL::Rotate().

◆ GetScreen()

◆ GetScreenCount()

int SCH_SHEET::GetScreenCount ( ) const

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

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

Definition at line 173 of file sch_sheet.cpp.

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

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

Referenced by DIALOG_SCH_SHEET_PROPS::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 907 of file sch_sheet.cpp.

908 {
909  return wxString::Format( _( "Hierarchical Sheet %s" ),
910  m_fields[ SHEETNAME ].GetText() );
911 }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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 216 of file base_struct.h.

217  {
218  return m_Status & type;
219  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 229 of file base_struct.h.

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

References EDA_ITEM::m_Status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 250 of file sch_item.h.

250 { 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 474 of file sch_item.h.

474 { 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 472 of file sch_item.h.

472 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), SCH_EDIT_TOOL::Init(), 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 306 of file sch_sheet.cpp.

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

References m_pins.

Referenced by SCH_EDIT_FRAME::ImportHierLabel().

◆ HasPins()

bool SCH_SHEET::HasPins ( )
inline

Definition at line 402 of file sch_sheet.h.

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

References m_pins.

◆ HasUndefinedPins()

bool SCH_SHEET::HasUndefinedPins ( )

Check all sheet labels against schematic for undefined hierarchical labels.

Returns
True if there are any undefined labels.

Definition at line 351 of file sch_sheet.cpp.

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

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

921 {
922  EDA_RECT rect = GetBodyBoundingBox();
923 
924  rect.Inflate( aAccuracy );
925 
926  return rect.Contains( aPosition );
927 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp: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.

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

931 {
932  EDA_RECT rect = aRect;
933 
934  rect.Inflate( aAccuracy );
935 
936  if( aContained )
937  return rect.Contains( GetBodyBoundingBox() );
938 
939  return rect.Intersects( GetBodyBoundingBox() );
940 }
bool Contains(const wxPoint &aPoint) const
Function Contains.
const EDA_RECT GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
Definition: sch_sheet.cpp: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.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

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

◆ InitializeConnection()

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

Creates a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize

Definition at line 190 of file sch_item.cpp.

192 {
193  if( Connection( aSheet ) )
194  {
195  Connection( aSheet )->Reset();
196  Connection( aSheet )->SetSheet( aSheet );
197  return Connection( aSheet );
198  }
199 
200  auto connection = new SCH_CONNECTION( this );
201  connection->SetSheet( aSheet );
202  m_connection_map.insert( std::make_pair( aSheet, connection ) );
203  connection->SetGraph( aGraph );
204 
205  return connection;
206 }
void SetSheet(SCH_SHEET_PATH aSheet)
void Reset()
Clears connectivity information.
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Stores connectivity information, per sheet.
Definition: sch_item.h:209
SCH_CONNECTION * Connection(const SCH_SHEET_PATH &aPath) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:150
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).

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

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBrightened()

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

544 { 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 141 of file sch_item.cpp.

142 {
143  if( ( m_Flags & STRUCT_DELETED ) || ( m_Flags & SKIP_STRUCT ) )
144  return false;
145 
146  return doIsConnected( aPosition );
147 }
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:128
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:126
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
virtual bool doIsConnected(const wxPoint &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_item.h:501

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

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

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

370 { return false; }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 201 of file base_struct.h.

201 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:119
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References IS_DRAGGED, and EDA_ITEM::m_Flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 286 of file base_struct.h.

286 { return m_forceVisible; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

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

Definition at line 269 of file sch_item.h.

269 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 198 of file base_struct.h.

198 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

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

266 { return false; }

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

bool SCH_SHEET::IsReplaceable ( ) const
inlineoverridevirtual

Function IsReplaceable.

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

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

Reimplemented from EDA_ITEM.

Definition at line 528 of file sch_sheet.h.

528 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 204 of file base_struct.h.

204 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:118

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

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

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, D_PAD, DRAWSEGMENT, TEXTE_MODULE, SCH_FIELD, SCH_LINE, EDGE_MODULE, and TEXTE_PCB.

Definition at line 262 of file base_struct.h.

263  {
264  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
265  return true;
266 
267  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
268  {
269  if( m_StructType == *p )
270  return true;
271  }
272 
273  return false;
274  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:170
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), TEXTE_PCB::IsType(), EDGE_MODULE::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), TEXTE_MODULE::IsType(), DRAWSEGMENT::IsType(), D_PAD::IsType(), DIMENSION::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVerticalOrientation()

bool SCH_SHEET::IsVerticalOrientation ( ) const

Definition at line 330 of file sch_sheet.cpp.

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

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

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 202 of file base_struct.h.

202 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:121
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

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

388  {
389  for( auto it : aList )
390  {
391  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
393  return SEARCH_RESULT::QUIT;
394  }
395 
397  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

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

Referenced by GERBER_FILE_IMAGE::Visit().

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

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

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

◆ 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:216
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:158
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221

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

Referenced by LocatePathOfScreen().

◆ Matches() [1/2]

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

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

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

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

Reimplemented from EDA_ITEM.

Definition at line 813 of file sch_sheet.cpp.

814 {
815  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
816 
817  // Sheets are searchable via the child field and pin item text.
818  return false;
819 }
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:907
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 140 of file base_struct.cpp.

141 {
142  wxString text = aText;
143  wxString searchText = aSearchData.GetFindString();
144 
145  // Don't match if searching for replaceable item and the item doesn't support text replace.
146  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
147  return false;
148 
149  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
150  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
151 
152  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
153  {
154  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
155  return text.Matches( searchText );
156 
157  return text.MakeUpper().Matches( searchText.MakeUpper() );
158  }
159 
160  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
161  return aText.Find( searchText ) != wxNOT_FOUND;
162 
163  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
164 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:502

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

769 {
770  MIRROR( m_pos.y, aXaxis_position );
771  m_pos.y -= m_size.y;
772 
773  for( SCH_SHEET_PIN* sheetPin : m_pins )
774  sheetPin->MirrorX( aXaxis_position );
775 }
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

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

◆ MirrorY()

void SCH_SHEET::MirrorY ( int  aYaxis_position)
overridevirtual

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

779 {
780  MIRROR( m_pos.x, aYaxis_position );
781  m_pos.x -= m_size.x;
782 
783  for( SCH_SHEET_PIN* sheetPin : m_pins )
784  sheetPin->MirrorY( aYaxis_position );
785 }
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:175
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84

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

◆ Move()

void SCH_SHEET::Move ( const wxPoint aMoveVector)
inlineoverridevirtual

Move the item by aMoveVector to a new position.

Parameters
aMoveVector= the displacement vector

Implements SCH_ITEM.

Definition at line 511 of file sch_sheet.h.

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

References m_fields, m_pins, and m_pos.

Referenced by SetPosition().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( ) const
inherited

Definition at line 160 of file sch_item.cpp.

161 {
162  if( m_connection_map.size() )
163  {
164  NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
165  const wxString& netname = m_connection_map.begin()->second->Name( true );
166  const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
167 
168  if( !netclassName.IsEmpty() )
169  return netSettings.m_NetClasses.Find( netclassName );
170  else
171  return netSettings.m_NetClasses.GetDefault();
172  }
173 
174  return nullptr;
175 }
std::map< wxString, wxString > m_NetClassAssignments
Definition: net_settings.h:43
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
Definition: netclass.cpp:132
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:116
NET_SETTINGS & NetSettings()
Definition: project_file.h:92
NETCLASSES m_NetClasses
Definition: net_settings.h:39
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:141
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
PROJECT & Prj() const
Return a reference to the project this schematic is part of.
Definition: schematic.h:77
NETCLASSPTR GetDefault() const
Function GetDefault.
Definition: netclass.h:264

References NETCLASSES::Find(), NETCLASSES::GetDefault(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClassAssignments, NET_SETTINGS::m_NetClasses, PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_JUNCTION::GetColor(), SCH_JUNCTION::GetDiameter(), SCH_LINE::GetEffectiveLineStyle(), 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 194 of file base_struct.cpp.

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

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

◆ operator<() [2/2]

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

Reimplemented from SCH_ITEM.

Definition at line 1023 of file sch_sheet.cpp.

1024 {
1025  if( Type() != aItem.Type() )
1026  return Type() < aItem.Type();
1027 
1028  auto sheet = static_cast<const SCH_SHEET*>( &aItem );
1029 
1030  if (m_fields[ SHEETNAME ].GetText() != sheet->m_fields[ SHEETNAME ].GetText())
1031  return m_fields[ SHEETNAME ].GetText() < sheet->m_fields[ SHEETNAME ].GetText();
1032 
1033  if (m_fields[ SHEETFILENAME ].GetText() != sheet->m_fields[ SHEETFILENAME ].GetText())
1034  return m_fields[ SHEETFILENAME ].GetText() < sheet->m_fields[ SHEETFILENAME ].GetText();
1035 
1036  return false;
1037 }
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

◆ operator=()

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

Definition at line 996 of file sch_sheet.cpp.

997 {
998  wxCHECK_MSG( Type() == aItem.Type(), *this,
999  wxT( "Cannot assign object type " ) + aItem.GetClass() + wxT( " to type " ) +
1000  GetClass() );
1001 
1002  if( &aItem != this )
1003  {
1004  SCH_ITEM::operator=( aItem );
1005 
1006  SCH_SHEET* sheet = (SCH_SHEET*) &aItem;
1007 
1008  m_pos = sheet->m_pos;
1009  m_size = sheet->m_size;
1010  m_fields = sheet->m_fields;
1011 
1012  for( SCH_SHEET_PIN* pin : sheet->m_pins )
1013  {
1014  m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
1015  m_pins.back()->SetParent( this );
1016  }
1017  }
1018 
1019  return *this;
1020 }
friend class SCH_SHEET_PIN
Definition: sch_sheet.h:218
wxSize m_size
Definition: sch_sheet.h:230
wxPoint m_pos
Definition: sch_sheet.h:229
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_sheet.h:252
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

◆ Plot()

void SCH_SHEET::Plot ( PLOTTER aPlotter)
overridevirtual

Plot the schematic item to aPlotter.

Parameters
aPlotterA pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 943 of file sch_sheet.cpp.

944 {
945  wxString Text;
946  wxPoint pos;
947 
948  bool override = false;
949 
950  if( KIGFX::SCH_RENDER_SETTINGS* settings =
951  dynamic_cast<KIGFX::SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() ) )
952  override = settings->m_OverrideItemColors;
953 
954  COLOR4D borderColor = GetBorderColor();
955  COLOR4D backgroundColor = GetBackgroundColor();
956 
957  if( override || borderColor == COLOR4D::UNSPECIFIED )
958  borderColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET );
959 
960  if( override || backgroundColor == COLOR4D::UNSPECIFIED )
961  backgroundColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_SHEET_BACKGROUND );
962 
963  aPlotter->SetColor( backgroundColor );
964  // Do not fill shape in B&W mode, otherwise texts are unreadable
965  bool fill = aPlotter->GetColorMode();
966  aPlotter->Rect( m_pos, m_pos + m_size, fill ? FILLED_SHAPE : NO_FILL, 1.0 );
967 
968  aPlotter->SetColor( borderColor );
969 
970  int penWidth = std::max( GetPenWidth(), aPlotter->RenderSettings()->GetMinPenWidth() );
971  aPlotter->SetCurrentLineWidth( penWidth );
972 
973  aPlotter->MoveTo( m_pos );
974  pos = m_pos;
975  pos.x += m_size.x;
976 
977  aPlotter->LineTo( pos );
978  pos.y += m_size.y;
979 
980  aPlotter->LineTo( pos );
981  pos = m_pos;
982  pos.y += m_size.y;
983 
984  aPlotter->LineTo( pos );
985  aPlotter->FinishTo( m_pos );
986 
987  for( SCH_FIELD field : m_fields )
988  field.Plot( aPlotter );
989 
990  /* Draw texts : SheetLabel */
991  for( SCH_SHEET_PIN* sheetPin : m_pins )
992  sheetPin->Plot( aPlotter );
993 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
virtual void SetColor(COLOR4D color)=0
wxSize m_size
Definition: sch_sheet.h:230
const COLOR4D & GetLayerColor(int aLayer) const
Function GetLayerColor Returns the color used to draw a layer.
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:290
wxPoint m_pos
Definition: sch_sheet.h:229
KIGFX::COLOR4D GetBackgroundColor() const
Definition: sch_sheet.h:293
void LineTo(const wxPoint &pos)
Definition: plotter.h:262
int GetPenWidth() const override
Definition: sch_sheet.cpp:491
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:147
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
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:99
bool GetColorMode() const
Definition: plotter.h:144

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(), PLOTTER::SetCurrentLineWidth(), wxPoint::x, and wxPoint::y.

◆ 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:52
int color
Definition: DXF_plotter.cpp:61
wxSize m_size
Definition: sch_sheet.h:230
KIGFX::COLOR4D GetBorderColor() const
Definition: sch_sheet.h:290
wxPoint m_pos
Definition: sch_sheet.h:229
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:846
int GetPenWidth() const override
Definition: sch_sheet.cpp:491
std::vector< SCH_SHEET_PIN * > m_pins
Definition: sch_sheet.h:224
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:84
std::vector< SCH_FIELD > m_fields
Definition: sch_sheet.h:226
int GetDefaultPenWidth() const
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

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

◆ RemovePin()

void SCH_SHEET::RemovePin ( SCH_SHEET_PIN aSheetPin)

Remove aSheetPin from the sheet.

Parameters
aSheetPinThe sheet pin item to remove from the sheet.

Definition at line 289 of file sch_sheet.cpp.

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

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

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

References m_pins.

Referenced by AddPin(), and RemovePin().

◆ Replace() [1/2]

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

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

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

Definition at line 167 of file base_struct.cpp.

168 {
169  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
170 
171  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
172  aSearchData.GetFindString() :
173  aSearchData.GetFindString().Upper() );
174 
175  if( result == wxNOT_FOUND )
176  return false;
177 
178  wxString prefix = aText.Left( result );
179  wxString suffix;
180 
181  if( aSearchData.GetFindString().length() + result < aText.length() )
182  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
183 
184  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
185  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
186  GetChars( suffix ) );
187 
188  aText = prefix + aSearchData.GetReplaceString() + suffix;
189 
190  return true;
191 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153

References GetChars(), and traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

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

Reimplemented in SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 490 of file base_struct.h.

490 { 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 796 of file sch_sheet.cpp.

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

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

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

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

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

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

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

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

Referenced by SCH_EDIT_TOOL::Rotate().

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

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

117 {
118  EDA_ITEM* parent = GetParent();
119 
120  while( parent )
121  {
122  if( parent->Type() == SCHEMATIC_T )
123  return static_cast<SCHEMATIC*>( parent );
124  else
125  parent = parent->GetParent();
126  }
127 
128  return nullptr;
129 }
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

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

Referenced by SCH_EDIT_FRAME::CreateSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_JUNCTION::GetBoundingBox(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::GetDiameter(), 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(), IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_JUNCTION::Plot(), SCH_JUNCTION::Print(), SCH_HIERLABEL::Print(), SCH_COMPONENT::ResolveTextVar(), 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:185
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: base_struct.h:195
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:216
EE_RTREE & Items()
Definition: sch_screen.h:158
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221

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

Referenced by SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_SCH_SHEET_PROPS::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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
void set(void *aObject, T aValue)
Definition: property.h:266
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:61
#define TYPE_HASH(x)
Macro to generate unique identifier for a type
Definition: property.h:53
size_t TYPE_ID
Unique type identifier
Definition: property_mgr.h:38
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:58
void set(void *aObject, T aValue)
Definition: property.h:266
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

Definition at line 294 of file sch_sheet.h.

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

References m_backgroundColor.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBorderColor()

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

Definition at line 291 of file sch_sheet.h.

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

References m_borderColor.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ SetBorderWidth()

void SCH_SHEET::SetBorderWidth ( int  aWidth)
inline

◆ SetBrightened()

◆ SetConnectivityDirty()

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

Definition at line 435 of file sch_item.h.

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

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetFields()

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

Set multiple schematic fields.

Parameters
aFieldsare the fields to set in this symbol.

Definition at line 275 of file sch_sheet.h.

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

References m_fields.

Referenced by DIALOG_SCH_SHEET_PROPS::TransferDataFromWindow().

◆ SetFileName()

void SCH_SHEET::SetFileName ( wxString  aFilename)
inline

Definition at line 502 of file sch_sheet.h.

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

References m_fields, and SHEETFILENAME.

Referenced by SCH_EDIT_FRAME::importFile(), 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 232 of file base_struct.h.

232 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Definition: base_struct.h:176

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), SCH_MOVE_TOOL::AlignElements(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupSegments(), TRACKS_CLEANER::cleanupSegments(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), LIB_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), LIB_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), 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(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), 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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

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

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

Definition at line 284 of file base_struct.h.

284 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: base_struct.h:175

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID  aLayer)
inlineinherited

Set the layer this item is on.

Parameters
aLayerThe layer number.

Definition at line 286 of file sch_item.h.

286 { m_Layer = aLayer; }
SCH_LAYER_ID m_Layer
Definition: sch_item.h:199

References SCH_ITEM::m_Layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool  aLocked)
inlinevirtualinherited

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

Definition at line 274 of file sch_item.h.

274 {}

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 87 of file base_struct.cpp.

88 {
90 
91  // If this a child object, then the parent modification state also needs to be set.
92  if( m_Parent )
94 }
void SetModified()
Definition: base_struct.cpp:87
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:113
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232

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

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION.

Definition at line 196 of file base_struct.h.

196 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:174

References EDA_ITEM::m_Parent.

Referenced by MODULE::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), ZONE_FILLER::buildCopperItemClearances(), LIB_FIELD::Copy(), LIB_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_PART::Flatten(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), LIB_PART::LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), MODULE::operator=(), LIB_PART::operator=(), PCB_PARSER::parseMODULE_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteModuleItemsToModEdit(), 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::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

void SCH_SHEET::SetPosition ( const wxPoint aPosition)
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 788 of file sch_sheet.cpp.

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

References m_pos, and Move().

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetScreen()

void SCH_SHEET::SetScreen ( SCH_SCREEN aScreen)

Set the SCH_SCREEN associated with this sheet to aScreen.

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

Parameters
aScreenThe new screen to associate with the sheet.

Definition at line 150 of file sch_sheet.cpp.

151 {
152  if( aScreen == m_screen )
153  return;
154 
155  if( m_screen != NULL )
156  {
158 
159  if( m_screen->GetRefCount() == 0 )
160  {
161  delete m_screen;
162  m_screen = NULL;
163  }
164  }
165 
166  m_screen = aScreen;
167 
168  if( m_screen )
170 }
#define NULL
void DecRefCount()
Definition: sch_screen.cpp:115
SCH_SCREEN * m_screen
Definition: sch_sheet.h:221
void IncRefCount()
Definition: sch_screen.cpp:109
int GetRefCount() const
Definition: sch_screen.h:196

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

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

◆ SetSelected()

◆ SetSize()

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

Definition at line 285 of file sch_sheet.h.

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

References m_size.

Referenced by EE_POINT_EDITOR::updateItem().

◆ SetState()

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

Definition at line 221 of file base_struct.h.

222  {
223  if( state )
224  m_Status |= type; // state = ON or OFF
225  else
226  m_Status &= ~type;
227  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

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

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 230 of file base_struct.h.

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

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint  aPos)
inlineinherited

Definition at line 251 of file sch_item.h.

251 { 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 476 of file sch_item.h.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 207 of file base_struct.h.

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

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

521 { 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 251 of file sch_sheet.cpp.

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

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

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

Returns
KICAD_T - the type of object.

Definition at line 193 of file base_struct.h.

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

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), 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(), SCH_JUNCTION::ClassOf(), SCH_NO_CONNECT::ClassOf(), TEXTE_PCB::ClassOf(), MARKER_PCB::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), EDGE_MODULE::ClassOf(), SCH_PIN::ClassOf(), PCB_GROUP::ClassOf(), SCH_LINE::ClassOf(), PCB_TARGET::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), ZONE_CONTAINER::ClassOf(), SCH_BITMAP::ClassOf(), D_PAD::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::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(), VIA::ClassOf(), ALIGNED_DIMENSION::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), ORTHOGONAL_DIMENSION::ClassOf(), LEADER::ClassOf(), CENTER_DIMENSION::ClassOf(), TRACKS_CLEANER::cleanupSegments(), 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(), MODULE::CoverageRatio(), BOARD_ADAPTER::createLayers(), PCB_BASE_FRAME::CreateNewModule(), SCH_DRAWING_TOOLS::createNewText(), BOARD_ADAPTER::createNewTrack(), ZONE_CREATE_HELPER::createNewZone(), D_PAD::D_PAD(), 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(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), MODULE::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(), NETLIST_EXPORTER::findNextComponent(), PCB_BASE_FRAME::FocusOnItem(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), SCH_FIELD::GetBoundingBox(), TRACK::GetBoundingBox(), 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(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), TEXTE_PCB::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), PCB_EDITOR_CONTROL::GroupFlattenSelected(), BOARD::GroupLegalOps(), PCB_EDITOR_CONTROL::GroupMergeSelected(), BOARD::GroupsSanityCheckInternal(), EE_SELECTION_TOOL::GuessSelectionCandidates(), SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), highlightNet(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_INSPECTION_TOOL::InspectClearance(), ARRAY_CREATOR::Invoke(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), 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(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_GENERIC::makeListOfNets(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), 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(), TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), DRAWSEGMENT::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::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=(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCB_PARSER::parseBOARD_unchecked(), 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(), SELECTION_TOOL::RebuildSelection(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::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(), WS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_SEXPR_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_SEXPR_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::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(), EE_SELECTION_TOOL::Selectable(), 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(), SCH_FIELD::SwapData(), TEXTE_PCB::SwapData(), TRACK::SwapData(), ARC::SwapData(), ALIGNED_DIMENSION::SwapData(), ORTHOGONAL_DIMENSION::SwapData(), SwapData(), SCH_COMPONENT::SwapData(), LEADER::SwapData(), VIA::SwapData(), CENTER_DIMENSION::SwapData(), D_PAD::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testCopperDrawItem(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), TEXTE_MODULE::TEXTE_MODULE(), BOARD::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(), PCB_EDITOR_CONTROL::UngroupSelected(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), DIALOG_SELECT_NET_FROM_LIST::updateNet(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), SCH_EDITOR_CONTROL::updatePastedInstances(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

◆ UpdateDanglingState()

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

Test the schematic item to aItemList to check if it's dangling state has changed.

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

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the 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 846 of file sch_sheet.cpp.

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

References m_pins.

◆ UsesDefaultStroke()

bool SCH_SHEET::UsesDefaultStroke ( ) const

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

The default stroke is defined as follows:

Returns
True if the outline stroke meets the default criteria.

Definition at line 245 of file sch_sheet.cpp.

246 {
247  return m_borderWidth == 0 && m_borderColor == COLOR4D::UNSPECIFIED;
248 }
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 MODULE, D_PAD, CENTER_DIMENSION, EDIT_POINTS, DRAWSEGMENT, GERBER_DRAW_ITEM, DIMENSION, TRACK, TEXTE_MODULE, ROUTER_PREVIEW_ITEM, KIGFX::WS_PROXY_VIEW_ITEM, MARKER_PCB, MY_DRAWING, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and BRIGHT_BOX.

Definition at line 215 of file base_struct.cpp.

216 {
217  // Basic fallback
218  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
219  VECTOR2I( GetBoundingBox().GetSize() ) );
220 }
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: base_struct.cpp:97

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

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

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

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

Reimplemented in EDIT_POINTS, ROUTER_PREVIEW_ITEM, KIGFX::WS_PROXY_VIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, 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 MODULE_ZONE_CONTAINER, MODULE, D_PAD, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, ZONE_CONTAINER, PCB_GROUP, and EDGE_MODULE.

Definition at line 141 of file view_item.h.

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

Referenced by 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 869 of file sch_sheet.cpp.

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

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 218 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

True if connectivity info might be out of date.

Definition at line 212 of file sch_item.h.

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

◆ m_fields

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_SHEET::m_fieldsAutoplaced
private

Definition at line 227 of file sch_sheet.h.

Referenced by AutoplaceFields(), Resize(), Rotate(), SCH_SHEET(), and SwapData().

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_Layer

◆ m_Parent

◆ m_pins

◆ m_pos

◆ m_screen

◆ m_size

◆ m_Status

◆ m_storedPos

wxPoint SCH_ITEM::m_storedPos
protectedinherited

Definition at line 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 162 of file base_struct.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), PCB_GROUP::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), D_PAD::D_PAD(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), MODULE::Duplicate(), MODULE::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::Exchange_Module(), PAD_TOOL::explodePad(), BOARD::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), MARKER_PCB::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), BOARD::GroupsSanityCheckInternal(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), EAGLE_PLUGIN::loadElements(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_GENERIC::makeComponents(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), DRAWSEGMENT::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), MODULE::cmp_drawings::operator()(), MODULE::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PCB_PARSER::parseBOARD_unchecked(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseMODULE_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), 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(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().


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