/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2015 Jean-Pierre Charras, jaen-pierre.charras at wanadoo.fr * Copyright (C) 2015 Wayne Stambaugh * Copyright (C) 2004-2024 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #ifndef CLASS_PIN_H #define CLASS_PIN_H #include #include // Circle diameter drawn at the active end of pins: #define TARGET_PIN_RADIUS schIUScale.MilsToIU( 15 ) // Pin visibility flag bit: #define PIN_INVISIBLE 1 // Set makes pin invisible class LIB_PIN : public SCH_ITEM { public: struct ALT { wxString m_Name; GRAPHIC_PINSHAPE m_Shape; // Shape drawn around pin ELECTRICAL_PINTYPE m_Type; // Electrical type of the pin. }; LIB_PIN( SCH_ITEM* aParent ); LIB_PIN( SCH_ITEM* aParent, const wxString& aName, const wxString& aNumber, PIN_ORIENTATION aOrientation, ELECTRICAL_PINTYPE aPinType, int aLength, int aNameTextSize, int aNumTextSize, int aConvert, const VECTOR2I& aPos, int aUnit ); // Do not create a copy constructor. The one generated by the compiler is adequate. ~LIB_PIN() { } wxString GetClass() const override { return wxT( "LIB_PIN" ); } static inline bool ClassOf( const EDA_ITEM* aItem ) { return aItem && aItem->Type() == LIB_PIN_T; } wxString GetFriendlyName() const override { return _( "Pin" ); } PIN_ORIENTATION GetOrientation() const { return m_orientation; } void SetOrientation( PIN_ORIENTATION aOrientation ) { m_orientation = aOrientation; } GRAPHIC_PINSHAPE GetShape() const { return m_shape; } void SetShape( GRAPHIC_PINSHAPE aShape ) { m_shape = aShape; } int GetLength() const { return m_length; } void SetLength( int aLength ) { m_length = aLength; } /** * Change the length of a pin and adjust its position based on orientation. * * @param aLength New length of pin */ void ChangeLength( int aLength ); ELECTRICAL_PINTYPE GetType() const { return m_type; } void SetType( ELECTRICAL_PINTYPE aType ) { m_type = aType; } wxString const GetCanonicalElectricalTypeName() const { return GetCanonicalElectricalTypeName( m_type ); } wxString const GetElectricalTypeName() const { return ElectricalPinTypeGetText( m_type ); } bool IsVisible() const { return ( m_attributes & PIN_INVISIBLE ) == 0; } void SetVisible( bool aVisible ) { if( aVisible ) m_attributes &= ~PIN_INVISIBLE; else m_attributes |= PIN_INVISIBLE; } const wxString& GetName() const { return m_name; } wxString GetShownName() const; void SetName( const wxString& aName ) { m_name = aName; // pin name string does not support spaces m_name.Replace( wxT( " " ), wxT( "_" ) ); m_nameExtentsCache.m_Extents = VECTOR2I(); } const wxString& GetNumber() const { return m_number; } wxString GetShownNumber() const { return m_number; } void SetNumber( const wxString& aNumber ) { m_number = aNumber; // pin number string does not support spaces m_number.Replace( wxT( " " ), wxT( "_" ) ); m_numExtentsCache.m_Extents = VECTOR2I(); } int GetNameTextSize() const { return m_nameTextSize; } void SetNameTextSize( int aSize ) { m_nameTextSize = aSize; m_nameExtentsCache.m_Extents = VECTOR2I(); } int GetNumberTextSize() const { return m_numTextSize; } void SetNumberTextSize( int aSize ) { m_numTextSize = aSize; m_numExtentsCache.m_Extents = VECTOR2I(); } std::map& GetAlternates() { return m_alternates; } ALT GetAlt( const wxString& aAlt ) { return m_alternates[ aAlt ]; } void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override; /** * Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), * according to its orientation and the matrix transform (rot, mirror) \a aTransform. * * @param aTransform Transform matrix */ PIN_ORIENTATION PinDrawOrient( const TRANSFORM& aTransform ) const; // No, LIB_PINs don't really have operating poinst. But we draw SCH_PINs through their LIB_PIN // counterparts, so here we are.... const wxString& GetOperatingPoint() const { return m_operatingPoint; } void SetOperatingPoint( const wxString& aText ) { m_operatingPoint = aText; } #if defined(DEBUG) void Show( int nestLevel, std::ostream& os ) const override; #endif bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override; bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override; void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) override; const BOX2I ViewBBox() const override; void ViewGetLayers( int aLayers[], int& aCount ) const override; /* Cannot use a default parameter here as it will not be compatible with the virtual. */ const BOX2I GetBoundingBox() const override { return GetBoundingBox( false, true, true ); } /** * @param aIncludeLabelsOnInvisblePins - if false, do not include labels for invisible pins * in the calculation. */ const BOX2I GetBoundingBox( bool aIncludeLabelsOnInvisblePins, bool aIncludeNameAndNumber, bool aIncludeElectricalType ) const; /** * Return whether this pin forms a global power connection: i.e., is part of a power symbol * and of type POWER_IN, or is a legacy invisible global power pin on a symbol. */ bool IsGlobalPower() const { return GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN && ( !IsVisible() || GetParentSymbol()->IsPower() ); } int GetPenWidth() const override; void Move( const VECTOR2I& aOffset ) override; VECTOR2I GetPosition() const override { return m_position; } void SetPosition( const VECTOR2I& aPos ) override { m_position = aPos; } // For properties system int GetX() const { return m_position.x; } void SetX( int aX ) { m_position.x = aX; } int GetY() const { return m_position.y; } void SetY( int aY ) { m_position.y = aY; } VECTOR2I GetPinRoot() const; void MirrorHorizontally( int aCenter ) override; void MirrorVertically( int aCenter ) override; void Rotate( const VECTOR2I& aCenter, bool aRotateCCW = true ) override; /** * Plot the pin name and number. * @param aTextInside - draw the names & numbers inside the symbol body (ie: in the opposite * direction of \a aPinOrient). */ void PlotPinTexts( PLOTTER *aPlotter, const VECTOR2I &aPinPos, PIN_ORIENTATION aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed ) const; void PlotPinType( PLOTTER *aPlotter, const VECTOR2I &aPosition, PIN_ORIENTATION aOrientation, bool aDimmed ) const; void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override; BITMAPS GetMenuImage() const override; wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override; wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, ALT* aAlt ) const; EDA_ITEM* Clone() const override; void CalcEdit( const VECTOR2I& aPosition ) override; /** * Return a string giving the electrical type of a pin. * * Can be used when a known, not translated name is needed (for instance in net lists) * * @param aType is the electrical type (see enum ELECTRICAL_PINTYPE ) * @return The electrical name for a pin type (see enun MsgPinElectricType for names). */ static const wxString GetCanonicalElectricalTypeName( ELECTRICAL_PINTYPE aType ); double Similarity( const SCH_ITEM& aItem ) const override; bool operator==( const SCH_ITEM& aItem ) const override; bool operator!=( const SCH_ITEM& aItem ) const { return !operator==( aItem ); } bool operator<( const LIB_PIN& aRhs ) const { return compare( aRhs, EQUALITY ) < 0; } bool operator>( const LIB_PIN& aRhs ) const { return compare( aRhs, EQUALITY ) > 0; } protected: wxString getItemDescription( ALT* aAlt ) const; struct EXTENTS_CACHE { KIFONT::FONT* m_Font = nullptr; int m_FontSize = 0; VECTOR2I m_Extents; }; void validateExtentsCache( KIFONT::FONT* aFont, int aSize, const wxString& aText, EXTENTS_CACHE* aCache ) const; /** * Print the pin symbol without text. * If \a aColor != 0, draw with \a aColor, else with the normal pin color. */ void printPinSymbol( const SCH_RENDER_SETTINGS *aSettings, const VECTOR2I &aPos, PIN_ORIENTATION aOrientation, bool aDimmed ); /** * Put the pin number and pin text info, given the pin line coordinates. * The line must be vertical or horizontal. * If aDrawPinName == false the pin name is not printed. * If aDrawPinNum = false the pin number is not printed. * If aTextInside then the text is been put inside,otherwise all is drawn outside. * Pin Name: substring between '~' is negated */ void printPinTexts( const RENDER_SETTINGS* aSettings, VECTOR2I& aPinPos, PIN_ORIENTATION aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed ); /** * Draw the electrical type text of the pin (only for the footprint editor) */ void printPinElectricalTypeName( const RENDER_SETTINGS* aSettings, VECTOR2I& aPosition, PIN_ORIENTATION aOrientation, bool aDimmed ); std::ostream& operator<<( std::ostream& aStream ); private: /** * @copydoc SCH_ITEM::compare() * * The pin specific sort order is as follows: * - Pin number. * - Pin name, case insensitive compare. * - Pin horizontal (X) position. * - Pin vertical (Y) position. */ int compare( const SCH_ITEM& aOther, int aCompareFlags = 0 ) const override; protected: VECTOR2I m_position; // Position of the pin. int m_length; // Length of the pin. PIN_ORIENTATION m_orientation; // Pin orientation (Up, Down, Left, Right) GRAPHIC_PINSHAPE m_shape; // Shape drawn around pin ELECTRICAL_PINTYPE m_type; // Electrical type of the pin. int m_attributes; // Set bit 0 to indicate pin is invisible. wxString m_name; wxString m_number; int m_numTextSize; // Pin num and Pin name sizes int m_nameTextSize; std::map m_alternates; // Map of alternate name to ALT structure wxString m_operatingPoint; // No, LIB_PINs don't really have simulation // operating points. But we draw SCH_PINs through // their LIB_PIN counterparts, so here we are.... mutable EXTENTS_CACHE m_numExtentsCache; mutable EXTENTS_CACHE m_nameExtentsCache; }; #endif // CLASS_PIN_H