50#include <magic_enum.hpp>
52#include <api/schematic/schematic_types.pb.h>
60static int TemplateIN_HN[] = { 6, 0, 0, -1, -1, -2, -1, -2, 1, -1, 1, 0, 0 };
61static int TemplateIN_HI[] = { 6, 0, 0, 1, 1, 2, 1, 2, -1, 1, -1, 0, 0 };
62static int TemplateIN_UP[] = { 6, 0, 0, 1, -1, 1, -2, -1, -2, -1, -1, 0, 0 };
63static int TemplateIN_BOTTOM[] = { 6, 0, 0, 1, 1, 1, 2, -1, 2, -1, 1, 0, 0 };
65static int TemplateOUT_HN[] = { 6, -2, 0, -1, 1, 0, 1, 0, -1, -1, -1, -2, 0 };
66static int TemplateOUT_HI[] = { 6, 2, 0, 1, -1, 0, -1, 0, 1, 1, 1, 2, 0 };
67static int TemplateOUT_UP[] = { 6, 0, -2, 1, -1, 1, 0, -1, 0, -1, -1, 0, -2 };
68static int TemplateOUT_BOTTOM[] = { 6, 0, 2, 1, 1, 1, 0, -1, 0, -1, 1, 0, 2 };
70static int TemplateUNSPC_HN[] = { 5, 0, -1, -2, -1, -2, 1, 0, 1, 0, -1 };
71static int TemplateUNSPC_HI[] = { 5, 0, -1, 2, -1, 2, 1, 0, 1, 0, -1 };
72static int TemplateUNSPC_UP[] = { 5, 1, 0, 1, -2, -1, -2, -1, 0, 1, 0 };
73static int TemplateUNSPC_BOTTOM[] = { 5, 1, 0, 1, 2, -1, 2, -1, 0, 1, 0 };
75static int TemplateBIDI_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 };
76static int TemplateBIDI_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 };
77static int TemplateBIDI_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 };
78static int TemplateBIDI_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 };
80static int Template3STATE_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 };
81static int Template3STATE_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 };
82static int Template3STATE_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 };
83static int Template3STATE_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 };
104 default:
return wxT(
"???" );
159 return ( ( (
int)
m_spin - (
int) aOther.
m_spin ) % 4 + 4 ) % 4;
167 m_isDangling( true ),
168 m_autoRotateOnPlacement( false ),
180 m_shape( aLabel.m_shape ),
181 m_connectionType( aLabel.m_connectionType ),
182 m_isDangling( aLabel.m_isDangling ),
183 m_autoRotateOnPlacement( aLabel.m_autoRotateOnPlacement ),
184 m_lastResolvedColor( aLabel.m_lastResolvedColor ),
185 m_cached_driver_name( aLabel.m_cached_driver_name )
192 field.SetParent(
this );
203 field.SetParent(
this );
218 if( aName == wxT(
"Intersheetrefs" ) )
219 return _(
"Sheet References" );
220 else if( aName == wxT(
"Netclass" ) )
221 return _(
"Net Class" );
222 else if( aName.IsEmpty() && aUseDefaultName )
243 for(
KICAD_T scanType : aScanTypes )
249 wxCHECK_MSG(
Schematic(),
false, wxT(
"No parent SCHEMATIC set for SCH_LABEL!" ) );
258 for(
KICAD_T scanType : aScanTypes )
262 for(
SCH_ITEM* connection : item_set )
264 if( connection->IsType( wireAndPinTypes ) )
271 for(
SCH_ITEM* connection : item_set )
273 if( connection->IsType( busTypes ) )
293 field.SetParent(
this );
323 wxFAIL_MSG(
"Bad spin style" );
402 field.Offset( aMoveVector );
417 field.SetTextPos( field.GetTextPos() + offset );
443 if( ( aLeftRight && field.GetTextAngle().IsHorizontal() )
444 || ( !aLeftRight && field.GetTextAngle().IsVertical() ) )
460 field.SetTextPos( pos );
473 field.FlipHJustify();
479 field.SetPosition( pos );
492 field.FlipHJustify();
498 field.SetPosition( pos );
533 for(
size_t ii = 0; ii <
m_fields.size(); ++ii )
555 if(
typeid( *
this ) !=
typeid( aOther ) )
564 for(
size_t ii = 0; ii <
m_fields.size(); ++ii )
574 similarity *= std::pow( 0.9, diff );
600 if( field.GetId() == FIELD_T::INTERSHEET_REFS )
601 offset.
x = - ( labelLen + margin );
603 offset.
y = accumulated + field.GetTextHeight() / 2;
611 if( field.GetId() == FIELD_T::INTERSHEET_REFS )
612 offset.
y = - ( labelLen + margin );
614 offset.
x = accumulated + field.GetTextHeight() / 2;
622 if( field.GetId() == FIELD_T::INTERSHEET_REFS )
623 offset.
x = labelLen + margin;
625 offset.
y = accumulated + field.GetTextHeight() / 2;
633 if( field.GetId() == FIELD_T::INTERSHEET_REFS )
634 offset.
y = labelLen + margin;
636 offset.
x = accumulated + field.GetTextHeight() / 2;
643 if( field.GetId() == FIELD_T::INTERSHEET_REFS )
644 accumulated += field.GetTextHeight() + margin;
653 std::vector<std::pair<wxString, wxString>>* pages )
664 std::vector<int> pageListCopy;
666 pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() );
668 if( !
Schematic()->Settings().m_IntersheetRefsListOwnPage )
671 std::erase( pageListCopy, currentPage );
673 if( pageListCopy.empty() )
677 std::sort( pageListCopy.begin(), pageListCopy.end() );
682 for(
int pageNum : pageListCopy )
683 pages->push_back( { sheetPages[ pageNum ], sheetNames[ pageNum ] } );
693 if( field.IsMandatory() )
694 aVars->push_back( field.GetCanonicalName().Upper() );
696 aVars->push_back( field.GetName() );
699 aVars->push_back( wxT(
"OP" ) );
700 aVars->push_back( wxT(
"CONNECTION_TYPE" ) );
701 aVars->push_back( wxT(
"SHORT_NET_NAME" ) );
702 aVars->push_back( wxT(
"NET_NAME" ) );
703 aVars->push_back( wxT(
"NET_CLASS" ) );
710 static wxRegEx operatingPoint( wxT(
"^"
712 "(.([0-9])?([a-zA-Z]*))?"
715 wxCHECK( aPath,
false );
722 if( operatingPoint.Matches( *token ) )
725 wxString precisionStr( operatingPoint.GetMatch( *token, 2 ) );
726 wxString range( operatingPoint.GetMatch( *token, 3 ) );
728 if( !precisionStr.IsEmpty() )
729 precision = precisionStr[0] -
'0';
731 if( range.IsEmpty() )
743 if( token->Contains(
':' ) )
750 && token->IsSameAs( wxT(
"CONNECTION_TYPE" ) ) )
756 else if( token->IsSameAs( wxT(
"SHORT_NET_NAME" ) ) )
759 *token = wxEmptyString;
766 else if( token->IsSameAs( wxT(
"NET_NAME" ) ) )
769 *token = wxEmptyString;
772 *token = connection->
Name();
776 else if( token->IsSameAs( wxT(
"NET_CLASS" ) ) )
779 *token = wxEmptyString;
789 *token = wxEmptyString;
793 if( ruleArea->GetExcludedFromBOM() )
794 *token =
_(
"Excluded from BOM" );
802 *token = wxEmptyString;
806 if( ruleArea->GetExcludedFromBoard() )
807 *token =
_(
"Excluded from board" );
815 *token = wxEmptyString;
819 if( ruleArea->GetExcludedFromSim() )
820 *token =
_(
"Excluded from simulation" );
828 *token = wxEmptyString;
832 if( ruleArea->GetDNP() )
841 if( token->IsSameAs( field.GetName() ) )
843 *token = field.GetShownText(
false, aDepth + 1 );
855 path.push_back( sheet );
894 std::function<bool( wxString* )> textResolver =
895 [&]( wxString* token ) ->
bool
933 if( connection->
IsBus() )
937 std::set<wxString> netNames;
939 for( std::shared_ptr<SCH_CONNECTION> member : allMembers )
940 netNames.insert( member->GetNetName() );
942 for(
const wxString& netName : netNames )
972 const std::vector<KICAD_T>& aScanTypes )
974 if(
IsType( aScanTypes ) )
976 if( INSPECT_RESULT::QUIT == aInspector(
this,
nullptr ) )
977 return INSPECT_RESULT::QUIT;
980 for(
KICAD_T scanType : aScanTypes )
986 if( INSPECT_RESULT::QUIT == aInspector( &field,
this ) )
987 return INSPECT_RESULT::QUIT;
992 return INSPECT_RESULT::CONTINUE;
999 aItemList.push_back( item );
1039 std::vector<VECTOR2I> pts;
1060 if( field.IsVisible() && field.GetText() != wxEmptyString )
1062 BOX2I fieldBBox = field.GetBoundingBox();
1067 box.
Merge( fieldBBox );
1087 if( field.IsVisible() )
1089 BOX2I fieldBBox = field.GetBoundingBox();
1090 fieldBBox.
Inflate( aAccuracy );
1095 if( fieldBBox.
Contains( aPosition ) )
1121 if( field.IsVisible() )
1123 BOX2I fieldBBox = field.GetBoundingBox();
1139 std::vector<DANGLING_END_ITEM>& aItemListByPos,
1148 it < aItemListByPos.end() && it->GetPosition() == text_pos; it++ )
1180 it < aItemListByType.end() && it->GetType() ==
BUS_END; it++ )
1201 sch_item->AddConnectionTo( *aPath,
this );
1210 it < aItemListByType.end() && it->GetType() ==
WIRE_END; it++ )
1231 sch_item->AddConnectionTo( *aPath,
this );
1256 wxCHECK( label,
false );
1264 std::vector<wxString> netclasses;
1265 std::vector<wxString> otherNetclasses;
1269 if( field.GetCanonicalName() == wxT(
"Netclass" ) )
1270 netclasses.push_back( field.GetText() );
1276 otherNetclasses.push_back( field.
GetText() );
1279 return netclasses != otherNetclasses;
1304 aList.emplace_back(
_(
"Font" ),
GetFont() ?
GetFont()->GetName() :
_(
"Default" ) );
1306 wxString textStyle[] = {
_(
"Normal" ),
_(
"Italic" ),
_(
"Bold" ),
_(
"Bold Italic" ) };
1308 aList.emplace_back(
_(
"Style" ), textStyle[style] );
1318 default: msg = wxT(
"???" );
break;
1321 aList.emplace_back(
_(
"Justification" ), msg );
1332 if( !conn->
IsBus() )
1334 aList.emplace_back(
_(
"Resolved Netclass" ),
1342 int aUnit,
int aBodyStyle,
const VECTOR2I& aOffset,
bool aDimmed )
1344 static std::vector<VECTOR2I> s_poly;
1386 if(
GetShape() == LABEL_FLAG_SHAPE::F_DOT )
1388 aPlotter->
MoveTo( s_poly[0] );
1389 aPlotter->
LineTo( s_poly[1] );
1392 int diameter = ( s_poly[2] - s_poly[1] ).EuclideanNorm() * 2;
1393 aPlotter->
FilledCircle( s_poly[2], diameter,
nullptr );
1395 else if(
GetShape() == LABEL_FLAG_SHAPE::F_ROUND )
1397 aPlotter->
MoveTo( s_poly[0] );
1398 aPlotter->
LineTo( s_poly[1] );
1401 int diameter = ( s_poly[2] - s_poly[1] ).EuclideanNorm() * 2;
1402 aPlotter->
ThickCircle( s_poly[2], diameter, penWidth,
nullptr );
1406 if( !s_poly.empty() )
1407 aPlotter->
PlotPoly( s_poly, FILL_T::NO_FILL, penWidth,
nullptr );
1411 bool linkAlreadyPlotted =
false;
1418 if( sheet->
size() >= 2 )
1423 linkAlreadyPlotted =
true;
1430 path.push_back( parent );
1432 linkAlreadyPlotted =
true;
1439 std::vector<wxString> properties;
1443 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
1445 connection->
Name() ) );
1447 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
1448 _(
"Resolved netclass" ),
1454 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
1456 field.GetShownText(
false ) ) );
1459 if( !properties.empty() )
1468 field.Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
1488 m_shape = LABEL_FLAG_SHAPE::L_INPUT;
1495 kiapi::schematic::types::LocalLabel label;
1500 aContainer.PackFrom( label );
1506 kiapi::schematic::types::LocalLabel label;
1508 if( !aContainer.UnpackTo( &label ) )
1549 return wxString::Format(
_(
"Label '%s'" ),
1556 return BITMAPS::add_line_label;
1564 m_shape = LABEL_FLAG_SHAPE::F_ROUND;
1623 if( ( aLeftRight && field.GetTextAngle().IsHorizontal() )
1624 || ( !aLeftRight && field.GetTextAngle().IsVertical() ) )
1640 field.SetTextPos( pos );
1668 field.SetPosition( pos );
1690 field.SetPosition( pos );
1696 std::vector<VECTOR2I>& aPoints,
1705 case LABEL_FLAG_SHAPE::F_DOT:
1706 symbolSize =
KiROUND( symbolSize * 0.7 );
1709 case LABEL_FLAG_SHAPE::F_ROUND:
1711 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1721 case LABEL_FLAG_SHAPE::F_DIAMOND:
1722 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1728 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1731 case LABEL_FLAG_SHAPE::F_RECTANGLE:
1732 symbolSize =
KiROUND( symbolSize * 0.8 );
1734 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1741 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1771 if(
m_shape == LABEL_FLAG_SHAPE::F_DIAMOND ||
m_shape == LABEL_FLAG_SHAPE::F_RECTANGLE )
1775 margin =
KiROUND( margin * 1.5 );
1781 if( field.GetText() == wxEmptyString )
1789 offset = { symbolWidth + margin, origin };
1794 offset = { -origin, -( symbolWidth + margin ) };
1799 offset = { symbolWidth + margin, -origin };
1804 offset = { origin, -( symbolWidth + margin ) };
1811 origin -= field.GetTextHeight() + margin;
1823 return _(
"Directive Label" );
1827 return wxString::Format(
_(
"Directive Label [%s %s]" ),
1869 m_shape = LABEL_FLAG_SHAPE::L_BIDI;
1876 m_fields.back().SetText( wxT(
"${INTERSHEET_REFS}" ) );
1877 m_fields.back().SetVisible(
false );
1907 m_fields.emplace_back(
this, aFieldType );
1927 case LABEL_FLAG_SHAPE::L_INPUT:
1928 case LABEL_FLAG_SHAPE::L_BIDI:
1929 case LABEL_FLAG_SHAPE::L_TRISTATE:
1933 case LABEL_FLAG_SHAPE::L_OUTPUT:
1934 case LABEL_FLAG_SHAPE::L_UNSPECIFIED:
1960 wxCHECK( aPath,
false );
1967 if( token->IsSameAs( wxT(
"INTERSHEET_REFS" ) ) )
1979 std::vector<int> pageListCopy;
1981 pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() );
1982 std::sort( pageListCopy.begin(), pageListCopy.end() );
1987 std::erase( pageListCopy, currentPage );
1994 ref.Append( wxString::Format( wxT(
"%s..%s" ),
1995 sheetPages[pageListCopy.front()],
1996 sheetPages[pageListCopy.back()] ) );
2000 for(
const int& pageNo : pageListCopy )
2001 ref.Append( wxString::Format( wxT(
"%s," ), sheetPages[pageNo] ) );
2003 if( !ref.IsEmpty() && ref.Last() ==
',' )
2029 std::vector<VECTOR2I>& aPoints,
2037 int x = symb_len + linewidth + 3;
2038 int y = halfSize + linewidth + 3;
2043 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
2044 aPoints.emplace_back(
VECTOR2I( 0, -y ) );
2045 aPoints.emplace_back(
VECTOR2I( -x, -y ) );
2046 aPoints.emplace_back(
VECTOR2I( -x, 0 ) );
2047 aPoints.emplace_back(
VECTOR2I( -x, y ) );
2048 aPoints.emplace_back(
VECTOR2I( 0, y ) );
2054 case LABEL_FLAG_SHAPE::L_INPUT:
2055 x_offset = -halfSize;
2056 aPoints[0].x += halfSize;
2059 case LABEL_FLAG_SHAPE::L_OUTPUT:
2060 aPoints[3].x -= halfSize;
2063 case LABEL_FLAG_SHAPE::L_BIDI:
2064 case LABEL_FLAG_SHAPE::L_TRISTATE:
2065 x_offset = -halfSize;
2066 aPoints[0].x += halfSize;
2067 aPoints[3].x -= halfSize;
2070 case LABEL_FLAG_SHAPE::L_UNSPECIFIED:
2078 aPoint.x += x_offset;
2092 aPoints.push_back( aPoints[0] );
2098 return wxString::Format(
_(
"Global Label '%s'" ),
2105 return BITMAPS::add_glabel;
2113 m_shape = LABEL_FLAG_SHAPE::L_INPUT;
2139 std::vector<VECTOR2I>& aPoints,
const VECTOR2I& aPos )
const
2146 std::vector<VECTOR2I>& aPoints,
const VECTOR2I& aPos,
2151 int imax = *Template;
2156 for(
int ii = 0; ii < imax; ii++ )
2159 corner.
x = ( halfSize * (*Template) ) + aPos.
x;
2162 corner.
y = ( halfSize * (*Template) ) + aPos.
y;
2165 aPoints.push_back( corner );
2245 return wxString::Format(
_(
"Hierarchical Label '%s'" ),
2252 return BITMAPS::add_hierarchical_label;
2263 wxSize sz( 320, 320 );
2265 dlg->SetMinSize( dlg->ConvertDialogToPixels( sz ) );
2283 if( labelShapeEnum.Choices().GetCount() == 0 )
2285 labelShapeEnum.Map( LABEL_SHAPE::LABEL_INPUT,
_HKI(
"Input" ) )
2286 .Map( LABEL_SHAPE::LABEL_OUTPUT,
_HKI(
"Output" ) )
2287 .Map( LABEL_SHAPE::LABEL_BIDI,
_HKI(
"Bidirectional" ) )
2288 .Map( LABEL_SHAPE::LABEL_TRISTATE,
_HKI(
"Tri-state" ) )
2289 .Map( LABEL_SHAPE::LABEL_PASSIVE,
_HKI(
"Passive" ) );
2314 auto hasLabelShape =
2325 .SetAvailableFunc( hasLabelShape );
2338 if( flagShapeEnum.Choices().GetCount() == 0 )
2340 flagShapeEnum.Map( FLAG_SHAPE::FLAG_DOT,
_HKI(
"Dot" ) )
2341 .Map( FLAG_SHAPE::FLAG_CIRCLE,
_HKI(
"Circle" ) )
2342 .Map( FLAG_SHAPE::FLAG_DIAMOND,
_HKI(
"Diamond" ) )
2343 .Map( FLAG_SHAPE::FLAG_RECTANGLE,
_HKI(
"Rectangle" ) );
2360 PROPERTY_DISPLAY::PT_SIZE ) );
2367 _HKI(
"Horizontal Justification" ) );
2369 _HKI(
"Vertical Justification" ) );
constexpr EDA_IU_SCALE schIUScale
BITMAPS
A list of all bitmap identifiers.
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
constexpr int GetSizeMax() const
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 void SetOrigin(const Vec &pos)
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
constexpr size_type GetWidth() const
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
constexpr bool Contains(const Vec &aPoint) const
constexpr const Vec & GetOrigin() const
constexpr void SetEnd(coord_type x, coord_type y)
constexpr void Offset(coord_type dx, coord_type dy)
constexpr bool Intersects(const BOX2< Vec > &aRect) const
static std::vector< DANGLING_END_ITEM >::iterator get_lower_type(std::vector< DANGLING_END_ITEM > &aItemListByType, const DANGLING_END_T &aType)
static std::vector< DANGLING_END_ITEM >::iterator get_lower_pos(std::vector< DANGLING_END_ITEM > &aItemListByPos, const VECTOR2I &aPos)
Helper class used to store the state of schematic items that can be connected to other schematic item...
DANGLING_END_T GetType() const
EDA_ITEM * GetItem() const
VECTOR2I GetPosition() const
The base class for create windows for drawing purpose.
KICAD_T Type() const
Returns the type of object.
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
virtual void SetParent(EDA_ITEM *aParent)
EDA_ITEM * m_parent
Owner.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
int GetTextHeight() const
const VECTOR2I & GetTextPos() const
COLOR4D GetTextColor() const
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
void SetTextPos(const VECTOR2I &aPoint)
KIFONT::FONT * GetFont() const
BOX2I GetTextBox(const RENDER_SETTINGS *aSettings, int aLine=-1) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
GR_TEXT_H_ALIGN_T GetHorizJustify() const
bool Replace(const EDA_SEARCH_DATA &aSearchData)
Helper function used in search and replace dialog.
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
static wxString GotoPageHref(const wxString &aDestination)
Generate a href to a page in the current schematic.
virtual void cacheShownText()
const TEXT_ATTRIBUTES & GetAttributes() const
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
virtual void SetText(const wxString &aText)
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
void SetMultilineAllowed(bool aAllow)
VECTOR2I GetTextSize() const
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
static ENUM_MAP< T > & Instance()
void SetDialogSizeInDU(int aWidth, int aHeight)
Set the dialog size, using a "logical" value.
void AddHTML_Text(const wxString &message)
Add HTML text (without any change) to message list.
void ShowModeless()
Show a modeless version of the dialog (without an OK button).
Class that other classes need to inherit from, in order to be inspectable.
FONT is an abstract base class for both outline and stroke fonts.
A color representation with 4 components: red, green, blue, alpha.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
int GetMinPenWidth() const
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
std::string AsStdString() const
Base plotter engine class.
virtual void FilledCircle(const VECTOR2I &pos, int diametre, void *aData)
void MoveTo(const VECTOR2I &pos)
RENDER_SETTINGS * RenderSettings()
virtual void Bookmark(const BOX2I &aBox, const wxString &aName, const wxString &aGroupName=wxEmptyString)
Create a bookmark to a symbol.
virtual void HyperlinkBox(const BOX2I &aBox, const wxString &aDestinationURL)
Create a clickable hyperlink with a rectangular click area.
bool GetColorMode() const
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
void LineTo(const VECTOR2I &pos)
virtual void PlotText(const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttributes, KIFONT::FONT *aFont=nullptr, const KIFONT::METRICS &aFontMetrics=KIFONT::METRICS::Default(), void *aData=nullptr)
virtual void PlotPoly(const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth, void *aData)=0
Draw a polygon ( filled or not ).
virtual void HyperlinkMenu(const BOX2I &aBox, const std::vector< wxString > &aDestURLs)
Create a clickable hyperlink menu with a rectangular click area.
virtual void ThickCircle(const VECTOR2I &pos, int diametre, int width, void *aData)
virtual void SetColor(const COLOR4D &color)=0
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.
void Mask(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName)
Sets a base class property as masked in a derived class.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
These are loaded from Eeschema settings but then overwritten by the project settings.
wxString m_IntersheetRefsPrefix
wxString m_IntersheetRefsSuffix
bool m_IntersheetRefsFormatShort
bool m_IntersheetRefsListOwnPage
Holds all the data relating to one schematic.
wxString GetOperatingPoint(const wxString &aNetName, int aPrecision, const wxString &aRange)
SCHEMATIC_SETTINGS & Settings() const
std::map< wxString, std::set< int > > & GetPageRefsMap()
std::map< int, wxString > GetVirtualPageToSheetPagesMap() const
std::map< int, wxString > GetVirtualPageToSheetNamesMap() const
SCH_SHEET_PATH & CurrentSheet() const
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
wxString GetNetName() const
const std::vector< std::shared_ptr< SCH_CONNECTION > > AllMembers() const
wxString LocalName() const
wxString Name(bool aIgnoreSheet=false) const
void AppendInfoToMsgPanel(std::vector< MSG_PANEL_ITEM > &aList) const
Adds information about the connection object to aList.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
void MirrorSpinStyle(bool aLeftRight) override
void RemoveConnectedRuleArea(SCH_RULE_AREA *aRuleArea)
Removes a specific rule area from the cache.
void ClearConnectedRuleAreas()
Removes all rule areas from the cache.
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
SCH_DIRECTIVE_LABEL(const VECTOR2I &aPos=VECTOR2I(0, 0))
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void CreateGraphicShape(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
Calculate the graphic shape (a polygon) associated to the text.
FLAG_SHAPE GetFlagShape() const
int GetPenWidth() const override
std::unordered_set< SCH_RULE_AREA * > m_connected_rule_areas
Cache of any rule areas with borders which this label connects to.
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
void SetPinLength(int aLength)
virtual bool IsDangling() const override
Determines dangling state from connectivity and cached connected rule areas.
void AddConnectedRuleArea(SCH_RULE_AREA *aRuleArea)
Adds an entry to the connected rule area cache.
void SetFlagShape(FLAG_SHAPE aShape)
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
const std::unordered_set< SCH_RULE_AREA * > GetConnectedRuleAreas() const
Schematic editor (Eeschema) main window.
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this label.
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
void CreateGraphicShape(const RENDER_SETTINGS *aRenderSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
Calculate the graphic shape (a polygon) associated to the text.
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth) const override
Resolve any references to system tokens supported by the label.
VECTOR2I GetSchematicTextOffset(const RENDER_SETTINGS *aSettings) const override
This offset depends on the orientation, the type of text, and the area required to draw the associate...
void SetSpinStyle(SPIN_STYLE aSpinStyle) override
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
SCH_GLOBALLABEL(const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString)
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
const BOX2I GetBodyBoundingBox(const RENDER_SETTINGS *aSettings) const override
Return the bounding box of the label only, without taking in account its fields.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void SetSpinStyle(SPIN_STYLE aSpinStyle) override
void CreateGraphicShape(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &aPos) const override
Calculate the graphic shape (a polygon) associated to the text.
SCH_HIERLABEL(const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString, KICAD_T aType=SCH_HIER_LABEL_T)
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
VECTOR2I GetSchematicTextOffset(const RENDER_SETTINGS *aSettings) const override
This offset depends on the orientation, the type of text, and the area required to draw the associate...
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual bool IsConnectable() const
SCH_ITEM & operator=(const SCH_ITEM &aPin)
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
void AddConnectionTo(const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
Add a connection link between this item and another.
std::shared_ptr< NETCLASS > GetEffectiveNetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
bool IsConnectivityDirty() const
AUTOPLACE_ALGO m_fieldsAutoplaced
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
const KIFONT::METRICS & GetFontMetrics() const
std::map< SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
bool operator==(const SCH_ITEM &aItem) const override
const wxString & GetCachedDriverName() const override
SCH_LABEL_BASE(const VECTOR2I &aPos, const wxString &aText, KICAD_T aType)
COLOR4D m_lastResolvedColor
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const override
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
bool HasCachedDriverName() const override
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
bool AutoRotateOnPlacement() const
autoRotateOnPlacement
SCH_LABEL_BASE & operator=(const SCH_LABEL_BASE &aLabel)
std::vector< SCH_FIELD > m_fields
CONNECTION_TYPE m_connectionType
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
int GetNextFieldOrdinal() const
Return the next ordinal for a user field for this label.
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 SetLabelShape(LABEL_SHAPE aShape)
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
SPIN_STYLE GetSpinStyle() const
void GetIntersheetRefs(const SCH_SHEET_PATH *aPath, std::vector< std::pair< wxString, wxString > > *pages)
Build an array of { pageNumber, pageName } pairs.
void MirrorSpinStyle(bool aLeftRight) override
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
COLOR4D GetLabelColor() const
LABEL_FLAG_SHAPE GetShape() const
const BOX2I GetBoundingBox() const override
Return the bounding box of the label including its fields.
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void SetPosition(const VECTOR2I &aPosition) override
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
virtual bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth) const
Resolve any references to system tokens supported by the label.
LABEL_SHAPE GetLabelShape() const
void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override
bool m_autoRotateOnPlacement
wxString m_cached_driver_name
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
int GetLabelBoxExpansion(const RENDER_SETTINGS *aSettings=nullptr) const
bool IncrementLabel(int aIncrement)
Increment the label text if it ends with a number.
void SetAutoRotateOnPlacement(bool autoRotate=true)
void cacheShownText() override
void Rotate90(bool aClockwise) override
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.
static const wxString GetDefaultFieldName(const wxString &aName, bool aUseDefaultName)
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
void GetContextualTextVars(wxArrayString *aVars) const
Return the list of system text vars & fields for this label.
virtual const BOX2I GetBodyBoundingBox(const RENDER_SETTINGS *aSettings) const
Return the bounding box of the label only, without taking in account its fields.
virtual void CreateGraphicShape(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPoints, const VECTOR2I &Pos) const
Calculate the graphic shape (a polygon) associated to the text.
std::vector< SCH_FIELD > & GetFields()
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.
VECTOR2I GetSchematicTextOffset(const RENDER_SETTINGS *aSettings) const override
This offset depends on the orientation, the type of text, and the area required to draw the associate...
virtual void SetSpinStyle(SPIN_STYLE aSpinStyle)
bool Replace(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) override
Perform a text replace using the find and replace criteria in aSearchData on items that support text ...
double Similarity(const SCH_ITEM &aItem) const override
Return a measure of how likely the other object is to represent the same object.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
const BOX2I GetBodyBoundingBox(const RENDER_SETTINGS *aSettings) const override
Return the bounding box of the label only, without taking in account its fields.
SCH_LABEL(const VECTOR2I &aPos=VECTOR2I(0, 0), const wxString &aText=wxEmptyString)
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
size_t size() const
Forwarded method from std::vector.
int GetVirtualPageNumber() const
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const override
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
static HTML_MESSAGE_BOX * ShowSyntaxHelp(wxWindow *aParentWindow)
VECTOR2I GetPosition() const override
virtual void Rotate90(bool aClockwise)
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
double Similarity(const SCH_ITEM &aItem) const override
Return a measure of how likely the other object is to represent the same object.
int GetPenWidth() const override
virtual void MirrorSpinStyle(bool aLeftRight)
bool operator==(const SCH_ITEM &aItem) const override
int GetTextOffset(const RENDER_SETTINGS *aSettings=nullptr) const
SPIN_STYLE MirrorX()
Mirror the label spin style across the X axis or simply swaps up and bottom.
SPIN_STYLE MirrorY()
Mirror the label spin style across the Y axis or simply swaps left and right.
unsigned CCWRotationsTo(const SPIN_STYLE &aOther) const
Get CCW rotation needed to get to the given spin style.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
#define DEFAULT_LABEL_SIZE_RATIO
The offset of the pin name string from the end of the pin in mils.
#define DANGLING_SYMBOL_SIZE
The size of the rectangle indicating an unconnected wire or label.
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_VERTICAL
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
static constexpr EDA_ANGLE ANGLE_270
static constexpr EDA_ANGLE ANGLE_180
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
KICOMMON_API bool IncrementString(wxString &name, int aIncrement)
Generic string incrementer.
@ LAYER_SELECTION_SHADOWS
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
constexpr T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Message panel definition file.
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
const SCH_FIELD * FindField(const std::vector< SCH_FIELD > &aFields, FIELD_T aFieldId)
int NextFieldOrdinal(const std::vector< SCH_FIELD > &aFields)
std::vector< SCH_ITEM * > SCH_ITEM_VEC
static int TemplateIN_HI[]
static int TemplateUNSPC_HI[]
static int TemplateOUT_HN[]
static int Template3STATE_HN[]
static int TemplateBIDI_HN[]
static int * TemplateShape[5][4]
static int TemplateIN_HN[]
static int TemplateIN_BOTTOM[]
static int TemplateUNSPC_HN[]
static int Template3STATE_BOTTOM[]
static int TemplateBIDI_BOTTOM[]
static struct SCH_LABEL_DESC _SCH_LABEL_DESC
static int Template3STATE_UP[]
static int TemplateOUT_UP[]
static int TemplateOUT_HI[]
static int TemplateUNSPC_UP[]
static int TemplateUNSPC_BOTTOM[]
static int TemplateOUT_BOTTOM[]
static int Template3STATE_HI[]
static int TemplateIN_UP[]
wxString getElectricalTypeLabel(LABEL_FLAG_SHAPE aType)
static int TemplateBIDI_UP[]
static int TemplateBIDI_HI[]
static struct SCH_DIRECTIVE_LABEL_DESC _SCH_DIRECTIVE_LABEL_DESC
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
void ConvertMarkdown2Html(const wxString &aMarkdownInput, wxString &aHtmlOutput)
constexpr int MilsToIU(int mils) const
SCH_DIRECTIVE_LABEL_DESC()
bool m_PDFHierarchicalLinks
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
bool TestSegmentHit(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
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.
@ SCH_LABEL_LOCATE_WIRE_T
VECTOR2< int32_t > VECTOR2I