51#include <magic_enum.hpp>
54#include <api/schematic/schematic_types.pb.h>
64static int TemplateIN_HN[] = { 6, 0, 0, -1, -1, -2, -1, -2, 1, -1, 1, 0, 0 };
65static int TemplateIN_HI[] = { 6, 0, 0, 1, 1, 2, 1, 2, -1, 1, -1, 0, 0 };
66static int TemplateIN_UP[] = { 6, 0, 0, 1, -1, 1, -2, -1, -2, -1, -1, 0, 0 };
67static int TemplateIN_BOTTOM[] = { 6, 0, 0, 1, 1, 1, 2, -1, 2, -1, 1, 0, 0 };
69static int TemplateOUT_HN[] = { 6, -2, 0, -1, 1, 0, 1, 0, -1, -1, -1, -2, 0 };
70static int TemplateOUT_HI[] = { 6, 2, 0, 1, -1, 0, -1, 0, 1, 1, 1, 2, 0 };
71static int TemplateOUT_UP[] = { 6, 0, -2, 1, -1, 1, 0, -1, 0, -1, -1, 0, -2 };
72static int TemplateOUT_BOTTOM[] = { 6, 0, 2, 1, 1, 1, 0, -1, 0, -1, 1, 0, 2 };
74static int TemplateUNSPC_HN[] = { 5, 0, -1, -2, -1, -2, 1, 0, 1, 0, -1 };
75static int TemplateUNSPC_HI[] = { 5, 0, -1, 2, -1, 2, 1, 0, 1, 0, -1 };
76static int TemplateUNSPC_UP[] = { 5, 1, 0, 1, -2, -1, -2, -1, 0, 1, 0 };
77static int TemplateUNSPC_BOTTOM[] = { 5, 1, 0, 1, 2, -1, 2, -1, 0, 1, 0 };
79static int TemplateBIDI_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 };
80static int TemplateBIDI_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 };
81static int TemplateBIDI_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 };
82static int TemplateBIDI_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 };
84static int Template3STATE_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 };
85static int Template3STATE_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 };
86static int Template3STATE_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 };
87static int Template3STATE_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 };
105 default:
return wxT(
"???" );
160 return ( ( (
int)
m_spin - (
int) aOther.
m_spin ) % 4 + 4 ) % 4;
193 field.SetParent(
this );
204 field.SetParent(
this );
219 if( aName == wxT(
"Intersheetrefs" ) )
220 return _(
"Sheet References" );
221 else if( aName == wxT(
"Netclass" ) )
222 return _(
"Net Class" );
223 else if( aName.IsEmpty() && aUseDefaultName )
244 for(
KICAD_T scanType : aScanTypes )
250 wxCHECK_MSG(
Schematic(),
false, wxT(
"No parent SCHEMATIC set for SCH_LABEL!" ) );
259 for(
KICAD_T scanType : aScanTypes )
263 for(
SCH_ITEM* connection : item_set )
265 if( connection->IsType( wireAndPinTypes ) )
272 for(
SCH_ITEM* connection : item_set )
274 if( connection->IsType( busTypes ) )
293 field.SetParent(
this );
320 static bool s_inUpdate =
false;
353 pin->SetLabelShape( aShape );
366 const wxString&
text =
pin->GetText();
382 if( other !=
pin && other->GetText() ==
text )
383 other->SetLabelShape( aShape );
476 field.Offset( aMoveVector );
491 field.SetTextPos( field.GetTextPos() + offset );
517 if( ( aLeftRight && field.GetTextAngle().IsHorizontal() )
518 || ( !aLeftRight && field.GetTextAngle().IsVertical() ) )
534 field.SetTextPos( pos );
547 field.FlipHJustify();
553 field.SetPosition( pos );
566 field.FlipHJustify();
572 field.SetPosition( pos );
604 for(
size_t ii = 0; ii <
m_fields.size(); ++ii )
626 if(
typeid( *
this ) !=
typeid( aOther ) )
632 for(
size_t ii = 0; ii <
m_fields.size(); ++ii )
642 similarity *= std::pow( 0.9, diff );
669 offset.
x = -( labelLen + margin );
671 offset.
y = accumulated + field.GetTextHeight() / 2;
680 offset.
y = -( labelLen + margin );
682 offset.
x = accumulated + field.GetTextHeight() / 2;
691 offset.
x = labelLen + margin;
693 offset.
y = accumulated + field.GetTextHeight() / 2;
702 offset.
y = labelLen + margin;
704 offset.
x = accumulated + field.GetTextHeight() / 2;
712 accumulated += field.GetTextHeight() + margin;
732 std::vector<int> pageListCopy;
734 pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() );
736 if( !
Schematic()->Settings().m_IntersheetRefsListOwnPage )
738 int currentPage =
path.GetVirtualPageNumber();
739 std::erase( pageListCopy, currentPage );
741 if( pageListCopy.empty() )
745 std::sort( pageListCopy.begin(), pageListCopy.end() );
750 for(
int pageNum : pageListCopy )
751 pages->push_back( { sheetPages[pageNum], sheetNames[pageNum] } );
761 if( field.IsMandatory() )
762 aVars->push_back( field.GetUntranslatedName().Upper() );
764 aVars->push_back( field.GetName() );
767 aVars->push_back( wxT(
"OP" ) );
768 aVars->push_back( wxT(
"CONNECTION_TYPE" ) );
769 aVars->push_back( wxT(
"SHORT_NET_NAME" ) );
770 aVars->push_back( wxT(
"NET_NAME" ) );
771 aVars->push_back( wxT(
"NET_CLASS" ) );
779 thread_local wxRegEx operatingPoint( wxT(
"^"
781 "(.([0-9])?([a-zA-Z]*))?"
784 wxCHECK( aPath,
false );
793 if( operatingPoint.Matches( *token ) )
796 wxString precisionStr( operatingPoint.GetMatch( *token, 2 ) );
797 wxString range( operatingPoint.GetMatch( *token, 3 ) );
799 if( !precisionStr.IsEmpty() )
800 precision = precisionStr[0] -
'0';
802 if( range.IsEmpty() )
811 if( token->Contains(
':' ) )
818 && token->IsSameAs( wxT(
"CONNECTION_TYPE" ) ) )
824 else if( token->IsSameAs( wxT(
"SHORT_NET_NAME" ) ) )
830 else if( token->IsSameAs( wxT(
"NET_NAME" ) ) )
836 else if( token->IsSameAs( wxT(
"NET_CLASS" ) ) )
845 *token = wxEmptyString;
849 if( ruleArea->GetExcludedFromBOM( aPath, variant ) )
850 *token = wxS(
"Excluded from BOM" );
858 *token = wxEmptyString;
862 if( ruleArea->GetExcludedFromBoard( aPath, variant ) )
863 *token = wxS(
"Excluded from board" );
871 *token = wxEmptyString;
875 if( ruleArea->GetExcludedFromSim( aPath, variant ) )
876 *token = wxS(
"Excluded from simulation" );
884 *token = wxEmptyString;
888 if( ruleArea->GetDNP( aPath, variant ) )
889 *token = wxS(
"DNP" );
897 if( token->IsSameAs( field.GetName() ) )
899 *token = field.GetShownText( aPath,
INTERNAL, variant, aDepth + 1 );
916 if(
path.Last() != sheet )
917 path.push_back( sheet );
960 std::function<bool( wxString* )> textResolver =
961 [&]( wxString* token ) ->
bool
998 if( connection->
IsBus() )
1002 std::set<wxString> netNames;
1004 for( std::shared_ptr<SCH_CONNECTION> member : allMembers )
1005 netNames.insert( member->GetNetName() );
1007 for(
const wxString& netName : netNames )
1038 if(
IsType( aScanTypes ) )
1044 for(
KICAD_T scanType : aScanTypes )
1063 aItemList.push_back( item );
1099 std::vector<VECTOR2I> pts;
1120 if( field.IsVisible() && field.GetText() != wxEmptyString )
1122 BOX2I fieldBBox = field.GetBoundingBox();
1127 box.
Merge( fieldBBox );
1147 if( field.IsVisible() )
1149 BOX2I fieldBBox = field.GetBoundingBox();
1150 fieldBBox.
Inflate( aAccuracy );
1155 if( fieldBBox.
Contains( aPosition ) )
1181 if( field.IsVisible() )
1183 BOX2I fieldBBox = field.GetBoundingBox();
1211 if( field.IsVisible() )
1213 BOX2I fieldBBox = field.GetBoundingBox();
1229 std::vector<DANGLING_END_ITEM>& aItemListByPos,
const SCH_SHEET_PATH* aPath )
1233 bool pinOrNoConnect =
false;
1238 it < aItemListByPos.end() && it->GetPosition() == text_pos; it++ )
1249 pinOrNoConnect =
true;
1264 if( pinOrNoConnect )
1270 if( !pinOrNoConnect )
1273 it < aItemListByType.end() && it->GetType() ==
BUS_END; it++ )
1292 sch_item->AddConnectionTo( *aPath,
this );
1301 it < aItemListByType.end() && it->GetType() ==
WIRE_END; it++ )
1320 sch_item->AddConnectionTo( *aPath,
this );
1344 wxCHECK( label,
false );
1352 std::vector<wxString> netclasses;
1353 std::vector<wxString> otherNetclasses;
1357 if( field.GetUntranslatedName() == wxT(
"Netclass" ) )
1358 netclasses.push_back( field.GetText() );
1364 otherNetclasses.push_back( field.
GetText() );
1367 return netclasses != otherNetclasses;
1392 aList.emplace_back(
_(
"Font" ),
GetFont() ?
GetFont()->GetName() :
_(
"Default" ) );
1394 wxString textStyle[] = {
_(
"Normal" ),
_(
"Italic" ),
_(
"Bold" ),
_(
"Bold Italic" ) };
1396 aList.emplace_back(
_(
"Style" ), textStyle[style] );
1406 default: msg = wxT(
"???" );
break;
1409 aList.emplace_back(
_(
"Justification" ), msg );
1417 int aBodyStyle,
const VECTOR2I& aOffset,
bool aDimmed )
1419 static std::vector<VECTOR2I> s_poly;
1441 color = color.
Mix( bg, 0.5f );
1478 shapeColor = shapeColor.
Mix( bg, 0.5f );
1486 aPlotter->
MoveTo( s_poly[0] );
1487 aPlotter->
LineTo( s_poly[1] );
1490 int diameter = ( s_poly[2] - s_poly[1] ).EuclideanNorm() * 2;
1491 aPlotter->
FilledCircle( s_poly[2], diameter,
nullptr );
1495 aPlotter->
MoveTo( s_poly[0] );
1496 aPlotter->
LineTo( s_poly[1] );
1499 int diameter = ( s_poly[2] - s_poly[1] ).EuclideanNorm() * 2;
1500 aPlotter->
ThickCircle( s_poly[2], diameter, penWidth,
nullptr );
1504 if( !s_poly.empty() )
1509 bool linkAlreadyPlotted =
false;
1516 if( sheet->
size() >= 2 )
1521 linkAlreadyPlotted =
true;
1528 path.push_back( parent );
1530 linkAlreadyPlotted =
true;
1537 std::vector<wxString> properties;
1541 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
_(
"Net" ), connection->
Name() ) );
1543 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
_(
"Resolved netclass" ),
1549 properties.emplace_back( wxString::Format( wxT(
"!%s = %s" ),
1551 field.GetShownText(
FOR_GUI ) ) );
1554 if( !properties.empty() )
1563 field.Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed );
1588template<
typename LabelProto>
1595 aOutput.set_locked( aLabel.
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
1596 : kiapi::common::types::LockedState::LS_UNLOCKED );
1598 aLabel.EDA_TEXT::Serialize( *aOutput.mutable_text(),
schIUScale );
1604 if( field.IsMandatory() )
1607 field.Serialize( *aOutput.add_fields(),
schIUScale );
1612template<
typename LabelProto>
1617 const_cast<KIID&
>( aLabel.
m_Uuid ) =
KIID( aInput.id().value() );
1618 aLabel.
SetLocked( aInput.locked() == kiapi::common::types::LockedState::LS_LOCKED );
1620 if( !aLabel.EDA_TEXT::Deserialize( aInput.text(),
schIUScale ) )
1628 for(
const types::SchematicField& field : aInput.fields() )
1640 kiapi::schematic::types::LocalLabel label;
1645 aContainer.PackFrom( label );
1651 kiapi::schematic::types::LocalLabel label;
1653 if( !aContainer.UnpackTo( &label ) )
1737 ruleArea->RemoveDirective(
this );
1743 kiapi::schematic::types::DirectiveLabel label;
1751 aContainer.PackFrom( label );
1757 kiapi::schematic::types::DirectiveLabel label;
1759 if( !aContainer.UnpackTo( &label ) )
1769 if( label.has_pin_length() )
1772 if( label.has_symbol_size() )
1781 if( !SCH_LABEL_BASE::operator==( aOther ) )
1813 if( ( aLeftRight && field.GetTextAngle().IsHorizontal() )
1814 || ( !aLeftRight && field.GetTextAngle().IsVertical() ) )
1830 field.SetTextPos( pos );
1858 field.SetPosition( pos );
1880 field.SetPosition( pos );
1898 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1909 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1915 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1919 symbolSize =
KiROUND( symbolSize * 0.8 );
1921 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1928 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
1961 margin =
KiROUND( margin * 1.5 );
1967 if( field.GetText() == wxEmptyString )
1975 offset = { symbolWidth + margin, origin };
1980 offset = { -origin, -( symbolWidth + margin ) };
1985 offset = { symbolWidth + margin, -origin };
1990 offset = { origin, -( symbolWidth + margin ) };
1997 origin -= field.GetTextHeight() + margin;
2009 return _(
"Directive Label" );
2016 if( content.IsEmpty() )
2057 if( field.GetUntranslatedName() == wxT(
"Netclass" ) || field.GetUntranslatedName() == wxT(
"Component Class" ) )
2059 wxString
text = field.GetText();
2063 field.SetText(
text );
2084 m_fields.back().SetText( wxT(
"${INTERSHEET_REFS}" ) );
2085 m_fields.back().SetVisible(
false );
2101 types::GlobalLabel label;
2103 label.mutable_id()->set_value(
m_Uuid.AsStdString() );
2105 label.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
2106 : kiapi::common::types::LockedState::LS_UNLOCKED );
2116 if( field.IsMandatory() )
2119 field.Serialize( *label.add_fields(),
schIUScale );
2123 field->Serialize( *label.mutable_intersheet_refs_field(),
schIUScale );
2125 aContainer.PackFrom( label );
2131 kiapi::schematic::types::GlobalLabel label;
2133 if( !aContainer.UnpackTo( &label ) )
2144 if( label.has_intersheet_refs_field() )
2156 m_fields.emplace_back(
this, aFieldType );
2207 wxCHECK( aPath,
false );
2214 if( token->IsSameAs( wxT(
"INTERSHEET_REFS" ) ) )
2217 std::map<wxString, std::set<int>>& pageRefs =
schematic->GetPageRefsMap();
2219 auto it = pageRefs.end();
2226 if( it == pageRefs.end() )
2232 std::vector<int> pageListCopy;
2234 pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() );
2235 std::sort( pageListCopy.begin(), pageListCopy.end() );
2240 std::erase( pageListCopy, currentPage );
2243 std::map<int, wxString> sheetPages =
schematic->GetVirtualPageToSheetPagesMap();
2247 ref.Append( wxString::Format( wxT(
"%s..%s" ),
2248 sheetPages[pageListCopy.front()],
2249 sheetPages[pageListCopy.back()] ) );
2253 for(
const int& pageNo : pageListCopy )
2254 ref.Append( wxString::Format( wxT(
"%s," ), sheetPages[pageNo] ) );
2256 if( !ref.IsEmpty() && ref.Last() ==
',' )
2284 int x = symb_len + linewidth + 3;
2285 int y = halfSize + linewidth + 3;
2290 aPoints.emplace_back(
VECTOR2I( 0, 0 ) );
2291 aPoints.emplace_back(
VECTOR2I( 0, -y ) );
2292 aPoints.emplace_back(
VECTOR2I( -x, -y ) );
2293 aPoints.emplace_back(
VECTOR2I( -x, 0 ) );
2294 aPoints.emplace_back(
VECTOR2I( -x, y ) );
2295 aPoints.emplace_back(
VECTOR2I( 0, y ) );
2302 x_offset = -halfSize;
2303 aPoints[0].x += halfSize;
2310 x_offset = -halfSize;
2311 aPoints[0].x += halfSize;
2312 aPoints[3].x -= halfSize;
2322 aPoint.x += x_offset;
2336 aPoints.push_back( aPoints[0] );
2364 kiapi::schematic::types::HierarchicalLabel label;
2370 aContainer.PackFrom( label );
2376 kiapi::schematic::types::HierarchicalLabel label;
2378 if( !aContainer.UnpackTo( &label ) )
2411 int imax = *Template;
2416 for(
int ii = 0; ii < imax; ii++ )
2419 corner.
x = ( halfSize * ( *Template ) ) + aPos.
x;
2422 corner.
y = ( halfSize * ( *Template ) ) + aPos.
y;
2425 aPoints.push_back( corner );
2523 wxSize sz( 320, 320 );
2525 dlg->SetMinSize( dlg->ConvertDialogToPixels( sz ) );
2543 if( labelShapeEnum.Choices().GetCount() == 0 )
2574 auto hasLabelShape = [](
INSPECTABLE* aItem ) ->
bool
2597 if( flagShapeEnum.Choices().GetCount() == 0 )
KICOMMON_API types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICOMMON_API KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
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 const COLOR4D WHITE
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
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.
EDA_ITEM * GetParent() const
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,...
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
virtual VECTOR2I GetTextSize() const
COLOR4D GetTextColor() const
virtual VECTOR2I GetTextPos() const
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual void SetTextPos(const VECTOR2I &aPoint)
virtual void SetTextX(int aX)
virtual int GetTextHeight() const
KIFONT::FONT * GetFont() const
virtual void SetTextY(int aY)
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,...
virtual wxString GetShownText(RESOLUTION_CONTEXT aContext, int aDepth=0) const
Return the string actually shown after processing of the base text.
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
virtual int GetTextWidth() const
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()
virtual EDA_ANGLE GetTextAngle() const
const TEXT_ATTRIBUTES & GetAttributes() const
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
virtual void SetText(const wxString &aText)
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
void SetMultilineAllowed(bool aAllow)
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
EE_TYPE OfType(KICAD_T aType) const
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.
std::shared_ptr< wxString > m_text
COLOR4D & Desaturate()
Removes color (in HSL model)
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Return a color that is mixed with the input by a factor.
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.
virtual const COLOR4D & GetBackgroundColor() const =0
Return current background color settings.
std::string AsStdString() const
const wxString GetName() const
Gets the name of this (maybe aggregate) netclass in a format for internal usage or for export to exte...
COLOR4D GetSchematicColor(bool aIsForSave=false) 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
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
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()
wxString GetCurrentVariant() const
Return the current variant being edited.
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 Name(bool aIgnoreSheet=false) const
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.
~SCH_DIRECTIVE_LABEL() override
bool operator==(const SCH_ITEM &aOther) const override
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
bool IncrementLabel(int aIncrement) override
Increment the netclass and component class labels if possible.
const std::unordered_set< SCH_RULE_AREA * > GetConnectedRuleAreas() const
Schematic editor (Eeschema) main window.
virtual const wxString & GetText() const override
Return the string associated with the text object.
wxString GetUntranslatedName() const
Get the untranslated field name for storage, variable look-up, etc.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
wxString GetShownText(const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, const wxString &aVariantName=wxEmptyString, int aDepth=0) const
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this label.
std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
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...
virtual bool IsConnectable() const
void SetLocked(bool aLocked) override
SCH_ITEM & operator=(const SCH_ITEM &aPin)
std::map< SCH_SHEET_PATH, std::vector< SCH_ITEM * >, SHEET_PATH_CMP > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
bool IsLocked() const override
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
void SetFieldsAutoplaced(AUTOPLACE_ALGO aAlgo)
bool IsConnectivityDirty() const
std::optional< wxString > GetConnectionName(const SCH_SHEET_PATH *aSheet=nullptr, bool aLocal=false, bool aIgnoreSheet=false) const
Return the connection name for this sheet instance, if connected.
AUTOPLACE_ALGO m_fieldsAutoplaced
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
AUTOPLACE_ALGO GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
wxString ResolveText(const wxString &aText, const SCH_SHEET_PATH *aPath, int aDepth=0) const
const KIFONT::METRICS & GetFontMetrics() const
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
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
void SetShape(LABEL_FLAG_SHAPE aShape)
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
virtual 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)
wxString GetShownText(const SCH_SHEET_PATH *aPath, RESOLUTION_CONTEXT aContext, int aDepth=0) const override
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.
std::vector< SCH_SHEET_PATH > & GetClientSheetPaths()
Return the number of times this screen is used.
EE_RTREE & Items()
Get the full RTree, usually for iterating.
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
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.
SCH_SCREEN * GetScreen() const
std::vector< SCH_SHEET_PIN * > & GetPins()
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
SCH_TEXT(const VECTOR2I &aPos={ 0, 0 }, const wxString &aText=wxEmptyString, SCH_LAYER_ID aLayer=LAYER_NOTES, KICAD_T aType=SCH_TEXT_T)
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
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().
void FinalizeTextVarExpansion(wxString &aText, RESOLUTION_CONTEXT aContext)
wxString ResolveTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aResolver, int &aDepth)
Multi-pass text variable expansion and math expression evaluation.
#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.
a few functions useful in geometry calculations.
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.
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.
std::optional< wxString > AppendConnectionInfo(const SCH_ITEM &aItem, std::vector< MSG_PANEL_ITEM > &aList, const SCH_SHEET_PATH *aPath=nullptr)
Append connection details; return its name for a signal, or no value for a bus/missing row.
KICOMMON_API int UnpackDistance(const types::Distance &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackCustomProperties(google::protobuf::RepeatedPtrField< types::CustomProperty > *aOutput, const EDA_ITEM &aItem)
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackDistance(types::Distance &aOutput, int aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput, const EDA_IU_SCALE &aScale)
KICOMMON_API void UnpackCustomProperties(const google::protobuf::RepeatedPtrField< types::CustomProperty > &aInput, EDA_ITEM &aItem)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
@ PT_SIZE
Size expressed in distance units (mm/inch)
@ BUS
This item represents a bus vector.
@ NET
This item represents a net.
@ NONE
No connection to this item.
const SCH_FIELD * FindField(const std::vector< SCH_FIELD > &aFields, FIELD_T aFieldId)
int NextFieldOrdinal(const std::vector< SCH_FIELD > &aFields)
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[]
bool unpackLabel(const LabelProto &aInput, SCH_LABEL_BASE &aLabel)
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[]
void packLabel(LabelProto &aOutput, const SCH_LABEL_BASE &aLabel)
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)
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...
@ USER
The field ID hasn't been set yet; field is invalid.
@ INTERSHEET_REFS
Global label cross-reference page numbers.
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