104 m_pins.emplace_back( new SCH_SHEET_PIN( *pin ) );
105 m_pins.back()->SetParent( this );
109 field.SetParent(
this );
174 wxCHECK_MSG(
Schematic(),
false,
"Can't call IsRootSheet without setting a schematic" );
183 [&](
const wxString& aVar )
186 aVars->push_back( aVar );
191 if( field.IsMandatory() )
192 add( field.GetCanonicalName().Upper() );
194 add( field.GetName() );
199 if( sheetPath.
size() >= 2 )
211 add( wxT(
"SHEETPATH" ) );
212 add( wxT(
"EXCLUDE_FROM_BOM" ) );
213 add( wxT(
"EXCLUDE_FROM_BOARD" ) );
214 add( wxT(
"EXCLUDE_FROM_SIM" ) );
216 add( wxT(
"ERC_ERROR <message_text>" ) );
217 add( wxT(
"ERC_WARNING <message_text>" ) );
219 m_screen->GetTitleBlock().GetContextualTextVars( aVars );
225 wxCHECK( aPath,
false );
232 if( token->Contains(
':' ) )
240 wxString fieldName = field.IsMandatory() ? field.GetCanonicalName().Upper()
243 if( token->IsSameAs( fieldName ) )
245 *token = field.GetShownText( aPath,
false, aDepth + 1 );
259 if( token->IsSameAs( wxT(
"#" ) ) )
264 else if( token->IsSameAs( wxT(
"##" ) ) )
266 *token = wxString::Format( wxT(
"%d" ), (
int) schematic->
Hierarchy().size() );
269 else if( token->IsSameAs( wxT(
"SHEETPATH" ) ) )
274 else if( token->IsSameAs( wxT(
"EXCLUDE_FROM_BOM" ) ) )
276 *token = wxEmptyString;
279 *token =
_(
"Excluded from BOM" );
283 else if( token->IsSameAs( wxT(
"EXCLUDE_FROM_BOARD" ) ) )
285 *token = wxEmptyString;
288 *token =
_(
"Excluded from board" );
292 else if( token->IsSameAs( wxT(
"EXCLUDE_FROM_SIM" ) ) )
294 *token = wxEmptyString;
297 *token =
_(
"Excluded from simulation" );
301 else if( token->IsSameAs( wxT(
"DNP" ) ) )
303 *token = wxEmptyString;
305 if( aPath->
GetDNP() || this->ResolveDNP() )
313 if( aPath->
size() >= 2 )
318 if(
path.Last()->ResolveTextVar( &
path, token, aDepth + 1 ) )
334 wxString::Format( wxT(
"SCH_SHEET object cannot swap data with %s object." ),
347 sheetPin->SetParent(
this );
353 field.SetParent(
this );
375 m_fields.emplace_back(
this, aFieldType );
403 wxASSERT( aSheetPin !=
nullptr );
407 m_pins.push_back( aSheetPin );
414 wxASSERT( aSheetPin !=
nullptr );
419 if( *i == aSheetPin )
433 if(
pin->GetText().Cmp( aName ) == 0 )
445 if( sheetPin->GetPosition() == aPosition )
460 switch(
pin->GetSide() )
470 return topBottom > 0 && leftRight == 0;
490 if( HLabel ==
nullptr )
500 constexpr int gridSize =
schIUScale.MilsToIU( 50 );
502 int base = aVal / gridSize;
503 int excess = abs( aVal % gridSize );
507 return ( base + 1 ) * gridSize;
509 else if( excess > 0 )
511 return ( base ) * gridSize;
515 return ( base - 1 ) * gridSize;
523 int pinsRight =
m_pos.x;
525 for(
size_t i = 0; i <
m_pins.size(); i++ )
533 pinsLeft = std::min( pinsLeft, pinRect.
GetLeft() );
534 pinsRight = std::max( pinsRight, pinRect.
GetRight() );
543 if( pinsLeft >= pinsRight )
546 pinMinWidth = pinsRight -
m_pos.x;
557 int pinsBottom =
m_pos.y;
559 for(
size_t i = 0; i <
m_pins.size(); i++ )
567 pinsTop = std::min( pinsTop, pinRect.
GetTop() );
568 pinsBottom = std::max( pinsBottom, pinRect.
GetBottom() );
577 if( pinsTop >= pinsBottom )
580 pinMinHeight = pinsBottom -
m_pos.y;
590 std::vector<SCH_SHEET_PIN*> pins =
m_pins;
618 if(
pin->HitTest( aPosition ) )
643 int margin = borderMargin +
KiROUND( std::max( textSize.
x, textSize.
y ) * 0.5 );
663 margin = borderMargin +
KiROUND( std::max( textSize.
x, textSize.
y ) * 0.4 );
701 end.x = std::max(
m_size.x, textLength );
719 bbox.
Merge( field.GetBoundingBox() );
775 if( screen && screen->
GetFileName().Cmp( aFilename ) == 0 )
820 if(
m_screen->GetFileName().Cmp( aFilename ) == 0 )
853 path.push_back(
this );
855 aList.emplace_back(
_(
"Hierarchical Path" ),
path.PathHumanReadable(
false,
true ) );
865 msgs.Add(
_(
"Simulation" ) );
868 msgs.Add(
_(
"BOM" ) );
871 msgs.Add(
_(
"Board" ) );
874 msgs.Add(
_(
"DNP" ) );
876 msg = wxJoin( msgs,
'|' );
877 msg.Replace(
'|', wxS(
", " ) );
880 aList.emplace_back(
_(
"Exclude from" ), msg );
897 m_pos += aMoveVector;
900 pin->Move( aMoveVector );
903 field.Move( aMoveVector );
929 sheetPin->Rotate( aCenter, aRotateCCW );
943 field.SetTextPos( pos );
958 sheetPin->MirrorVertically( aCenter );
964 field.SetTextPos( pos );
978 sheetPin->MirrorHorizontally( aCenter );
984 field.SetTextPos( pos );
1010 sheetPin->ConstrainOnEdge( sheetPin->GetPosition(),
false );
1027 pin->SetNumber(
id );
1039 while( !sheetPath.
empty() && sheetPath.
Last() !=
this )
1042 if( sheetPath.
empty() )
1058 wxT(
"Invalid item in schematic sheet pin list. Bad programmer!" ) );
1060 sheetPin->GetEndPoints( aItemList );
1066 std::vector<DANGLING_END_ITEM>& aItemListByPos,
1069 bool changed =
false;
1072 changed |= sheetPin->UpdateDanglingState( aItemListByType, aItemListByPos );
1088 wxCHECK( sheet,
false );
1102 for(
size_t i = 0; i <
m_pins.size(); i++ )
1114 std::vector<VECTOR2I> retval;
1117 retval.push_back( sheetPin->GetPosition() );
1124 const std::vector<KICAD_T>& aScanTypes )
1126 for(
KICAD_T scanType : aScanTypes )
1163 aFunction( &field );
1174 return wxString::Format(
_(
"Hierarchical Sheet '%s'" ),
1216 int aUnit,
int aBodyStyle,
const VECTOR2I& aOffset,
bool aDimmed )
1231 if( aBackground && backgroundColor.
a > 0.0 )
1233 aPlotter->
SetColor( backgroundColor );
1252 std::vector<wxString> properties;
1258 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ), field.GetName(),
1259 field.GetShownText(
false ) ) );
1267 sheetPin->Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
1271 field.Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
1280 std::max( bbox.
GetY() - pins.
GetY(),
1284 margins.
x = std::max( margins.
x * 0.6, margins.
y * 0.3 );
1285 margins.
y = std::max( margins.
y * 0.6, margins.
x * 0.3 );
1294 strokeWidth,
nullptr );
1301 wxCHECK_MSG(
Type() == aItem.
Type(), *
this,
1302 wxT(
"Cannot assign object type " ) + aItem.
GetClass() + wxT(
" to type " ) +
1305 if( &aItem !=
this )
1318 m_pins.back()->SetParent(
this );
1350 for(
int ii =
m_instances.size() - 1; ii >= 0; --ii )
1356 " page %s, from project %s.",
1384 if( instance.m_Path == aPath )
1390 (
GetName().IsEmpty() ) ? wxString( wxT(
"root" ) ) :
GetName() );
1403 bool aTestFromEnd )
const
1409 if( instance.m_Path == aSheetPath )
1411 aInstance = instance;
1415 else if( instance.m_Path.EndsWith( aSheetPath ) )
1417 aInstance = instance;
1430 if( instance.m_Path.size() == 0 )
1442 if( instance.m_Path.size() == 0 )
1456 wxString pageNumber;
1460 if( instance.m_Path == aParentPath )
1462 pageNumber = instance.m_PageNumber;
1475 if( instance.m_Path == aPath )
1477 instance.m_PageNumber = aPageNumber;
1487 if( &aOther ==
this )
1494 std::vector<SCH_SHEET_INSTANCE> instances =
GetInstances();
1495 std::vector<SCH_SHEET_INSTANCE> otherInstances = aOther.
GetInstances();
1501 std::sort( instances.begin(), instances.end(),
1504 if( aLhs.m_Path > aRhs.m_Path )
1509 std::sort( otherInstances.begin(), otherInstances.end(),
1512 if( aLhs.m_Path > aRhs.m_Path )
1518 auto itThis = instances.begin();
1519 auto itOther = otherInstances.begin();
1521 while( itThis != instances.end() )
1523 if( ( itThis->m_Path == itOther->m_Path )
1524 && ( itThis->m_PageNumber != itOther->m_PageNumber ) )
1539 if( aPageNumberA == aPageNumberB )
1544 bool isIntegerPageA = aPageNumberA.ToLong( &pageA );
1545 bool isIntegerPageB = aPageNumberB.ToLong( &pageB );
1547 if( isIntegerPageA && isIntegerPageB )
1556 if( isIntegerPageA )
1558 else if( isIntegerPageB )
1565 wxCHECK(
result != 0, 0 );
1610 for(
size_t i = 0; i <
GetFields().size(); ++i )
1636void SCH_SHEET::Show(
int nestLevel, std::ostream& os )
const
1641 NestedSpace( nestLevel, os ) <<
'<' << s.Lower().mb_str() <<
">" <<
" sheet_name=\""
1646 sheetPin->Show( nestLevel + 1, os );
1648 NestedSpace( nestLevel, os ) <<
"</" << s.Lower().mb_str() <<
">\n" << std::flush;
1667 if( !aValue.GetAs( &value ) )
1675 return std::make_unique<VALIDATION_ERROR_MSG>( msg );
1688 const wxString groupAttributes =
_HKI(
"Attributes" );
constexpr EDA_IU_SCALE schIUScale
BITMAPS
A list of all bitmap identifiers.
@ add_hierarchical_subsheet
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
constexpr const Vec GetEnd() const
constexpr coord_type GetY() const
constexpr size_type GetWidth() const
constexpr coord_type GetX() const
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
constexpr const Vec GetCenter() const
constexpr size_type GetHeight() const
constexpr coord_type GetLeft() const
constexpr bool Contains(const Vec &aPoint) const
constexpr const Vec & GetOrigin() const
constexpr coord_type GetRight() const
constexpr void SetEnd(coord_type x, coord_type y)
constexpr coord_type GetTop() const
constexpr bool Intersects(const BOX2< Vec > &aRect) const
constexpr coord_type GetBottom() const
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
virtual void SetParent(EDA_ITEM *aParent)
EDA_ITEM * GetParent() const
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
virtual const wxString & GetText() const
Return the string associated with the text object.
void SetTextPos(const VECTOR2I &aPoint)
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
static wxString GotoPageHref(const wxString &aDestination)
Generate a href to a page in the current schematic.
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
VECTOR2I GetTextSize() const
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
A color representation with 4 components: red, green, blue, alpha.
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
wxString AsString() const
Base plotter engine class.
RENDER_SETTINGS * RenderSettings()
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width, int aCornerRadius=0)=0
virtual void HyperlinkBox(const BOX2I &aBox, const wxString &aDestinationURL)
Create a clickable hyperlink with a rectangular click area.
bool GetColorMode() const
virtual void ThickSegment(const VECTOR2I &start, const VECTOR2I &end, int width, void *aData)
virtual void HyperlinkMenu(const BOX2I &aBox, const std::vector< wxString > &aDestURLs)
Create a clickable hyperlink menu with a rectangular click area.
virtual void SetColor(const COLOR4D &color)=0
Container for project specific data.
PROPERTY_BASE & SetValidator(PROPERTY_VALIDATOR_FN &&aValidator)
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
Holds all the data relating to one schematic.
SCHEMATIC_SETTINGS & Settings() const
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
PROJECT & Project() const
Return a reference to the project this schematic is part of.
bool ResolveTextVar(const SCH_SHEET_PATH *aSheetPath, wxString *token, int aDepth) const
void GetContextualTextVars(wxArrayString *aVars) const
SCH_SHEET_PATH & CurrentSheet() const
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Schematic editor (Eeschema) main window.
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Base class for any item which can be embedded within the SCHEMATIC container class,...
SCH_ITEM & operator=(const SCH_ITEM &aPin)
SCH_RENDER_SETTINGS * getRenderSettings(PLOTTER *aPlotter) const
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
AUTOPLACE_ALGO m_fieldsAutoplaced
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
wxString GetClass() const override
Return the class name.
int GetEffectivePenWidth(const SCH_RENDER_SETTINGS *aSettings) const
bool m_OverrideItemColors
const wxString & GetFileName() const
bool GetExcludedFromBOM() const
bool empty() const
Forwarded method from std::vector.
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
wxString GetPageNumber() const
bool GetExcludedFromSim() const
bool GetExcludedFromBoard() const
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
size_t size() const
Forwarded method from std::vector.
void pop_back()
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this sheet.
bool GetExcludedFromBoard() const override
void SetBorderColor(KIGFX::COLOR4D aColor)
friend class SCH_SHEET_PIN
void SetExcludedFromBoard(bool aExcludeFromBoard) override
Set or clear exclude from board netlist flag.
void SetFileName(const wxString &aFilename)
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
wxString GetFileName() const
Return the filename corresponding to this sheet.
bool getInstance(SCH_SHEET_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void RemoveInstance(const KIID_PATH &aInstancePath)
bool addInstance(const KIID_PATH &aInstance)
Add a new instance aSheetPath to the instance list.
void AddPin(SCH_SHEET_PIN *aSheetPin)
Add aSheetPin to the sheet.
bool HasRootInstance() const
Check to see if this sheet has a root sheet instance.
wxString GetClass() const override
Return the class name.
wxString getPageNumber(const KIID_PATH &aParentPath) const
Return the sheet page number for aParentPath.
int GetPenWidth() const override
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
SCH_SHEET_PATH findSelf() const
Get the sheetpath of this sheet.
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
std::vector< SCH_FIELD > & GetFields()
Return a reference to the vector holding the sheet's fields.
bool GetExcludedFromBOM() const override
KIGFX::COLOR4D m_borderColor
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this sheet.
void renumberPins()
Renumber the sheet pins in the sheet.
VECTOR2I GetRotationCenter() const
Rotating around the boundingBox's center can cause walking when the sheetname or filename is longer t...
SCH_SHEET_PIN * GetPin(const VECTOR2I &aPosition)
Return the sheet pin item found at aPosition in the sheet.
bool operator<(const SCH_ITEM &aItem) const override
void CleanupSheet()
Delete sheet label which do not have a corresponding hierarchical label.
void RemovePin(const SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
void SetPositionIgnoringPins(const VECTOR2I &aPosition)
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
bool LocatePathOfScreen(SCH_SCREEN *aScreen, SCH_SHEET_PATH *aList)
Search the existing hierarchy for an instance of screen loaded from aFileName.
std::vector< SCH_SHEET_INSTANCE > m_instances
bool HasUndefinedPins() const
Check all sheet labels against schematic for undefined hierarchical labels.
void SetPosition(const VECTOR2I &aPosition) override
void SetBackgroundColor(KIGFX::COLOR4D aColor)
int SymbolCount() const
Count our own symbols, without the power symbols.
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
Plot the item to aPlotter.
void AddInstance(const SCH_SHEET_INSTANCE &aInstance)
int GetMinWidth(bool aFromLeft) const
Return the minimum width of the sheet based on the widths of the sheet pin text.
bool operator==(const SCH_ITEM &aOther) const override
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
std::vector< SCH_FIELD > m_fields
KIGFX::COLOR4D m_backgroundColor
SCH_SHEET(EDA_ITEM *aParent=nullptr, const VECTOR2I &aPos=VECTOR2I(0, 0), VECTOR2I aSize=VECTOR2I(schIUScale.MilsToIU(MIN_SHEET_WIDTH), schIUScale.MilsToIU(MIN_SHEET_HEIGHT)))
void SetName(const wxString &aName)
int CountSheets() const
Count the number of sheets found in "this" sheet including all of the subsheets.
int GetNextFieldOrdinal() const
Return the next ordinal for a user field for this sheet.
VECTOR2I GetPosition() const override
const BOX2I GetBodyBoundingBox() const
Return a bounding box for the sheet body but not the fields.
bool HasPin(const wxString &aName) const
Check if the sheet already has a sheet pin named aName.
static int ComparePageNum(const wxString &aPageNumberA, const wxString &aPageNumberB)
Compare page numbers of schematic sheets.
void SetExcludedFromBOM(bool aExcludeFromBOM) override
Set or clear the exclude from schematic bill of materials flag.
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
void SetFields(const std::vector< SCH_FIELD > &aFields)
Set multiple schematic fields.
int GetScreenCount() const
Return the number of times the associated screen for the sheet is being used.
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
SCH_SHEET & operator=(const SCH_ITEM &aSheet)
bool HasPageNumberChanges(const SCH_SHEET &aOther) const
Check if the instance data of this sheet has any changes compared to aOther.
const SCH_SHEET_INSTANCE & GetRootInstance() const
Return the root sheet instance data.
bool doIsConnected(const VECTOR2I &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
KIGFX::COLOR4D GetBorderColor() const
std::vector< SCH_SHEET_PIN * > m_pins
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
void SetBorderWidth(int aWidth)
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void setPageNumber(const KIID_PATH &aInstance, const wxString &aPageNumber)
Set the page number for the sheet instance aInstance.
bool GetExcludedFromSim() const override
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
int GetMinHeight(bool aFromTop) const
Return the minimum height that the sheet can be resized based on the sheet pin positions.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, const SCH_SHEET_PATH *aPath=nullptr) override
Test the schematic item to aItemList to check if it's dangling state has changed.
void Resize(const VECTOR2I &aSize)
Resize this sheet to aSize and adjust all of the labels accordingly.
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
int GetBorderWidth() const
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
void SetDNP(bool aDNP) override
bool GetDNP() const override
Set or clear the 'Do Not Populate' flags.
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
bool IsVerticalOrientation() const
void SetExcludedFromSim(bool aExcludeFromSim) override
Set or clear the exclude from simulation flag.
bool HitTest(const VECTOR2I &aPosition, int aAccuracy) const override
Test if aPosition is inside or on the boundary of this item.
KIGFX::COLOR4D GetBackgroundColor() const
bool IsPower() const override
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
#define DEFAULT_LINE_WIDTH_MILS
The default wire width in mils. (can be changed in preference menu)
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_VERTICAL
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
static constexpr EDA_ANGLE ANGLE_270
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
@ FILLED_SHAPE
Fill with object color.
a few functions useful in geometry calculations.
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
@ LAYER_SELECTION_SHADOWS
constexpr void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Message panel definition file.
bool BoxHitTest(const VECTOR2I &aHitPoint, const BOX2I &aHittee, int aAccuracy)
Perform a point-to-box hit test.
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
KICOMMON_API wxString EllipsizeStatusText(wxWindow *aWindow, const wxString &aString)
Ellipsize text (at the end) to be no more than 1/3 of the window width.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
@ PT_SIZE
Size expressed in distance units (mm/inch)
std::optional< std::unique_ptr< VALIDATION_ERROR > > VALIDATOR_RESULT
Null optional means validation succeeded.
const SCH_FIELD * FindField(const std::vector< SCH_FIELD > &aFields, FIELD_T aFieldId)
int NextFieldOrdinal(const std::vector< SCH_FIELD > &aFields)
int bumpToNextGrid(const int aVal, const int aDirection)
static struct SCH_SHEET_DESC _SCH_SHEET_DESC
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
SHEET_SIDE
Define the edge of the sheet that the sheet pin is positioned.
COLOR_SETTINGS * GetColorSettings(const wxString &aName)
std::vector< FAB_LAYER_COLOR > dummy
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
bool m_PDFHierarchicalLinks
A simple container for sheet instance information.
wxString GetDefaultFieldName(FIELD_T aFieldId, bool aTranslateForHI)
Return a default symbol field name for a mandatory field type.
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
wxString result
Test unit parsing edge cases and error handling.
wxLogTrace helper definitions.
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
wxString GetFieldValidationErrorMessage(FIELD_T aFieldId, const wxString &aValue)
Return the error message if aValue is invalid for aFieldId.
Custom text control validator definitions.
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D