KiCad PCB EDA Suite
LIB_PIN Class Reference

#include <lib_pin.h>

Inheritance diagram for LIB_PIN:
LIB_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Types

enum  LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 }
 

Public Member Functions

 LIB_PIN (LIB_PART *aParent)
 
 ~LIB_PIN ()
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
wxString GetTypeName () override
 Provide a user-consumable name of the object type. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...
 
void GetMsgPanelInfo (EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Display basic info (type, part and convert) about the current item in message panel. More...
 
void GetMsgPanelInfo (EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList, SCH_COMPONENT *aComponent)
 Display pin info (given by GetMsgPanelInfo) and add some info related to aComponent (schematic pin position, and sheet path) More...
 
bool Matches (wxFindReplaceData &aSearchData, void *aAuxData) override
 Function Matches compares the item against the search criteria in aSearchData. More...
 
const EDA_RECT GetBoundingBox () const override
 
const EDA_RECT GetBoundingBox (bool aIncludeInvisibles) const
 
wxPoint PinEndPoint () const
 
int PinDrawOrient (const TRANSFORM &aTransform) const
 Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation and the matrix transform (rot, mirror) aTransform. More...
 
const wxString & GetName () const
 
void SetName (const wxString &aName, bool aTestOtherPins=true)
 Set the pin name. More...
 
void SetNameTextSize (int aSize, bool aTestOtherPins=true)
 Set the aSize of the pin name text. More...
 
int GetNameTextSize () const
 
const wxString & GetNumber () const
 
void SetNumber (const wxString &aNumber)
 Set the pin number. More...
 
void SetNumberTextSize (int aSize, bool aTestOtherPins=true)
 Set the size of the pin number text. More...
 
int GetNumberTextSize () const
 
int GetOrientation () const
 
void SetOrientation (int aOrientation, bool aTestOtherPins=true)
 Set orientation on the pin. More...
 
GRAPHIC_PINSHAPE GetShape () const
 
void SetShape (GRAPHIC_PINSHAPE aShape)
 Set the shape of the pin to aShape. More...
 
ELECTRICAL_PINTYPE GetType () const
 Get the electrical type of the pin. More...
 
wxString const GetCanonicalElectricalTypeName () const
 return a string giving the electrical type of the pin. More...
 
wxString const GetElectricalTypeName () const
 return a translated string for messages giving the electrical type of the pin. More...
 
void SetType (ELECTRICAL_PINTYPE aType, bool aTestOtherPins=true)
 Set the electrical type of the pin. More...
 
void SetLength (int aLength, bool aTestOtherPins=true)
 Set the pin length. More...
 
int GetLength ()
 
void SetPartNumber (int aPart)
 Set the pin part number. More...
 
int GetPartNumber () const
 Get the pin part number. More...
 
void SetConversion (int aConversion)
 Set the body style (conversion) of the pin. More...
 
void SetVisible (bool aVisible)
 Set or clear the visibility flag for the pin. More...
 
void EnableEditMode (bool aEnable, bool aEditPinByPin=false)
 Enable or clear pin editing mode. More...
 
bool IsVisible () const
 Return the visibility status of the draw object. More...
 
bool IsPowerConnection () const
 Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN. More...
 
int GetPenSize () const override
 
void PrintPinSymbol (wxDC *aDC, const wxPoint &aPos, int aOrientation)
 Print the pin symbol without text. More...
 
void PrintPinTexts (wxDC *aDC, wxPoint &aPosition, int aOrientation, int TextInside, bool DrawPinNum, bool DrawPinName)
 Put the pin number and pin text info, given the pin line coordinates. More...
 
void PrintPinElectricalTypeName (wxDC *aDC, wxPoint &aPosition, int aOrientation)
 Draw the electrical type text of the pin (only for the footprint editor) More...
 
void PlotPinTexts (PLOTTER *aPlotter, wxPoint &aPosition, int aOrientation, int aTextInside, bool aDrawPinNum, bool aDrawPinName, int aWidth)
 Plot the pin number and pin text info, given the pin line coordinates. More...
 
void PlotSymbol (PLOTTER *aPlotter, const wxPoint &aPosition, int aOrientation)
 
void Offset (const wxPoint &aOffset) override
 Set the drawing object by aOffset from the current position. More...
 
bool Inside (EDA_RECT &aRect) const override
 Test if any part of the draw object is inside rectangle bounds of aRect. More...
 
void MoveTo (const wxPoint &aPosition) override
 Move a draw object to aPosition. More...
 
wxPoint GetPosition () const override
 
void SetPinPosition (wxPoint aPosition)
 move this and all linked pins to the new position used in pin editing. More...
 
void MirrorHorizontal (const wxPoint &aCenter) override
 Mirror the draw object along the horizontal (X) axis about aCenter point. More...
 
void MirrorVertical (const wxPoint &aCenter) override
 Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...
 
void Rotate (const wxPoint &aCenter, bool aRotateCCW=true) override
 Rotate the object about aCenter point. More...
 
void Plot (PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) override
 Plot the draw item using the plot object. More...
 
int GetWidth () const override
 
void SetWidth (int aWidth) override
 
BITMAP_DEF GetMenuImage () const override
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
EDA_ITEMClone () const override
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
void CalcEdit (const wxPoint &aPosition) override
 Calculates the attributes of an item at aPosition when it is being edited. More...
 
virtual void BeginEdit (const wxPoint aPosition)
 Begin drawing a component library draw item at aPosition. More...
 
virtual bool ContinueEdit (const wxPoint aPosition)
 Continue an edit in progress at aPosition. More...
 
virtual void EndEdit ()
 End an object editing action. More...
 
virtual void Print (wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
 Draw an item. More...
 
LIB_PARTGetParent () const
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...
 
bool operator== (const LIB_ITEM &aOther) const
 Test LIB_ITEM objects for equivalence. More...
 
bool operator== (const LIB_ITEM *aOther) const
 
bool operator< (const LIB_ITEM &aOther) const
 Test if another draw item is less than this draw object. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
void SetPosition (const wxPoint &aPosition)
 
bool IsFillable () const
 Check if draw object can be filled. More...
 
virtual COLOR4D GetDefaultColor ()
 
void SetUnit (int aUnit)
 
int GetUnit () const
 
void SetConvert (int aConvert)
 
int GetConvert () const
 
void SetFillMode (FILL_T aFillMode)
 
FILL_T GetFillMode () const
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
void SetParent (EDA_ITEM *aParent)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag)
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
virtual bool IsType (const KICAD_T aScanTypes[]) const
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 

Static Public Member Functions

static const wxString GetCanonicalElectricalTypeName (ELECTRICAL_PINTYPE aType)
 return a string giving the electrical type of a pin. More...
 
static wxArrayString GetOrientationNames ()
 Get a list of pin orientation names. More...
 
static const BITMAP_DEFGetOrientationSymbols ()
 Get a list of pin orientation bitmaps for menus and dialogs. More...
 
static int GetOrientationCode (int aIndex)
 Get the orientation code by index used to set the pin orientation. More...
 
static int GetOrientationIndex (int aCode)
 Get the index of the orientation code. More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
template<class T >
static SEARCH_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T ) More...
 
static bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Protected Member Functions

bool Matches (const wxString &aText, wxFindReplaceData &aSearchData)
 Function Matches compares aText against search criteria in aSearchData. More...
 

Protected Attributes

int m_Unit
 Unit identification for multiple parts per package. More...
 
int m_Convert
 Shape identification for alternate body styles. More...
 
FILL_T m_Fill
 The body fill type. More...
 
