lib_pin.h

Go to the documentation of this file.

/*
 * 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 <[email protected]>
 * Copyright (C) 2004-2023 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 <lib_item.h>
#include <pin_type.h>
#include <lib_symbol.h>
 
// 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
 
 
enum DrawPinOrient {
 PIN_RIGHT = 'R',
 PIN_LEFT = 'L',
 PIN_UP = 'U',
 PIN_DOWN = 'D'
};
 
 
class LIB_PIN : public LIB_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() { }
 
 wxString GetClass() const override
 {
 return wxT( "LIB_PIN" );
 }
 
 wxString GetTypeName() const override
 {
 return _( "Pin" );
 }
 
 int GetOrientation() const { return m_orientation; }
 void SetOrientation( int 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; }
 
 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( "_" ) );
 }
 
 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( "_" ) );
 }
 
 int GetNameTextSize() const { return m_nameTextSize; }
 void SetNameTextSize( int aSize ) { m_nameTextSize = aSize; }
 
 int GetNumberTextSize() const { return m_numTextSize; }
 void SetNumberTextSize( int aSize ) { m_numTextSize = aSize; }
 
 std::map<wxString, ALT>& GetAlternates() { return m_alternates; }
 
 ALT GetAlt( const wxString& aAlt ) { return m_alternates[ aAlt ]; }
 
 void print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, void* aData,
 const TRANSFORM& aTransform, bool aDimmed ) override;
 
 int PinDrawOrient( const TRANSFORM& aTransform ) const;
 
 LIB_PIN( LIB_SYMBOL* aParent );
 
 LIB_PIN( LIB_SYMBOL* aParent, const wxString& aName, const wxString& aNumber, int 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.
 
 // 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<MSG_PANEL_ITEM>& 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, false ); }
 
 const BOX2I GetBoundingBox( bool aIncludeInvisiblePins, bool aIncludeNameAndNumber,
 bool aIncludeElectricalType ) const;
 
 bool IsGlobalPower() const
 {
 return GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN
 && ( !IsVisible() || (LIB_SYMBOL*) GetParent()->IsPower() );
 }
 
 int GetPenWidth() const override;
 
 void PlotPinTexts( PLOTTER *aPlotter, const VECTOR2I &aPinPos, int aPinOrient, int aTextInside,
 bool aDrawPinNum, bool aDrawPinName, bool aDimmed ) const;
 
 void PlotSymbol( PLOTTER *aPlotter, const VECTOR2I &aPosition, int aOrientation,
 bool aDimmed ) const;
 
 void Offset( const VECTOR2I& aOffset ) override;
 
 void MoveTo( const VECTOR2I& aNewPosition ) override;
 
 VECTOR2I GetPosition() const override { return m_position; }
 void SetPosition( const VECTOR2I& aPos ) override { m_position = aPos; }
 
 VECTOR2I GetPinRoot() const;
 
 void MirrorHorizontal( const VECTOR2I& aCenter ) override;
 void MirrorVertical( const VECTOR2I& aCenter ) override;
 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW = true ) override;
 
 void Plot( PLOTTER* aPlotter, bool aBackground, const VECTOR2I& aOffset,
 const TRANSFORM& aTransform, bool aDimmed ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 EDA_ITEM* Clone() const override;
 
 void CalcEdit( const VECTOR2I& aPosition ) override;
 
 static const wxString GetCanonicalElectricalTypeName( ELECTRICAL_PINTYPE aType );
 
protected:
 void printPinSymbol( const RENDER_SETTINGS *aSettings, const VECTOR2I &aPos, int aOrientation,
 bool aDimmed );
 
 void printPinTexts( const RENDER_SETTINGS* aSettings, VECTOR2I& aPinPos, int aPinOrient,
 int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed );
 
 void printPinElectricalTypeName( const RENDER_SETTINGS* aSettings, VECTOR2I& aPosition,
 int aOrientation, bool aDimmed );
 
private:
 int compare( const LIB_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
protected:
 VECTOR2I m_position; // Position of the pin.
 int m_length; // Length of the pin.
 int 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<wxString, ALT> m_alternates; // Map of alternate name to ALT structure
 
 wxString m_operatingPoint; // No, LIB_PINs don't really have operating points.
 // But we draw SCH_PINs through their LIB_PIN
 // counterparts, so here we are....
};
 
 
#endif // CLASS_PIN_H