44#define PIN_TEXT_MARGIN 4
52 static const wxChar* msgPinElectricType[] =
56 wxT(
"bidirectional" ),
63 wxT(
"open_collector" ),
64 wxT(
"open_emitter" ),
68 return msgPinElectricType[
static_cast<int>( aType )];
103 m_position( { 0, 0 } ),
108 m_isDangling(
true ),
109 m_layoutCache( std::make_unique<PIN_LAYOUT_CACHE>( *
this ) )
137 int aNameTextSize,
int aNumTextSize,
int aBodyStyle,
const VECTOR2I& aPos,
143 m_orientation( aOrientation ),
147 m_numTextSize( aNumTextSize ),
148 m_nameTextSize( aNameTextSize ),
149 m_isDangling( true ),
165 m_isDangling( true ),
168 wxASSERT( aParentSymbol );
183 const KIID& aUuid ) :
191 m_isDangling( true ),
194 wxASSERT( aParentSymbol );
203 m_libPin( aPin.m_libPin ),
204 m_alternates( aPin.m_alternates ),
205 m_position( aPin.m_position ),
206 m_length( aPin.m_length ),
207 m_orientation( aPin.m_orientation ),
208 m_shape( aPin.m_shape ),
209 m_type( aPin.m_type ),
210 m_hidden( aPin.m_hidden ),
211 m_numTextSize( aPin.m_numTextSize ),
212 m_nameTextSize( aPin.m_nameTextSize ),
214 m_isDangling( aPin.m_isDangling ),
255 return symbol->GetTransform().TransformCoordinate(
m_position ) + symbol->GetPosition();
265 return PIN_ORIENTATION::PIN_RIGHT;
276 if( !
m_alt.IsEmpty() )
279 return GRAPHIC_PINSHAPE::LINE;
283 else if(
m_shape == GRAPHIC_PINSHAPE::INHERIT )
286 return GRAPHIC_PINSHAPE::LINE;
311 if( !
m_alt.IsEmpty() )
314 return ELECTRICAL_PINTYPE::PT_UNSPECIFIED;
318 else if(
m_type == ELECTRICAL_PINTYPE::PT_INHERIT )
321 return ELECTRICAL_PINTYPE::PT_UNSPECIFIED;
341 if(
m_type == ELECTRICAL_PINTYPE::PT_INHERIT )
355 if(
m_type == ELECTRICAL_PINTYPE::PT_INHERIT )
369 return GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN
390 if( !
m_alt.IsEmpty() )
413 m_name.Replace( wxT(
" " ), wxT(
"_" ) );
421 if(
GetType() == ELECTRICAL_PINTYPE::PT_NC ||
GetType() == ELECTRICAL_PINTYPE::PT_NIC )
436 bool isConnectableType_a =
GetType() == ELECTRICAL_PINTYPE::PT_PASSIVE
437 ||
GetType() == ELECTRICAL_PINTYPE::PT_NIC;
438 bool isConnectableType_b = aPin->
GetType() == ELECTRICAL_PINTYPE::PT_PASSIVE
439 || aPin->
GetType() == ELECTRICAL_PINTYPE::PT_NIC;
444 && (
GetType() == aPin->
GetType() || isConnectableType_a || isConnectableType_b );
463 bool isReplaced =
false;
479 aAccuracy = std::max( aAccuracy,
Schematic()->Settings().m_PinSymbolSize / 4 );
506 if( !
m_alt.IsEmpty() )
511 if(
m_name == wxS(
"~" ) )
512 return wxEmptyString;
521 return wxEmptyString;
534 m_number.Replace( wxT(
" " ), wxT(
"_" ) );
592 const TRANSFORM& t = symbol->GetTransform();
612 const VECTOR2I& aOffset,
bool aForceNoFill,
bool aDimmed )
616 wxCHECK( part && aSettings, );
637 &&
m_type != ELECTRICAL_PINTYPE::PT_NC
638 &&
m_type != ELECTRICAL_PINTYPE::PT_NIC )
664 int MapX1, MapY1, x1, y1;
688 switch( aOrientation )
690 case PIN_ORIENTATION::PIN_UP: y1 = posY - len; MapY1 = 1;
break;
691 case PIN_ORIENTATION::PIN_DOWN: y1 = posY + len; MapY1 = -1;
break;
692 case PIN_ORIENTATION::PIN_LEFT: x1 = posX - len; MapX1 = 1;
break;
693 case PIN_ORIENTATION::PIN_RIGHT: x1 = posX + len; MapX1 = -1;
break;
694 case PIN_ORIENTATION::INHERIT: wxFAIL_MSG( wxS(
"aOrientation must be resolved!" ) );
break;
697 if(
m_shape == GRAPHIC_PINSHAPE::INVERTED ||
m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK )
702 GRMoveTo( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 );
712 if(
m_shape == GRAPHIC_PINSHAPE::CLOCK
713 ||
m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK
714 ||
m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK
715 ||
m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
721 GRLineTo( DC, x1 - MapX1 * clock_size * 2, y1, width,
color );
727 GRLineTo( DC, x1, y1 - MapY1 * clock_size * 2, width,
color );
733 if(
m_shape == GRAPHIC_PINSHAPE::INPUT_LOW
734 ||
m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK
735 ||
m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
740 GRMoveTo( x1 + MapX1 * deco_size * 2, y1 );
741 GRLineTo( DC, x1 + MapX1 * deco_size * 2, y1 - deco_size * 2, width,
color );
746 GRMoveTo( x1, y1 + MapY1 * deco_size * 2 );
747 GRLineTo( DC, x1 - deco_size * 2, y1 + MapY1 * deco_size * 2, width,
color );
752 if(
m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW )
758 GRLineTo( DC, x1 + MapX1 * deco_size * 2, y1, width,
color );
763 GRLineTo( DC, x1, y1 + MapY1 * deco_size * 2, width,
color );
766 else if(
m_shape == GRAPHIC_PINSHAPE::NONLOGIC )
769 GRMoveTo( x1 - (MapX1 + MapY1) * deco_size, y1 - (MapY1 - MapX1) * deco_size );
770 GRLineTo( DC, x1 + (MapX1 + MapY1) * deco_size, y1 + ( MapY1 - MapX1 ) * deco_size, width,
772 GRMoveTo( x1 - (MapX1 - MapY1) * deco_size, y1 - (MapY1 + MapX1) * deco_size );
773 GRLineTo( DC, x1 + (MapX1 - MapY1) * deco_size, y1 + ( MapY1 + MapX1 ) * deco_size, width,
777 if(
m_type == ELECTRICAL_PINTYPE::PT_NC )
780 GRLine( DC, posX - deco_size, posY - deco_size, posX + deco_size, posY + deco_size, width,
782 GRLine( DC, posX + deco_size, posY - deco_size, posX - deco_size, posY + deco_size, width,
790 bool aDrawPinName,
bool aDimmed )
792 if( !aDrawPinName && !aDrawPinNum )
818 nameColor = nameColor.
Mix( bg, 0.5f );
819 numColor = numColor.
Mix( bg, 0.5f );
827 case PIN_ORIENTATION::PIN_UP: y1 -=
GetLength();
break;
828 case PIN_ORIENTATION::PIN_DOWN: y1 +=
GetLength();
break;
829 case PIN_ORIENTATION::PIN_LEFT: x1 -=
GetLength();
break;
830 case PIN_ORIENTATION::PIN_RIGHT: x1 +=
GetLength();
break;
831 case PIN_ORIENTATION::INHERIT: wxFAIL_MSG( wxT(
"aPinOrient must be resolved!" ) );
break;
835 aDrawPinName =
false;
845 nameSize, hAlign, vAlign, 0,
false,
false, font,
GetFontMetrics() );
853 numSize, hAlign, vAlign, 0,
false,
false, font,
GetFontMetrics() );
858 if( ( aPinOrient == PIN_ORIENTATION::PIN_LEFT )
859 || ( aPinOrient == PIN_ORIENTATION::PIN_RIGHT ) )
864 if( aPinOrient == PIN_ORIENTATION::PIN_RIGHT )
885 if( aPinOrient == PIN_ORIENTATION::PIN_DOWN )
917 if( ( aPinOrient == PIN_ORIENTATION::PIN_LEFT )
918 || ( aPinOrient == PIN_ORIENTATION::PIN_RIGHT ) )
921 if( aDrawPinName && aDrawPinNum )
929 else if( aDrawPinName )
934 else if( aDrawPinNum )
942 if( aDrawPinName && aDrawPinNum )
950 else if( aDrawPinName )
955 else if( aDrawPinNum )
975 #define ETXT_MAX_SIZE schIUScale.mmToIU( 0.7 )
981 int pensize = textSize/6;
1005 switch( aOrientation )
1007 case PIN_ORIENTATION::PIN_UP:
1013 case PIN_ORIENTATION::PIN_DOWN:
1018 case PIN_ORIENTATION::PIN_LEFT:
1022 case PIN_ORIENTATION::PIN_RIGHT:
1027 case PIN_ORIENTATION::INHERIT:
1028 wxFAIL_MSG( wxS(
"aOrientation must be resolved!" ) );
1040 int MapX1, MapY1, x1, y1;
1047 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->
GetColorMode() )
1048 bg = COLOR4D::WHITE;
1052 color.Desaturate( );
1060 x1 = aPosition.
x; y1 = aPosition.
y;
1062 switch( aOrientation )
1064 case PIN_ORIENTATION::PIN_UP: y1 = aPosition.
y - pinLength; MapY1 = 1;
break;
1065 case PIN_ORIENTATION::PIN_DOWN: y1 = aPosition.
y + pinLength; MapY1 = -1;
break;
1066 case PIN_ORIENTATION::PIN_LEFT: x1 = aPosition.
x - pinLength; MapX1 = 1;
break;
1067 case PIN_ORIENTATION::PIN_RIGHT: x1 = aPosition.
x + pinLength; MapX1 = -1;
break;
1068 case PIN_ORIENTATION::INHERIT: wxFAIL_MSG( wxS(
"aOrientation must be resolved!" ) );
break;
1071 if(
m_shape == GRAPHIC_PINSHAPE::INVERTED ||
m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK )
1074 aPlotter->
Circle(
VECTOR2I( MapX1 * radius + x1, MapY1 * radius + y1 ), radius * 2,
1075 FILL_T::NO_FILL, penWidth );
1077 aPlotter->
MoveTo(
VECTOR2I( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 ) );
1080 else if(
m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK )
1096 aPlotter->
MoveTo(
VECTOR2I( MapX1 * deco_size * 2 + x1, MapY1 * deco_size * 2 + y1 ) );
1105 if(
m_shape == GRAPHIC_PINSHAPE::CLOCK
1106 ||
m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK
1107 ||
m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
1124 if(
m_shape == GRAPHIC_PINSHAPE::INPUT_LOW
1125 ||
m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
1132 aPlotter->
LineTo(
VECTOR2I( x1 + MapX1 * deco_size * 2, y1 - deco_size * 2 ) );
1138 aPlotter->
LineTo(
VECTOR2I( x1 - deco_size * 2, y1 + MapY1 * deco_size * 2 ) );
1143 if(
m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW )
1158 else if(
m_shape == GRAPHIC_PINSHAPE::NONLOGIC )
1162 y1 - ( MapY1 - MapX1 ) * deco_size ) );
1164 y1 + ( MapY1 - MapX1 ) * deco_size ) );
1166 y1 - ( MapY1 + MapX1 ) * deco_size ) );
1168 y1 + ( MapY1 + MapX1 ) * deco_size ) );
1171 if(
m_type == ELECTRICAL_PINTYPE::PT_NC )
1174 const int ex1 = aPosition.
x;
1175 const int ey1 = aPosition.
y;
1176 aPlotter->
MoveTo(
VECTOR2I( ex1 - deco_size, ey1 - deco_size ) );
1178 aPlotter->
MoveTo(
VECTOR2I( ex1 + deco_size, ey1 - deco_size ) );
1185 int aTextInside,
bool aDrawPinNum,
bool aDrawPinName,
1186 bool aDimmed )
const
1194 aDrawPinName =
false;
1197 aDrawPinNum =
false;
1199 if( !aDrawPinNum && !aDrawPinName )
1212 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->
GetColorMode() )
1213 bg = COLOR4D::WHITE;
1219 nameColor = nameColor.
Mix( bg, 0.5f );
1220 numColor = numColor.
Mix( bg, 0.5f );
1226 switch( aPinOrient )
1228 case PIN_ORIENTATION::PIN_UP: y1 -=
GetLength();
break;
1229 case PIN_ORIENTATION::PIN_DOWN: y1 +=
GetLength();
break;
1230 case PIN_ORIENTATION::PIN_LEFT: x1 -=
GetLength();
break;
1231 case PIN_ORIENTATION::PIN_RIGHT: x1 +=
GetLength();
break;
1232 case PIN_ORIENTATION::INHERIT: wxFAIL_MSG( wxS(
"aPinOrient must be resolved!" ) );
break;
1268 if( ( aPinOrient == PIN_ORIENTATION::PIN_LEFT )
1269 || ( aPinOrient == PIN_ORIENTATION::PIN_RIGHT ) )
1273 if( aPinOrient == PIN_ORIENTATION::PIN_RIGHT )
1293 if( aPinOrient == PIN_ORIENTATION::PIN_DOWN )
1325 if( ( aPinOrient == PIN_ORIENTATION::PIN_LEFT )
1326 || ( aPinOrient == PIN_ORIENTATION::PIN_RIGHT ) )
1329 if( aDrawPinName && aDrawPinNum )
1337 else if( aDrawPinName )
1342 else if( aDrawPinNum )
1351 if( aDrawPinName && aDrawPinNum )
1359 else if( aDrawPinName )
1364 else if( aDrawPinNum )
1382 case PIN_ORIENTATION::PIN_RIGHT: end.
x = 1;
break;
1383 case PIN_ORIENTATION::PIN_UP: end.
y = -1;
break;
1384 case PIN_ORIENTATION::PIN_DOWN: end.
y = 1;
break;
1385 case PIN_ORIENTATION::PIN_LEFT: end.
x = -1;
break;
1390 orient = PIN_ORIENTATION::PIN_UP;
1395 orient = PIN_ORIENTATION::PIN_DOWN;
1399 orient = PIN_ORIENTATION::PIN_RIGHT;
1402 orient = PIN_ORIENTATION::PIN_LEFT;
1420 int lengthChange =
GetLength() - aLength;
1427 case PIN_ORIENTATION::PIN_RIGHT:
1428 offsetX = lengthChange;
1430 case PIN_ORIENTATION::PIN_LEFT:
1431 offsetX = -1 * lengthChange;
1433 case PIN_ORIENTATION::PIN_UP:
1434 offsetY = lengthChange;
1436 case PIN_ORIENTATION::PIN_DOWN:
1437 offsetY = -1 * lengthChange;
1501 case PIN_ORIENTATION::PIN_RIGHT:
m_orientation = PIN_ORIENTATION::PIN_UP;
break;
1502 case PIN_ORIENTATION::PIN_UP:
m_orientation = PIN_ORIENTATION::PIN_LEFT;
break;
1503 case PIN_ORIENTATION::PIN_LEFT:
m_orientation = PIN_ORIENTATION::PIN_DOWN;
break;
1504 case PIN_ORIENTATION::PIN_DOWN:
m_orientation = PIN_ORIENTATION::PIN_RIGHT;
break;
1514 case PIN_ORIENTATION::PIN_RIGHT:
m_orientation = PIN_ORIENTATION::PIN_DOWN;
break;
1515 case PIN_ORIENTATION::PIN_UP:
m_orientation = PIN_ORIENTATION::PIN_RIGHT;
break;
1516 case PIN_ORIENTATION::PIN_LEFT:
m_orientation = PIN_ORIENTATION::PIN_UP;
break;
1517 case PIN_ORIENTATION::PIN_DOWN:
m_orientation = PIN_ORIENTATION::PIN_LEFT;
break;
1531 int aUnit,
int aBodyStyle,
const VECTOR2I& aOffset,
bool aDimmed )
1562 aList.emplace_back(
_(
"Type" ),
_(
"Pin" ) );
1567 wxString(
"Undefined library pin." );
1568 aList.emplace_back(
_(
"Unit" ), msg );
1574 wxString(
"Undefined library pin." );
1575 aList.emplace_back(
_(
"Body Style" ), msg );
1584 aList.emplace_back(
_(
"Visible" ),
IsVisible() ?
_(
"Yes" ) :
_(
"No" ) );
1603 aList.emplace_back( symbol->
GetRef( currentSheet ),
1656 if( it->second.second == aForceNoConnect )
1657 return it->second.first;
1660 wxString
name =
"Net-(";
1661 bool unconnected =
false;
1663 if( aForceNoConnect ||
GetType() == ELECTRICAL_PINTYPE::PT_NC )
1666 name = (
"unconnected-(" );
1669 bool annotated =
true;
1671 std::vector<SCH_PIN*> pins = symbol->
GetPins( &aPath );
1672 bool has_multiple =
false;
1678 && unconnected == (
pin->GetType() == ELECTRICAL_PINTYPE::PT_NC ) )
1680 has_multiple =
true;
1689 if( symbol->
GetRef( &aPath,
false ).Last() ==
'?' )
1694 name <<
"-Pad" << libPinNumber <<
")";
1697 else if( !libPinShownName.IsEmpty() && ( libPinShownName != libPinShownNumber ) )
1704 if( unconnected || has_multiple )
1739 if( aCache->
m_Font == aFont
1758 bool aIncludeElectricalType )
const
1761 return m_layoutCache->GetPinBoundingBox( aIncludeLabelsOnInvisiblePins, aIncludeNameAndNumber,
1762 aIncludeElectricalType );
1776 wxCHECK(
pin,
false );
1817 if( !
m_alt.IsEmpty() )
1820 alt = &localStorage;
1824 : wxString( wxS(
"Undefined library pin." ) );
1828 return wxString::Format(
"Symbol %s %s",
1850 if ( !
name.IsEmpty() )
1852 return wxString::Format(
_(
"Pin %s [%s, %s, %s]" ),
1860 return wxString::Format(
_(
"Pin %s [%s, %s]" ),
1868 if( !
name.IsEmpty() )
1870 return wxString::Format(
_(
"Hidden pin %s [%s, %s, %s]" ),
1878 return wxString::Format(
_(
"Hidden pin %s [%s, %s]" ),
1998 return static_cast<int>(
m_shape ) -
static_cast<int>( tmp->
m_shape );
2001 return static_cast<int>(
m_type ) -
static_cast<int>( tmp->
m_type );
2020 const ALT& lhsAlt = lhsItem->second;
2021 const ALT& rhsAlt = rhsItem->second;
2029 return static_cast<int>( lhsAlt.
m_Type ) -
static_cast<int>( rhsAlt.
m_Type );
2032 return static_cast<int>( lhsAlt.
m_Shape ) -
static_cast<int>( rhsAlt.
m_Shape );
2105 aStream <<
"SCH_PIN:" << std::endl
2106 <<
" Name: \"" <<
m_name <<
"\"" << std::endl
2107 <<
" Number: \"" <<
m_number <<
"\"" << std::endl
2109 <<
" Length: " <<
GetLength() << std::endl
2122void SCH_PIN::Show(
int nestLevel, std::ostream& os )
const
2124 NestedSpace( nestLevel, os ) <<
'<' <<
GetClass().Lower().mb_str()
2146 if( pinTypeEnum.Choices().GetCount() == 0 )
2148 pinTypeEnum.Map( ELECTRICAL_PINTYPE::PT_INPUT,
_HKI(
"Input" ) )
2149 .Map( ELECTRICAL_PINTYPE::PT_OUTPUT,
_HKI(
"Output" ) )
2150 .Map( ELECTRICAL_PINTYPE::PT_BIDI,
_HKI(
"Bidirectional" ) )
2151 .Map( ELECTRICAL_PINTYPE::PT_TRISTATE,
_HKI(
"Tri-state" ) )
2152 .Map( ELECTRICAL_PINTYPE::PT_PASSIVE,
_HKI(
"Passive" ) )
2153 .Map( ELECTRICAL_PINTYPE::PT_NIC,
_HKI(
"Free" ) )
2154 .Map( ELECTRICAL_PINTYPE::PT_UNSPECIFIED,
_HKI(
"Unspecified" ) )
2155 .Map( ELECTRICAL_PINTYPE::PT_POWER_IN,
_HKI(
"Power input" ) )
2156 .Map( ELECTRICAL_PINTYPE::PT_POWER_OUT,
_HKI(
"Power output" ) )
2157 .Map( ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR,
_HKI(
"Open collector" ) )
2158 .Map( ELECTRICAL_PINTYPE::PT_OPENEMITTER,
_HKI(
"Open emitter" ) )
2159 .Map( ELECTRICAL_PINTYPE::PT_NC,
_HKI(
"Unconnected" ) );
2164 if( pinShapeEnum.Choices().GetCount() == 0 )
2166 pinShapeEnum.Map( GRAPHIC_PINSHAPE::LINE,
_HKI(
"Line" ) )
2167 .Map( GRAPHIC_PINSHAPE::INVERTED,
_HKI(
"Inverted" ) )
2168 .Map( GRAPHIC_PINSHAPE::CLOCK,
_HKI(
"Clock" ) )
2169 .Map( GRAPHIC_PINSHAPE::INVERTED_CLOCK,
_HKI(
"Inverted clock" ) )
2170 .Map( GRAPHIC_PINSHAPE::INPUT_LOW,
_HKI(
"Input low" ) )
2171 .Map( GRAPHIC_PINSHAPE::CLOCK_LOW,
_HKI(
"Clock low" ) )
2172 .Map( GRAPHIC_PINSHAPE::OUTPUT_LOW,
_HKI(
"Output low" ) )
2173 .Map( GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK,
_HKI(
"Falling edge clock" ) )
2174 .Map( GRAPHIC_PINSHAPE::NONLOGIC,
_HKI(
"NonLogic" ) );
2179 if( orientationEnum.Choices().GetCount() == 0 )
2181 orientationEnum.Map( PIN_ORIENTATION::PIN_RIGHT,
_(
"Right" ) )
2182 .Map( PIN_ORIENTATION::PIN_LEFT,
_(
"Left" ) )
2183 .Map( PIN_ORIENTATION::PIN_UP,
_(
"Up" ) )
2184 .Map( PIN_ORIENTATION::PIN_DOWN,
_(
"Down" ) );
2187 auto isSymbolEditor =
2191 return dynamic_cast<LIB_SYMBOL*
>(
pin->GetParentSymbol() ) !=
nullptr;
2210 _HKI(
"Electrical Type" ),
2215 _HKI(
"Graphic Style" ),
2233 PROPERTY_DISPLAY::PT_SIZE ) )
2238 PROPERTY_DISPLAY::PT_SIZE ) )
2243 PROPERTY_DISPLAY::PT_SIZE ) )
constexpr EDA_IU_SCALE schIUScale
BITMAPS
A list of all bitmap identifiers.
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
constexpr bool Contains(const Vec &aPoint) const
constexpr bool Intersects(const BOX2< Vec > &aRect) 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 bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
EDA_ITEM * GetParent() const
EDA_ITEM * m_parent
Linked list: Link (parent struct).
virtual const wxString & GetText() const
Return the string associated with the text object.
static ENUM_MAP< T > & Instance()
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.
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)
VECTOR2I StringBoundaryLimits(const wxString &aText, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic, const METRICS &aFontMetrics) const
Compute the boundary limits of aText (the bounding box of all shapes).
A color representation with 4 components: red, green, blue, alpha.
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
const wxString & GetDefaultFont() 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.
wxDC * GetPrintDC() const
wxString AsString() const
Define a library symbol object.
Container for data for KiCad programs.
virtual SETTINGS_MANAGER & GetSettingsManager() const
A pin layout helper is a class that manages the layout of the parts of a pin on a schematic symbol:
Base plotter engine class.
virtual void Circle(const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
void MoveTo(const VECTOR2I &pos)
void FinishTo(const VECTOR2I &pos)
RENDER_SETTINGS * RenderSettings()
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 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.
PROPERTY_BASE & SetWriteableFunc(std::function< bool(INSPECTABLE *)> aFunc)
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.
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void AppendInfoToMsgPanel(std::vector< MSG_PANEL_ITEM > &aList) const
Adds information about the connection object to aList.
Schematic editor (Eeschema) main window.
SCH_SHEET_PATH & GetCurrentSheet() 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
const SYMBOL * GetParentSymbol() const
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
static wxString GetUnitDescription(int aUnit)
virtual int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const
Provide the draw object specific comparison called by the == and < operators.
bool IsConnectivityDirty() const
static wxString GetBodyStyleDescription(int aBodyStyle)
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
int GetEffectivePenWidth(const SCH_RENDER_SETTINGS *aSettings) const
double SimilarityBase(const SCH_ITEM &aItem) const
Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure vir...
void getSymbolEditorMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW=true) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
std::ostream & operator<<(std::ostream &aStream)
void PlotPinTexts(PLOTTER *aPlotter, const VECTOR2I &aPinPos, PIN_ORIENTATION aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed) const
Plot the pin name and number.
int GetNumberTextSize() const
std::optional< bool > m_hidden
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
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.
std::unique_ptr< PIN_LAYOUT_CACHE > m_layoutCache
The layout cache for this pin.
void MirrorVerticallyPin(int aCenter)
void validateExtentsCache(KIFONT::FONT *aFont, int aSize, const wxString &aText, EXTENTS_CACHE *aCache) const
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
void CalcEdit(const VECTOR2I &aPosition) override
Calculate the attributes of an item at aPosition when it is being edited.
void SetNumber(const wxString &aNumber)
std::optional< int > m_nameTextSize
PIN_ORIENTATION PinDrawOrient(const TRANSFORM &aTransform) const
Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation...
void SetVisible(bool aVisible)
void ChangeLength(int aLength)
Change the length of a pin and adjust its position based on orientation.
ALT GetAlt(const wxString &aAlt)
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
SCH_PIN & operator=(const SCH_PIN &aPin)
wxString GetShownNumber() const
void Move(const VECTOR2I &aOffset) override
Move the item by aMoveVector to a new position.
std::map< const SCH_SHEET_PATH, std::pair< wxString, bool > > m_net_name_map
PIN_ORIENTATION m_orientation
void SetOrientation(PIN_ORIENTATION aOrientation)
void SetName(const wxString &aName)
bool IsGlobalPower() const
Return whether this pin forms a global power connection: i.e., is part of a power symbol and of type ...
wxString getItemDescription(ALT *aAlt) const
bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Return true if this item should propagate connection info to aItem.
std::optional< int > m_numTextSize
VECTOR2I GetPinRoot() const
ELECTRICAL_PINTYPE m_type
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
SCH_PIN * GetLibPin() const
void SetPosition(const VECTOR2I &aPos) override
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void SetIsDangling(bool aIsDangling)
wxString GetElectricalTypeName() const
std::map< wxString, ALT > m_alternates
const wxString & GetName() const
void SetLength(int aLength)
bool IsDangling() const override
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 MirrorHorizontally(int aCenter) override
these transforms have effect only if the pin has a LIB_SYMBOL as parent
std::recursive_mutex m_netmap_mutex
The name that this pin connection will drive onto a net.
PIN_ORIENTATION GetOrientation() const
wxString GetClass() const override
Return the class name.
void SetNumberTextSize(int aSize)
void printPinTexts(const RENDER_SETTINGS *aSettings, const VECTOR2I &aPinPos, PIN_ORIENTATION aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed)
Put the pin number and pin text info, given the pin line coordinates.
void SetShape(GRAPHIC_PINSHAPE aShape)
void RotatePin(const VECTOR2I &aCenter, bool aRotateCCW=true)
VECTOR2I GetPosition() const override
wxString GetCanonicalElectricalTypeName() const
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 ...
int GetNameTextSize() const
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
void printPinSymbol(const SCH_RENDER_SETTINGS *aSettings, const VECTOR2I &aPos, PIN_ORIENTATION aOrientation, bool aDimmed)
Print the pin symbol without text.
int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const override
The pin specific sort order is as follows:
wxString GetShownName() const
void MirrorHorizontallyPin(int aCenter)
these transforms have always effects
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
void SetType(ELECTRICAL_PINTYPE aType)
const wxString & GetBaseName() const
Get the name without any alternates.
void ClearDefaultNetName(const SCH_SHEET_PATH *aPath)
void printPinElectricalTypeName(const RENDER_SETTINGS *aSettings, const VECTOR2I &aPosition, PIN_ORIENTATION aOrientation, bool aDimmed)
Draw the electrical type text of the pin (only for the footprint editor)
SCH_PIN(LIB_SYMBOL *aParentSymbol)
bool IsStacked(const SCH_PIN *aPin) const
const wxString & GetNumber() const
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void Print(const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aForceNoFill, bool aDimmed) override
Print an item.
wxString GetDefaultNetName(const SCH_SHEET_PATH &aPath, bool aForceNoConnect=false)
std::optional< int > m_length
GRAPHIC_PINSHAPE GetShape() const
void PlotPinType(PLOTTER *aPlotter, const VECTOR2I &aPosition, PIN_ORIENTATION aOrientation, bool aDimmed) const
ELECTRICAL_PINTYPE GetType() const
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void SetNameTextSize(int aSize)
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
const KIGFX::COLOR4D & GetBackgroundColor() const override
Return current background color settings.
bool m_ShowPinsElectricalType
bool m_ShowConnectionPoints
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
const wxString GetValue(bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet) const
Retrieve a list of the SCH_PINs for the given sheet path.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
T * GetAppSettings(const wxString &aFilename)
Return a handle to the a given settings by type.
A base class for LIB_SYMBOL and SCH_SYMBOL.
virtual int GetUnitCount() const =0
virtual const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const =0
virtual bool IsPower() const =0
int GetPinNameOffset() const
virtual bool GetShowPinNames() const
virtual bool GetShowPinNumbers() const
virtual bool HasAlternateBodyStyle() const =0
Test if symbol has more than one body conversion type (DeMorgan).
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
#define DEFAULT_PINNUM_SIZE
The default pin name size when creating pins(can be changed in preference menu)
#define DEFAULT_PINNAME_SIZE
The default selection highlight thickness (can be changed in preference menu)
#define DEFAULT_PIN_LENGTH
The default pin number size when creating pins(can be changed in preference menu)
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_VERTICAL
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#define SHOW_ELEC_TYPE
Show pin electrical type. Shared with IS_ROLLOVER.
void GRLineTo(wxDC *DC, int x, int y, int width, const COLOR4D &Color)
void GRCircle(wxDC *aDC, const VECTOR2I &aPos, int aRadius, int aWidth, const COLOR4D &aColor)
void GRMoveTo(int x, int y)
void GRLine(wxDC *DC, int x1, int y1, int x2, int y2, int width, const COLOR4D &Color, wxPenStyle aStyle)
bool GetGRForceBlackPenState(void)
int GetPenSizeForNormal(int aTextSize)
void GRPrintText(wxDC *aDC, const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics)
Print a graphic text through wxDC.
@ LAYER_SELECTION_SHADOWS
PGM_BASE * PgmOrNull()
Return a reference that can be nullptr when running a shared lib from a script, not from a kicad app.
wxString ElectricalPinTypeGetText(ELECTRICAL_PINTYPE aType)
BITMAPS ElectricalPinTypeGetBitmap(ELECTRICAL_PINTYPE aType)
wxString PinShapeGetText(GRAPHIC_PINSHAPE aShape)
wxString PinOrientationName(PIN_ORIENTATION aOrientation)
ELECTRICAL_PINTYPE
The symbol library pin object electrical types used in ERC tests.
@ PT_UNSPECIFIED
unknown electrical properties: creates always a warning when connected
PIN_ORIENTATION
The symbol library pin object orientations.
@ PIN_RIGHT
The pin extends rightwards from the connection point.
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
static int externalPinDecoSize(const RENDER_SETTINGS *aSettings, const SCH_PIN &aPin)
Utility for getting the size of the 'external' pin decorators (as a radius)
static int internalPinDecoSize(const RENDER_SETTINGS *aSettings, const SCH_PIN &aPin)
Utility for getting the size of the 'internal' pin decorators (as a radius)
static struct SCH_PIN_DESC _SCH_PIN_DESC
#define TARGET_PIN_RADIUS
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:...
constexpr int MilsToIU(int mils) const
constexpr int mmToIU(double mm) const
ELECTRICAL_PINTYPE m_Type
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
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.
VECTOR2< int32_t > VECTOR2I