bool m_isFillable
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void print (wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
 Print a pin, with or without the pin texts. More...
 
void getMsgPanelInfoBase (EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList)
 Build the pin basic info to display in message panel. More...
 
int compare (const LIB_ITEM &aOther) const override
 Provide the draw object specific comparison called by the == and < operators. More...
 

Private Attributes

wxPoint m_position
 Position of the pin. More...
 
int m_length
 Length of the pin. More...
 
int m_orientation
 Pin orientation (Up, Down, Left, Right) More...
 
GRAPHIC_PINSHAPE m_shape
 Shape drawn around pin. More...
 
int m_width
 Line width of the pin. More...
 
ELECTRICAL_PINTYPE m_type
 Electrical type of the pin. See enum ELECTRICAL_PINTYPE. More...
 
int m_attributes
 Set bit 0 to indicate pin is invisible. More...
 
wxString m_name
 
wxString m_number
 
int m_numTextSize
 
int m_nameTextSize
 Pin num and Pin name sizes. More...
 

Friends

class SCH_LEGACY_PLUGIN_CACHE
 

Detailed Description

Definition at line 60 of file lib_pin.h.

Member Enumeration Documentation

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int
inherited
Enumerator
BASE 
DEMORGAN 

Definition at line 107 of file lib_item.h.

107 : int { BASE = 1, DEMORGAN = 2 };

Constructor & Destructor Documentation

◆ LIB_PIN()

LIB_PIN::LIB_PIN ( LIB_PART aParent)

Definition at line 146 of file lib_pin.cpp.

148 {
150  m_orientation = PIN_RIGHT; // Pin orient: Up, Down, Left, Right
151  m_type = ELECTRICAL_PINTYPE::PT_UNSPECIFIED; // electrical type of pin
152  m_attributes = 0; // bit 0 != 0: pin invisible
155  m_width = 0;
156 }
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
int m_numTextSize
Definition: lib_pin.h:76
static int GetDefaultPinLength()
unknown electrical properties: creates always a warning when connected
int m_length
Length of the pin.
Definition: lib_pin.h:68
static int GetPinNumDefaultSize()
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
int m_attributes
Set bit 0 to indicate pin is invisible.
Definition: lib_pin.h:73
static int GetPinNameDefaultSize()
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72
LIB_ITEM(KICAD_T aType, LIB_PART *aComponent=NULL, int aUnit=0, int aConvert=0, FILL_T aFillType=NO_FILL)
Definition: lib_item.cpp:37
int m_width
Line width of the pin.
Definition: lib_pin.h:71

References LIB_EDIT_FRAME::GetDefaultPinLength(), LIB_EDIT_FRAME::GetPinNameDefaultSize(), LIB_EDIT_FRAME::GetPinNumDefaultSize(), LINE, m_attributes, m_length, m_nameTextSize, m_numTextSize, m_orientation, m_type, m_width, PIN_RIGHT, and PT_UNSPECIFIED.

Referenced by Clone().

◆ ~LIB_PIN()

LIB_PIN::~LIB_PIN ( )
inline

Definition at line 96 of file lib_pin.h.

96 { }

Member Function Documentation

◆ BeginEdit()

virtual void LIB_ITEM::BeginEdit ( const wxPoint  aPosition)
inlinevirtualinherited

Begin drawing a component library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the component library editor and one of the graphics tools is selected.

Parameters
aPositionThe position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented in LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 124 of file lib_item.h.

124 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ CalcEdit()

void LIB_PIN::CalcEdit ( const wxPoint aPosition)
overridevirtual

Calculates the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the component library editor. Therefore, the default method does nothing.

Parameters
aPositionThe current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 1637 of file lib_pin.cpp.

1638 {
1639  if( IsMoving() )
1640  {
1641  DBG(printf("MOVEPIN\n");)
1642  MoveTo( aPosition );
1643  }
1644 }
bool IsMoving() const
Definition: base_struct.h:220
void MoveTo(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_pin.cpp:1278
#define DBG(x)
Definition: fctsys.h:33

References DBG, EDA_ITEM::IsMoving(), and MoveTo().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 235 of file base_struct.h.

235 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearEditFlags()

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 256 of file base_struct.h.

256 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References EDA_ITEM::m_Flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_COMPONENT::ClearAllHighlightFlags(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearHighlighted(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), MWAVE::CreateMicrowaveInductor(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::Exchange_Module(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), KIGFX::SCH_VIEW::HighlightItem(), MODULE_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceModule(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::RollbackPartFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearHighlighted()

void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 234 of file base_struct.h.

234 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )
inlineinherited

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 268 of file base_struct.h.

269  {
271  }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
#define CANDIDATE
flag indicating that the structure is connected
Definition: base_struct.h:130
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:256
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:132
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, and STARTPOINT.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 153 of file view_item.h.

154  {
156  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:161
#define NULL

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * LIB_PIN::Clone ( ) const
overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns
A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 1234 of file lib_pin.cpp.

1235 {
1236  return new LIB_PIN( *this );
1237 }
LIB_PIN(LIB_PART *aParent)
Definition: lib_pin.cpp:146

References LIB_PIN().

Referenced by LIB_PIN_TOOL::CreateImagePins(), and LIB_PIN_TOOL::RepeatPin().

◆ compare()

int LIB_PIN::compare ( const LIB_ITEM aOther) const
overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

  • Component alternate part (DeMorgan) number.
  • Component part number.
  • KICAD_T enum value.
  • Result of derived classes comparison.
Parameters
aOtherA reference to the other LIB_ITEM to compare the arc against.
Returns
An integer value less than 0 if the object is less than aOther ojbect, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The pin specific sort order is as follows:

  • Pin number.
  • Pin name, case insensitive compare.
  • Pin horizontal (X) position.
  • Pin vertical (Y) position.

Implements LIB_ITEM.

Definition at line 1240 of file lib_pin.cpp.

1241 {
1242  wxASSERT( other.Type() == LIB_PIN_T );
1243 
1244  const LIB_PIN* tmp = (LIB_PIN*) &other;
1245 
1246  if( m_number != tmp->m_number )
1247  return m_number.Cmp( tmp->m_number );
1248 
1249  int result = m_name.CmpNoCase( tmp->m_name );
1250 
1251  if( result != 0 )
1252  return result;
1253 
1254  if( m_position.x != tmp->m_position.x )
1255  return m_position.x - tmp->m_position.x;
1256 
1257  if( m_position.y != tmp->m_position.y )
1258  return m_position.y - tmp->m_position.y;
1259 
1260  return 0;
1261 }
wxString m_name
Definition: lib_pin.h:74
wxString m_number
Definition: lib_pin.h:75
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References LIB_PIN_T, m_name, m_number, m_position, EDA_ITEM::Type(), wxPoint::x, and wxPoint::y.

◆ ContinueEdit()

virtual bool LIB_ITEM::ContinueEdit ( const wxPoint  aPosition)
inlinevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters
aPositionThe position of the mouse left click in drawing coordinates.
Returns
True if additional mouse clicks are required to complete the edit in progress.

Reimplemented in LIB_POLYLINE.

Definition at line 136 of file lib_item.h.

136 { return false; }

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ EnableEditMode()

void LIB_PIN::EnableEditMode ( bool  aEnable,
bool  aEditPinByPin = false 
)

Enable or clear pin editing mode.

The pin editing mode marks or unmarks all pins common to this pin object for further editing. If any of the pin modification methods are called after enabling the editing mode, all pins marked for editing will have the same attribute changed. The only case were this is not true making this pin common to all parts or body styles in the component. See SetCommonToAllParts() and SetCommonToAllBodyStyles() for more information.

Parameters
aEnable= true marks all common pins for editing mode. False clears the editing mode.
aEditPinByPin== true enables the edit pin by pin mode. aEditPinByPin == false enables the pin edit coupling between pins at the same location if aEnable == false, aEditPinByPin is not used

Definition at line 502 of file lib_pin.cpp.

503 {
504  LIB_PINS pinList;
505 
506  if( GetParent() == NULL )
507  return;
508 
509  GetParent()->GetPins( pinList );
510 
511  for( size_t i = 0; i < pinList.size(); i++ )
512  {
513  if( pinList[i] == this )
514  continue;
515 
516  if( ( pinList[i]->m_position == m_position )
517  && ( pinList[i]->m_orientation == m_orientation )
518  && !IsNew() && !aEditPinByPin && aEnable )
519  {
520  pinList[i]->SetFlags( IS_LINKED | IN_EDIT );
521  }
522  else
523  pinList[i]->ClearFlags( IS_LINKED | IN_EDIT );
524  }
525 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
#define IN_EDIT
Item currently edited.
Definition: base_struct.h:118
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
bool IsNew() const
Definition: base_struct.h:218
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
#define NULL
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IN_EDIT, IS_LINKED, EDA_ITEM::IsNew(), m_orientation, m_position, and NULL.

Referenced by LIB_PIN_TOOL::EditPinProperties().

◆ EndEdit()

virtual void LIB_ITEM::EndEdit ( )
inlinevirtualinherited

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented in LIB_POLYLINE.

Definition at line 143 of file lib_item.h.

143 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ GetBoundingBox() [1/2]

const EDA_RECT LIB_PIN::GetBoundingBox ( ) const
inlineoverridevirtual
Returns
the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 128 of file lib_pin.h.

128 { return GetBoundingBox( false ); }
const EDA_RECT GetBoundingBox() const override
Definition: lib_pin.h:128

References GetBoundingBox().

Referenced by SCH_PIN::GetBoundingBox(), GetBoundingBox(), HitTest(), and DIALOG_LIB_EDIT_PIN::OnPaintShowPanel().

◆ GetBoundingBox() [2/2]

const EDA_RECT LIB_PIN::GetBoundingBox ( bool  aIncludeInvisibles) const
Parameters
aIncludeInvisibles- if false, do not include labels for invisible pins in the calculation.

Definition at line 1438 of file lib_pin.cpp.

1439 {
1440  LIB_PART* entry = static_cast<LIB_PART*>( m_Parent );
1441  EDA_RECT bbox;
1442  wxPoint begin;
1443  wxPoint end;
1444  int nameTextOffset = 0;
1445  bool showName = !m_name.IsEmpty() && (m_name != wxT( "~" ));
1446  bool showNum = !m_number.IsEmpty();
1447  int minsizeV = TARGET_PIN_RADIUS;
1448 
1449  if( !aIncludeInvisibles && !IsVisible() )
1450  showName = false;
1451 
1452  if( entry )
1453  {
1454  if( entry->ShowPinNames() )
1455  nameTextOffset = entry->GetPinNameOffset();
1456  else
1457  showName = false;
1458 
1459  showNum = entry->ShowPinNumbers();
1460  }
1461 
1462  // First, calculate boundary box corners position
1463  int numberTextLength = showNum ? m_numTextSize * m_number.Len() : 0;
1464 
1465  // Actual text height is bigger than text size
1466  int numberTextHeight = showNum ? KiROUND( m_numTextSize * 1.1 ) : 0;
1467 
1469  minsizeV = std::max( TARGET_PIN_RADIUS, ExternalPinDecoSize( *this ) );
1470 
1471  // calculate top left corner position
1472  // for the default pin orientation (PIN_RIGHT)
1473  begin.y = std::max( minsizeV, numberTextHeight + Mils2iu( PIN_TEXT_MARGIN ) );
1474  begin.x = std::min( -TARGET_PIN_RADIUS, m_length - (numberTextLength / 2) );
1475 
1476  // calculate bottom right corner position and adjust top left corner position
1477  int nameTextLength = 0;
1478  int nameTextHeight = 0;
1479 
1480  if( showName )
1481  {
1482  int length = m_name.Len();
1483 
1484  // Don't count the line over text symbol.
1485  if( m_name.Left( 1 ) == wxT( "~" ) )
1486  length -= 1;
1487 
1488  nameTextLength = ( m_nameTextSize * length ) + nameTextOffset;
1489 
1490  // Actual text height are bigger than text size
1491  nameTextHeight = KiROUND( m_nameTextSize * 1.1 ) + Mils2iu( PIN_TEXT_MARGIN );
1492  }
1493 
1494  if( nameTextOffset ) // for values > 0, pin name is inside the body
1495  {
1496  end.x = m_length + nameTextLength + TARGET_PIN_RADIUS;
1497  end.y = std::min( -minsizeV, -nameTextHeight / 2 );
1498  }
1499  else // if value == 0:
1500  // pin name is outside the body, and above the pin line
1501  // pin num is below the pin line
1502  {
1503  end.x = std::max( m_length + TARGET_PIN_RADIUS, nameTextLength );
1504  end.y = -begin.y;
1505  begin.y = std::max( minsizeV, nameTextHeight );
1506  }
1507 
1508  // Now, calculate boundary box corners position for the actual pin orientation
1509  int orient = PinDrawOrient( DefaultTransform );
1510 
1511  /* Calculate the pin position */
1512  switch( orient )
1513  {
1514  case PIN_UP:
1515  // Pin is rotated and texts positions are mirrored
1516  RotatePoint( &begin, wxPoint( 0, 0 ), -900 );
1517  RotatePoint( &end, wxPoint( 0, 0 ), -900 );
1518  break;
1519 
1520  case PIN_DOWN:
1521  RotatePoint( &begin, wxPoint( 0, 0 ), 900 );
1522  RotatePoint( &end, wxPoint( 0, 0 ), 900 );
1523  begin.x = -begin.x;
1524  end.x = -end.x;
1525  break;
1526 
1527  case PIN_LEFT:
1528  begin.x = -begin.x;
1529  end.x = -end.x;
1530  break;
1531 
1532  case PIN_RIGHT:
1533  break;
1534  }
1535 
1536  begin += m_position;
1537  end += m_position;
1538 
1539  bbox.SetOrigin( begin );
1540  bbox.SetEnd( end );
1541  bbox.Normalize();
1542  bbox.Inflate( ( GetPenSize() / 2 ) + 1 );
1543 
1544  // Draw Y axis is reversed in schematic:
1545  bbox.RevertYAxis();
1546 
1547  return bbox;
1548 }
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:177
static int ExternalPinDecoSize(const LIB_PIN &aPin)
Utility for getting the size of the 'external' pin decorators (as a radius)
Definition: lib_pin.cpp:141
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
int GetPinNameOffset()
int m_numTextSize
Definition: lib_pin.h:76
TRANSFORM DefaultTransform
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:131
wxString m_name
Definition: lib_pin.h:74
Definition: lib_pin.h:55
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int PinDrawOrient(const TRANSFORM &aTransform) const
Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation...
Definition: lib_pin.cpp:1200
int m_length
Length of the pin.
Definition: lib_pin.h:68
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size)
Definition: eda_rect.h:209
bool ShowPinNames()
int GetPenSize() const override
Definition: lib_pin.cpp:536
bool ShowPinNumbers()
wxString m_number
Definition: lib_pin.h:75
void SetEnd(int x, int y)
Definition: eda_rect.h:192
Define a library symbol object.
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
void Normalize()
Function Normalize ensures that the height ant width are positive.
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67
#define PIN_TEXT_MARGIN
Definition: lib_pin.cpp:65
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:61
#define TARGET_PIN_RADIUS
Definition: lib_pin.h:43
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References DefaultTransform, ExternalPinDecoSize(), GetPenSize(), LIB_PART::GetPinNameOffset(), EDA_RECT::Inflate(), INVERTED, INVERTED_CLOCK, IsVisible(), KiROUND(), m_length, m_name, m_nameTextSize, m_number, m_numTextSize, EDA_ITEM::m_Parent, m_position, m_shape, EDA_RECT::Normalize(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PinDrawOrient(), EDA_RECT::RevertYAxis(), RotatePoint(), EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), LIB_PART::ShowPinNames(), LIB_PART::ShowPinNumbers(), TARGET_PIN_RADIUS, wxPoint::x, and wxPoint::y.

◆ GetCanonicalElectricalTypeName() [1/2]

const wxString LIB_PIN::GetCanonicalElectricalTypeName ( ELECTRICAL_PINTYPE  aType)
static

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)

Parameters
aTypeis the electrical type (see enum ELECTRICAL_PINTYPE )
Returns
The electrical name for a pin type (see enun MsgPinElectricType for names).

Definition at line 78 of file lib_pin.cpp.

79 {
80  // These strings are the canonical name of the electrictal type
81  // Not translated, no space in name, only ASCII chars.
82  // to use when the string name must be known and well defined
83  // must have same order than enum ELECTRICAL_PINTYPE (see lib_pin.h)
84  static const wxChar* msgPinElectricType[] =
85  {
86  wxT( "input" ),
87  wxT( "output" ),
88  wxT( "BiDi" ),
89  wxT( "3state" ),
90  wxT( "passive" ),
91  wxT( "unspc" ),
92  wxT( "power_in" ),
93  wxT( "power_out" ),
94  wxT( "openCol" ),
95  wxT( "openEm" ),
96  wxT( "NotConnected" )
97  };
98 
99  return msgPinElectricType[static_cast<int>( aType )];
100 }

◆ GetCanonicalElectricalTypeName() [2/2]

wxString const LIB_PIN::GetCanonicalElectricalTypeName ( ) const
inline

return a string giving the electrical type of the pin.

Can be used when a known, not translated name is needed (for instance in net lists)

Returns
The canonical electrical name of the pin.

Definition at line 247 of file lib_pin.h.

248  {
250  }
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72
wxString const GetCanonicalElectricalTypeName() const
return a string giving the electrical type of the pin.
Definition: lib_pin.h:247

References m_type.

◆ GetClass()

wxString LIB_PIN::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 98 of file lib_pin.h.

99  {
100  return wxT( "LIB_PIN" );
101  }

◆ GetConvert()

◆ GetDefaultColor()

COLOR4D LIB_ITEM::GetDefaultColor ( )
virtualinherited

Reimplemented in LIB_FIELD.

Definition at line 139 of file lib_item.cpp.

140 {
141  return GetLayerColor( LAYER_DEVICE );
142 }
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)

References GetLayerColor(), and LAYER_DEVICE.

Referenced by LIB_TEXT::Plot(), and LIB_TEXT::print().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 260 of file base_struct.h.

261  {
265  return m_Flags & mask;
266  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: base_struct.h:128
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:139
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:138
#define EDA_ITEM_ALL_FLAGS
Definition: base_struct.h:154
#define SELECTED
Definition: base_struct.h:127
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143
#define DP_COUPLED
item is coupled with another item making a differential pair
Definition: base_struct.h:145
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
#define IS_DANGLING
indicates a pin is dangling
Definition: base_struct.h:149
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#define ENDPOINT
ends. (Used to support dragging.)
Definition: base_struct.h:126
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: base_struct.h:125

References BEGIN_ONPAD, BRIGHTENED, DP_COUPLED, EDA_ITEM_ALL_FLAGS, END_ONPAD, ENDPOINT, HIGHLIGHTED, IS_DANGLING, EDA_ITEM::m_Flags, SELECTED, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeShape(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editComponentFieldText(), SCH_EDITOR_CONTROL::EditWithLibEdit(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetElectricalTypeName()

wxString const LIB_PIN::GetElectricalTypeName ( ) const
inline

return a translated string for messages giving the electrical type of the pin.

Returns
The electrical name of the pin.

Definition at line 256 of file lib_pin.h.

257  {
258  return GetText( m_type );
259  }
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72

References GetText(), and m_type.

Referenced by KIGFX::SCH_PAINTER::draw(), GetSelectMenuText(), and PrintPinElectricalTypeName().

◆ GetFillMode()

◆ GetFlags()

◆ GetLength()

int LIB_PIN::GetLength ( )
inline

◆ GetMenuImage()

BITMAP_DEF LIB_PIN::GetMenuImage ( ) const
overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns
The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1591 of file lib_pin.cpp.

1592 {
1593  return GetBitmap( m_type );
1594 }
BITMAP_DEF GetBitmap(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:68
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72

References GetBitmap(), and m_type.

◆ GetMsgPanelInfo() [1/2]

void LIB_PIN::GetMsgPanelInfo ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Display basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters
aListis the list to populate.

Reimplemented from LIB_ITEM.

Referenced by LIB_PIN_TOOL::EditPinProperties(), and SCH_PIN::GetMsgPanelInfo().

◆ GetMsgPanelInfo() [2/2]

void LIB_PIN::GetMsgPanelInfo ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList,
SCH_COMPONENT aComponent 
)

Display pin info (given by GetMsgPanelInfo) and add some info related to aComponent (schematic pin position, and sheet path)

Parameters
aListis the message list to fill
aComponentis the component which "owns" the pin

Definition at line 1407 of file lib_pin.cpp.

1409 {
1410  getMsgPanelInfoBase( aUnits, aList );
1411 
1412  if( !aComponent )
1413  return;
1414 
1415  wxString text;
1416  wxPoint pinpos = aComponent->GetTransform().TransformCoordinate( GetPosition() )
1417  + aComponent->GetPosition();
1418 
1419  text = MessageTextFromValue( aUnits, pinpos.x, true );
1420  aList.emplace_back( _( "Pos X" ), text, DARKMAGENTA );
1421 
1422  text = MessageTextFromValue( aUnits, pinpos.y, true );
1423  aList.emplace_back( _( "Pos Y" ), text, DARKMAGENTA );
1424 
1425  aList.emplace_back( aComponent->GetField( REFERENCE )->GetShownText(),
1426  aComponent->GetField( VALUE )->GetShownText(), DARKCYAN );
1427 
1428 #if defined(DEBUG)
1429 
1430  auto conn = aComponent->GetConnectionForPin( this, *g_CurrentSheet );
1431 
1432  if( conn )
1433  conn->AppendDebugInfoToMsgPanel( aList );
1434 
1435 #endif
1436 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:127
Field Reference of part, i.e. "IC21".
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define VALUE
SCH_SHEET_PATH * g_CurrentSheet
With the new connectivity algorithm, many more places than before want to know what the current sheet...
TRANSFORM & GetTransform() const
SCH_CONNECTION * GetConnectionForPin(LIB_PIN *aPin, const SCH_SHEET_PATH &aSheet)
Retrieves the connection for a given pin of the component.
void AppendDebugInfoToMsgPanel(MSG_PANEL_ITEMS &aList) const
Adds extended debug information about the connection object to aList.
wxPoint GetPosition() const override
Definition: lib_pin.h:429
void getMsgPanelInfoBase(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList)
Build the pin basic info to display in message panel.
Definition: lib_pin.cpp:1367
#define _(s)
Definition: 3d_actions.cpp:31
wxPoint GetPosition() const override
Function GetPosition.
virtual wxString GetShownText() const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:129

References _, SCH_CONNECTION::AppendDebugInfoToMsgPanel(), DARKCYAN, DARKMAGENTA, g_CurrentSheet, SCH_COMPONENT::GetConnectionForPin(), SCH_COMPONENT::GetField(), getMsgPanelInfoBase(), GetPosition(), SCH_COMPONENT::GetPosition(), EDA_TEXT::GetShownText(), SCH_COMPONENT::GetTransform(), MessageTextFromValue(), REFERENCE, TRANSFORM::TransformCoordinate(), VALUE, wxPoint::x, and wxPoint::y.

◆ getMsgPanelInfoBase()

void LIB_PIN::getMsgPanelInfoBase ( EDA_UNITS  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
private

Build the pin basic info to display in message panel.

they are pin info without the actual pin position, which is not known in schematic without knowing the parent component

Definition at line 1367 of file lib_pin.cpp.

1368 {
1369  wxString text = m_number.IsEmpty() ? wxT( "?" ) : m_number;
1370 
1371  LIB_ITEM::GetMsgPanelInfo( aUnits, aList );
1372 
1373  aList.push_back( MSG_PANEL_ITEM( _( "Name" ), m_name, DARKCYAN ) );
1374  aList.push_back( MSG_PANEL_ITEM( _( "Number" ), text, DARKCYAN ) );
1375  aList.push_back( MSG_PANEL_ITEM( _( "Type" ), GetText( m_type ), RED ) );
1376 
1377  text = GetText( m_shape );
1378  aList.push_back( MSG_PANEL_ITEM( _( "Style" ), text, BLUE ) );
1379 
1380  text = IsVisible() ? _( "Yes" ) : _( "No" );
1381  aList.push_back( MSG_PANEL_ITEM( _( "Visible" ), text, DARKGREEN ) );
1382 
1383  // Display pin length
1384  text = StringFromValue( aUnits, m_length, true );
1385  aList.push_back( MSG_PANEL_ITEM( _( "Length" ), text, MAGENTA ) );
1386 
1388  aList.push_back( MSG_PANEL_ITEM( _( "Orientation" ), text, DARKMAGENTA ) );
1389 }
Definition: colors.h:57
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
void GetMsgPanelInfo(EDA_UNITS aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
Definition: lib_item.cpp:52
static const wxString getPinOrientationName(unsigned aPinOrientationCode)
Definition: lib_pin.cpp:107
static int GetOrientationIndex(int aCode)
Get the index of the orientation code.
Definition: lib_pin.cpp:1571
Definition: colors.h:61
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, bool aUseMils)
Function StringFromValue returns the string from aValue according to units (inch, mm ....
Definition: base_units.cpp:219
wxString m_name
Definition: lib_pin.h:74
int m_length
Length of the pin.
Definition: lib_pin.h:68
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
wxString m_number
Definition: lib_pin.h:75
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
Definition: colors.h:60
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
#define _(s)
Definition: 3d_actions.cpp:31
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53

References _, BLUE, DARKCYAN, DARKGREEN, DARKMAGENTA, LIB_ITEM::GetMsgPanelInfo(), GetOrientationIndex(), getPinOrientationName(), GetText(), IsVisible(), m_length, m_name, m_number, m_orientation, m_shape, m_type, MAGENTA, RED, and StringFromValue().

Referenced by GetMsgPanelInfo().

◆ GetName()

const wxString& LIB_PIN::GetName ( void  ) const
inline

◆ GetNameTextSize()

int LIB_PIN::GetNameTextSize ( ) const
inline

◆ GetNumber()

◆ GetNumberTextSize()

◆ GetOrientation()

◆ GetOrientationCode()

int LIB_PIN::GetOrientationCode ( int  aIndex)
static

Get the orientation code by index used to set the pin orientation.

Parameters
aIndex- The index of the orientation code to look up.
Returns
Orientation code if index is valid. Returns right orientation on index error.

Definition at line 1562 of file lib_pin.cpp.

1563 {
1564  if( index >= 0 && index < (int) PIN_ORIENTATION_CNT )
1565  return pin_orientation_codes[ index ];
1566 
1567  return PIN_RIGHT;
1568 }
static const int pin_orientation_codes[]
Definition: lib_pin.cpp:55
#define PIN_ORIENTATION_CNT
Definition: lib_pin.cpp:62

References PIN_ORIENTATION_CNT, pin_orientation_codes, and PIN_RIGHT.

Referenced by DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ GetOrientationIndex()

int LIB_PIN::GetOrientationIndex ( int  aCode)
static

Get the index of the orientation code.

Parameters
aCode- The orientation code to look up.
Returns
The index of the orientation code if found. Otherwise, return wxNOT_FOUND.

Definition at line 1571 of file lib_pin.cpp.

1572 {
1573  size_t i;
1574 
1575  for( i = 0; i < PIN_ORIENTATION_CNT; i++ )
1576  {
1577  if( pin_orientation_codes[i] == code )
1578  return (int) i;
1579  }
1580 
1581  return wxNOT_FOUND;
1582 }
static const int pin_orientation_codes[]
Definition: lib_pin.cpp:55
#define PIN_ORIENTATION_CNT
Definition: lib_pin.cpp:62

References PIN_ORIENTATION_CNT, and pin_orientation_codes.

Referenced by getMsgPanelInfoBase(), PIN_TABLE_DATA_MODEL::GetValue(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

◆ GetOrientationNames()

wxArrayString LIB_PIN::GetOrientationNames ( void  )
static

Get a list of pin orientation names.

Returns
List of valid pin orientation names.

Definition at line 1551 of file lib_pin.cpp.

1552 {
1553  wxArrayString tmp;
1554 
1555  for( unsigned ii = 0; ii < PIN_ORIENTATION_CNT; ii++ )
1556  tmp.Add( getPinOrientationName( ii ) );
1557 
1558  return tmp;
1559 }
static const wxString getPinOrientationName(unsigned aPinOrientationCode)
Definition: lib_pin.cpp:107
#define PIN_ORIENTATION_CNT
Definition: lib_pin.cpp:62

References getPinOrientationName(), and PIN_ORIENTATION_CNT.

Referenced by DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), and DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE().

◆ GetOrientationSymbols()

const BITMAP_DEF * LIB_PIN::GetOrientationSymbols ( )
static

Get a list of pin orientation bitmaps for menus and dialogs.

Returns
List of valid pin orientation bitmaps symbols in .xpm format

Definition at line 1585 of file lib_pin.cpp.

1586 {
1587  return iconsPinsOrientations;
1588 }
static const BITMAP_DEF iconsPinsOrientations[]
Definition: lib_pin.cpp:69

References iconsPinsOrientations.

Referenced by DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), and DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE().

◆ GetParent()

◆ GetPartNumber()

int LIB_PIN::GetPartNumber ( ) const
inline

Get the pin part number.

Definition at line 296 of file lib_pin.h.

296 { return m_Unit; }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81

References LIB_ITEM::m_Unit.

◆ GetPenSize()

int LIB_PIN::GetPenSize ( ) const
overridevirtual
Returns
the size of the "pen" that be used to draw or plot this item

Implements LIB_ITEM.

Definition at line 536 of file lib_pin.cpp.

537 {
538  if( m_width > 0 )
539  return m_width;
540 
541  if( m_width == 0 )
542  return GetDefaultLineThickness();
543 
544  return 0;
545 }
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
int m_width
Line width of the pin.
Definition: lib_pin.h:71

References GetDefaultLineThickness(), and m_width.

Referenced by GetBoundingBox(), Plot(), PlotPinTexts(), PlotSymbol(), PrintPinSymbol(), and PrintPinTexts().

◆ GetPosition()

◆ GetSelectMenuText()

wxString LIB_PIN::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1597 of file lib_pin.cpp.

1598 {
1599  return wxString::Format( _( "Pin %s, %s, %s" ),
1600  m_number,
1602  GetText( m_shape ));
1603 }
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
wxString m_number
Definition: lib_pin.h:75
wxString const GetElectricalTypeName() const
return a translated string for messages giving the electrical type of the pin.
Definition: lib_pin.h:256
wxString GetText(GRAPHIC_PINSHAPE aShape)
Definition: pin_shape.cpp:58
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:31

References _, Format(), GetElectricalTypeName(), GetText(), m_number, and m_shape.

Referenced by SCH_PIN::GetSelectMenuText(), and Matches().

◆ GetShape()

GRAPHIC_PINSHAPE LIB_PIN::GetShape ( ) const
inline

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 239 of file base_struct.h.

240  {
241  return m_Status & type;
242  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by SELECTION_TOOL::expandConnection(), TRACK::GetMsgPanelInfoBase_Common(), TRACK::IsLocked(), TRACK::Print(), and ZONE_CONTAINER::PrintFilledArea().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 252 of file base_struct.h.

252 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

◆ GetTimeStamp()

◆ GetType()

ELECTRICAL_PINTYPE LIB_PIN::GetType ( ) const
inline

Get the electrical type of the pin.

Returns
The electrical type of the pin (see enum ELECTRICAL_PINTYPE for values).

Definition at line 232 of file lib_pin.h.

232 { return m_type; }
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72

References m_type.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN_TOOL::EditPinProperties(), SCH_PIN::GetType(), IsPowerConnection(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), LIB_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

◆ GetTypeName()

wxString LIB_PIN::GetTypeName ( )
inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 103 of file lib_pin.h.

104  {
105  return _( "Pin" );
106  }
#define _(s)
Definition: 3d_actions.cpp:31

References _.

◆ GetUnit()

◆ GetWidth()

int LIB_PIN::GetWidth ( ) const
inlineoverridevirtual

Implements LIB_ITEM.

Definition at line 446 of file lib_pin.h.

446 { return m_width; }
int m_width
Line width of the pin.
Definition: lib_pin.h:71

References m_width.

◆ HasFlag()

◆ HitTest() [1/2]

bool LIB_PIN::HitTest ( const wxPoint aPosition,
int  aAccuracy = 0 
) const
overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from LIB_ITEM.

Definition at line 528 of file lib_pin.cpp.

529 {
530  EDA_RECT rect = GetBoundingBox();
531 
532  return rect.Inflate( aAccuracy ).Contains( aPosition );
533 }
const EDA_RECT GetBoundingBox() const override
Definition: lib_pin.h:128
bool Contains(const wxPoint &aPoint) const
Function Contains.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), GetBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool LIB_ITEM::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtualinherited

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Reimplemented in LIB_POLYLINE, and LIB_TEXT.

Definition at line 106 of file lib_item.cpp.

107 {
108  if( m_Flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
109  return false;
110 
111  EDA_RECT sel = aRect;
112 
113  if ( aAccuracy )
114  sel.Inflate( aAccuracy );
115 
116  if( aContained )
117  return sel.Contains( GetBoundingBox() );
118 
119  return sel.Intersects( GetBoundingBox() );
120 }
const EDA_RECT GetBoundingBox() const override
Definition: lib_item.h:195
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:131
bool Contains(const wxPoint &aPoint) const
Function Contains.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:129
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.

References EDA_RECT::Contains(), LIB_ITEM::GetBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_ITEM::m_Flags, SKIP_STRUCT, and STRUCT_DELETED.

◆ Inside()

bool LIB_PIN::Inside ( EDA_RECT aRect) const
overridevirtual

Test if any part of the draw object is inside rectangle bounds of aRect.

Parameters
aRectRectangle to check against.
Returns
True if object is inside rectangle.

Implements LIB_ITEM.

Definition at line 1270 of file lib_pin.cpp.

1271 {
1272  wxPoint end = PinEndPoint();
1273 
1274  return rect.Contains( m_position.x, -m_position.y ) || rect.Contains( end.x, -end.y );
1275 }
wxPoint PinEndPoint() const
Definition: lib_pin.cpp:1184
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References EDA_RECT::Contains(), m_position, PinEndPoint(), wxPoint::x, and wxPoint::y.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 221 of file base_struct.h.

221 { return m_Flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:122
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References IS_DRAGGED, and EDA_ITEM::m_Flags.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), KIGFX::SCH_PAINTER::setDeviceColors(), and ShowClearance().

◆ IsFillable()

bool LIB_ITEM::IsFillable ( ) const
inlineinherited

Check if draw object can be filled.

The default setting is false. If the derived object support filling, set the m_isFillable member to true.

Definition at line 295 of file lib_item.h.

295 { return m_isFillable; }
bool m_isFillable
Definition: lib_item.h:94

References LIB_ITEM::m_isFillable.

Referenced by LIB_EDIT_TOOL::editGraphicProperties(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

◆ IsHighlighted()

bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

225 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References HIGHLIGHTED, and EDA_ITEM::m_Flags.

Referenced by SCH_COMPONENT::ClearAllHighlightFlags(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and KIGFX::SCH_VIEW::HighlightItem().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

219 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References IS_CHANGED, and EDA_ITEM::m_Flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsPowerConnection()

bool LIB_PIN::IsPowerConnection ( ) const
inline

Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN.

Definition at line 349 of file lib_pin.h.

350  {
352  && ( !IsVisible() || (LIB_PART*) GetParent()->IsPower() );
353  }
power input (GND, VCC for ICs). Must be connected to a power output.
LIB_PART * GetParent() const
Definition: lib_item.h:176
Define a library symbol object.
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
ELECTRICAL_PINTYPE GetType() const
Get the electrical type of the pin.
Definition: lib_pin.h:232
bool IsPower() const

References LIB_ITEM::GetParent(), GetType(), LIB_PART::IsPower(), IsVisible(), and PT_POWER_IN.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_PIN::GetDefaultNetName(), and SCH_PIN::IsPowerConnection().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns
True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 515 of file base_struct.h.

515 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

224 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:121

References IS_RESIZED, and EDA_ITEM::m_Flags.

Referenced by KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsSelected()

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[]) const
inlinevirtualinherited

Function IsType Checks whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented in SCH_LABEL, SCH_FIELD, and SCH_LINE.

Definition at line 284 of file base_struct.h.

285  {
286  if( aScanTypes[0] == SCH_LOCATE_ANY_T )
287  return true;
288 
289  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
290  {
291  if( m_StructType == *p )
292  return true;
293  }
294 
295  return false;
296  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78

References EOT, EDA_ITEM::m_StructType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_LINE::IsType(), SCH_FIELD::IsType(), SCH_LABEL::IsType(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVisible()

bool LIB_PIN::IsVisible ( ) const
inline

Return the visibility status of the draw object.

Returns
True if draw object is visible otherwise false.

Definition at line 343 of file lib_pin.h.

343 { return ( m_attributes & PIN_INVISIBLE ) == 0; }
#define PIN_INVISIBLE
Definition: lib_pin.h:46
int m_attributes
Set bit 0 to indicate pin is invisible.
Definition: lib_pin.h:73

References m_attributes, and PIN_INVISIBLE.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN_TOOL::EditPinProperties(), GetBoundingBox(), getMsgPanelInfoBase(), IsPowerConnection(), SCH_PIN::IsVisible(), Plot(), print(), PrintPinElectricalTypeName(), PrintPinSymbol(), PrintPinTexts(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SetVisible(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

222 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References IS_WIRE_IMAGE, and EDA_ITEM::m_Flags.

◆ IterateForward() [1/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::deque< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use the main queue instead

Definition at line 397 of file base_struct.h.

401  {
402  for( auto it : aList )
403  {
404  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
406  return SEARCH_RESULT::QUIT;
407  }
408 
410  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit(), and BOARD::Visit().

◆ IterateForward() [2/2]

template<class T >
static SEARCH_RESULT EDA_ITEM::IterateForward ( std::vector< T > &  aList,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 418 of file base_struct.h.

420  {
421  for( auto it : aList )
422  {
423  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
425  return SEARCH_RESULT::QUIT;
426  }
427 
429  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ Matches() [1/2]

bool LIB_PIN::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData 
)
overridevirtual

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 1606 of file lib_pin.cpp.

1607 {
1608  wxLogTrace( traceFindItem, wxT( " item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
1609 
1610  // Note: this will have to be modified if we add find and replace capability to the
1611  // compoment library editor. Otherwise, you wont be able to replace pin text.
1612  if( !( aSearchData.GetFlags() & FR_SEARCH_ALL_PINS )
1613  || ( aSearchData.GetFlags() & FR_SEARCH_REPLACE ) )
1614  return false;
1615 
1616  wxLogTrace(
1617  traceFindItem, wxT( " child item " ) + GetSelectMenuText( EDA_UNITS::MILLIMETRES ) );
1618 
1619  return EDA_ITEM::Matches( GetName(), aSearchData )
1620  || EDA_ITEM::Matches( m_number, aSearchData );
1621 }
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: lib_pin.cpp:1597
wxString m_number
Definition: lib_pin.h:75
const wxString & GetName() const
Definition: lib_pin.h:149
const wxChar *const traceFindItem
Flag to enable find debug tracing.
virtual bool Matches(wxFindReplaceData &aSearchData, void *aAuxData)
Function Matches compares the item against the search criteria in aSearchData.
Definition: base_struct.h:471

References FR_SEARCH_ALL_PINS, FR_SEARCH_REPLACE, GetName(), GetSelectMenuText(), m_number, EDA_ITEM::Matches(), MILLIMETRES, and traceFindItem.

Referenced by SCH_PIN::Matches().

◆ Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText,
wxFindReplaceData &  aSearchData 
)
protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 153 of file base_struct.cpp.

154 {
155  wxString text = aText;
156  wxString searchText = aSearchData.GetFindString();
157 
158  // Don't match if searching for replaceable item and the item doesn't support text replace.
159  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
160  return false;
161 
162  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
163  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
164 
165  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
166  {
167  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
168  return text.Matches( searchText );
169 
170  return text.MakeUpper().Matches( searchText.MakeUpper() );
171  }
172 
173  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
174  return aText.Find( searchText ) != wxNOT_FOUND;
175 
176  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
177 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:515

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

◆ MirrorHorizontal()

void LIB_PIN::MirrorHorizontal ( const wxPoint aCenter)
overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 1288 of file lib_pin.cpp.

1289 {
1290  m_position.x -= center.x;
1291  m_position.x *= -1;
1292  m_position.x += center.x;
1293 
1294  if( m_orientation == PIN_RIGHT )
1296  else if( m_orientation == PIN_LEFT )
1298 }
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_orientation, m_position, PIN_LEFT, PIN_RIGHT, and wxPoint::x.

◆ MirrorVertical()

void LIB_PIN::MirrorVertical ( const wxPoint aCenter)
overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters
aCenterPoint to mirror around.

Implements LIB_ITEM.

Definition at line 1300 of file lib_pin.cpp.

1301 {
1302  m_position.y -= center.y;
1303  m_position.y *= -1;
1304  m_position.y += center.y;
1305 
1306  if( m_orientation == PIN_UP )
1308  else if( m_orientation == PIN_DOWN )
1310 }
Definition: lib_pin.h:55
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_orientation, m_position, PIN_DOWN, PIN_UP, and wxPoint::y.

◆ MoveTo()

void LIB_PIN::MoveTo ( const wxPoint aPosition)
overridevirtual

Move a draw object to aPosition.

Parameters
aPositionPosition to move draw item to.

Implements LIB_ITEM.

Definition at line 1278 of file lib_pin.cpp.

1279 {
1280  if( m_position != newPosition )
1281  {
1282  m_position = newPosition;
1283  SetModified();
1284  }
1285 }
void SetModified()
Definition: base_struct.cpp:95
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_position, and EDA_ITEM::SetModified().

Referenced by CalcEdit(), and LIB_PIN_TOOL::CreatePin().

◆ Offset()

void LIB_PIN::Offset ( const wxPoint aOffset)
overridevirtual

Set the drawing object by aOffset from the current position.

Parameters
aOffsetCoordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 1264 of file lib_pin.cpp.

1265 {
1266  m_position += aOffset;
1267 }
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_position.

Referenced by LIB_PIN_TOOL::RepeatPin().

◆ operator<() [1/2]

bool LIB_ITEM::operator< ( const LIB_ITEM aOther) const
inherited

Test if another draw item is less than this draw object.

Parameters
aOther- Draw item to compare against.
Returns
- True if object is less than this object.

Definition at line 85 of file lib_item.cpp.

86 {
87  int result = m_Convert - aOther.m_Convert;
88 
89  if( result != 0 )
90  return result < 0;
91 
92  result = m_Unit - aOther.m_Unit;
93 
94  if( result != 0 )
95  return result < 0;
96 
97  result = Type() - aOther.Type();
98 
99  if( result != 0 )
100  return result < 0;
101 
102  return ( compare( aOther ) < 0 );
103 }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
virtual int compare(const LIB_ITEM &aOther) const =0
Provide the draw object specific comparison called by the == and < operators.
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LIB_ITEM::compare(), LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, and EDA_ITEM::Type().

◆ operator<() [2/2]

bool EDA_ITEM::operator< ( const EDA_ITEM aItem) const
inherited

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 207 of file base_struct.cpp.

208 {
209  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
210  GetChars( GetClass() ) ) );
211 
212  return false;
213 }
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), GetChars(), and EDA_ITEM::GetClass().

◆ operator==() [1/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inherited

Test LIB_ITEM objects for equivalence.

Parameters
aOtherObject to test against.
Returns
True if object is identical to this object.

Definition at line 76 of file lib_item.cpp.

77 {
78  return ( ( Type() == aOther.Type() )
79  && ( m_Unit == aOther.m_Unit )
80  && ( m_Convert == aOther.m_Convert )
81  && compare( aOther ) == 0 );
82 }
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
virtual int compare(const LIB_ITEM &aOther) const =0
Provide the draw object specific comparison called by the == and < operators.
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207

References LIB_ITEM::compare(), LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, and EDA_ITEM::Type().

◆ operator==() [2/2]

bool LIB_ITEM::operator== ( const LIB_ITEM aOther) const
inlineinherited

Definition at line 215 of file lib_item.h.

216  {
217  return *this == *aOther;
218  }

◆ PinDrawOrient()

int LIB_PIN::PinDrawOrient ( const TRANSFORM aTransform) const

Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation and the matrix transform (rot, mirror) aTransform.

Parameters
aTransformTransform matrix

Definition at line 1200 of file lib_pin.cpp.

1201 {
1202  int orient;
1203  wxPoint end; // position of pin end starting at 0,0 according to its orientation, length = 1
1204 
1205  switch( m_orientation )
1206  {
1207  case PIN_UP: end.y = 1; break;
1208  case PIN_DOWN: end.y = -1; break;
1209  case PIN_LEFT: end.x = -1; break;
1210  case PIN_RIGHT: end.x = 1; break;
1211  }
1212 
1213  // = pos of end point, according to the component orientation
1214  end = aTransform.TransformCoordinate( end );
1215  orient = PIN_UP;
1216 
1217  if( end.x == 0 )
1218  {
1219  if( end.y > 0 )
1220  orient = PIN_DOWN;
1221  }
1222  else
1223  {
1224  orient = PIN_RIGHT;
1225 
1226  if( end.x < 0 )
1227  orient = PIN_LEFT;
1228  }
1229 
1230  return orient;
1231 }
Definition: lib_pin.h:55
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69

References m_orientation, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

Referenced by AUTOPLACER::get_pin_side(), GetBoundingBox(), Plot(), and print().

◆ PinEndPoint()

wxPoint LIB_PIN::PinEndPoint ( ) const
Returns
The pin end position for a component in the normal orientation.

Definition at line 1184 of file lib_pin.cpp.

1185 {
1186  wxPoint pos = m_position;
1187 
1188  switch( m_orientation )
1189  {
1190  case PIN_UP: pos.y += m_length; break;
1191  case PIN_DOWN: pos.y -= m_length; break;
1192  case PIN_LEFT: pos.x -= m_length; break;
1193  case PIN_RIGHT: pos.x += m_length; break;
1194  }
1195 
1196  return pos;
1197 }
Definition: lib_pin.h:55
int m_length
Length of the pin.
Definition: lib_pin.h:68
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_length, m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, wxPoint::x, and wxPoint::y.

Referenced by Inside().

◆ Plot()

void LIB_PIN::Plot ( PLOTTER aPlotter,
const wxPoint aOffset,
bool  aFill,
const TRANSFORM aTransform 
)
overridevirtual

Plot the draw item using the plot object.

Parameters
aPlotterThe plot object to plot to.
aOffsetPlot offset position.
aFillFlag to indicate whether or not the object is filled.
aTransformThe plot transform.

Implements LIB_ITEM.

Definition at line 1341 of file lib_pin.cpp.

1343 {
1344  if( ! IsVisible() )
1345  return;
1346 
1347  int orient = PinDrawOrient( aTransform );
1348 
1349  wxPoint pos = aTransform.TransformCoordinate( m_position ) + offset;
1350 
1351  PlotSymbol( plotter, pos, orient );
1352  PlotPinTexts( plotter, pos, orient, GetParent()->GetPinNameOffset(),
1353  GetParent()->ShowPinNumbers(), GetParent()->ShowPinNames(), GetPenSize() );
1354 }
LIB_PART * GetParent() const
Definition: lib_item.h:176
void PlotPinTexts(PLOTTER *aPlotter, wxPoint &aPosition, int aOrientation, int aTextInside, bool aDrawPinNum, bool aDrawPinName, int aWidth)
Plot the pin number and pin text info, given the pin line coordinates.
Definition: lib_pin.cpp:995
int PinDrawOrient(const TRANSFORM &aTransform) const
Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation...
Definition: lib_pin.cpp:1200
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
int GetPenSize() const override
Definition: lib_pin.cpp:536
void PlotSymbol(PLOTTER *aPlotter, const wxPoint &aPosition, int aOrientation)
Definition: lib_pin.cpp:868
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References LIB_ITEM::GetParent(), GetPenSize(), IsVisible(), m_position, PinDrawOrient(), PlotPinTexts(), PlotSymbol(), and TRANSFORM::TransformCoordinate().

◆ PlotPinTexts()

void LIB_PIN::PlotPinTexts ( PLOTTER aPlotter,
wxPoint aPosition,
int  aOrientation,
int  aTextInside,
bool  aDrawPinNum,
bool  aDrawPinName,
int  aWidth 
)

Plot the pin number and pin text info, given the pin line coordinates.

Same as DrawPinTexts((), but output is the plotter The line must be vertical or horizontal. If TextInside then the text is been put inside (moving from x1, y1 in the opposite direction to x2,y2), otherwise all is drawn outside.

Definition at line 995 of file lib_pin.cpp.

998 {
999  if( m_name.IsEmpty() || m_name == wxT( "~" ) )
1000  DrawPinName = false;
1001 
1002  if( m_number.IsEmpty() )
1003  DrawPinNum = false;
1004 
1005  if( !DrawPinNum && !DrawPinName )
1006  return;
1007 
1008  int x, y;
1009  wxSize PinNameSize = wxSize( m_nameTextSize, m_nameTextSize );
1010  wxSize PinNumSize = wxSize( m_numTextSize, m_numTextSize );
1011 
1012  int nameLineWidth = GetPenSize();
1013  nameLineWidth = Clamp_Text_PenSize( nameLineWidth, m_nameTextSize, false );
1014  int numLineWidth = GetPenSize();
1015  numLineWidth = Clamp_Text_PenSize( numLineWidth, m_numTextSize, false );
1016 
1017  int name_offset = Mils2iu( PIN_TEXT_MARGIN ) +
1018  ( nameLineWidth + GetDefaultLineThickness() ) / 2;
1019  int num_offset = Mils2iu( PIN_TEXT_MARGIN ) +
1020  ( numLineWidth + GetDefaultLineThickness() ) / 2;
1021 
1022  /* Get the num and name colors */
1023  COLOR4D NameColor = GetLayerColor( LAYER_PINNAM );
1024  COLOR4D NumColor = GetLayerColor( LAYER_PINNUM );
1025 
1026  int x1 = pin_pos.x;
1027  int y1 = pin_pos.y;
1028 
1029  switch( orient )
1030  {
1031  case PIN_UP: y1 -= m_length; break;
1032  case PIN_DOWN: y1 += m_length; break;
1033  case PIN_LEFT: x1 -= m_length; break;
1034  case PIN_RIGHT: x1 += m_length; break;
1035  }
1036 
1037  /* Draw the text inside, but the pin numbers outside. */
1038  if( TextInside )
1039  {
1040  if( (orient == PIN_LEFT) || (orient == PIN_RIGHT) ) /* Its an horizontal line. */
1041  {
1042  if( DrawPinName )
1043  {
1044  if( orient == PIN_RIGHT )
1045  {
1046  x = x1 + TextInside;
1047  plotter->Text( wxPoint( x, y1 ), NameColor,
1048  m_name,
1050  PinNameSize,
1053  aWidth, false, false );
1054  }
1055  else // orient == PIN_LEFT
1056  {
1057  x = x1 - TextInside;
1058 
1059  if( DrawPinName )
1060  plotter->Text( wxPoint( x, y1 ),
1061  NameColor, m_name, TEXT_ANGLE_HORIZ,
1062  PinNameSize,
1065  aWidth, false, false );
1066  }
1067  }
1068  if( DrawPinNum )
1069  {
1070  plotter->Text( wxPoint( (x1 + pin_pos.x) / 2,
1071  y1 - num_offset ),
1072  NumColor, m_number,
1073  TEXT_ANGLE_HORIZ, PinNumSize,
1076  aWidth, false, false );
1077  }
1078  }
1079  else /* Its a vertical line. */
1080  {
1081  if( orient == PIN_DOWN )
1082  {
1083  y = y1 + TextInside;
1084 
1085  if( DrawPinName )
1086  plotter->Text( wxPoint( x1, y ), NameColor,
1087  m_name,
1088  TEXT_ANGLE_VERT, PinNameSize,
1091  aWidth, false, false );
1092 
1093  if( DrawPinNum )
1094  {
1095  plotter->Text( wxPoint( x1 - num_offset,
1096  (y1 + pin_pos.y) / 2 ),
1097  NumColor, m_number,
1098  TEXT_ANGLE_VERT, PinNumSize,
1101  aWidth, false, false );
1102  }
1103  }
1104  else /* PIN_UP */
1105  {
1106  y = y1 - TextInside;
1107 
1108  if( DrawPinName )
1109  plotter->Text( wxPoint( x1, y ), NameColor,
1110  m_name,
1111  TEXT_ANGLE_VERT, PinNameSize,
1114  aWidth, false, false );
1115 
1116  if( DrawPinNum )
1117  {
1118  plotter->Text( wxPoint( x1 - num_offset,
1119  (y1 + pin_pos.y) / 2 ),
1120  NumColor, m_number,
1121  TEXT_ANGLE_VERT, PinNumSize,
1124  aWidth, false, false );
1125  }
1126  }
1127  }
1128  }
1129  else /* Draw num & text pin outside */
1130  {
1131  if( (orient == PIN_LEFT) || (orient == PIN_RIGHT) )
1132  {
1133  /* Its an horizontal line. */
1134  if( DrawPinName )
1135  {
1136  x = (x1 + pin_pos.x) / 2;
1137  plotter->Text( wxPoint( x, y1 - name_offset ),
1138  NameColor, m_name,
1139  TEXT_ANGLE_HORIZ, PinNameSize,
1142  aWidth, false, false );
1143  }
1144 
1145  if( DrawPinNum )
1146  {
1147  x = ( x1 + pin_pos.x ) / 2;
1148  plotter->Text( wxPoint( x, y1 + num_offset ),
1149  NumColor, m_number,
1150  TEXT_ANGLE_HORIZ, PinNumSize,
1153  aWidth, false, false );
1154  }
1155  }
1156  else /* Its a vertical line. */
1157  {
1158  if( DrawPinName )
1159  {
1160  y = ( y1 + pin_pos.y ) / 2;
1161  plotter->Text( wxPoint( x1 - name_offset, y ),
1162  NameColor, m_name,
1163  TEXT_ANGLE_VERT, PinNameSize,
1166  aWidth, false, false );
1167  }
1168 
1169  if( DrawPinNum )
1170  {
1171  plotter->Text( wxPoint( x1 + num_offset,
1172  ( y1 + pin_pos.y ) / 2 ),
1173  NumColor, m_number,
1174  TEXT_ANGLE_VERT, PinNumSize,
1177  aWidth, false, false );
1178  }
1179  }
1180  }
1181 }
#define TEXT_ANGLE_HORIZ
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
#define TEXT_ANGLE_VERT
int m_numTextSize
Definition: lib_pin.h:76
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
wxString m_name
Definition: lib_pin.h:74
Definition: lib_pin.h:55
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
int m_length
Length of the pin.
Definition: lib_pin.h:68
int GetPenSize() const override
Definition: lib_pin.cpp:536
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:81
wxString m_number
Definition: lib_pin.h:75
#define PIN_TEXT_MARGIN
Definition: lib_pin.cpp:65
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References Clamp_Text_PenSize(), GetDefaultLineThickness(), GetLayerColor(), GetPenSize(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, LAYER_PINNAM, LAYER_PINNUM, m_length, m_name, m_nameTextSize, m_number, m_numTextSize, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PLOTTER::Text(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, wxPoint::x, and wxPoint::y.

Referenced by Plot().

◆ PlotSymbol()

void LIB_PIN::PlotSymbol ( PLOTTER aPlotter,
const wxPoint aPosition,
int  aOrientation 
)

Definition at line 868 of file lib_pin.cpp.

869 {
870  int MapX1, MapY1, x1, y1;
872 
873  aPlotter->SetColor( color );
874  aPlotter->SetCurrentLineWidth( GetPenSize() );
875 
876  MapX1 = MapY1 = 0;
877  x1 = aPosition.x; y1 = aPosition.y;
878 
879  switch( aOrientation )
880  {
881  case PIN_UP: y1 = aPosition.y - m_length; MapY1 = 1; break;
882  case PIN_DOWN: y1 = aPosition.y + m_length; MapY1 = -1; break;
883  case PIN_LEFT: x1 = aPosition.x - m_length; MapX1 = 1; break;
884  case PIN_RIGHT: x1 = aPosition.x + m_length; MapX1 = -1; break;
885  }
886 
888  {
889  const int radius = ExternalPinDecoSize( *this );
890  aPlotter->Circle( wxPoint( MapX1 * radius + x1, MapY1 * radius + y1 ),
891  radius * 2, NO_FILL, GetPenSize() );
892 
893  aPlotter->MoveTo( wxPoint( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 ) );
894  aPlotter->FinishTo( aPosition );
895  }
897  {
898  const int deco_size = InternalPinDecoSize( *this );
899  if( MapY1 == 0 ) /* MapX1 = +- 1 */
900  {
901  aPlotter->MoveTo( wxPoint( x1, y1 + deco_size ) );
902  aPlotter->LineTo( wxPoint( x1 + MapX1 * deco_size * 2, y1 ) );
903  aPlotter->FinishTo( wxPoint( x1, y1 - deco_size ) );
904  }
905  else /* MapX1 = 0 */
906  {
907  aPlotter->MoveTo( wxPoint( x1 + deco_size, y1 ) );
908  aPlotter->LineTo( wxPoint( x1, y1 + MapY1 * deco_size * 2 ) );
909  aPlotter->FinishTo( wxPoint( x1 - deco_size, y1 ) );
910  }
911 
912  aPlotter->MoveTo( wxPoint( MapX1 * deco_size * 2 + x1, MapY1 * deco_size * 2 + y1 ) );
913  aPlotter->FinishTo( aPosition );
914  }
915  else
916  {
917  aPlotter->MoveTo( wxPoint( x1, y1 ) );
918  aPlotter->FinishTo( aPosition );
919  }
920 
923  {
924  const int deco_size = InternalPinDecoSize( *this );
925  if( MapY1 == 0 ) /* MapX1 = +- 1 */
926  {
927  aPlotter->MoveTo( wxPoint( x1, y1 + deco_size ) );
928  aPlotter->LineTo( wxPoint( x1 - MapX1 * deco_size * 2, y1 ) );
929  aPlotter->FinishTo( wxPoint( x1, y1 - deco_size ) );
930  }
931  else /* MapX1 = 0 */
932  {
933  aPlotter->MoveTo( wxPoint( x1 + deco_size, y1 ) );
934  aPlotter->LineTo( wxPoint( x1, y1 - MapY1 * deco_size * 2 ) );
935  aPlotter->FinishTo( wxPoint( x1 - deco_size, y1 ) );
936  }
937  }
938 
940  || m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW ) /* IEEE symbol "Active Low Input" */
941  {
942  const int deco_size = ExternalPinDecoSize( *this );
943 
944  if( MapY1 == 0 ) /* MapX1 = +- 1 */
945  {
946  aPlotter->MoveTo( wxPoint( x1 + MapX1 * deco_size * 2, y1 ) );
947  aPlotter->LineTo( wxPoint( x1 + MapX1 * deco_size * 2, y1 - deco_size * 2 ) );
948  aPlotter->FinishTo( wxPoint( x1, y1 ) );
949  }
950  else /* MapX1 = 0 */
951  {
952  aPlotter->MoveTo( wxPoint( x1, y1 + MapY1 * deco_size * 2 ) );
953  aPlotter->LineTo( wxPoint( x1 - deco_size * 2, y1 + MapY1 * deco_size * 2 ) );
954  aPlotter->FinishTo( wxPoint( x1, y1 ) );
955  }
956  }
957 
958 
959  if( m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW ) /* IEEE symbol "Active Low Output" */
960  {
961  const int symbol_size = ExternalPinDecoSize( *this );
962 
963  if( MapY1 == 0 ) /* MapX1 = +- 1 */
964  {
965  aPlotter->MoveTo( wxPoint( x1, y1 - symbol_size * 2 ) );
966  aPlotter->FinishTo( wxPoint( x1 + MapX1 * symbol_size * 2, y1 ) );
967  }
968  else /* MapX1 = 0 */
969  {
970  aPlotter->MoveTo( wxPoint( x1 - symbol_size * 2, y1 ) );
971  aPlotter->FinishTo( wxPoint( x1, y1 + MapY1 * symbol_size * 2 ) );
972  }
973  }
974  else if( m_shape == GRAPHIC_PINSHAPE::NONLOGIC ) /* NonLogic pin symbol */
975  {
976  const int deco_size = ExternalPinDecoSize( *this );
977  aPlotter->MoveTo( wxPoint( x1 - (MapX1 + MapY1) * deco_size, y1 - (MapY1 - MapX1) * deco_size ) );
978  aPlotter->FinishTo( wxPoint( x1 + (MapX1 + MapY1) * deco_size, y1 + (MapY1 - MapX1) * deco_size ) );
979  aPlotter->MoveTo( wxPoint( x1 - (MapX1 - MapY1) * deco_size, y1 - (MapY1 + MapX1) * deco_size ) );
980  aPlotter->FinishTo( wxPoint( x1 + (MapX1 - MapY1) * deco_size, y1 + (MapY1 + MapX1) * deco_size ) );
981  }
982  if( m_type == ELECTRICAL_PINTYPE::PT_NC ) // Draw a N.C. symbol
983  {
984  const int deco_size = TARGET_PIN_RADIUS;
985  const int ex1 = aPosition.x;
986  const int ey1 = aPosition.y;
987  aPlotter->MoveTo( wxPoint( ex1 - deco_size, ey1 - deco_size ) );
988  aPlotter->FinishTo( wxPoint( ex1 + deco_size, ey1 + deco_size ) );
989  aPlotter->MoveTo( wxPoint( ex1 + deco_size, ey1 - deco_size ) );
990  aPlotter->FinishTo( wxPoint( ex1 - deco_size, ey1 + deco_size ) );
991  }
992 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:270
static int ExternalPinDecoSize(const LIB_PIN &aPin)
Utility for getting the size of the 'external' pin decorators (as a radius)
Definition: lib_pin.cpp:141
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
virtual void SetColor(COLOR4D color)=0
int color
Definition: DXF_plotter.cpp:61
Definition: lib_pin.h:55
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
int m_length
Length of the pin.
Definition: lib_pin.h:68
int GetPenSize() const override
Definition: lib_pin.cpp:536
void LineTo(const wxPoint &pos)
Definition: plotter.h:265
static int InternalPinDecoSize(const LIB_PIN &aPin)
Utility for getting the size of the 'internal' pin decorators (as a radius)
Definition: lib_pin.cpp:132
void MoveTo(const wxPoint &pos)
Definition: plotter.h:260
#define TARGET_PIN_RADIUS
Definition: lib_pin.h:43
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72
not connected (must be left open)
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References PLOTTER::Circle(), CLOCK, CLOCK_LOW, color, ExternalPinDecoSize(), FALLING_EDGE_CLOCK, PLOTTER::FinishTo(), GetLayerColor(), GetPenSize(), INPUT_LOW, InternalPinDecoSize(), INVERTED, INVERTED_CLOCK, LAYER_PIN, PLOTTER::LineTo(), m_length, m_shape, m_type, PLOTTER::MoveTo(), NO_FILL, NONLOGIC, OUTPUT_LOW, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, PT_NC, PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), TARGET_PIN_RADIUS, wxPoint::x, and wxPoint::y.

Referenced by Plot().

◆ print()

void LIB_PIN::print ( wxDC *  aDC,
const wxPoint aOffset,
void *  aData,
const TRANSFORM aTransform 
)
overrideprivatevirtual

Print a pin, with or without the pin texts.

Parameters
aDCDevice Context (can be null)
aOffsetOffset to draw
aData= used here as a boolean indicating whether or not to draw the pin electrical types
aTransformTransform Matrix (rotation, mirror ..)

Implements LIB_ITEM.

Definition at line 548 of file lib_pin.cpp.

549 {
550  PART_DRAW_OPTIONS* opts = (PART_DRAW_OPTIONS*) aData;
551  LIB_PART* part = GetParent();
552 
553  /* Calculate pin orient taking in account the component orientation. */
554  int orient = PinDrawOrient( aTransform );
555 
556  /* Calculate the pin position */
557  wxPoint pos1 = aTransform.TransformCoordinate( m_position ) + aOffset;
558 
559  if( IsVisible() || ( opts && opts->draw_hidden_fields ) )
560  {
561  PrintPinSymbol( aDC, pos1, orient );
562 
563  PrintPinTexts( aDC, pos1, orient, part->GetPinNameOffset(), part->ShowPinNumbers(),
564  part->ShowPinNames() );
565 
566  if( opts && opts->show_elec_type )
567  PrintPinElectricalTypeName( aDC, pos1, orient );
568  }
569 }
int GetPinNameOffset()
void PrintPinTexts(wxDC *aDC, wxPoint &aPosition, int aOrientation, int TextInside, bool DrawPinNum, bool DrawPinName)
Put the pin number and pin text info, given the pin line coordinates.
Definition: lib_pin.cpp:678
LIB_PART * GetParent() const
Definition: lib_item.h:176
void PrintPinElectricalTypeName(wxDC *aDC, wxPoint &aPosition, int aOrientation)
Draw the electrical type text of the pin (only for the footprint editor)
Definition: lib_pin.cpp:818
int PinDrawOrient(const TRANSFORM &aTransform) const
Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation...
Definition: lib_pin.cpp:1200
bool draw_hidden_fields
Whether to draw "hidden" fields.
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:42
bool ShowPinNames()
bool ShowPinNumbers()
Define a library symbol object.
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67
bool show_elec_type
Whether to show the pin electrical type.
void PrintPinSymbol(wxDC *aDC, const wxPoint &aPos, int aOrientation)
Print the pin symbol without text.
Definition: lib_pin.cpp:572

References PART_DRAW_OPTIONS::draw_hidden_fields, LIB_ITEM::GetParent(), LIB_PART::GetPinNameOffset(), IsVisible(), m_position, PinDrawOrient(), PrintPinElectricalTypeName(), PrintPinSymbol(), PrintPinTexts(), PART_DRAW_OPTIONS::show_elec_type, LIB_PART::ShowPinNames(), LIB_PART::ShowPinNumbers(), and TRANSFORM::TransformCoordinate().

◆ Print()

void LIB_ITEM::Print ( wxDC *  aDC,
const wxPoint aOffset,
void *  aData,
const TRANSFORM aTransform 
)
virtualinherited

Draw an item.

Parameters
aDCDevice Context (can be null)
aOffsetOffset to draw
aDataValue or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib component for pins.
aTransformTransform Matrix (rotation, mirror ..)

Definition at line 123 of file lib_item.cpp.

124 {
125  print( aDC, aOffset, aData, aTransform );
126 }
virtual void print(wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)=0
Print the item to aDC.

References LIB_ITEM::print().

Referenced by DIALOG_LIB_EDIT_PIN::OnPaintShowPanel().

◆ PrintPinElectricalTypeName()

void LIB_PIN::PrintPinElectricalTypeName ( wxDC *  aDC,
wxPoint aPosition,
int  aOrientation 
)

Draw the electrical type text of the pin (only for the footprint editor)

Definition at line 818 of file lib_pin.cpp.

819 {
820  wxString typeName = GetElectricalTypeName();
821 
822  // Use a reasonable (small) size to draw the text
823  int textSize = (m_nameTextSize*3)/4;
824 
825  #define ETXT_MAX_SIZE Millimeter2iu(0.7 )
826  if( textSize > ETXT_MAX_SIZE )
827  textSize = ETXT_MAX_SIZE;
828 
829  // Use a reasonable pen size to draw the text
830  int pensize = textSize/6;
831 
832  // Get a suitable color
834 
835  wxPoint txtpos = aPosition;
836  int offset = Millimeter2iu( 0.4 );
838  int orient = TEXT_ANGLE_HORIZ;
839 
840  switch( aOrientation )
841  {
842  case PIN_UP:
843  txtpos.y += offset;
844  orient = TEXT_ANGLE_VERT;
845  hjustify = GR_TEXT_HJUSTIFY_RIGHT;
846  break;
847 
848  case PIN_DOWN:
849  txtpos.y -= offset;
850  orient = TEXT_ANGLE_VERT;
851  break;
852 
853  case PIN_LEFT:
854  txtpos.x += offset;
855  break;
856 
857  case PIN_RIGHT:
858  txtpos.x -= offset;
859  hjustify = GR_TEXT_HJUSTIFY_RIGHT;
860  break;
861  }
862 
863  GRText( aDC, txtpos, color, typeName, orient, wxSize( textSize, textSize ), hjustify,
864  GR_TEXT_VJUSTIFY_CENTER, pensize, false, false );
865 }
#define TEXT_ANGLE_HORIZ
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:44
#define ETXT_MAX_SIZE
#define TEXT_ANGLE_VERT
int color
Definition: DXF_plotter.cpp:61
Definition: lib_pin.h:55
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
COLOR4D GetInvisibleItemColor()
wxString const GetElectricalTypeName() const
return a translated string for messages giving the electrical type of the pin.
Definition: lib_pin.h:256
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
void GRText(wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Function GRText Draw a graphic text (like module texts)
Definition: gr_text.cpp:143
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References color, ETXT_MAX_SIZE, GetElectricalTypeName(), GetInvisibleItemColor(), GetLayerColor(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, GRText(), IsVisible(), LAYER_NOTES, m_nameTextSize, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, wxPoint::x, and wxPoint::y.

Referenced by print().

◆ PrintPinSymbol()

void LIB_PIN::PrintPinSymbol ( wxDC *  aDC,
const wxPoint aPos,
int  aOrientation 
)

Print the pin symbol without text.

If aColor != 0, draw with aColor, else with the normal pin color.

Definition at line 572 of file lib_pin.cpp.

573 {
574  int MapX1, MapY1, x1, y1;
575  int width = GetPenSize();
576  int posX = aPos.x, posY = aPos.y, len = m_length;
578 
579  MapX1 = MapY1 = 0;
580  x1 = posX;
581  y1 = posY;
582 
583  switch( aOrient )
584  {
585  case PIN_UP: y1 = posY - len; MapY1 = 1; break;
586  case PIN_DOWN: y1 = posY + len; MapY1 = -1; break;
587  case PIN_LEFT: x1 = posX - len; MapX1 = 1; break;
588  case PIN_RIGHT: x1 = posX + len; MapX1 = -1; break;
589  }
590 
592  {
593  const int radius = ExternalPinDecoSize( *this );
594  GRCircle( nullptr, aDC, MapX1 * radius + x1, MapY1 * radius + y1, radius, width, color );
595 
596  GRMoveTo( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 );
597  GRLineTo( nullptr, aDC, posX, posY, width, color );
598  }
599  else
600  {
601  GRMoveTo( x1, y1 );
602  GRLineTo( nullptr, aDC, posX, posY, width, color );
603  }
604 
605  // Draw the clock shape (>)inside the symbol
609  {
610  const int clock_size = InternalPinDecoSize( *this );
611  if( MapY1 == 0 ) /* MapX1 = +- 1 */
612  {
613  GRMoveTo( x1, y1 + clock_size );
614  GRLineTo( nullptr, aDC, x1 - MapX1 * clock_size * 2, y1, width, color );
615  GRLineTo( nullptr, aDC, x1, y1 - clock_size, width, color );
616  }
617  else /* MapX1 = 0 */
618  {
619  GRMoveTo( x1 + clock_size, y1 );
620  GRLineTo( nullptr, aDC, x1, y1 - MapY1 * clock_size * 2, width, color );
621  GRLineTo( nullptr, aDC, x1 - clock_size, y1, width, color );
622  }
623  }
624 
625  // Draw the active low (or H to L active transition)
628  {
629  const int deco_size = ExternalPinDecoSize( *this );
630  if( MapY1 == 0 ) /* MapX1 = +- 1 */
631  {
632  GRMoveTo( x1 + MapX1 * deco_size * 2, y1 );
633  GRLineTo( nullptr, aDC, x1 + MapX1 * deco_size * 2, y1 - deco_size * 2, width, color );
634  GRLineTo( nullptr, aDC, x1, y1, width, color );
635  }
636  else /* MapX1 = 0 */
637  {
638  GRMoveTo( x1, y1 + MapY1 * deco_size * 2 );
639  GRLineTo( nullptr, aDC, x1 - deco_size * 2, y1 + MapY1 * deco_size * 2, width, color );
640  GRLineTo( nullptr, aDC, x1, y1, width, color );
641  }
642  }
643 
644  if( m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW ) /* IEEE symbol "Active Low Output" */
645  {
646  const int deco_size = ExternalPinDecoSize( *this );
647  if( MapY1 == 0 ) /* MapX1 = +- 1 */
648  {
649  GRMoveTo( x1, y1 - deco_size * 2 );
650  GRLineTo( nullptr, aDC, x1 + MapX1 * deco_size * 2, y1, width, color );
651  }
652  else /* MapX1 = 0 */
653  {
654  GRMoveTo( x1 - deco_size * 2, y1 );
655  GRLineTo( nullptr, aDC, x1, y1 + MapY1 * deco_size * 2, width, color );
656  }
657  }
658  else if( m_shape == GRAPHIC_PINSHAPE::NONLOGIC ) /* NonLogic pin symbol */
659  {
660  const int deco_size = ExternalPinDecoSize( *this );
661  GRMoveTo( x1 - (MapX1 + MapY1) * deco_size, y1 - (MapY1 - MapX1) * deco_size );
662  GRLineTo( nullptr, aDC, x1 + (MapX1 + MapY1) * deco_size, y1 + (MapY1 - MapX1) * deco_size, width,
663  color );
664  GRMoveTo( x1 - (MapX1 - MapY1) * deco_size, y1 - (MapY1 + MapX1) * deco_size );
665  GRLineTo( nullptr, aDC, x1 + (MapX1 - MapY1) * deco_size, y1 + (MapY1 + MapX1) * deco_size, width,
666  color );
667  }
668 
669  if( m_type == ELECTRICAL_PINTYPE::PT_NC ) // Draw a N.C. symbol
670  {
671  const int deco_size = TARGET_PIN_RADIUS;
672  GRLine( nullptr, aDC, posX - deco_size, posY - deco_size, posX + deco_size, posY + deco_size, width, color );
673  GRLine( nullptr, aDC, posX + deco_size, posY - deco_size, posX - deco_size, posY + deco_size, width, color );
674  }
675 }
static int ExternalPinDecoSize(const LIB_PIN &aPin)
Utility for getting the size of the 'external' pin decorators (as a radius)
Definition: lib_pin.cpp:141
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
int color
Definition: DXF_plotter.cpp:61
Definition: lib_pin.h:55
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
int m_length
Length of the pin.
Definition: lib_pin.h:68
COLOR4D GetInvisibleItemColor()
void GRLineTo(EDA_RECT *ClipBox, wxDC *DC, int x, int y, int width, COLOR4D Color)
Definition: gr_basic.cpp:266
int GetPenSize() const override
Definition: lib_pin.cpp:536
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
static int InternalPinDecoSize(const LIB_PIN &aPin)
Utility for getting the size of the 'internal' pin decorators (as a radius)
Definition: lib_pin.cpp:132
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:230
void GRMoveTo(int x, int y)
Definition: gr_basic.cpp:256
void GRCircle(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, int r, int width, COLOR4D Color)
Definition: gr_basic.cpp:596
#define TARGET_PIN_RADIUS
Definition: lib_pin.h:43
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72
not connected (must be left open)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References CLOCK, CLOCK_LOW, color, ExternalPinDecoSize(), FALLING_EDGE_CLOCK, GetInvisibleItemColor(), GetLayerColor(), GetPenSize(), GRCircle(), GRLine(), GRLineTo(), GRMoveTo(), INPUT_LOW, InternalPinDecoSize(), INVERTED, INVERTED_CLOCK, IsVisible(), LAYER_PIN, m_length, m_shape, m_type, NONLOGIC, OUTPUT_LOW, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, PT_NC, TARGET_PIN_RADIUS, wxPoint::x, and wxPoint::y.

Referenced by print().

◆ PrintPinTexts()

void LIB_PIN::PrintPinTexts ( wxDC *  aDC,
wxPoint aPosition,
int  aOrientation,
int  TextInside,
bool  DrawPinNum,
bool  DrawPinName 
)

Put the pin number and pin text info, given the pin line coordinates.

The line must be vertical or horizontal. If DrawPinName == false the pin name is not printed. If DrawPinNum = false the pin number is not printed. If TextInside then the text is been put inside,otherwise all is drawn outside. Pin Name: substring between '~' is negated

Definition at line 678 of file lib_pin.cpp.

680 {
681  if( !DrawPinName && !DrawPinNum )
682  return;
683 
684  int x, y;
685 
686  wxSize PinNameSize( m_nameTextSize, m_nameTextSize );
687  wxSize PinNumSize( m_numTextSize, m_numTextSize );
688  int nameLineWidth = Clamp_Text_PenSize( GetPenSize(), m_nameTextSize, false );
689  int numLineWidth = Clamp_Text_PenSize( GetPenSize(), m_numTextSize, false );
690  int name_offset = Mils2iu( PIN_TEXT_MARGIN ) +
691  ( nameLineWidth + GetDefaultLineThickness() ) / 2;
692  int num_offset = Mils2iu( PIN_TEXT_MARGIN ) +
693  ( numLineWidth + GetDefaultLineThickness() ) / 2;
694 
695  /* Get the num and name colors */
698 
699  int x1 = pin_pos.x;
700  int y1 = pin_pos.y;
701 
702  switch( orient )
703  {
704  case PIN_UP: y1 -= m_length; break;
705  case PIN_DOWN: y1 += m_length; break;
706  case PIN_LEFT: x1 -= m_length; break;
707  case PIN_RIGHT: x1 += m_length; break;
708  }
709 
710  if( m_name.IsEmpty() )
711  DrawPinName = false;
712 
713  if( TextInside ) // Draw the text inside, but the pin numbers outside.
714  {
715  if( (orient == PIN_LEFT) || (orient == PIN_RIGHT) )
716  {
717  // It is an horizontal line
718  if( DrawPinName )
719  {
720  if( orient == PIN_RIGHT )
721  {
722  x = x1 + TextInside;
723  GRText( DC, wxPoint( x, y1 ), NameColor, m_name, TEXT_ANGLE_HORIZ,
725  nameLineWidth, false, false );
726  }
727  else // Orient == PIN_LEFT
728  {
729  x = x1 - TextInside;
730  GRText( DC, wxPoint( x, y1 ), NameColor, m_name, TEXT_ANGLE_HORIZ,
732  nameLineWidth, false, false );
733  }
734  }
735 
736  if( DrawPinNum )
737  {
738  GRText( DC, wxPoint( (x1 + pin_pos.x) / 2, y1 - num_offset ), NumColor, m_number,
740  GR_TEXT_VJUSTIFY_BOTTOM, numLineWidth, false, false );
741  }
742  }
743  else /* Its a vertical line. */
744  {
745  // Text is drawn from bottom to top (i.e. to negative value for Y axis)
746  if( orient == PIN_DOWN )
747  {
748  y = y1 + TextInside;
749 
750  if( DrawPinName )
751  GRText( DC, wxPoint( x1, y ), NameColor, m_name, TEXT_ANGLE_VERT, PinNameSize,
752  GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, nameLineWidth, false,
753  false );
754 
755  if( DrawPinNum )
756  GRText( DC, wxPoint( x1 - num_offset, (y1 + pin_pos.y) / 2 ), NumColor,
758  GR_TEXT_VJUSTIFY_BOTTOM, numLineWidth, false, false );
759  }
760  else /* PIN_UP */
761  {
762  y = y1 - TextInside;
763 
764  if( DrawPinName )
765  GRText( DC, wxPoint( x1, y ), NameColor, m_name, TEXT_ANGLE_VERT, PinNameSize,
766  GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, nameLineWidth, false,
767  false );
768 
769  if( DrawPinNum )
770  GRText( DC, wxPoint( x1 - num_offset, (y1 + pin_pos.y) / 2 ), NumColor,
772  GR_TEXT_VJUSTIFY_BOTTOM, numLineWidth, false, false );
773  }
774  }
775  }
776  else /**** Draw num & text pin outside ****/
777  {
778  if( (orient == PIN_LEFT) || (orient == PIN_RIGHT) )
779  {
780  /* Its an horizontal line. */
781  if( DrawPinName )
782  {
783  x = (x1 + pin_pos.x) / 2;
784  GRText( DC, wxPoint( x, y1 - name_offset ), NameColor, m_name, TEXT_ANGLE_HORIZ,
786  nameLineWidth, false, false );
787  }
788  if( DrawPinNum )
789  {
790  x = (x1 + pin_pos.x) / 2;
791  GRText( DC, wxPoint( x, y1 + num_offset ), NumColor, m_number, TEXT_ANGLE_HORIZ,
792  PinNumSize, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, numLineWidth,
793  false, false );
794  }
795  }
796  else /* Its a vertical line. */
797  {
798  if( DrawPinName )
799  {
800  y = (y1 + pin_pos.y) / 2;
801  GRText( DC, wxPoint( x1 - name_offset, y ), NameColor, m_name, TEXT_ANGLE_VERT,
803  nameLineWidth, false, false );
804  }
805 
806  if( DrawPinNum )
807  {
808  GRText( DC, wxPoint( x1 + num_offset, (y1 + pin_pos.y) / 2 ), NumColor, m_number,
810  numLineWidth, false, false );
811  }
812  }
813  }
814 }
#define TEXT_ANGLE_HORIZ
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
#define TEXT_ANGLE_VERT
int m_numTextSize
Definition: lib_pin.h:76
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
wxString m_name
Definition: lib_pin.h:74
Definition: lib_pin.h:55
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
int m_length
Length of the pin.
Definition: lib_pin.h:68
COLOR4D GetInvisibleItemColor()
int GetPenSize() const override
Definition: lib_pin.cpp:536
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize Don't allow text to become cluttered up in its own fatness.
Definition: gr_text.cpp:81
wxString m_number
Definition: lib_pin.h:75
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
void GRText(wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData), void *aCallbackData, PLOTTER *aPlotter)
Function GRText Draw a graphic text (like module texts)
Definition: gr_text.cpp:143
#define PIN_TEXT_MARGIN
Definition: lib_pin.cpp:65
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References Clamp_Text_PenSize(), GetDefaultLineThickness(), GetInvisibleItemColor(), GetLayerColor(), GetPenSize(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, GRText(), IsVisible(), LAYER_PINNAM, LAYER_PINNUM, m_length, m_name, m_nameTextSize, m_number, m_numTextSize, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, wxPoint::x, and wxPoint::y.

Referenced by print().

◆ Replace() [1/2]

bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
staticinherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 180 of file base_struct.cpp.

181 {
182  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
183 
184  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
185  aSearchData.GetFindString() :
186  aSearchData.GetFindString().Upper() );
187 
188  if( result == wxNOT_FOUND )
189  return false;
190 
191  wxString prefix = aText.Left( result );
192  wxString suffix;
193 
194  if( aSearchData.GetFindString().length() + result < aText.length() )
195  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
196 
197  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
198  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
199  GetChars( suffix ) );
200 
201  aText = prefix + aSearchData.GetReplaceString() + suffix;
202 
203  return true;
204 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101

References GetChars(), and traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), SCH_SHEET::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
void *  aAuxData = NULL 
)
inlinevirtualinherited

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA pointer to optional data required for the search or NULL if not used.
Returns
True if the item text was modified, otherwise false.

Reimplemented in SCH_SHEET, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 503 of file base_struct.h.

503 { return false; }

◆ Rotate()

void LIB_PIN::Rotate ( const wxPoint aCenter,
bool  aRotateCCW = true 
)
overridevirtual

Rotate the object about aCenter point.

Parameters
aCenterPoint to rotate around.
aRotateCCWTrue to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Definition at line 1312 of file lib_pin.cpp.

1313 {
1314  int rot_angle = aRotateCCW ? -900 : 900;
1315 
1316  RotatePoint( &m_position, center, rot_angle );
1317 
1318  if( aRotateCCW )
1319  {
1320  switch( m_orientation )
1321  {
1322  case PIN_RIGHT: m_orientation = PIN_UP; break;
1323  case PIN_UP: m_orientation = PIN_LEFT; break;
1324  case PIN_LEFT: m_orientation = PIN_DOWN; break;
1325  case PIN_DOWN: m_orientation = PIN_RIGHT; break;
1326  }
1327  }
1328  else
1329  {
1330  switch( m_orientation )
1331  {
1332  case PIN_RIGHT: m_orientation = PIN_DOWN; break;
1333  case PIN_UP: m_orientation = PIN_RIGHT; break;
1334  case PIN_LEFT: m_orientation = PIN_UP; break;
1335  case PIN_DOWN: m_orientation = PIN_LEFT; break;
1336  }
1337  }
1338 }
Definition: lib_pin.h:55
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67

References m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, and RotatePoint().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 231 of file base_struct.h.

231 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:143

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConversion()

void LIB_PIN::SetConversion ( int  aConversion)

Set the body style (conversion) of the pin.

If the pin is changed from not common to common to all body styles, any linked pins will be removed from the parent component.

Parameters
aConversion- Body style of the pin. Set to zero to make pin common to all body styles.

Definition at line 438 of file lib_pin.cpp.

439 {
440  if( m_Convert == style )
441  return;
442 
443  m_Convert = style;
444  SetFlags( IS_CHANGED );
445 
446  if( style == 0 )
447  {
448  LIB_PIN* pin;
449  LIB_PIN* tmp = GetParent()->GetNextPin();
450 
451  while( tmp != NULL )
452  {
453  pin = tmp;
454  tmp = GetParent()->GetNextPin( pin );
455 
456  if( ( pin->m_Flags & IS_LINKED ) == 0
457  || ( pin == this )
458  || ( m_Unit && ( m_Unit != pin->m_Unit ) )
459  || ( m_position != pin->m_position )
460  || ( pin->m_orientation != m_orientation ) )
461  continue;
462 
463  GetParent()->RemoveDrawItem( (LIB_ITEM*) pin );
464  }
465  }
466 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
LIB_PART * GetParent() const
Definition: lib_item.h:176
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
The base class for drawable items used by schematic library components.
Definition: lib_item.h:60
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define NULL
LIB_PIN * GetNextPin(LIB_PIN *aItem=NULL)
Return the next pin object from the draw list.
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
void RemoveDrawItem(LIB_ITEM *aItem)
Remove draw aItem from list.

References LIB_PART::GetNextPin(), LIB_ITEM::GetParent(), IS_CHANGED, IS_LINKED, LIB_ITEM::m_Convert, EDA_ITEM::m_Flags, m_orientation, m_position, LIB_ITEM::m_Unit, NULL, LIB_PART::RemoveDrawItem(), and EDA_ITEM::SetFlags().

Referenced by DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetConvert()

◆ SetFillMode()

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 255 of file base_struct.h.

255 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References EDA_ITEM::m_Flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddModuleToBoard(), PCBNEW_CONTROL::AppendBoard(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::ConvertTextType(), SCH_EDIT_FRAME::CreateNewText(), LIB_PIN_TOOL::CreatePin(), SCH_EDIT_FRAME::CreateSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), LIB_DRAWING_TOOLS::DrawShape(), SCH_EDIT_TOOL::Duplicate(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_VIEW::HighlightItem(), EDIT_POINTS_FACTORY::Make(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), LIB_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_DRAWING_TOOLS::PlaceImage(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), LIB_EDIT_FRAME::SaveCopyInUndoList(), EE_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectPoint(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters
aEnableTrue forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 306 of file base_struct.h.

306 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:181

References EDA_ITEM::m_forceVisible.

◆ SetHighlighted()

void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 230 of file base_struct.h.

230 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:142

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

◆ SetLength()

void LIB_PIN::SetLength ( int  aLength,
bool  aTestOtherPins = true 
)

Set the pin length.

This will also update the length of the pins marked by EnableEditMode().

Parameters
aLength- The length of the pin in mils.
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 351 of file lib_pin.cpp.

352 {
353  if( m_length != length )
354  {
355  m_length = length;
356  SetModified();
357  }
358 
359  if( !aTestOtherPins )
360  return;
361 
362  if( GetParent() == NULL )
363  return;
364 
365  LIB_PINS pinList;
366  GetParent()->GetPins( pinList );
367 
368  for( size_t i = 0; i < pinList.size(); i++ )
369  {
370  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0
371  || pinList[i]->m_Convert != m_Convert
372  || pinList[i]->m_length == length )
373  continue;
374 
375  pinList[i]->m_length = length;
376  SetModified();
377  }
378 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
int m_length
Length of the pin.
Definition: lib_pin.h:68
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, LIB_ITEM::m_Convert, EDA_ITEM::m_Flags, m_length, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

Definition at line 95 of file base_struct.cpp.

96 {
98 
99  // If this a child object, then the parent modification state also needs to be set.
100  if( m_Parent )
102 }
void SetModified()
Definition: base_struct.cpp:95
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:177
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:116
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255

References IS_CHANGED, EDA_ITEM::m_Parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by SCH_COMPONENT::ClearAnnotation(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), MoveTo(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SetLength(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SetName(), SetNameTextSize(), SetNumber(), SetNumberTextSize(), SetOrientation(), SetPartNumber(), SetPinPosition(), SetShape(), SCH_COMPONENT::SetTransform(), SetType(), SCH_COMPONENT::SetUnit(), SetVisible(), and SetWidth().

◆ SetName()

void LIB_PIN::SetName ( const wxString &  aName,
bool  aTestOtherPins = true 
)

Set the pin name.

This will also all of the pin names marked by EnableEditMode().

Parameters
aNameNew pin name.
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 159 of file lib_pin.cpp.

160 {
161  wxString tmp = ( aName.IsEmpty() ) ? wxT( "~" ) : aName;
162 
163  // pin name string does not support spaces
164  tmp.Replace( wxT( " " ), wxT( "_" ) );
165 
166  if( m_name != tmp )
167  {
168  m_name = tmp;
169  SetModified();
170  }
171 
172  if( !aTestOtherPins )
173  return;
174 
175  if( GetParent() == NULL )
176  return;
177 
178  LIB_PINS pinList;
179  GetParent()->GetPins( pinList );
180 
181  for( size_t i = 0; i < pinList.size(); i++ )
182  {
183  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 || pinList[i]->m_name == m_name )
184  continue;
185 
186  pinList[i]->m_name = m_name;
187  SetModified();
188  }
189 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
wxString m_name
Definition: lib_pin.h:74
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, EDA_ITEM::m_Flags, m_name, NULL, and EDA_ITEM::SetModified().

Referenced by DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), LIB_PIN_TOOL::RepeatPin(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetNameTextSize()

void LIB_PIN::SetNameTextSize ( int  aSize,
bool  aTestOtherPins = true 
)

Set the aSize of the pin name text.

This will also update the text size of the name of the pins marked by EnableEditMode().

Parameters
aSizeThe text size of the pin name in schematic units ( mils ).
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 192 of file lib_pin.cpp.

193 {
194  if( size != m_nameTextSize )
195  {
196  m_nameTextSize = size;
197  SetModified();
198  }
199 
200  if( !aTestOtherPins )
201  return;
202 
203  if( GetParent() == NULL )
204  return;
205 
206  LIB_PINS pinList;
207  GetParent()->GetPins( pinList );
208 
209  for( size_t i = 0; i < pinList.size(); i++ )
210  {
211  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 || pinList[i]->m_nameTextSize == size )
212  continue;
213 
214  pinList[i]->m_nameTextSize = size;
215  SetModified();
216  }
217 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
int m_nameTextSize
Pin num and Pin name sizes.
Definition: lib_pin.h:77
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, EDA_ITEM::m_Flags, m_nameTextSize, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetNumber()

void LIB_PIN::SetNumber ( const wxString &  aNumber)

Set the pin number.

Others pin numbers marked by EnableEditMode() are not modified because each pin has its own number

Parameters
aNumberNew pin number.

Definition at line 220 of file lib_pin.cpp.

221 {
222  // Unlike SetName, others pin numbers marked by EnableEditMode() are
223  // not modified because each pin has its own number, so set number
224  // only for this.
225 
226  wxString tmp = ( aNumber.IsEmpty() ) ? wxT( "~" ) : aNumber;
227 
228  // pin number string does not support spaces
229  tmp.Replace( wxT( " " ), wxT( "_" ) );
230 
231  if( m_number != tmp )
232  {
233  m_number = tmp;
234  SetModified();
235  }
236 }
void SetModified()
Definition: base_struct.cpp:95
wxString m_number
Definition: lib_pin.h:75

References m_number, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreateImagePins(), SCH_EAGLE_PLUGIN::loadSymbol(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), LIB_PIN_TOOL::RepeatPin(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetNumberTextSize()

void LIB_PIN::SetNumberTextSize ( int  aSize,
bool  aTestOtherPins = true 
)

Set the size of the pin number text.

This will also update the text size of the number of the pins marked by EnableEditMode().

Parameters
aSizeThe text size of the pin number in schematic units ( mils ).
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 239 of file lib_pin.cpp.

240 {
241  if( size != m_numTextSize )
242  {
243  m_numTextSize = size;
244  SetModified();
245  }
246 
247  if( !aTestOtherPins )
248  return;
249 
250  if( GetParent() == NULL )
251  return;
252 
253  LIB_PINS pinList;
254  GetParent()->GetPins( pinList );
255 
256  for( size_t i = 0; i < pinList.size(); i++ )
257  {
258  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 || pinList[i]->m_numTextSize == size )
259  continue;
260 
261  pinList[i]->m_numTextSize = size;
262  SetModified();
263  }
264 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
int m_numTextSize
Definition: lib_pin.h:76
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, EDA_ITEM::m_Flags, m_numTextSize, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetOrientation()

void LIB_PIN::SetOrientation ( int  aOrientation,
bool  aTestOtherPins = true 
)

Set orientation on the pin.

This will also update the orientation of the pins marked by EnableEditMode().

Parameters
aOrientation- The orientation of the pin.
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 267 of file lib_pin.cpp.

268 {
269  if( m_orientation != orientation )
270  {
271  m_orientation = orientation;
272  SetModified();
273  }
274 
275  if( !aTestOtherPins )
276  return;
277 
278  if( GetParent() == NULL )
279  return;
280 
281  LIB_PINS pinList;
282  GetParent()->GetPins( pinList );
283 
284  for( size_t i = 0; i < pinList.size(); i++ )
285  {
286  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 ||
287  pinList[i]->m_orientation == orientation )
288  continue;
289 
290  pinList[i]->m_orientation = orientation;
291  SetModified();
292  }
293 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, EDA_ITEM::m_Flags, m_orientation, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetParent()

◆ SetPartNumber()

void LIB_PIN::SetPartNumber ( int  aPart)

Set the pin part number.

If the pin is changed from not common to common to all parts, any linked pins will be removed from the parent component.

Parameters
aPart- Number of the part the pin belongs to. Set to zero to make pin common to all parts in a multi-part component.

Definition at line 408 of file lib_pin.cpp.

409 {
410  if( m_Unit == part )
411  return;
412 
413  m_Unit = part;
414  SetModified();
415 
416  if( m_Unit == 0 )
417  {
418  LIB_PIN* pin;
419  LIB_PIN* tmp = GetParent()->GetNextPin();
420 
421  while( tmp != NULL )
422  {
423  pin = tmp;
424  tmp = GetParent()->GetNextPin( pin );
425 
426  if( pin->m_Flags == 0 || pin == this
427  || ( m_Convert && ( m_Convert != pin->m_Convert ) )
428  || ( m_position != pin->m_position )
429  || ( pin->m_orientation != m_orientation ) )
430  continue;
431 
432  GetParent()->RemoveDrawItem( (LIB_ITEM*) pin );
433  }
434  }
435 }
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
int m_Unit
Unit identification for multiple parts per package.
Definition: lib_item.h:81
The base class for drawable items used by schematic library components.
Definition: lib_item.h:60
int m_orientation
Pin orientation (Up, Down, Left, Right)
Definition: lib_pin.h:69
#define NULL
LIB_PIN * GetNextPin(LIB_PIN *aItem=NULL)
Return the next pin object from the draw list.
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87
void RemoveDrawItem(LIB_ITEM *aItem)
Remove draw aItem from list.

References LIB_PART::GetNextPin(), LIB_ITEM::GetParent(), LIB_ITEM::m_Convert, EDA_ITEM::m_Flags, m_orientation, m_position, LIB_ITEM::m_Unit, NULL, LIB_PART::RemoveDrawItem(), and EDA_ITEM::SetModified().

Referenced by DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetPinPosition()

void LIB_PIN::SetPinPosition ( wxPoint  aPosition)

move this and all linked pins to the new position used in pin editing.

use SetPinPosition to set the position of this only

Parameters
aPositionis the new position of this and linked pins

Definition at line 381 of file lib_pin.cpp.

382 {
383  if( m_position != aPosition )
384  {
385  m_position = aPosition;
386  SetModified();
387  }
388 
389  if( GetParent() == NULL )
390  return;
391 
392  LIB_PINS pinList;
393  GetParent()->GetPins( pinList );
394 
395  for( size_t i = 0; i < pinList.size(); i++ )
396  {
397  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0
398  || pinList[i]->m_Convert != m_Convert
399  || pinList[i]->m_position == aPosition )
400  continue;
401 
402  pinList[i]->m_position = aPosition;
403  SetModified();
404  }
405 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
wxPoint m_position
Position of the pin.
Definition: lib_pin.h:67
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, LIB_ITEM::m_Convert, EDA_ITEM::m_Flags, m_position, NULL, and EDA_ITEM::SetModified().

Referenced by DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetPosition()

◆ SetSelected()

void EDA_ITEM::SetSelected ( )
inlineinherited

◆ SetShape()

void LIB_PIN::SetShape ( GRAPHIC_PINSHAPE  aShape)

Set the shape of the pin to aShape.

This will also update the draw style of the pins marked by EnableEditMode().

Parameters
aShape- The draw shape of the pin. See enum GRAPHIC_PINSHAPE.

Definition at line 296 of file lib_pin.cpp.

297 {
298  if( m_shape != aShape )
299  {
300  m_shape = aShape;
301  SetModified();
302  }
303 
304  if( GetParent() == NULL )
305  return;
306 
307  LIB_PINS pinList;
308  GetParent()->GetPins( pinList );
309 
310  for( size_t i = 0; i < pinList.size(); i++ )
311  {
312  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0
313  || pinList[i]->m_Convert != m_Convert
314  || pinList[i]->m_shape == aShape )
315  continue;
316 
317  pinList[i]->m_shape = aShape;
318  SetModified();
319  }
320 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
GRAPHIC_PINSHAPE m_shape
Shape drawn around pin.
Definition: lib_pin.h:70
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
int m_Convert
Shape identification for alternate body styles.
Definition: lib_item.h:87

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, LIB_ITEM::m_Convert, EDA_ITEM::m_Flags, m_shape, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetState()

void EDA_ITEM::SetState ( int  type,
int  state 
)
inlineinherited

Definition at line 244 of file base_struct.h.

245  {
246  if( state )
247  m_Status |= type; // state = ON or OFF
248  else
249  m_Status &= ~type;
250  }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 253 of file base_struct.h.

253 { m_Status = aStatus; }
STATUS_FLAGS m_Status
Definition: base_struct.h:173

References EDA_ITEM::m_Status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetTimeStamp()

void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 212 of file base_struct.h.

212 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:178

References EDA_ITEM::m_TimeStamp.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_FRAME::AddModuleToBoard(), BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), Diagnose(), SCH_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::EditFpInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), EDA_ITEM::initVars(), BOARD::InsertArea(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), SCH_EDIT_FRAME::LoadSheetFromFile(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseDIMENSION(), SCH_EDITOR_CONTROL::Paste(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_TOOL::RepeatDrawItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), SwapItemData(), TestDuplicateSheetNames(), DIALOG_ERC::TestErc(), and TestMultiunitFootprints().

◆ SetType()

void LIB_PIN::SetType ( ELECTRICAL_PINTYPE  aType,
bool  aTestOtherPins = true 
)

Set the electrical type of the pin.

This will also update the electrical type of the pins marked by EnableEditMode().

Parameters
aType- The electrical type of the pin(see enun ELECTRICAL_PINTYPE for values).
aTestOtherPinsdetermines if other pins need to be updated

Definition at line 323 of file lib_pin.cpp.

324 {
325  if( m_type != aType )
326  {
327  m_type = aType;
328  SetModified();
329  }
330 
331  if( !aTestOtherPins )
332  return;
333 
334  if( GetParent() == NULL )
335  return;
336 
337  LIB_PINS pinList;
338  GetParent()->GetPins( pinList );
339 
340  for( size_t i = 0; i < pinList.size(); i++ )
341  {
342  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 || pinList[i]->m_type == aType )
343  continue;
344 
345  pinList[i]->m_type = aType;
346  SetModified();
347  }
348 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184
ELECTRICAL_PINTYPE m_type
Electrical type of the pin. See enum ELECTRICAL_PINTYPE.
Definition: lib_pin.h:72

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, EDA_ITEM::m_Flags, m_type, NULL, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_LIB_EDIT_PIN::TransferDataFromWindow().

◆ SetUnit()

◆ SetVisible()

void LIB_PIN::SetVisible ( bool  aVisible)

Set or clear the visibility flag for the pin.

This will also update the visibility of the pins marked by EnableEditMode().

Parameters
aVisible- True to make the pin visible or false to hide the pin.

Definition at line 469 of file lib_pin.cpp.

470 {
471  if( visible == IsVisible() )
472  return;
473 
474  if( visible )
476  else
478 
479  SetModified();
480 
481  if( GetParent() == NULL )
482  return;
483 
484  LIB_PINS pinList;
485  GetParent()->GetPins( pinList );
486 
487  for( size_t i = 0; i < pinList.size(); i++ )
488  {
489  if( ( pinList[i]->m_Flags & IS_LINKED ) == 0 || pinList[i]->IsVisible() == visible )
490  continue;
491 
492  if( visible )
493  pinList[i]->m_attributes &= ~PIN_INVISIBLE;
494  else
495  pinList[i]->m_attributes |= PIN_INVISIBLE;
496 
497  SetModified();
498  }
499 }
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: base_struct.h:117
void SetModified()
Definition: base_struct.cpp:95
LIB_PART * GetParent() const
Definition: lib_item.h:176
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:54
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
#define NULL
#define PIN_INVISIBLE
Definition: lib_pin.h:46
bool IsVisible() const
Return the visibility status of the draw object.
Definition: lib_pin.h:343
int m_attributes
Set bit 0 to indicate pin is invisible.
Definition: lib_pin.h:73
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:184

References LIB_ITEM::GetParent(), LIB_PART::GetPins(), IS_LINKED, IsVisible(), m_attributes, EDA_ITEM::m_Flags, NULL, PIN_INVISIBLE, and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::CreatePin(), DIALOG_LIB_EDIT_PIN::OnPropertiesChange(), DIALOG_LIB_EDIT_PIN::TransferDataFromWindow(), and DIALOG_LIB_EDIT_PIN::TransferDataToWindow().

◆ SetWidth()

void LIB_PIN::SetWidth ( int  aWidth)
overridevirtual

Implements LIB_ITEM.

Definition at line 1357 of file lib_pin.cpp.

1358 {
1359  if( m_width != aWidth )
1360  {
1361  m_width = aWidth;
1362  SetModified();
1363  }
1364 }
void SetModified()
Definition: base_struct.cpp:95
int m_width
Line width of the pin.
Definition: lib_pin.h:71

References m_width, and EDA_ITEM::SetModified().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 228 of file base_struct.h.

228 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:255
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:124

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

static bool EDA_ITEM::Sort ( const EDA_ITEM aLeft,
const EDA_ITEM aRight 
)
inlinestaticinherited

Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 534 of file base_struct.h.

534 { return *aLeft < *aRight; }

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const
inlineinherited

Function Type()

returns the type of object. This attribute should never be changed after a constructor sets it, so there is no public "setter" method.

Returns
KICAD_T - the type of object.

Definition at line 207 of file base_struct.h.

208  {
209  return m_StructType;
210  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it.
Definition: base_struct.h:172

References EDA_ITEM::m_StructType.

Referenced by MODULE::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_SCREENS::buildScreenList(), calcArea(), calcMaxArea(), PCB_INSPECTION_TOOL::calculateSelectionRatsnest(), POINT_EDITOR::canAddCorner(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), TEXTE_PCB::ClassOf(), SCH_NO_CONNECT::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), SCH_PIN::ClassOf(), EDGE_MODULE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), SCH_FIELD::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), MARKER_PCB::ClassOf(), ZONE_CONTAINER::ClassOf(), TRACK::ClassOf(), SCH_BITMAP::ClassOf(), DIMENSION::ClassOf(), NETINFO_ITEM::ClassOf(), SCH_SHEET_PIN::ClassOf(), MODULE::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_SCREEN::ClassOf(), D_PAD::ClassOf(), SCH_COMPONENT::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_TEXT::ClassOf(), SCH_SHEET::ClassOf(), VIA::ClassOf(), SCH_LABEL::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_HIERLABEL::ClassOf(), TRACKS_CLEANER::cleanupSegments(), LIB_RECTANGLE::compare(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), compare(), GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), EE_RTREE::contains(), SCH_EDIT_FRAME::ConvertTextType(), MODULE::CoverageRatio(), CINFO3D_VISU::createLayers(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), NETLIST_EXPORTER::CreatePinList(), D_PAD::D_PAD(), SCH_SCREEN::DeleteItem(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), DRC::doTrackDrc(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), CN_ITEM::Dump(), SCH_ITEM::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), SCH_EDIT_TOOL::EditField(), LIB_EDIT_TOOL::editTextProperties(), EditToolSelectionFilter(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckLabels(), NETLIST_EXPORTER::findNextComponent(), EDIT_TOOL::FootprintFilter(), SCH_LEGACY_PLUGIN::Format(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNameForDriver(), CONNECTIVITY_DATA::GetNetItems(), LIB_PART::GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), LIB_PART::GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), KIGFX::SCH_PAINTER::getRenderColor(), PCBNEW_SELECTION::GetTopLeftItem(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_eda(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlight(), KIGFX::SCH_VIEW::HighlightItem(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_MOVE_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_CONNECTION::Name(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), POINT_EDITOR::OnSelectionChange(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), EDIT_TOOL::PadFilter(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshItem(), SCH_BASE_FRAME::RefreshSelection(), EE_RTREE::remove(), MODULE::Remove(), CN_CONNECTIVITY_ALGO::Remove(), BOARD::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), LIB_PART::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), CONNECTION_SUBGRAPH::ResolveDrivers(), WS_PROXY_UNDO_ITEM::Restore(), SCH_EDIT_TOOL::Rotate(), SCH_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SELECTION_TOOL::select(), SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), SELECTION_TOOL::selectConnectedTracks(), ITEM_PICKER::SetItem(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowClearance(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), SCH_FIELD::SwapData(), TRACK::SwapData(), DIMENSION::SwapData(), VIA::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), MODULE::SwapData(), ZONE_CONTAINER::SwapData(), D_PAD::SwapData(), SwapItemData(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), TRACK::TransformShapeWithClearanceToPolygon(), LIB_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlight(), SCH_TEXT::UpdateDanglingState(), EE_POINT_EDITOR::updateItem(), POINT_EDITOR::updateItem(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updatePoints(), POINT_EDITOR::updatePoints(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateView(), PCB_BRIGHT_BOX::ViewDraw(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_SHEET::Visit(), SCH_COMPONENT::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in D_PAD, MODULE, EDIT_POINTS, GERBER_DRAW_ITEM, DRAWSEGMENT, DIMENSION, TEXTE_MODULE, TRACK, MARKER_PCB, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 231 of file base_struct.cpp.

232 {
233  // Basic fallback
234  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
235  VECTOR2I( GetBoundingBox().GetSize() ) );
236 }
BOX2< VECTOR2I > BOX2I
Definition: box2.h:521
VECTOR2< int > VECTOR2I
Definition: vector2d.h:594
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if if there is no PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 116 of file view_item.h.

117  {}

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

void LIB_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtualinherited

Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters
aLayers[]output layer index array
aCountnumber of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Reimplemented in LIB_TEXT.

Definition at line 129 of file lib_item.cpp.

130 {
131  // Basic fallback
132  aCount = 3;
133  aLayers[0] = LAYER_DEVICE;
134  aLayers[1] = LAYER_DEVICE_BACKGROUND;
135  aLayers[2] = LAYER_SELECTION_SHADOWS;
136 }

References LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, and LAYER_SELECTION_SHADOWS.

◆ ViewGetLOD()

virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters
aLayercurrent drawing layer
aViewpointer to the VIEW device we are drawing on
Returns
the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in MODULE_ZONE_CONTAINER, D_PAD, MODULE, VIA, GERBER_DRAW_ITEM, TEXTE_MODULE, TRACK, and EDGE_MODULE.

Definition at line 140 of file view_item.h.

141  {
142  // By default always show the item
143  return 0;
144  }

Referenced by KIGFX::VIEW::drawItem::operator()(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

◆ Visit()

SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
virtualinherited

Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, SCH_COMPONENT, MODULE, SCH_SHEET, LIB_PART, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 128 of file base_struct.cpp.

129 {
130 #if 0 && defined(DEBUG)
131  std::cout << GetClass().mb_str() << ' ';
132 #endif
133 
134  if( IsType( scanTypes ) )
135  {
136  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
137  return SEARCH_RESULT::QUIT;
138  }
139 
141 }
virtual bool IsType(const KICAD_T aScanTypes[]) const
Function IsType Checks whether the item is one of the listed types.
Definition: base_struct.h:284
virtual wxString GetClass() const =0
Function GetClass returns the class name.

References CONTINUE, EDA_ITEM::GetClass(), EDA_ITEM::IsType(), and QUIT.

Referenced by GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), and EDA_ITEM::IterateForward().

Friends And Related Function Documentation

◆ SCH_LEGACY_PLUGIN_CACHE

friend class SCH_LEGACY_PLUGIN_CACHE
friend

Definition at line 65 of file lib_pin.h.

Member Data Documentation

◆ m_attributes

int LIB_PIN::m_attributes
private

Set bit 0 to indicate pin is invisible.

Definition at line 73 of file lib_pin.h.

Referenced by IsVisible(), LIB_PIN(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), and SetVisible().

◆ m_Convert

int LIB_ITEM::m_Convert
protectedinherited

Shape identification for alternate body styles.

Set 0 if the item is common to all body styles. This is typially used for representing DeMorgan variants in KiCad.

Definition at line 87 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::GetConvert(), LIB_ITEM::GetMsgPanelInfo(), LIB_ITEM::LIB_ITEM(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LIB_ITEM::operator<(), LIB_ITEM::operator==(), SetConversion(), LIB_PART::SetConversion(), LIB_ITEM::SetConvert(), SetLength(), SetPartNumber(), SetPinPosition(), and SetShape().

◆ m_Fill

◆ m_Flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

Set to true to override the visibility setting of the item.

Definition at line 181 of file base_struct.h.

Referenced by EDA_ITEM::initVars(), EDA_ITEM::operator=(), SCH_FIELD::Print(), and EDA_ITEM::SetForceVisible().

◆ m_isFillable

◆ m_length

◆ m_name

wxString LIB_PIN::m_name
private

◆ m_nameTextSize

int LIB_PIN::m_nameTextSize
private

◆ m_number

◆ m_numTextSize

int LIB_PIN::m_numTextSize
private

◆ m_orientation

int LIB_PIN::m_orientation
private

◆ m_Parent

◆ m_position

◆ m_shape

GRAPHIC_PINSHAPE LIB_PIN::m_shape
private

◆ m_TimeStamp

timestamp_t EDA_ITEM::m_TimeStamp
protectedinherited

◆ m_type

ELECTRICAL_PINTYPE LIB_PIN::m_type
private

◆ m_Unit

int LIB_ITEM::m_Unit
protectedinherited

◆ m_width

int LIB_PIN::m_width
private

Line width of the pin.

Definition at line 71 of file lib_pin.h.

Referenced by GetPenSize(), GetWidth(), LIB_PIN(), and SetWidth().


The documentation for this class was generated from the following files: