KiCad PCB EDA Suite
LIB_PART Class Reference

Class LIB_PART defines a library part object. More...

#include <class_libentry.h>

Inheritance diagram for LIB_PART:
EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

 LIB_PART (const wxString &aName, PART_LIB *aLibrary=NULL)
 
 LIB_PART (LIB_PART &aPart, PART_LIB *aLibrary=NULL)
 
virtual ~LIB_PART ()
 
PART_SPTR SharedPtr ()
 
virtual wxString GetClass () const override
 Function GetClass returns the class name. More...
 
virtual void SetName (const wxString &aName)
 
const wxString & GetName () const
 
const LIB_IDGetLibId () const
 
void SetLibId (const LIB_ID &aLibId)
 
const wxString GetLibraryName ()
 
PART_LIBGetLib ()
 
void SetLib (PART_LIB *aLibrary)
 
wxArrayString GetAliasNames (bool aIncludeRoot=true) const
 
size_t GetAliasCount () const
 
LIB_ALIASGetAlias (size_t aIndex)
 
LIB_ALIASGetAlias (const wxString &aName)
 
void AddAlias (const wxString &aName)
 Function AddAlias. More...
 
bool HasAlias (const wxString &aName) const
 Test if alias aName is in part alias list. More...
 
void SetAliases (const wxArrayString &aAliasList)
 
void RemoveAlias (const wxString &aName)
 
LIB_ALIASRemoveAlias (LIB_ALIAS *aAlias)
 
void RemoveAllAliases ()
 
wxArrayString & GetFootPrints ()
 
const EDA_RECT GetUnitBoundingBox (int aUnit, int aConvert) const
 Function GetBoundingBox. More...
 
const EDA_RECT GetBodyBoundingBox (int aUnit, int aConvert) const
 Function GetBodyBoundingBox. More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
bool SaveDateAndTime (OUTPUTFORMATTER &aFormatter)
 Function SaveDateAndTime write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss". More...
 
bool LoadDateAndTime (char *aLine)
 
bool Save (OUTPUTFORMATTER &aFormatter)
 Function Save writes the data structures out to aFormatter in the part library "*.lib" format. More...
 
bool Load (LINE_READER &aReader, wxString &aErrorMsg)
 Load part definition from aReader. More...
 
bool LoadField (LINE_READER &aReader, wxString &aErrorMsg)
 
bool LoadDrawEntries (LINE_READER &aReader, wxString &aErrorMsg)
 
bool LoadAliases (char *aLine, wxString &aErrorMsg)
 
bool LoadFootprints (LINE_READER &aReader, wxString &aErrorMsg)
 
bool IsPower () const
 
bool IsNormal () const
 
void SetPower ()
 
void SetNormal ()
 
void LockUnits (bool aLockUnits)
 
bool UnitsLocked () const
 
void SetFields (const std::vector< LIB_FIELD > &aFieldsList)
 Function SetFields overwrites all the existing in this part with fields supplied in aFieldsList. More...
 
void GetFields (LIB_FIELDS &aList)
 Function GetFields returns a list of fields withing this part. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Function FindField finds a field within this part matching aFieldName and returns it or NULL if not found. More...
 
LIB_FIELDGetField (int aId)
 Return pointer to the requested field. More...
 
LIB_FIELDGetValueField ()
 Return reference to the value field. More...
 
LIB_FIELDGetReferenceField ()
 Return reference to the reference designator field. More...
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDc, const wxPoint &aOffset, int aMulti, int aConvert, const PART_DRAW_OPTIONS &aOpts)
 Draw part. More...
 
void Plot (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot lib part to plotter. More...
 
void PlotLibFields (PLOTTER *aPlotter, int aUnit, int aConvert, const wxPoint &aOffset, const TRANSFORM &aTransform)
 Plot Lib Fields only of the part to plotter. More...
 
void AddDrawItem (LIB_ITEM *aItem)
 Add a new draw aItem to the draw object list. More...
 
void RemoveDrawItem (LIB_ITEM *aItem, EDA_DRAW_PANEL *aPanel=NULL, wxDC *aDc=NULL)
 Remove draw aItem from list. More...
 
LIB_ITEMGetNextDrawItem (LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
 Return the next draw object pointer. More...
 
LIB_PINGetNextPin (LIB_PIN *aItem=NULL)
 Return the next pin object from the draw list. More...
 
void GetPins (LIB_PINS &aList, int aUnit=0, int aConvert=0)
 Return a list of pin object pointers from the draw item list. More...
 
LIB_PINGetPin (const wxString &aNumber, int aUnit=0, int aConvert=0)
 Return pin object with the requested pin aNumber. More...
 
bool PinsConflictWith (LIB_PART &aOtherPart, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength)
 Function PinsConflictWith returns true if this part's pins do not match another part's pins. More...
 
void SetOffset (const wxPoint &aOffset)
 Move the part aOffset. More...
 
void RemoveDuplicateDrawItems ()
 Remove duplicate draw items from list. More...
 
bool HasConversion () const
 Test if part has more than one body conversion type (DeMorgan). More...
 
void ClearStatus ()
 Clears the status flag all draw objects in this part. More...
 
int SelectItems (EDA_RECT &aRect, int aUnit, int aConvert, bool aEditPinByPin)
 Checks all draw objects of part to see if they are with block. More...
 
void ClearSelectedItems ()
 Clears all the draw items marked by a block select. More...
 
void DeleteSelectedItems ()
 Deletes the select draw items marked by a block select. More...
 
void MoveSelectedItems (const wxPoint &aOffset)
 Move the selected draw items marked by a block select. More...
 
void CopySelectedItems (const wxPoint &aOffset)
 Make a copy of the selected draw items marked by a block select. More...
 
void MirrorSelectedItemsH (const wxPoint &aCenter)
 Horizontally (X axis) mirror selected draw items about a point. More...
 
void MirrorSelectedItemsV (const wxPoint &aCenter)
 Vertically (Y axis) mirror selected draw items about a point. More...
 
void RotateSelectedItems (const wxPoint &aCenter)
 Rotate CCW selected draw items about a point. More...
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
 Locate a draw object. More...
 
LIB_ITEMLocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint, const TRANSFORM &aTransform)
 Locate a draw object (overlaid) More...
 
LIB_ITEMSGetDrawItemList ()
 Return a reference to the draw item list. More...
 
void SetUnitCount (int count)
 Set the units per part count. More...
 
int GetUnitCount () const
 
bool IsMulti () const
 Function IsMulti. More...
 
void SetConversion (bool aSetConvert)
 Set or clear the alternate body style (DeMorgan) for the part. More...
 
void SetPinNameOffset (int aOffset)
 Set the offset in mils of the pin name text from the pin symbol. More...
 
int GetPinNameOffset ()
 
void SetShowPinNames (bool aShow)
 Set or clear the pin name visibility flag. More...
 
bool ShowPinNames ()
 
void SetShowPinNumbers (bool aShow)
 Set or clear the pin number visibility flag. More...
 
bool ShowPinNumbers ()
 
bool operator== (const LIB_PART *aPart) const
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (time_t aNewTimeStamp)
 
time_t GetTimeStamp () const
 
EDA_ITEMNext () const
 
EDA_ITEMBack () const
 
EDA_ITEMGetParent () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
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
 
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 void GetMsgPanelInfo (std::vector< MSG_PANEL_ITEM > &aList)
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
virtual bool HitTest (const wxPoint &aPosition) const
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. 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 wxString GetSelectMenuText () const
 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...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
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...
 
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...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 
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 of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static wxString SubReference (int aUnit, bool aAddSeparator=true)
 Function SubReference. More...
 
static int GetSubpartIdSeparator ()
 
static int * SubpartIdSeparatorPtr ()
 return a reference to m_subpartIdSeparator, only for read/save setting functions More...
 
static int GetSubpartFirstId ()
 
static int * SubpartFirstIdPtr ()
 return a reference to m_subpartFirstId, only for read/save setting functions More...
 
static void SetSubpartIdNotation (int aSep, int aFirstId)
 Set the separator char between the subpart id and the reference 0 (no separator) or '. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. 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

EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
time_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 deleteAllFields ()
 

Private Attributes

PART_SPTR m_me
 http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared More...
 
wxString m_name
 
LIB_ID m_libId
 
int m_pinNameOffset
 The offset in mils to draw the pin name. More...
 
bool m_unitsLocked
 True if part has multiple units and changing one unit does not automatically change another unit. More...
 
bool m_showPinNames
 Determines if part pin names are visible. More...
 
bool m_showPinNumbers
 Determines if part pin numbers are visible. More...
 
long m_dateModified
 Date the part was last modified. More...
 
LIBRENTRYOPTIONS m_options
 Special part features such as POWER or NORMAL.) More...
 
int m_unitCount
 Number of units (parts) per package. More...
 
LIB_ITEMS drawings
 How to draw this part. More...
 
wxArrayString m_FootprintList
 List of suitable footprint names for the part (wild card names accepted). More...
 
LIB_ALIASES m_aliases
 List of alias object pointers associated with the part. More...
 
PART_LIBm_library
 Library the part belongs to if any. More...
 

Static Private Attributes

static int m_subpartIdSeparator = 0
 the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A More...
 
static int m_subpartFirstId = 'A'
 the ascii char value to calculate the subpart symbol id from the part number: only 'A', 'a' or '1' can be used, other values have no sense. More...
 

Friends

class PART_LIB
 
class LIB_ALIAS
 
class SCH_LEGACY_PLUGIN_CACHE
 

Detailed Description

Class LIB_PART defines a library part object.

A library part object is typically saved and loaded in a part library file (.lib). Library parts are different from schematic components.

Definition at line 221 of file class_libentry.h.

Constructor & Destructor Documentation

LIB_PART::LIB_PART ( const wxString &  aName,
PART_LIB aLibrary = NULL 
)

Definition at line 179 of file class_libentry.cpp.

References DATASHEET, drawings, ENTRY_NORMAL, FOOTPRINT, m_aliases, m_dateModified, m_library, m_name, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, REFERENCE, LIB_FIELD::SetText(), and VALUE.

179  :
180  EDA_ITEM( LIB_PART_T ),
181  m_me( this, null_deleter() )
182 {
183  m_name = aName;
184  m_library = aLibrary;
185  m_dateModified = 0;
186  m_unitCount = 1;
187  m_pinNameOffset = 40;
189  m_unitsLocked = false;
190  m_showPinNumbers = true;
191  m_showPinNames = true;
192 
193  // Create the default alias if the name parameter is not empty.
194  if( !aName.IsEmpty() )
195  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
196 
197  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
198  // when the field editors are invoked.
199  LIB_FIELD* value = new LIB_FIELD( this, VALUE );
200  value->SetText( aName );
201  drawings.push_back( value );
202 
203  drawings.push_back( new LIB_FIELD( this, REFERENCE ) );
204  drawings.push_back( new LIB_FIELD( this, FOOTPRINT ) );
205  drawings.push_back( new LIB_FIELD( this, DATASHEET ) );
206 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
name of datasheet
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
PART_LIB * m_library
Library the part belongs to if any.
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
int m_pinNameOffset
The offset in mils to draw the pin name.
wxString m_name
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:679
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:66
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
Field Value of part, i.e. "3.3K".
LIB_ITEMS drawings
How to draw this part.
long m_dateModified
Date the part was last modified.
bool m_showPinNames
Determines if part pin names are visible.
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_PART::LIB_PART ( LIB_PART aPart,
PART_LIB aLibrary = NULL 
)

Definition at line 209 of file class_libentry.cpp.

References EDA_ITEM::Clone(), drawings, GetDrawItemList(), LIB_ALIAS, m_aliases, m_dateModified, m_FootprintList, m_library, m_name, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, and EDA_ITEM::SetParent().

209  :
210  EDA_ITEM( aPart ),
211  m_me( this, null_deleter() )
212 {
213  LIB_ITEM* newItem;
214 
215  m_library = aLibrary;
216  m_name = aPart.m_name;
218  m_unitCount = aPart.m_unitCount;
224  m_options = aPart.m_options;
225 
226  for( LIB_ITEM& oldItem : aPart.GetDrawItemList() )
227  {
228  if( oldItem.IsNew() )
229  continue;
230 
231  newItem = (LIB_ITEM*) oldItem.Clone();
232  newItem->SetParent( this );
233  drawings.push_back( newItem );
234  }
235 
236  for( size_t i = 0; i < aPart.m_aliases.size(); i++ )
237  {
238  LIB_ALIAS* alias = new LIB_ALIAS( *aPart.m_aliases[i], this );
239  m_aliases.push_back( alias );
240  }
241 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
LIB_ITEMS & GetDrawItemList()
Return a reference to the draw item list.
bool m_showPinNumbers
Determines if part pin numbers are visible.
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
int m_unitCount
Number of units (parts) per package.
PART_LIB * m_library
Library the part belongs to if any.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
int m_pinNameOffset
The offset in mils to draw the pin name.
wxString m_name
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:213
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType)
Definition: base_struct.cpp:66
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_ITEMS drawings
How to draw this part.
friend class LIB_ALIAS
long m_dateModified
Date the part was last modified.
bool m_showPinNames
Determines if part pin names are visible.
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
LIB_PART::~LIB_PART ( )
virtual

Definition at line 244 of file class_libentry.cpp.

References GetChars(), GetName(), m_aliases, and traceSchLibMem.

245 {
246  wxLogTrace( traceSchLibMem,
247  wxT( "%s: destroying part '%s' with alias list count of %llu." ),
248  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ), GetChars( GetName() ),
249  (long long unsigned) m_aliases.size() );
250 
251  // If the part is being deleted directly rather than through the library,
252  // delete all of the aliases.
253  while( m_aliases.size() )
254  {
255  LIB_ALIAS* alias = m_aliases.back();
256  m_aliases.pop_back();
257  delete alias;
258  }
259 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
const wxChar traceSchLibMem[]
WXTRACE value to enable schematic library memory deletion debug output.
const wxString & GetName() const
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:92

Member Function Documentation

void LIB_PART::AddAlias ( const wxString &  aName)

Function AddAlias.

Add an alias aName to the part.

Duplicate alias names are not added to the alias list. Debug builds will raise an assertion. Release builds will fail silently.

Parameters
aName- Name of alias to add.

Definition at line 1888 of file class_libentry.cpp.

References GetName(), HasAlias(), LIB_ALIAS, and m_aliases.

1889 {
1890  wxCHECK_RET( !HasAlias( aName ),
1891  wxT( "Part <" ) + GetName() + wxT( "> already has an alias <" ) +
1892  aName + wxT( ">. Bad programmer." ) );
1893 
1894  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
1895 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
const wxString & GetName() const
friend class LIB_ALIAS
void LIB_PART::AddDrawItem ( LIB_ITEM aItem)

Add a new draw aItem to the draw object list.

Parameters
aItem- New draw object to add to part.

Definition at line 574 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::CreateImagePins(), dummy(), LIB_EDIT_FRAME::LoadOneSymbol(), and LIB_EDIT_FRAME::PlacePin().

575 {
576  wxASSERT( aItem != NULL );
577 
578  drawings.push_back( aItem );
579  drawings.sort();
580 }
LIB_ITEMS drawings
How to draw this part.
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::Pback.

Referenced by DHEAD::insert(), DHEAD::remove(), and BOARD_ITEM::SwapData().

207 { return Pback; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:165
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 233 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

233 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 254 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), CopySelectedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DeleteSelectedItems(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), LIB_PIN::Save(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

254 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 232 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

232 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void EDA_ITEM::ClearSelected ( )
inlineinherited

Definition at line 231 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), SELECTION_TOOL::unselectVisually(), and PCB_EDITOR_CONTROL::ZoneDuplicate().

231 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:120
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void LIB_PART::ClearSelectedItems ( )

Clears all the draw items marked by a block select.

Definition at line 1475 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::LoadOneSymbol().

1476 {
1477  for( LIB_ITEM& item : drawings )
1478  {
1479  item.m_Flags = 0;
1480  }
1481 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::ClearStatus ( )

Clears the status flag all draw objects in this part.

Definition at line 1420 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::CreatePin(), and LIB_EDIT_FRAME::SaveCopyInUndoList().

1421 {
1422  for( LIB_ITEM& item : drawings )
1423  {
1424  item.m_Flags = 0;
1425  }
1426 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

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 in ZONE_CONTAINER, SCH_SHEET, SCH_COMPONENT, MODULE, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_LINE, SCH_BITMAP, TEXTE_PCB, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, SCH_MARKER, LIB_CIRCLE, PCB_TARGET, LIB_BEZIER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 125 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), CopyMarkedItems(), CopySelectedItems(), BOARD::Duplicate(), DuplicateStruct(), SCH_SCREEN::ExtractWires(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), SetUnitCount(), and COMMIT::Stage().

126 {
127  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
128  wxT( ". Bad programmer!" ) );
129 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void LIB_PART::CopySelectedItems ( const wxPoint aOffset)

Make a copy of the selected draw items marked by a block select.

Fields are not copied. Only part body items are copied. Copying fields would result in duplicate fields which does not make sense in this context.

Definition at line 1514 of file class_libentry.cpp.

References EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), drawings, EDA_ITEM::IsSelected(), LIB_FIELD_T, MoveSelectedItems(), SELECTED, EDA_ITEM::SetFlags(), and EDA_ITEM::Type().

Referenced by LIB_EDIT_FRAME::HandleBlockPlace().

1515 {
1516  /* *do not* use iterators here, because new items
1517  * are added to drawings that is a boost::ptr_vector.
1518  * When push_back elements in buffer,
1519  * a memory reallocation can happen and will break pointers
1520  */
1521  unsigned icnt = drawings.size();
1522 
1523  for( unsigned ii = 0; ii < icnt; ii++ )
1524  {
1525  LIB_ITEM& item = drawings[ii];
1526 
1527  // We *do not* copy fields because they are unique for the whole component
1528  // so skip them (do not duplicate) if they are flagged selected.
1529  if( item.Type() == LIB_FIELD_T )
1530  item.ClearFlags( SELECTED );
1531 
1532  if( !item.IsSelected() )
1533  continue;
1534 
1535  item.ClearFlags( SELECTED );
1536  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1537  newItem->SetFlags( SELECTED );
1538  drawings.push_back( newItem );
1539  }
1540 
1541  MoveSelectedItems( aOffset );
1542  drawings.sort();
1543 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
bool IsSelected() const
Definition: base_struct.h:221
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
#define SELECTED
Definition: base_struct.h:120
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
LIB_ITEMS drawings
How to draw this part.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void MoveSelectedItems(const wxPoint &aOffset)
Move the selected draw items marked by a block select.
void LIB_PART::deleteAllFields ( )
private

Definition at line 1231 of file class_libentry.cpp.

References drawings, and LIB_FIELD_T.

Referenced by SetFields().

1232 {
1233  LIB_ITEMS::iterator it;
1234 
1235  for( it = drawings.begin(); it != drawings.end(); /* deleting */ )
1236  {
1237  if( it->Type() != LIB_FIELD_T )
1238  {
1239  ++it;
1240  continue;
1241  }
1242 
1243  // 'it' is not advanced, but should point to next in list after erase()
1244  it = drawings.erase( it );
1245  }
1246 }
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::DeleteSelectedItems ( )

Deletes the select draw items marked by a block select.

The name and reference field will not be deleted. They are the minimum drawing items required for any part. Their properties can be changed but the cannot be removed.

Definition at line 1484 of file class_libentry.cpp.

References EDA_ITEM::ClearFlags(), drawings, LIB_FIELD::GetId(), LIB_FIELD_T, REFERENCE, SELECTED, and VALUE.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

1485 {
1486  LIB_ITEMS::iterator item = drawings.begin();
1487 
1488  // We *do not* remove the 2 mandatory fields: reference and value
1489  // so skip them (do not remove) if they are flagged selected.
1490  // Skip also not visible items.
1491  // But I think fields must not be deleted by a block delete command or other global command
1492  // because they are not really graphic items
1493  while( item != drawings.end() )
1494  {
1495  if( item->Type() == LIB_FIELD_T )
1496  {
1497 #if 0 // Set to 1 to allows fields deletion on block delete or other global command
1498  LIB_FIELD& field = ( LIB_FIELD& ) *item;
1499 
1500  if( (field.GetId() == REFERENCE) || (field.m_FieldId == VALUE) ||
1501  (field.m_Attributs & TEXT_NO_VISIBLE) )
1502 #endif
1503  item->ClearFlags( SELECTED );
1504  }
1505 
1506  if( !item->IsSelected() )
1507  item++;
1508  else
1509  item = drawings.erase( item );
1510  }
1511 }
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Field Reference of part, i.e. "IC21".
#define SELECTED
Definition: base_struct.h:120
int GetId() const
Definition: lib_field.h:136
Field Value of part, i.e. "3.3K".
LIB_ITEMS drawings
How to draw this part.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void LIB_PART::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDc,
const wxPoint aOffset,
int  aMulti,
int  aConvert,
const PART_DRAW_OPTIONS aOpts 
)

Draw part.

Parameters
aPanel- Window to draw on. Can be NULL if not available.
aDc- Device context to draw on.
aOffset- Position of part.
aMulti- unit if multiple units per part.
aConvert- Component conversion (DeMorgan) if available.
aOpts- Drawing options

Definition at line 316 of file class_libentry.cpp.

References PART_DRAW_OPTIONS::color, PART_DRAW_OPTIONS::draw_hidden_fields, PART_DRAW_OPTIONS::draw_mode, PART_DRAW_OPTIONS::draw_visible_fields, drawings, FILLED_WITH_BG_BODYCOLOR, EDA_DRAW_PANEL::GetClipBox(), GetGRForceBlackPenState(), EDA_DRAW_PANEL::GetScreen(), GetUnitBoundingBox(), GRLine(), GRRect(), GRSetDrawMode(), IS_MOVED, IsPower(), LIB_PIN::IsPowerConnection(), LIB_FIELD::IsVisible(), LIB_FIELD_T, LIB_PIN_T, LIGHTMAGENTA, BASE_SCREEN::m_IsPrinting, EDA_RECT::Move(), PART_DRAW_OPTIONS::only_selected, PIN_DANGLING_HIDDEN, PIN_DRAW_DANGLING, PIN_DRAW_ELECTRICAL_TYPE_NAME, PIN_DRAW_TEXTS, PART_DRAW_OPTIONS::PinIsDangling(), EDA_RECT::RevertYAxis(), PART_DRAW_OPTIONS::show_elec_type, PART_DRAW_OPTIONS::show_pin_text, PART_DRAW_OPTIONS::transform, TRANSFORM::TransformCoordinate(), wxPoint::x, and wxPoint::y.

Referenced by SCH_COMPONENT::Draw(), DrawMovingBlockOutlines(), LIB_EDIT_FRAME::PrintPage(), LIB_VIEW_FRAME::RedrawActiveWindow(), LIB_EDIT_FRAME::RedrawComponent(), DIALOG_RESCUE_EACH::renderPreview(), and DIALOG_CHOOSE_COMPONENT::RenderPreview().

318 {
319  BASE_SCREEN* screen = aPanel ? aPanel->GetScreen() : NULL;
320 
321  GRSetDrawMode( aDc, aOpts.draw_mode );
322 
323  /* draw background for filled items using background option
324  * Solid lines will be drawn after the background
325  * Note also, background is not drawn when:
326  * printing in black and white
327  * If the color is not the default color (aColor != -1 )
328  */
329  if( ! ( screen && screen->m_IsPrinting && GetGRForceBlackPenState() )
330  && ( aOpts.color == COLOR4D::UNSPECIFIED ) )
331  {
332  for( LIB_ITEM& drawItem : drawings )
333  {
334  if( drawItem.m_Fill != FILLED_WITH_BG_BODYCOLOR )
335  continue;
336 
337  if( aOpts.only_selected && !drawItem.IsSelected() )
338  continue;
339 
340  // Do not draw an item while moving (the cursor handler does that)
341  if( drawItem.m_Flags & IS_MOVED )
342  continue;
343 
344  // Do not draw items not attached to the current part
345  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
346  continue;
347 
348  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
349  continue;
350 
351  if( drawItem.Type() == LIB_FIELD_T )
352  continue;
353 
354  if( drawItem.Type() == LIB_FIELD_T )
355  {
356  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
357  aOpts.draw_mode, (void*) NULL, aOpts.transform );
358  }
359 
360  // Now, draw only the background for items with
361  // m_Fill == FILLED_WITH_BG_BODYCOLOR:
362  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
363  aOpts.draw_mode, (void*) false, aOpts.transform );
364  }
365  }
366 
367  // Track the index into the dangling pins list
368  size_t pin_index = 0;
369 
370  for( LIB_ITEM& drawItem : drawings )
371  {
372  if( aOpts.only_selected && !drawItem.IsSelected() )
373  continue;
374 
375  // Do not draw an item while moving (the cursor handler does that)
376  if( drawItem.m_Flags & IS_MOVED )
377  continue;
378 
379  // Do not draw items not attached to the current part
380  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
381  continue;
382 
383  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
384  continue;
385 
386  if( drawItem.Type() == LIB_FIELD_T )
387  {
388  LIB_FIELD& field = dynamic_cast<LIB_FIELD&>( drawItem );
389 
390  if( field.IsVisible() && !aOpts.draw_visible_fields )
391  continue;
392 
393  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
394  continue;
395  }
396 
397  if( drawItem.Type() == LIB_PIN_T )
398  {
399  LIB_PIN& pin = dynamic_cast<LIB_PIN&>( drawItem );
400 
401  uintptr_t flags = 0;
402  if( aOpts.show_pin_text )
403  flags |= PIN_DRAW_TEXTS;
404 
405  if( aOpts.show_elec_type )
407 
408  if( aOpts.PinIsDangling( pin_index ) )
409  flags |= PIN_DRAW_DANGLING;
410 
411  if( pin.IsPowerConnection() && IsPower() )
412  flags |= PIN_DANGLING_HIDDEN;
413 
414  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
415  aOpts.draw_mode, (void*) flags, aOpts.transform );
416 
417  ++pin_index;
418  }
419  else if( drawItem.Type() == LIB_FIELD_T )
420  {
421  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
422  aOpts.draw_mode, (void*) NULL, aOpts.transform );
423  }
424  else
425  {
426  bool forceNoFill = drawItem.m_Fill == FILLED_WITH_BG_BODYCOLOR;
427  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
428  aOpts.draw_mode, (void*) forceNoFill,
429  aOpts.transform );
430  }
431 
432  }
433 
434  // Enable this to draw the anchor of the component.
435 #if 0
436  int len = aDc->DeviceToLogicalXRel( 3 );
437  EDA_RECT* const clipbox = aPanel ? aPanel->GetClipBox() : NULL;
438 
439  GRLine( clipbox, aDc, aOffset.x, aOffset.y - len, aOffset.x,
440  aOffset.y + len, 0, aOpts.color );
441  GRLine( clipbox, aDc, aOffset.x - len, aOffset.y, aOffset.x + len,
442  aOffset.y, 0, aOpts.color );
443 #endif
444 
445  /* Enable this to draw the bounding box around the component to validate
446  * the bounding box calculations. */
447 #if 0
448  EDA_RECT bBox = GetUnitBoundingBox( aMulti, aConvert );
449  bBox.RevertYAxis();
450  bBox = aOpts.transform.TransformCoordinate( bBox );
451  bBox.Move( aOffset );
452  GRRect( aPanel ? aPanel->GetClipBox() : NULL, aDc, bBox, 0, LIGHTMAGENTA );
453 #endif
454 }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Function GetBoundingBox.
bool PinIsDangling(size_t aPin) const
void Move(const wxPoint &aMoveVector)
Function Move moves the rectangle by the aMoveVector.
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:290
bool IsPower() const
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:352
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
bool draw_hidden_fields
Whether to draw "hidden" fields.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1077
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
EDA_RECT * GetClipBox()
GR_DRAWMODE draw_mode
Device context drawing mode, see wxDC.
COLOR4D color
Color to draw part in.
LIB_ITEMS drawings
How to draw this part.
bool IsVisible() const
Function IsVisible.
Definition: lib_field.h:168
Class EDA_RECT handles the component boundary box.
bool show_pin_text
Whether to show pin texts.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:188
bool only_selected
Draws only the body items that are selected, for block moves.
bool show_elec_type
Whether to show the pin electrical type.
bool IsPowerConnection() const
Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN...
Definition: lib_pin.h:378
bool draw_visible_fields
Whether to draw "visible" fields.
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:281
TRANSFORM transform
Coordinate adjustment settings.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:112
LIB_FIELD * LIB_PART::FindField ( const wxString &  aFieldName)

Function FindField finds a field within this part matching aFieldName and returns it or NULL if not found.

Definition at line 1320 of file class_libentry.cpp.

References drawings, LIB_FIELD::GetName(), and LIB_FIELD_T.

1321 {
1322  for( LIB_ITEM& item : drawings )
1323  {
1324  if( item.Type() != LIB_FIELD_T )
1325  continue;
1326 
1327  LIB_FIELD* field = ( LIB_FIELD* ) &item;
1328 
1329  if( field->GetName() == aFieldName )
1330  return field;
1331  }
1332 
1333  return NULL;
1334 }
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
LIB_ITEMS drawings
How to draw this part.
LIB_ALIAS * LIB_PART::GetAlias ( size_t  aIndex)
LIB_ALIAS * LIB_PART::GetAlias ( const wxString &  aName)

Definition at line 1864 of file class_libentry.cpp.

References GetName(), and m_aliases.

1865 {
1866  wxCHECK2_MSG( !aName.IsEmpty(), return NULL,
1867  wxT( "Cannot get alias with an empty name. Bad programmer!" ) );
1868 
1869  for( size_t i = 0; i < m_aliases.size(); i++ )
1870  {
1871  if( aName == m_aliases[i]->GetName() )
1872  return m_aliases[i];
1873  }
1874 
1875  return NULL;
1876 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const wxString & GetName() const
size_t LIB_PART::GetAliasCount ( ) const
inline
wxArrayString LIB_PART::GetAliasNames ( bool  aIncludeRoot = true) const

Definition at line 1722 of file class_libentry.cpp.

References m_aliases.

Referenced by SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), LIB_EDIT_FRAME::EditField(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::initDlg(), NETLIST_EXPORTER_GENERIC::makeLibParts(), SetAliases(), and LIB_EDIT_FRAME::UpdateAliasSelectList().

1723 {
1724  wxArrayString names;
1725 
1726  LIB_ALIASES::const_iterator it;
1727 
1728  for( it=m_aliases.begin(); it != m_aliases.end(); ++it )
1729  {
1730  if( !aIncludeRoot && (*it)->IsRoot() )
1731  continue;
1732 
1733  names.Add( (*it)->GetName() );
1734  }
1735 
1736  return names;
1737 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const EDA_RECT LIB_PART::GetBodyBoundingBox ( int  aUnit,
int  aConvert 
) const

Function GetBodyBoundingBox.

Returns
the part bounding box ( in user coordinates ) without fields
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Fields are not taken in account

Definition at line 1199 of file class_libentry.cpp.

References drawings, LIB_ITEM::GetBoundingBox(), LIB_FIELD_T, LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, m_unitCount, EDA_RECT::Merge(), and EDA_ITEM::Type().

Referenced by SCH_COMPONENT::GetBodyBoundingBox().

1200 {
1201  EDA_RECT bBox;
1202  bool initialized = false;
1203 
1204  for( unsigned ii = 0; ii < drawings.size(); ii++ )
1205  {
1206  const LIB_ITEM& item = drawings[ii];
1207 
1208  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
1209  && ( aUnit != item.m_Unit ) ) )
1210  continue;
1211 
1212  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
1213  continue;
1214 
1215  if( item.Type() == LIB_FIELD_T )
1216  continue;
1217 
1218  if( initialized )
1219  bBox.Merge( item.GetBoundingBox() );
1220  else
1221  {
1222  bBox = item.GetBoundingBox();
1223  initialized = true;
1224  }
1225  }
1226 
1227  return bBox;
1228 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
int m_unitCount
Number of units (parts) per package.
int m_Unit
Unit identification for multiple parts per package.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
virtual const EDA_RECT GetBoundingBox() const override
LIB_ITEMS drawings
How to draw this part.
Class EDA_RECT handles the component boundary box.
int m_Convert
Shape identification for alternate body styles.
const EDA_RECT LIB_PART::GetBoundingBox ( ) const
inlineoverridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 349 of file class_libentry.h.

References GetUnitBoundingBox().

350  {
351  return GetUnitBoundingBox( 0, 0 );
352  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Function GetBoundingBox.
virtual wxString LIB_PART::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 270 of file class_libentry.h.

271  {
272  return wxT( "LIB_PART" );
273  }
LIB_ITEMS& LIB_PART::GetDrawItemList ( )
inline

Return a reference to the draw item list.

Returns
LIB_ITEMS& - Reference to the draw item object list.

Definition at line 684 of file class_libentry.h.

References drawings.

Referenced by LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::locateItem(), and LIB_EDIT_FRAME::SaveOneSymbol().

684 { return drawings; }
LIB_ITEMS drawings
How to draw this part.
LIB_FIELD * LIB_PART::GetField ( int  aId)

Return pointer to the requested field.

Parameters
aId- Id of field to return.
Returns
The field if found, otherwise NULL.

Definition at line 1303 of file class_libentry.cpp.

References drawings, LIB_FIELD::GetId(), and LIB_FIELD_T.

Referenced by GetFields(), GetReferenceField(), GetValueField(), LoadField(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_EDIT_FRAME::RedrawComponent(), and DIALOG_CHOOSE_COMPONENT::ShowFootprintFor().

1304 {
1305  for( LIB_ITEM& item : drawings )
1306  {
1307  if( item.Type() != LIB_FIELD_T )
1308  continue;
1309 
1310  LIB_FIELD* field = ( LIB_FIELD* ) &item;
1311 
1312  if( field->GetId() == aId )
1313  return field;
1314  }
1315 
1316  return NULL;
1317 }
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
int GetId() const
Definition: lib_field.h:136
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::GetFields ( LIB_FIELDS aList)

Function GetFields returns a list of fields withing this part.

The only known caller of this function is the library part field editor, and it establishes needed behavior.

Parameters
aList- List to add fields to

Definition at line 1268 of file class_libentry.cpp.

References drawings, GetField(), LIB_FIELD::GetId(), LIB_FIELD_T, and MANDATORY_FIELDS.

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), NETLIST_EXPORTER_GENERIC::makeLibParts(), Save(), SCH_COMPONENT::SCH_COMPONENT(), and ALIAS_INFO_GENERATOR::SetHtmlFieldTable().

1269 {
1270  LIB_FIELD* field;
1271 
1272  // The only caller of this function is the library field editor, so it
1273  // establishes policy here.
1274 
1275  // Grab the MANDATORY_FIELDS first, in expected order given by
1276  // enum NumFieldType
1277  for( int id=0; id<MANDATORY_FIELDS; ++id )
1278  {
1279  field = GetField( id );
1280 
1281  // the MANDATORY_FIELDS are exactly that in RAM.
1282  wxASSERT( field );
1283 
1284  aList.push_back( *field );
1285  }
1286 
1287  // Now grab all the rest of fields.
1288  for( LIB_ITEM& item : drawings )
1289  {
1290  if( item.Type() != LIB_FIELD_T )
1291  continue;
1292 
1293  field = ( LIB_FIELD* ) &item;
1294 
1295  if( (unsigned) field->GetId() < MANDATORY_FIELDS )
1296  continue; // was added above
1297 
1298  aList.push_back( *field );
1299  }
1300 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
int GetId() const
Definition: lib_field.h:136
LIB_ITEMS drawings
How to draw this part.
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 255 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), BOARD::Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), LIB_EDIT_FRAME::LoadOneSymbol(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

255 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
wxArrayString& LIB_PART::GetFootPrints ( )
inline
PART_LIB* LIB_PART::GetLib ( )
inline

Definition at line 284 of file class_libentry.h.

References m_library.

Referenced by LIB_ALIAS::GetLib(), NETLIST_EXPORTER_GENERIC::makeComponents(), and NETLIST_EXPORTER_GENERIC::makeLibParts().

284 { return m_library; }
PART_LIB * m_library
Library the part belongs to if any.
const LIB_ID& LIB_PART::GetLibId ( ) const
inline

Definition at line 279 of file class_libentry.h.

References m_libId.

Referenced by SYMBOL_LIB_TABLE::LoadSymbol(), and SYMBOL_LIB_TABLE::SaveSymbol().

279 { return m_libId; }
LIB_ID m_libId
const wxString LIB_PART::GetLibraryName ( )

Definition at line 262 of file class_libentry.cpp.

References PART_LIB::GetName(), and m_library.

Referenced by LIB_ALIAS::GetLibraryName(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), and RemoveDrawItem().

263 {
264  if( m_library )
265  return m_library->GetName();
266 
267  return wxString( _( "none" ) );
268 }
PART_LIB * m_library
Library the part belongs to if any.
const wxString GetName() const
Return the file name without path or extension.
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

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 in ZONE_CONTAINER, SCH_SHEET, MODULE, SCH_COMPONENT, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, SCH_SHEET_PIN, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, LIB_ARC, TEXTE_PCB, SCH_BITMAP, LIB_TEXT, SCH_LINE, EDGE_MODULE, LIB_POLYLINE, SCH_BUS_ENTRY_BASE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 282 of file base_struct.cpp.

References dummy_xpm.

Referenced by FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

283 {
284  return dummy_xpm;
285 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
virtual void EDA_ITEM::GetMsgPanelInfo ( std::vector< MSG_PANEL_ITEM > &  aList)
inlinevirtualinherited

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented in BOARD, D_PAD, MODULE, NETINFO_ITEM, SCH_SHEET, LIB_ITEM, SCH_COMPONENT, GERBER_DRAW_ITEM, SCH_TEXT, TRACK, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, ZONE_CONTAINER, EDGE_MODULE, LIB_ARC, MARKER_PCB, LIB_BEZIER, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 277 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::LocateItem(), EDA_DRAW_FRAME::SetMsgPanel(), and PCB_BASE_FRAME::UpdateMsgPanel().

278  {
279  }
LIB_ITEM * LIB_PART::GetNextDrawItem ( LIB_ITEM aItem = NULL,
KICAD_T  aType = TYPE_NOT_INIT 
)

Return the next draw object pointer.

Parameters
aItem- Pointer to the current draw item. Setting item NULL with return the first item of type in the list.
aType- type of searched item (filter). if TYPE_NOT_INIT search for all items types
Returns
- The next drawing object in the list if found, otherwise NULL.

Definition at line 583 of file class_libentry.cpp.

References drawings, EDA_ITEM::Type(), and TYPE_NOT_INIT.

Referenced by GetNextPin().

584 {
585  /* Return the next draw object pointer.
586  * If item is NULL return the first item of type in the list.
587  */
588  if( drawings.empty() )
589  return NULL;
590 
591  if( aItem == NULL && aType == TYPE_NOT_INIT ) // type is unspecified
592  return &drawings[0];
593 
594  // Search for last item
595  size_t idx = 0;
596 
597  if( aItem )
598  {
599  for( ; idx < drawings.size(); idx++ )
600  {
601  if( aItem == &drawings[idx] )
602  {
603  idx++; // Prepare the next item search
604  break;
605  }
606  }
607  }
608 
609  // Search the next item
610  for( ; idx < drawings.size(); idx++ )
611  {
612  if( aType == TYPE_NOT_INIT || drawings[ idx ].Type() == aType )
613  return &drawings[ idx ];
614  }
615 
616  return NULL;
617 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
LIB_ITEMS drawings
How to draw this part.
LIB_PIN* LIB_PART::GetNextPin ( LIB_PIN aItem = NULL)
inline

Return the next pin object from the draw list.

This is just a pin object specific version of GetNextDrawItem().

Parameters
aItem- Pointer to the previous pin item, or NULL to get the first pin in the draw object list.
Returns
- The next pin object in the list if found, otherwise NULL.

Definition at line 517 of file class_libentry.h.

References GetNextDrawItem(), and LIB_PIN_T.

Referenced by LIB_EDIT_FRAME::deleteItem(), NETLIST_EXPORTER::findAllInstancesOfComponent(), LIB_EDIT_FRAME::GlobalSetPins(), LIB_EDIT_FRAME::PlacePin(), LIB_PIN::SetConversion(), LIB_PIN::SetPartNumber(), and LIB_EDIT_FRAME::StartMovePin().

518  {
519  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
520  }
LIB_ITEM * GetNextDrawItem(LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
Return the next draw object pointer.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_PIN * LIB_PART::GetPin ( const wxString &  aNumber,
int  aUnit = 0,
int  aConvert = 0 
)

Return pin object with the requested pin aNumber.

Parameters
aNumber- Number of the pin to find.
aUnit- Unit of the part to find. Set to 0 if a specific unit number is not required.
aConvert- Alternate body style filter (DeMorgan). Set to 0 if no alternate body style is required.
Returns
The pin object if found. Otherwise NULL.

Definition at line 646 of file class_libentry.cpp.

References GetPins(), LIB_PIN_T, and EDA_ITEM::Type().

647 {
648  wxString pNumber;
649  LIB_PINS pinList;
650 
651  GetPins( pinList, aUnit, aConvert );
652 
653  for( size_t i = 0; i < pinList.size(); i++ )
654  {
655  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
656 
657  pinList[i]->PinStringNum( pNumber );
658 
659  if( aNumber == pNumber )
660  return pinList[i];
661  }
662 
663  return NULL;
664 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:70
int LIB_PART::GetPinNameOffset ( )
inline
void LIB_PART::GetPins ( LIB_PINS aList,
int  aUnit = 0,
int  aConvert = 0 
)

Return a list of pin object pointers from the draw item list.

Note pin objects are owned by the draw list of the part. Deleting any of the objects will leave list in a unstable state and will likely segfault when the list is destroyed.

Parameters
aList- Pin list to place pin object pointers into.
aUnit- Unit number of pin to add to list. Set to 0 to get pins from any part unit.
aConvert- Convert number of pin to add to list. Set to 0 to get pins from any convert of part.

Definition at line 620 of file class_libentry.cpp.

References drawings, and LIB_PIN_T.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DataViewModel::DataViewModel(), LIB_PIN::EnableEditMode(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), GetPin(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnCheckComponent(), PinsConflictWith(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

621 {
622  /* Notes:
623  * when aUnit == 0: no unit filtering
624  * when aConvert == 0: no convert (shape selection) filtering
625  * when .m_Unit == 0, the body item is common to units
626  * when .m_Convert == 0, the body item is common to shapes
627  */
628  for( LIB_ITEM& item : drawings )
629  {
630  if( item.Type() != LIB_PIN_T ) // we search pins only
631  continue;
632 
633  // Unit filtering:
634  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
635  continue;
636 
637  // Shape filtering:
638  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
639  continue;
640 
641  aList.push_back( (LIB_PIN*) &item );
642  }
643 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
LIB_FIELD & LIB_PART::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 1345 of file class_libentry.cpp.

References GetField(), and REFERENCE.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), Load(), Save(), LIB_EDIT_FRAME::SaveOneSymbol(), and SCH_COMPONENT::SCH_COMPONENT().

1346 {
1347  LIB_FIELD* field = GetField( REFERENCE );
1348  wxASSERT( field != NULL );
1349  return *field;
1350 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Field Reference of part, i.e. "IC21".
wxString EDA_ITEM::GetSelectMenuText ( ) const
virtualinherited

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 in ZONE_CONTAINER, SCH_SHEET, MODULE, SCH_COMPONENT, D_PAD, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, SCH_SHEET_PIN, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, SCH_BITMAP, LIB_TEXT, SCH_LINE, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 175 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

176 {
177  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
178  GetClass() );
179 
180  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
181 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 250 of file base_struct.h.

References EDA_ITEM::m_Status.

250 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:161
static int LIB_PART::GetSubpartFirstId ( )
inlinestatic

Definition at line 726 of file class_libentry.h.

References m_subpartFirstId.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

726 { return m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only 'A'...
static int LIB_PART::GetSubpartIdSeparator ( )
inlinestatic

Definition at line 719 of file class_libentry.h.

References m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

719 { return m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
const EDA_RECT LIB_PART::GetUnitBoundingBox ( int  aUnit,
int  aConvert 
) const

Function GetBoundingBox.

Returns
the part bounding box ( in user coordinates )
Parameters
aUnit= unit selection = 0, or 1..n
aConvert= 0, 1 or 2 If aUnit == 0, unit is not used if aConvert == 0 Convert is non used Invisible fields are not taken in account

Definition at line 1167 of file class_libentry.cpp.

References drawings, LIB_ITEM::GetBoundingBox(), LIB_FIELD_T, LIB_ITEM::m_Convert, LIB_ITEM::m_Unit, m_unitCount, EDA_RECT::Merge(), and EDA_ITEM::Type().

Referenced by LIB_VIEW_FRAME::BestZoom(), LIB_EDIT_FRAME::BestZoom(), Draw(), GetBoundingBox(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_RESCUE_EACH::renderPreview(), and DIALOG_CHOOSE_COMPONENT::RenderPreview().

1168 {
1169  EDA_RECT bBox;
1170  bool initialized = false;
1171 
1172  for( unsigned ii = 0; ii < drawings.size(); ii++ )
1173  {
1174  const LIB_ITEM& item = drawings[ii];
1175 
1176  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
1177  && ( aUnit != item.m_Unit ) ) )
1178  continue;
1179 
1180  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
1181  continue;
1182 
1183  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
1184  continue;
1185 
1186  if( initialized )
1187  bBox.Merge( item.GetBoundingBox() );
1188  else
1189  {
1190  bBox = item.GetBoundingBox();
1191  initialized = true;
1192  }
1193  }
1194 
1195  return bBox;
1196 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
int m_unitCount
Number of units (parts) per package.
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
int m_Unit
Unit identification for multiple parts per package.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
virtual const EDA_RECT GetBoundingBox() const override
LIB_ITEMS drawings
How to draw this part.
Class EDA_RECT handles the component boundary box.
int m_Convert
Shape identification for alternate body styles.
LIB_FIELD & LIB_PART::GetValueField ( )

Return reference to the value field.

Definition at line 1337 of file class_libentry.cpp.

References GetField(), and VALUE.

Referenced by Load(), LIB_EDIT_FRAME::OnCreateNewPartFromExisting(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), Save(), LIB_EDIT_FRAME::SaveOneSymbol(), and SetName().

1338 {
1339  LIB_FIELD* field = GetField( VALUE );
1340  wxASSERT( field != NULL );
1341  return *field;
1342 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
Field Value of part, i.e. "3.3K".
bool LIB_PART::HasAlias ( const wxString &  aName) const

Test if alias aName is in part alias list.

Alias name comparisons are case insensitive.

Parameters
aName- Name of alias.
Returns
True if alias name in alias list.

Definition at line 1740 of file class_libentry.cpp.

References GetName(), and m_aliases.

Referenced by AddAlias(), LIB_EDIT_FRAME::DeleteOnePart(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), and SetAliases().

1741 {
1742  wxCHECK2_MSG( !aName.IsEmpty(), return false,
1743  wxT( "Cannot get alias with an empty name, bad programmer." ) );
1744 
1745  for( size_t i = 0; i < m_aliases.size(); i++ )
1746  {
1747  if( aName == m_aliases[i]->GetName() )
1748  return true;
1749  }
1750 
1751  return false;
1752 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const wxString & GetName() const
bool LIB_PART::HasConversion ( ) const

Test if part has more than one body conversion type (DeMorgan).

Returns
True if part has more than one conversion.

Definition at line 1407 of file class_libentry.cpp.

References drawings, and LIB_ITEM::m_Convert.

Referenced by AddMenusForEditComponent(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), LIB_EDIT_FRAME::EditGraphicSymbol(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), LIB_VIEW_FRAME::onUpdateAlternateBodyStyleButton(), LIB_EDIT_FRAME::OnUpdateDeMorganConvert(), LIB_EDIT_FRAME::OnUpdateDeMorganNormal(), LIB_VIEW_FRAME::onUpdateNormalBodyStyleButton(), SetConversion(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::SetUnsetConvert(), and LIB_EDIT_FRAME::SynchronizePins().

1408 {
1409  for( unsigned ii = 0; ii < drawings.size(); ii++ )
1410  {
1411  const LIB_ITEM& item = drawings[ii];
1412  if( item.m_Convert > 1 )
1413  return true;
1414  }
1415 
1416  return false;
1417 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
int m_Convert
Shape identification for alternate body styles.
virtual bool EDA_ITEM::HitTest ( const wxPoint aPosition) const
inlinevirtualinherited

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

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented in D_PAD, VIA, MODULE, SCH_ITEM, BOARD_ITEM, ZONE_CONTAINER, LIB_ITEM, GERBER_DRAW_ITEM, TRACK, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, LIB_ARC, MARKER_PCB, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_POLYLINE, LIB_BEZIER, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 288 of file base_struct.h.

Referenced by LIB_ITEM::HitTest(), BOARD_ITEM::HitTest(), and SCH_COLLECTOR::Inspect().

289  {
290  return false; // derived classes should override this function
291  }
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 224 of file base_struct.h.

References BRIGHTENED.

Referenced by SELECTION_TOOL::disambiguationMenu().

224 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References HIGHLIGHTED.

223 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 217 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

217 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:109
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool LIB_PART::IsMulti ( ) const
inline

Function IsMulti.

Returns
true if the part has multiple units per part. When happens, the reference has a sub reference ti identify part

Definition at line 705 of file class_libentry.h.

Referenced by CMP_TREE_NODE_ALIAS::CMP_TREE_NODE_ALIAS(), LIB_FIELD::GetFullText(), SCH_BASE_FRAME::SelectComponentFromLibrary(), and LIB_EDIT_FRAME::SynchronizePins().

705 { return m_unitCount > 1; }
int m_unitCount
Number of units (parts) per package.
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 216 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

216 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:113
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
bool LIB_PART::IsNormal ( ) const
inline

Definition at line 391 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by AddMenusForEditComponent().

391 { return m_options == ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
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_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 444 of file base_struct.h.

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

444 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 222 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

222 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:114
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

220 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:117
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 132 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), MODULE::Visit(), and BOARD::Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
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...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
bool LIB_PART::Load ( LINE_READER aReader,
wxString &  aErrorMsg 
)

Load part definition from aReader.

Parameters
aReaderA LINE_READER object to load file from.
aErrorMsg- Description of error on load failure.
Returns
True if the load was successful, false if there was an error.

Definition at line 853 of file class_libentry.cpp.

References drawings, EDA_TEXT::Empty(), ENTRY_POWER, FROM_UTF8(), GetChars(), GetReferenceField(), GetValueField(), LIB_ALIAS, LINE_READER::Line(), LINE_READER::LineNumber(), LoadAliases(), LoadDateAndTime(), LoadDrawEntries(), LoadField(), LoadFootprints(), m_aliases, m_name, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, LINE_READER::ReadLine(), LIB_FIELD::SetText(), and EDA_TEXT::SetVisible().

854 {
855  int unused;
856  char* p;
857  char* componentName;
858  char* prefix = NULL;
859  char* line;
860 
861  bool result;
862  wxString Msg;
863 
864  line = aLineReader.Line();
865 
866  p = strtok( line, " \t\r\n" );
867 
868  if( strcmp( p, "DEF" ) != 0 )
869  {
870  aErrorMsg.Printf( wxT( "DEF command expected in line %d, aborted." ),
871  aLineReader.LineNumber() );
872  return false;
873  }
874 
875  // Read DEF line:
876  char drawnum = 0;
877  char drawname = 0;
878 
879  if( ( componentName = strtok( NULL, " \t\n" ) ) == NULL // Part name:
880  || ( prefix = strtok( NULL, " \t\n" ) ) == NULL // Prefix name:
881  || ( p = strtok( NULL, " \t\n" ) ) == NULL // NumOfPins:
882  || sscanf( p, "%d", &unused ) != 1
883  || ( p = strtok( NULL, " \t\n" ) ) == NULL // TextInside:
884  || sscanf( p, "%d", &m_pinNameOffset ) != 1
885  || ( p = strtok( NULL, " \t\n" ) ) == NULL // DrawNums:
886  || sscanf( p, "%c", &drawnum ) != 1
887  || ( p = strtok( NULL, " \t\n" ) ) == NULL // DrawNums:
888  || sscanf( p, "%c", &drawname ) != 1
889  || ( p = strtok( NULL, " \t\n" ) ) == NULL // m_unitCount:
890  || sscanf( p, "%d", &m_unitCount ) != 1 )
891  {
892  aErrorMsg.Printf( wxT( "Wrong DEF format in line %d, skipped." ),
893  aLineReader.LineNumber() );
894 
895  while( (line = aLineReader.ReadLine()) != NULL )
896  {
897  p = strtok( line, " \t\n" );
898 
899  if( p && strcasecmp( p, "ENDDEF" ) == 0 )
900  break;
901  }
902 
903  return false;
904  }
905 
906  // Ensure m_unitCount is >= 1 (could be read as 0 in old libraries)
907  if( m_unitCount < 1 )
908  m_unitCount = 1;
909 
910  m_showPinNumbers = ( drawnum == 'N' ) ? false : true;
911  m_showPinNames = ( drawname == 'N' ) ? false : true;
912 
913  // Copy part name and prefix.
914  LIB_FIELD& value = GetValueField();
915 
916  if( componentName[0] != '~' )
917  {
918  m_name = FROM_UTF8( componentName );
919  value.SetText( m_name );
920  }
921  else
922  {
923  m_name = FROM_UTF8( &componentName[1] );
924  value.SetText( m_name );
925  value.SetVisible( false );
926  }
927 
928  // Add the root alias to the alias list.
929  m_aliases.push_back( new LIB_ALIAS( m_name, this ) );
930 
931  LIB_FIELD& reference = GetReferenceField();
932 
933  if( strcmp( prefix, "~" ) == 0 )
934  {
935  reference.Empty();
936  reference.SetVisible( false );
937  }
938  else
939  {
940  reference.SetText( FROM_UTF8( prefix ) );
941  }
942 
943  // Copy optional infos
944  if( ( p = strtok( NULL, " \t\n" ) ) != NULL && *p == 'L' )
945  m_unitsLocked = true;
946 
947  if( ( p = strtok( NULL, " \t\n" ) ) != NULL && *p == 'P' )
949 
950  // Read next lines, until "ENDDEF" is found
951  while( ( line = aLineReader.ReadLine() ) != NULL )
952  {
953  p = strtok( line, " \t\r\n" );
954 
955  // This is the error flag ( if an error occurs, result = false)
956  result = true;
957 
958  if( *line == '#' ) // a comment
959  continue;
960 
961  if( p == NULL ) // empty line
962  continue;
963 
964  if( line[0] == 'T' && line[1] == 'i' )
965  result = LoadDateAndTime( aLineReader );
966  else if( *line == 'F' )
967  result = LoadField( aLineReader, Msg );
968  else if( strcmp( p, "ENDDEF" ) == 0 ) // End of component description
969  goto ok;
970  else if( strcmp( p, "DRAW" ) == 0 )
971  result = LoadDrawEntries( aLineReader, Msg );
972  else if( strncmp( p, "ALIAS", 5 ) == 0 )
973  {
974  p = strtok( NULL, "\r\n" );
975  result = LoadAliases( p, aErrorMsg );
976  }
977  else if( strncmp( p, "$FPLIST", 5 ) == 0 )
978  result = LoadFootprints( aLineReader, Msg );
979 
980  // End line or block analysis: test for an error
981  if( !result )
982  {
983  if( Msg.IsEmpty() )
984  aErrorMsg.Printf( wxT( "error occurred at line %d " ), aLineReader.LineNumber() );
985  else
986  aErrorMsg.Printf( wxT( "error <%s> occurred at line %d " ),
987  GetChars( Msg ), aLineReader.LineNumber() );
988 
989  return false;
990  }
991  }
992 
993  return false;
994 
995 ok:
996  // If we are here, this part is O.k. - put it in:
997  drawings.sort();
998 
999  return true;
1000 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
bool LoadFootprints(LINE_READER &aReader, wxString &aErrorMsg)
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
void SetVisible(bool aVisible)
Definition: eda_text.h:175
bool LoadDrawEntries(LINE_READER &aReader, wxString &aErrorMsg)
LIB_FIELD & GetValueField()
Return reference to the value field.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
bool LoadDateAndTime(char *aLine)
int m_pinNameOffset
The offset in mils to draw the pin name.
bool LoadField(LINE_READER &aReader, wxString &aErrorMsg)
LIB_FIELD & GetReferenceField()
Return reference to the reference designator field.
wxString m_name
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:679
void Empty()
Definition: eda_text.h:231
bool LoadAliases(char *aLine, wxString &aErrorMsg)
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:92
LIB_ITEMS drawings
How to draw this part.
friend class LIB_ALIAS
bool m_showPinNames
Determines if part pin names are visible.
bool LIB_PART::LoadAliases ( char *  aLine,
wxString &  aErrorMsg 
)

Definition at line 1093 of file class_libentry.cpp.

References FROM_UTF8(), LIB_ALIAS, and m_aliases.

Referenced by Load().

1094 {
1095  char* text = strtok( aLine, " \t\r\n" );
1096 
1097  while( text )
1098  {
1099  m_aliases.push_back( new LIB_ALIAS( FROM_UTF8( text ), this ) );
1100  text = strtok( NULL, " \t\r\n" );
1101  }
1102 
1103  return true;
1104 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
friend class LIB_ALIAS
bool LIB_PART::LoadDateAndTime ( char *  aLine)

Definition at line 1373 of file class_libentry.cpp.

References m_dateModified, and min.

Referenced by Load().

1374 {
1375  int year, mon, day, hour, min, sec;
1376 
1377  year = mon = day = hour = min = sec = 0;
1378  strtok( aLine, " \r\t\n" );
1379  strtok( NULL, " \r\t\n" );
1380 
1381  if( sscanf( aLine, "%d/%d/%d %d:%d:%d", &year, &mon, &day, &hour, &min, &sec ) != 6 )
1382  return false;
1383 
1384  m_dateModified = ( sec & 63 ) + ( ( min & 63 ) << 6 ) +
1385  ( ( hour & 31 ) << 12 ) + ( ( day & 31 ) << 17 ) +
1386  ( ( mon & 15 ) << 22 ) + ( ( year - 1990 ) << 26 );
1387 
1388  return true;
1389 }
long m_dateModified
Date the part was last modified.
#define min(a, b)
Definition: auxiliary.h:85
bool LIB_PART::LoadDrawEntries ( LINE_READER aReader,
wxString &  aErrorMsg 
)

Definition at line 1003 of file class_libentry.cpp.

References drawings, GetChars(), LIB_ITEM::Load(), and LINE_READER::ReadLine().

Referenced by Load().

1004 {
1005  char* line;
1006  LIB_ITEM* newEntry = NULL;
1007 
1008  while( true )
1009  {
1010  if( !( line = aLineReader.ReadLine() ) )
1011  {
1012  aErrorMsg = wxT( "file ended prematurely loading component draw element" );
1013  return false;
1014  }
1015 
1016  if( strncmp( line, "ENDDRAW", 7 ) == 0 )
1017  break;
1018 
1019  newEntry = NULL;
1020 
1021  switch( line[0] )
1022  {
1023  case 'A': // Arc
1024  newEntry = ( LIB_ITEM* ) new LIB_ARC( this );
1025  break;
1026 
1027  case 'C': // Circle
1028  newEntry = ( LIB_ITEM* ) new LIB_CIRCLE( this );
1029  break;
1030 
1031  case 'T': // Text
1032  newEntry = ( LIB_ITEM* ) new LIB_TEXT( this );
1033  break;
1034 
1035  case 'S': // Square
1036  newEntry = ( LIB_ITEM* ) new LIB_RECTANGLE( this );
1037  break;
1038 
1039  case 'X': // Pin Description
1040  newEntry = ( LIB_ITEM* ) new LIB_PIN( this );
1041  break;
1042 
1043  case 'P': // Polyline
1044  newEntry = ( LIB_ITEM* ) new LIB_POLYLINE( this );
1045  break;
1046 
1047  case 'B': // Bezier Curves
1048  newEntry = ( LIB_ITEM* ) new LIB_BEZIER( this );
1049  break;
1050 
1051  case '#': // Comment
1052  continue;
1053 
1054  case '\n':
1055  case '\r':
1056  case 0: // empty line
1057  continue;
1058 
1059  default:
1060  aErrorMsg.Printf( wxT( "undefined DRAW command %c" ), line[0] );
1061  return false;
1062  }
1063 
1064  if( !newEntry->Load( aLineReader, aErrorMsg ) )
1065  {
1066  aErrorMsg.Printf( wxT( "error '%s' in DRAW command %c" ),
1067  GetChars( aErrorMsg ), line[0] );
1068  delete newEntry;
1069 
1070  // Flush till end of draw section
1071  do
1072  {
1073  if( !aLineReader.ReadLine() )
1074  {
1075  aErrorMsg = wxT( "file ended prematurely while attempting "
1076  "to flush to end of drawing section." );
1077  return false;
1078  }
1079  } while( strncmp( line, "ENDDRAW", 7 ) != 0 );
1080 
1081  return false;
1082  }
1083  else
1084  {
1085  drawings.push_back( newEntry );
1086  }
1087  }
1088 
1089  return true;
1090 }
Class LIB_TEXT defines a component library graphical text item.
Definition: lib_text.h:45
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
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:92
LIB_ITEMS drawings
How to draw this part.
virtual bool Load(LINE_READER &aLine, wxString &aErrorMsg)=0
Class LIB_BEZIER defines bezier curve graphic body item.
Definition: lib_bezier.h:39
bool LIB_PART::LoadField ( LINE_READER aReader,
wxString &  aErrorMsg 
)

Definition at line 1107 of file class_libentry.cpp.

References drawings, GetField(), LIB_FIELD::GetId(), EDA_TEXT::GetText(), LIB_FIELD::Load(), m_name, MANDATORY_FIELDS, and VALUE.

Referenced by Load().

1108 {
1109  LIB_FIELD* field = new LIB_FIELD( this );
1110 
1111  if( !field->Load( aLineReader, aErrorMsg ) )
1112  {
1113  delete field;
1114  return false;
1115  }
1116 
1117  if( field->GetId() < MANDATORY_FIELDS )
1118  {
1119  LIB_FIELD* fixedField = GetField( field->GetId() );
1120 
1121  // this will fire only if somebody broke a constructor or editor.
1122  // MANDATORY_FIELDS are always present in ram resident components, no
1123  // exceptions, and they always have their names set, even fixed fields.
1124  wxASSERT( fixedField );
1125 
1126  *fixedField = *field;
1127 
1128  if( field->GetId() == VALUE )
1129  m_name = field->GetText();
1130 
1131  delete field;
1132  }
1133  else
1134  {
1135  drawings.push_back( field );
1136  }
1137 
1138  return true;
1139 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
bool Load(LINE_READER &aLineReader, wxString &errorMsg) override
Definition: lib_field.cpp:157
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
wxString m_name
int GetId() const
Definition: lib_field.h:136
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
Field Value of part, i.e. "3.3K".
LIB_ITEMS drawings
How to draw this part.
bool LIB_PART::LoadFootprints ( LINE_READER aReader,
wxString &  aErrorMsg 
)

Definition at line 1142 of file class_libentry.cpp.

References FROM_UTF8(), m_FootprintList, and LINE_READER::ReadLine().

Referenced by Load().

1143 {
1144  char* line;
1145  char* p;
1146 
1147  while( true )
1148  {
1149  if( !( line = aLineReader.ReadLine() ) )
1150  {
1151  aErrorMsg = wxT( "file ended prematurely while loading footprints" );
1152  return false;
1153  }
1154 
1155  p = strtok( line, " \t\r\n" );
1156 
1157  if( strcasecmp( p, "$ENDFPLIST" ) == 0 )
1158  break;
1159 
1160  m_FootprintList.Add( FROM_UTF8( p ) );
1161  }
1162 
1163  return true;
1164 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ITEM * LIB_PART::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint aPoint 
)

Locate a draw object.

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
Returns
The draw object if found. Otherwise NULL.

Definition at line 1591 of file class_libentry.cpp.

References drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

1593 {
1594  for( LIB_ITEM& item : drawings )
1595  {
1596  if( ( aUnit && item.m_Unit && ( aUnit != item.m_Unit) )
1597  || ( aConvert && item.m_Convert && ( aConvert != item.m_Convert ) )
1598  || ( ( item.Type() != aType ) && ( aType != TYPE_NOT_INIT ) ) )
1599  continue;
1600 
1601  if( item.HitTest( aPoint ) )
1602  return &item;
1603  }
1604 
1605  return NULL;
1606 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
LIB_ITEM * LIB_PART::LocateDrawItem ( int  aUnit,
int  aConvert,
KICAD_T  aType,
const wxPoint aPoint,
const TRANSFORM aTransform 
)

Locate a draw object (overlaid)

Parameters
aUnit- Unit number of draw item.
aConvert- Body style of draw item.
aType- Draw object type, set to 0 to search for any type.
aPoint- Coordinate for hit testing.
aTransform= the transform matrix
Returns
The draw object if found. Otherwise NULL.

Definition at line 1609 of file class_libentry.cpp.

References DefaultTransform, and LocateDrawItem().

1611 {
1612  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1613  * wxPoint& pt ) to search items.
1614  * because this function uses DefaultTransform as orient/mirror matrix
1615  * we temporary copy aTransform in DefaultTransform
1616  */
1617  LIB_ITEM* item;
1618  TRANSFORM transform = DefaultTransform;
1619  DefaultTransform = aTransform;
1620 
1621  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1622 
1623  // Restore matrix
1624  DefaultTransform = transform;
1625 
1626  return item;
1627 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM DefaultTransform
Definition: eeschema.cpp:57
LIB_ITEM * LocateDrawItem(int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
Locate a draw object.
void LIB_PART::LockUnits ( bool  aLockUnits)
inline

Definition at line 396 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

396 { m_unitsLocked = aLockUnits; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
virtual bool EDA_ITEM::Matches ( wxFindReplaceData &  aSearchData,
void *  aAuxData,
wxPoint aFindLocation 
)
inlinevirtualinherited

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.
aFindLocationA pointer to a wxPoint object to store the location of matched item. The pointer can be NULL if it is not used.
Returns
True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_SHEET, SCH_COMPONENT, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 400 of file base_struct.h.

Referenced by SCH_FIND_COLLECTOR::Inspect(), SCH_MARKER::Matches(), LIB_PIN::Matches(), SCH_TEXT::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), and SCH_SHEET::Matches().

401  {
402  return false;
403  }
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 184 of file base_struct.cpp.

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

185 {
186  wxString text = aText;
187  wxString searchText = aSearchData.GetFindString();
188 
189  // Don't match if searching for replaceable item and the item doesn't support text replace.
190  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
191  return false;
192 
193  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
194  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
195 
196  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
197  {
198  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
199  return text.Matches( searchText );
200 
201  return text.MakeUpper().Matches( searchText.MakeUpper() );
202  }
203 
204  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
205  return aText.Find( searchText ) != wxNOT_FOUND;
206 
207  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
208 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:444
Perform search using simple wild card matching (* & ?).
Perform a search for a item that has replaceable text.
void LIB_PART::MirrorSelectedItemsH ( const wxPoint aCenter)

Horizontally (X axis) mirror selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1547 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1548 {
1549  for( LIB_ITEM& item : drawings )
1550  {
1551  if( !item.IsSelected() )
1552  continue;
1553 
1554  item.MirrorHorizontal( aCenter );
1555  item.m_Flags = 0;
1556  }
1557 
1558  drawings.sort();
1559 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::MirrorSelectedItemsV ( const wxPoint aCenter)

Vertically (Y axis) mirror selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1561 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1562 {
1563  for( LIB_ITEM& item : drawings )
1564  {
1565  if( !item.IsSelected() )
1566  continue;
1567 
1568  item.MirrorVertical( aCenter );
1569  item.m_Flags = 0;
1570  }
1571 
1572  drawings.sort();
1573 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::MoveSelectedItems ( const wxPoint aOffset)

Move the selected draw items marked by a block select.

Definition at line 1460 of file class_libentry.cpp.

References drawings.

Referenced by CopySelectedItems(), and LIB_EDIT_FRAME::HandleBlockPlace().

1461 {
1462  for( LIB_ITEM& item : drawings )
1463  {
1464  if( !item.IsSelected() )
1465  continue;
1466 
1467  item.SetOffset( aOffset );
1468  item.m_Flags = 0;
1469  }
1470 
1471  drawings.sort();
1472 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
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 241 of file base_struct.cpp.

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

242 {
243  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
244  GetChars( GetClass() ) ) );
245 
246  return false;
247 }
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:92
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
bool LIB_PART::operator== ( const LIB_PART aPart) const
inline

Definition at line 785 of file class_libentry.h.

785 { return this == aPart; }
bool LIB_PART::PinsConflictWith ( LIB_PART aOtherPart,
bool  aTestNums,
bool  aTestNames,
bool  aTestType,
bool  aTestOrientation,
bool  aTestLength 
)

Function PinsConflictWith returns true if this part's pins do not match another part's pins.

This is used to detect whether the project cache is out of sync with the system libs.

Parameters
aOtherPart- The other library part to test
aTestNums- Whether two pins at the same point must have the same number.
aTestNames- Whether two pins at the same point must have the same name.
aTestType- Whether two pins at the same point must have the same electrical type.
aTestOrientation- Whether two pins at the same point must have the same orientation.
aTestLength- Whether two pins at the same point must have the same length.

Definition at line 667 of file class_libentry.cpp.

References GetPins().

Referenced by RESCUE_CACHE_CANDIDATE::FindRescues().

669 {
670  LIB_PINS thisPinList;
671  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
672 
673  for( LIB_PIN* eachThisPin : thisPinList )
674  {
675  wxASSERT( eachThisPin );
676  LIB_PINS otherPinList;
677  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
678  bool foundMatch = false;
679 
680  for( LIB_PIN* eachOtherPin : otherPinList )
681  {
682  wxASSERT( eachOtherPin );
683  // Same position?
684  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
685  continue;
686 
687  // Same number?
688  wxString eachThisPinNumber, eachOtherPinNumber;
689  eachThisPin->PinStringNum( eachThisPinNumber );
690  eachOtherPin->PinStringNum( eachOtherPinNumber );
691  if( aTestNums && ( eachThisPinNumber != eachOtherPinNumber ))
692  continue;
693 
694  // Same name?
695  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ))
696  continue;
697 
698  // Same electrical type?
699  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ))
700  continue;
701 
702  // Same orientation?
703  if( aTestOrientation && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ))
704  continue;
705 
706  // Same length?
707  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ))
708  continue;
709 
710  foundMatch = true;
711  }
712 
713  if( !foundMatch )
714  {
715  // This means there was not an identical (according to the arguments)
716  // pin at the same position in the other component.
717  return true;
718  }
719  }
720 
721  // The loop never gave up, so no conflicts were found.
722  return false;
723 }
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:70
void LIB_PART::Plot ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint aOffset,
const TRANSFORM aTransform 
)

Plot lib part to plotter.

Lib Fields not are plotted here, because this plot function is used to plot schematic items, which have they own fields

Parameters
aPlotter- Plotter object to plot to.
aUnit- Component part to plot.
aConvert- Component alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Component plot transform matrix.

Definition at line 457 of file class_libentry.cpp.

References drawings, FILLED_WITH_BG_BODYCOLOR, PLOTTER::GetColorMode(), GetLayerColor(), LAYER_DEVICE, LIB_FIELD_T, and PLOTTER::SetColor().

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

459 {
460  wxASSERT( aPlotter != NULL );
461 
462  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
463  bool fill = aPlotter->GetColorMode();
464 
465  // draw background for filled items using background option
466  // Solid lines will be drawn after the background
467  for( LIB_ITEM& item : drawings )
468  {
469  // Lib Fields are not plotted here, because this plot function
470  // is used to plot schematic items, which have they own fields
471  if( item.Type() == LIB_FIELD_T )
472  continue;
473 
474  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
475  continue;
476 
477  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
478  continue;
479 
480  if( item.m_Fill == FILLED_WITH_BG_BODYCOLOR )
481  item.Plot( aPlotter, aOffset, fill, aTransform );
482  }
483 
484  // Not filled items and filled shapes are now plotted
485  // (plot only items which are not already plotted)
486  for( LIB_ITEM& item : drawings )
487  {
488  if( item.Type() == LIB_FIELD_T )
489  continue;
490 
491  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
492  continue;
493 
494  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
495  continue;
496 
497  if( item.m_Fill != FILLED_WITH_BG_BODYCOLOR )
498  item.Plot( aPlotter, aOffset, fill, aTransform );
499  }
500 }
virtual void SetColor(COLOR4D color)=0
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
COLOR4D GetLayerColor(LAYERSCH_ID aLayer)
Definition: eeschema.cpp:166
bool GetColorMode() const
Definition: plot_common.h:121
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::PlotLibFields ( PLOTTER aPlotter,
int  aUnit,
int  aConvert,
const wxPoint aOffset,
const TRANSFORM aTransform 
)

Plot Lib Fields only of the part to plotter.

is used to plot the full lib part, outside the schematic

Parameters
aPlotter- Plotter object to plot to.
aUnit- Component part to plot.
aConvert- Component alternate body style to plot.
aOffset- Distance to shift the plot coordinates.
aTransform- Component plot transform matrix.

Definition at line 502 of file class_libentry.cpp.

References drawings, PLOTTER::GetColorMode(), LIB_FIELD::GetFullText(), LIB_FIELD::GetId(), GetLayerColor(), EDA_TEXT::GetShownText(), LAYER_FIELDS, LIB_FIELD_T, REFERENCE, PLOTTER::SetColor(), and LIB_FIELD::SetText().

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

504 {
505  wxASSERT( aPlotter != NULL );
506 
507  aPlotter->SetColor( GetLayerColor( LAYER_FIELDS ) );
508  bool fill = aPlotter->GetColorMode();
509 
510  for( LIB_ITEM& item : drawings )
511  {
512  if( item.Type() != LIB_FIELD_T )
513  continue;
514 
515  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
516  continue;
517 
518  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
519  continue;
520 
521  // The reference is a special case: we should change the basic text
522  // to add '?' and the part id
523  LIB_FIELD& field = (LIB_FIELD&) item;
524  wxString tmp = field.GetShownText();
525  if( field.GetId() == REFERENCE )
526  {
527  wxString text = field.GetFullText( aUnit );
528  field.SetText( text );
529  }
530  item.Plot( aPlotter, aOffset, fill, aTransform );
531  field.SetText( tmp );
532  }
533 }
virtual void SetColor(COLOR4D color)=0
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:533
Field Reference of part, i.e. "IC21".
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
COLOR4D GetLayerColor(LAYERSCH_ID aLayer)
Definition: eeschema.cpp:166
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:135
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:679
int GetId() const
Definition: lib_field.h:136
bool GetColorMode() const
Definition: plot_common.h:121
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::RemoveAlias ( const wxString &  aName)

Definition at line 1808 of file class_libentry.cpp.

References GetAlias().

Referenced by SCH_LEGACY_PLUGIN_CACHE::DeleteAlias(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DeleteAliasOfPart(), LIB_EDIT_FRAME::EditField(), SCH_LEGACY_PLUGIN_CACHE::removeAlias(), and LIB_ALIAS::~LIB_ALIAS().

1809 {
1810  LIB_ALIAS* a = GetAlias( aName );
1811 
1812  if( a )
1813  RemoveAlias( a );
1814 }
Part library alias object definition.
LIB_ALIAS * GetAlias(size_t aIndex)
void RemoveAlias(const wxString &aName)
LIB_ALIAS * LIB_PART::RemoveAlias ( LIB_ALIAS aAlias)

Definition at line 1818 of file class_libentry.cpp.

References GetChars(), LIB_ALIAS::GetName(), LIB_ALIAS::IsRoot(), m_aliases, m_me, m_name, SetName(), and traceSchLibMem.

1819 {
1820  wxCHECK_MSG( aAlias, NULL, wxT( "Cannot remove alias by NULL pointer." ) );
1821 
1822  LIB_ALIAS* nextAlias = NULL;
1823 
1824  LIB_ALIASES::iterator it = find( m_aliases.begin(), m_aliases.end(), aAlias );
1825 
1826  if( it != m_aliases.end() )
1827  {
1828  bool rename = aAlias->IsRoot();
1829 
1830  wxLogTrace( traceSchLibMem,
1831  wxT( "%s: part:'%s', alias:'%s', alias count %llu, reference count %ld." ),
1832  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
1833  GetChars( m_name ),
1834  GetChars( aAlias->GetName() ),
1835  (long long unsigned) m_aliases.size(),
1836  m_me.use_count() );
1837 
1838  it = m_aliases.erase( it );
1839 
1840  if( !m_aliases.empty() )
1841  {
1842  if( it == m_aliases.end() )
1843  it = m_aliases.begin();
1844 
1845  nextAlias = *it;
1846 
1847  if( rename )
1848  SetName( nextAlias->GetName() );
1849  }
1850  }
1851 
1852  return nextAlias;
1853 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
const wxChar traceSchLibMem[]
WXTRACE value to enable schematic library memory deletion debug output.
bool IsRoot() const
wxString m_name
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:92
const wxString & GetName() const
virtual void SetName(const wxString &aName)
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
void LIB_PART::RemoveAllAliases ( )

Definition at line 1856 of file class_libentry.cpp.

References m_aliases.

1857 {
1858  // Remove all of the aliases except the root alias.
1859  while( m_aliases.size() > 1 )
1860  m_aliases.pop_back();
1861 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
void LIB_PART::RemoveDrawItem ( LIB_ITEM aItem,
EDA_DRAW_PANEL aPanel = NULL,
wxDC *  aDc = NULL 
)

Remove draw aItem from list.

Parameters
aItem- Draw item to remove from list.
aPanel- Panel to remove part from.
aDc- Device context to remove part from.

Definition at line 536 of file class_libentry.cpp.

References DefaultTransform, LIB_ITEM::Draw(), drawings, g_XorMode, GetChars(), LIB_FIELD::GetId(), GetLibraryName(), LIB_FIELD::GetName(), GetName(), LIB_FIELD_T, MANDATORY_FIELDS, EDA_ITEM::SetModified(), and EDA_ITEM::Type().

Referenced by LIB_EDIT_FRAME::deleteItem(), LIB_PIN::SetConversion(), and LIB_PIN::SetPartNumber().

537 {
538  wxASSERT( aItem != NULL );
539 
540  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
541  // omitted when saving to disk.
542  if( aItem->Type() == LIB_FIELD_T )
543  {
544  LIB_FIELD* field = (LIB_FIELD*) aItem;
545 
546  if( field->GetId() < MANDATORY_FIELDS )
547  {
548  wxLogWarning( _(
549  "An attempt was made to remove the %s field from component %s in library %s." ),
550  GetChars( field->GetName() ), GetChars( GetName() ),
551  GetChars( GetLibraryName() ) );
552  return;
553  }
554  }
555 
556  LIB_ITEMS::iterator i;
557 
558  for( i = drawings.begin(); i != drawings.end(); i++ )
559  {
560  if( *i == aItem )
561  {
562  if( aDc != NULL )
563  aItem->Draw( aPanel, aDc, wxPoint( 0, 0 ), COLOR4D::UNSPECIFIED,
564  g_XorMode, NULL, DefaultTransform );
565 
566  drawings.erase( i );
567  SetModified();
568  break;
569  }
570  }
571 }
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:51
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void SetModified()
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
int GetId() const
Definition: lib_field.h:136
const wxString & GetName() const
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:609
const wxString GetLibraryName()
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:92
TRANSFORM DefaultTransform
Definition: eeschema.cpp:57
LIB_ITEMS drawings
How to draw this part.
virtual void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform)
Draw an item.
void LIB_PART::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 1401 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::LoadOneSymbol().

1402 {
1403  drawings.unique();
1404 }
LIB_ITEMS drawings
How to draw this part.
bool EDA_ITEM::Replace ( wxFindReplaceData &  aSearchData,
wxString &  aText 
)
inherited

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 211 of file base_struct.cpp.

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

Referenced by SCH_TEXT::Replace(), SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), SCH_SHEET::Replace(), and SCH_FIND_COLLECTOR::ReplaceItem().

212 {
213  wxCHECK_MSG( IsReplaceable(), false,
214  wxT( "Attempt to replace text in <" ) + GetClass() + wxT( "> item." ) );
215 
216  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
217 
218  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
219  aSearchData.GetFindString() :
220  aSearchData.GetFindString().Upper() );
221 
222  if( result == wxNOT_FOUND )
223  return false;
224 
225  wxString prefix = aText.Left( result );
226  wxString suffix;
227 
228  if( aSearchData.GetFindString().length() + result < aText.length() )
229  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
230 
231  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
232  GetChars( aText ), GetChars( prefix ), GetChars( aSearchData.GetReplaceString() ),
233  GetChars( suffix ) );
234 
235  aText = prefix + aSearchData.GetReplaceString() + suffix;
236 
237  return true;
238 }
virtual bool IsReplaceable() const
Function IsReplaceable.
Definition: base_struct.h:444
const wxString traceFindReplace(wxT("KicadFindReplace"))
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:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
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_SHEET_PIN, SCH_FIELD, and SCH_TEXT.

Definition at line 432 of file base_struct.h.

432 { return false; }
void LIB_PART::RotateSelectedItems ( const wxPoint aCenter)

Rotate CCW selected draw items about a point.

Parameters
aCenter- Center point to mirror around.

Definition at line 1575 of file class_libentry.cpp.

References drawings.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), and LIB_EDIT_FRAME::HandleBlockPlace().

1576 {
1577  for( LIB_ITEM& item : drawings )
1578  {
1579  if( !item.IsSelected() )
1580  continue;
1581 
1582  item.Rotate( aCenter );
1583  item.m_Flags = 0;
1584  }
1585 
1586  drawings.sort();
1587 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
bool LIB_PART::Save ( OUTPUTFORMATTER aFormatter)

Function Save writes the data structures out to aFormatter in the part library "*.lib" format.

Parameters
aFormatterA reference to an OUTPUTFORMATTER to write to.
Returns
True if success writing else false.

Definition at line 726 of file class_libentry.cpp.

References drawings, ENTRY_POWER, GetFields(), GetName(), GetReferenceField(), GetText(), EDA_TEXT::GetText(), GetValueField(), LIB_FIELD::IsVisible(), LIB_FIELD_T, m_aliases, m_FootprintList, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), SaveDateAndTime(), and TO_UTF8.

727 {
728  LIB_FIELD& value = GetValueField();
729 
730  // First line: it s a comment (component name for readers)
731  aFormatter.Print( 0, "#\n# %s\n#\n", TO_UTF8( value.GetText() ) );
732 
733  // Save data
734  aFormatter.Print( 0, "DEF" );
735 
736  if( value.IsVisible() )
737  {
738  aFormatter.Print( 0, " %s", TO_UTF8( value.GetText() ) );
739  }
740  else
741  {
742  aFormatter.Print( 0, " ~%s", TO_UTF8( value.GetText() ) );
743  }
744 
745  LIB_FIELD& reference = GetReferenceField();
746 
747  if( !reference.GetText().IsEmpty() )
748  {
749  aFormatter.Print( 0, " %s", TO_UTF8( reference.GetText() ) );
750  }
751  else
752  {
753  aFormatter.Print( 0, " ~" );
754  }
755 
756  aFormatter.Print( 0, " %d %d %c %c %d %c %c\n",
757  0, m_pinNameOffset,
758  m_showPinNumbers ? 'Y' : 'N',
759  m_showPinNames ? 'Y' : 'N',
760  m_unitCount, m_unitsLocked ? 'L' : 'F',
761  m_options == ENTRY_POWER ? 'P' : 'N' );
762 
763  if( !SaveDateAndTime( aFormatter ) )
764  return false;
765 
766  LIB_FIELDS fields;
767  GetFields( fields );
768 
769  // Mandatory fields:
770  // may have their own save policy so there is a separate loop for them.
771  // Empty fields are saved, because the user may have set visibility,
772  // size and orientation
773  for( int i = 0; i < MANDATORY_FIELDS; ++i )
774  {
775  if( !fields[i].Save( aFormatter ) )
776  return false;
777  }
778 
779  // User defined fields:
780  // may have their own save policy so there is a separate loop for them.
781 
782  int fieldId = MANDATORY_FIELDS; // really wish this would go away.
783 
784  for( unsigned i = MANDATORY_FIELDS; i < fields.size(); ++i )
785  {
786  // There is no need to save empty fields, i.e. no reason to preserve field
787  // names now that fields names come in dynamically through the template
788  // fieldnames.
789  if( !fields[i].GetText().IsEmpty() )
790  {
791  fields[i].SetId( fieldId++ );
792 
793  if( !fields[i].Save( aFormatter ) )
794  return false;
795  }
796  }
797 
798  // Save the alias list: a line starting by "ALIAS". The first alias is the root
799  // and has the same name as the component. In the old library file format this
800  // alias does not get added to the alias list.
801  if( m_aliases.size() > 1 )
802  {
803  aFormatter.Print( 0, "ALIAS" );
804 
805  for( unsigned i = 1; i < m_aliases.size(); i++ )
806  {
807  aFormatter.Print( 0, " %s", TO_UTF8( m_aliases[i]->GetName() ) );
808  }
809 
810  aFormatter.Print( 0, "\n" );
811  }
812 
813  // Write the footprint filter list
814  if( m_FootprintList.GetCount() != 0 )
815  {
816  aFormatter.Print( 0, "$FPLIST\n" );
817 
818  for( unsigned i = 0; i < m_FootprintList.GetCount(); i++ )
819  {
820  aFormatter.Print( 0, " %s\n", TO_UTF8( m_FootprintList[i] ) );
821  }
822 
823  aFormatter.Print( 0, "$ENDFPLIST\n" );
824  }
825 
826  // Save graphics items (including pins)
827  if( !drawings.empty() )
828  {
829  /* we sort the draw items, in order to have an edition more easy,
830  * when a file editing "by hand" is made */
831  drawings.sort();
832 
833  aFormatter.Print( 0, "DRAW\n" );
834 
835  for( LIB_ITEM& item : drawings )
836  {
837  if( item.Type() == LIB_FIELD_T )
838  continue;
839 
840  if( !item.Save( aFormatter ) )
841  return false;
842  }
843 
844  aFormatter.Print( 0, "ENDDRAW\n" );
845  }
846 
847  aFormatter.Print( 0, "ENDDEF\n" );
848 
849  return true;
850 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
LIB_FIELD & GetValueField()
Return reference to the value field.
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
int m_pinNameOffset
The offset in mils to draw the pin name.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
LIB_FIELD & GetReferenceField()
Return reference to the reference designator field.
bool Save(OUTPUTFORMATTER &aFormatter)
Function Save writes the data structures out to aFormatter in the part library "*.lib" format.
const wxString & GetName() const
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:130
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ITEMS drawings
How to draw this part.
bool IsVisible() const
Function IsVisible.
Definition: lib_field.h:168
std::vector< LIB_FIELD > LIB_FIELDS
Definition: lib_field.h:261
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
bool m_showPinNames
Determines if part pin names are visible.
void GetFields(LIB_FIELDS &aList)
Function GetFields returns a list of fields withing this part.
bool SaveDateAndTime(OUTPUTFORMATTER &aFormatter)
Function SaveDateAndTime write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:s...
bool LIB_PART::SaveDateAndTime ( OUTPUTFORMATTER aFormatter)

Function SaveDateAndTime write the date and time of part to aFile in the format: "Ti yy/mm/jj hh:mm:ss".

Parameters
aFormatterA reference to an OUTPUTFORMATTER object containing the output format to write to.
Returns
True if the date and time were successfully written to aFormatter.

Definition at line 1353 of file class_libentry.cpp.

References m_dateModified, min, and OUTPUTFORMATTER::Print().

Referenced by Save().

1354 {
1355  int year, mon, day, hour, min, sec;
1356 
1357  if( m_dateModified == 0 )
1358  return true;
1359 
1360  sec = m_dateModified & 63;
1361  min = ( m_dateModified >> 6 ) & 63;
1362  hour = ( m_dateModified >> 12 ) & 31;
1363  day = ( m_dateModified >> 17 ) & 31;
1364  mon = ( m_dateModified >> 22 ) & 15;
1365  year = ( m_dateModified >> 26 ) + 1990;
1366 
1367  aFormatter.Print( 0, "Ti %d/%d/%d %d:%d:%d\n", year, mon, day, hour, min, sec );
1368 
1369  return true;
1370 }
long m_dateModified
Date the part was last modified.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
#define min(a, b)
Definition: auxiliary.h:85
int LIB_PART::SelectItems ( EDA_RECT aRect,
int  aUnit,
int  aConvert,
bool  aEditPinByPin 
)

Checks all draw objects of part to see if they are with block.

Use this method to mark draw objects as selected during block functions.

Parameters
aRect- The bounding rectangle to test in draw items are inside.
aUnit- The current unit number to test against.
aConvert- Are the draw items being selected a conversion.
aEditPinByPin- Used to ignore pin selections when in edit pin by pin mode is enabled.
Returns
The number of draw objects found inside the block select rectangle.

Definition at line 1429 of file class_libentry.cpp.

References drawings, LIB_PIN_T, m_unitsLocked, and SELECTED.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

1430 {
1431  int itemCount = 0;
1432 
1433  for( LIB_ITEM& item : drawings )
1434  {
1435  item.ClearFlags( SELECTED );
1436 
1437  if( ( item.m_Unit && item.m_Unit != aUnit )
1438  || ( item.m_Convert && item.m_Convert != aConvert ) )
1439  {
1440  if( item.Type() != LIB_PIN_T )
1441  continue;
1442 
1443  // Specific rules for pins.
1444  if( aEditPinByPin || m_unitsLocked
1445  || ( item.m_Convert && item.m_Convert != aConvert ) )
1446  continue;
1447  }
1448 
1449  if( item.Inside( aRect ) )
1450  {
1451  item.SetFlags( SELECTED );
1452  itemCount++;
1453  }
1454  }
1455 
1456  return itemCount;
1457 }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
#define SELECTED
Definition: base_struct.h:120
LIB_ITEMS drawings
How to draw this part.
void LIB_PART::SetAliases ( const wxArrayString &  aAliasList)

Definition at line 1755 of file class_libentry.cpp.

References GetAliasNames(), HasAlias(), LIB_ALIAS, m_aliases, and m_library.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

1756 {
1757  wxCHECK_RET( !m_library,
1758  wxT( "Part aliases cannot be changed when they are owned by a library." ) );
1759 
1760  if( aAliasList == GetAliasNames() )
1761  return;
1762 
1763  // Add names not existing in the current component alias list.
1764  for( size_t i = 0; i < aAliasList.GetCount(); i++ )
1765  {
1766  if( HasAlias( aAliasList[ i ] ) )
1767  continue;
1768 
1769  m_aliases.push_back( new LIB_ALIAS( aAliasList[ i ], this ) );
1770  }
1771 
1772  // Remove names in the current component that are not in the new alias list.
1773  LIB_ALIASES::iterator it = m_aliases.begin();
1774 
1775  while( it != m_aliases.end() )
1776  {
1777  int index = aAliasList.Index( (*it)->GetName(), false );
1778 
1779  if( index != wxNOT_FOUND || (*it)->IsRoot() )
1780  ++it;
1781  else
1782  it = m_aliases.erase( it );
1783  }
1784 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
PART_LIB * m_library
Library the part belongs to if any.
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
wxArrayString GetAliasNames(bool aIncludeRoot=true) const
friend class LIB_ALIAS
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 212 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), and DHEAD::remove().

212 { Pback = aBack; }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:165
void EDA_ITEM::SetBrightened ( )
inlineinherited

Definition at line 229 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::disambiguationMenu().

229 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:137
void LIB_PART::SetConversion ( bool  aSetConvert)

Set or clear the alternate body style (DeMorgan) for the part.

If the part already has an alternate body style set and a asConvert if false, all of the existing draw items for the alternate body style are remove. If the alternate body style is not set and asConvert is true, than the base draw items are duplicated and added to the part.

Parameters
aSetConvert- Set or clear the part alternate body style.

Definition at line 1677 of file class_libentry.cpp.

References EDA_ITEM::Clone(), drawings, HasConversion(), LIB_PIN_T, and LIB_ITEM::m_Convert.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::SetUnsetConvert().

1678 {
1679  if( aSetConvert == HasConversion() )
1680  return;
1681 
1682  // Duplicate items to create the converted shape
1683  if( aSetConvert )
1684  {
1685  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1686 
1687  for( LIB_ITEM& item : drawings )
1688  {
1689  // Only pins are duplicated.
1690  if( item.Type() != LIB_PIN_T )
1691  continue;
1692 
1693  if( item.m_Convert == 1 )
1694  {
1695  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1696  newItem->m_Convert = 2;
1697  tmp.push_back( newItem );
1698  }
1699  }
1700 
1701  // Transfer the new pins to the LIB_PART.
1702  for( unsigned i = 0; i < tmp.size(); i++ )
1703  drawings.push_back( tmp[i] );
1704  }
1705  else
1706  {
1707  // Delete converted shape items because the converted shape does
1708  // not exist
1709  LIB_ITEMS::iterator i = drawings.begin();
1710 
1711  while( i != drawings.end() )
1712  {
1713  if( i->m_Convert > 1 )
1714  i = drawings.erase( i );
1715  else
1716  i++;
1717  }
1718  }
1719 }
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
int m_Convert
Shape identification for alternate body styles.
void LIB_PART::SetFields ( const std::vector< LIB_FIELD > &  aFieldsList)

Function SetFields overwrites all the existing in this part with fields supplied in aFieldsList.

The only known caller of this function is the library part field editor, and it establishes needed behavior.

` *

Parameters
aFieldsListis a set of fields to import, removing all previous fields.

Definition at line 1249 of file class_libentry.cpp.

References deleteAllFields(), drawings, and EDA_ITEM::SetParent().

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick().

1250 {
1251  deleteAllFields();
1252 
1253  for( unsigned i=0; i<aFields.size(); ++i )
1254  {
1255  // drawings is a ptr_vector, new and copy an object on the heap.
1256  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
1257 
1258  field->SetParent( this );
1259  drawings.push_back( field );
1260  }
1261 
1262  // Reorder drawings: transparent polygons first, pins and text last.
1263  // so texts have priority on screen.
1264  drawings.sort();
1265 }
Class LIB_FIELD is used in symbol libraries.
Definition: lib_field.h:60
void deleteAllFields()
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:213
LIB_ITEMS drawings
How to draw this part.
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 253 of file base_struct.h.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddSegmentToDragList(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::BeginMoveDimensionText(), PCB_EDIT_FRAME::BeginMoveTarget(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_EDIT_FRAME::ConvertPart(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), CopySelectedItems(), SCH_EDIT_FRAME::CreateBusBusEntry(), SCH_EDIT_FRAME::CreateBusWireEntry(), SCH_EDIT_FRAME::CreateNewImage(), SCH_EDIT_FRAME::CreateNewText(), LIB_EDIT_FRAME::CreatePin(), SCH_EDIT_FRAME::CreateSheet(), SCH_EDIT_FRAME::CreateSheetPin(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::EditDimension(), LIB_PIN::EnableEditMode(), PCB_EDIT_FRAME::FlipTextePcb(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), FOOTPRINT_EDIT_FRAME::HandleBlockEnd(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_EDIT_FRAME::ImportSheetPin(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_EDIT_FRAME::Load_Component(), PCB_BASE_FRAME::LoadModuleFromLibrary(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), moveBitmap(), SCH_EDIT_FRAME::MoveImage(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::OnEditPin(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), SCH_EDIT_FRAME::OnSelectUnit(), PCB_EDIT_FRAME::Other_Layer_Route(), DRAWING_TOOL::PlaceText(), SCH_EDIT_FRAME::PrepareMoveItem(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_EDIT_FRAME::ReSizeSheet(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_SCREEN::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), LIB_PIN::SetNumber(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::Start_Move_DrawItem(), FOOTPRINT_EDIT_FRAME::Start_Move_EdgeMod(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), PCB_EDIT_FRAME::Start_Move_Zone_Drag_Outline_Edge(), PCB_EDIT_FRAME::Start_Move_Zone_Outlines(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), PCB_BASE_FRAME::StartMovePad(), LIB_EDIT_FRAME::StartMovePin(), PCB_BASE_FRAME::StartMoveTexteModule(), PCB_EDIT_FRAME::StartMoveTextePcb(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and UndrawAndMarkSegmentsToDrag().

253 { m_Flags |= aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
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 265 of file base_struct.h.

Referenced by SCH_EDIT_FRAME::OnFindSchematicItem(), and SCH_EDIT_FRAME::updateFindReplaceView().

265 { m_forceVisible = aEnable; }
bool m_forceVisible
Set to true to override the visibility setting of the item.
Definition: base_struct.h:172
void EDA_ITEM::SetHighlighted ( )
inlineinherited

Definition at line 228 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

228 { SetFlags( HIGHLIGHTED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:136
void LIB_PART::SetLib ( PART_LIB aLibrary)
inline

Definition at line 286 of file class_libentry.h.

Referenced by PART_LIB::LoadLibrary().

286 { m_library = aLibrary; }
PART_LIB * m_library
Library the part belongs to if any.
void LIB_PART::SetLibId ( const LIB_ID aLibId)
inline

Definition at line 280 of file class_libentry.h.

280 { m_libId = aLibId; }
LIB_ID m_libId
void EDA_ITEM::SetList ( DHEAD aList)
inlineinherited

Definition at line 214 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), and DHEAD::remove().

214 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:166
void EDA_ITEM::SetModified ( )
inherited

Definition at line 102 of file base_struct.cpp.

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

Referenced by SCH_COMPONENT::ClearAnnotation(), SCH_LINE::Move(), SCH_COMPONENT::Move(), LIB_PIN::Move(), RemoveDrawItem(), SCH_COMPONENT::SetConvert(), LIB_PIN::SetLength(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), SCH_COMPONENT::SetTransform(), LIB_PIN::SetType(), SCH_COMPONENT::SetUnit(), LIB_PIN::SetVisible(), and LIB_PIN::SetWidth().

103 {
104  SetFlags( IS_CHANGED );
105 
106  // If this a child object, then the parent modification state also needs to be set.
107  if( m_Parent )
109 }
void SetModified()
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:168
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:109
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
void LIB_PART::SetName ( const wxString &  aName)
virtual

Definition at line 303 of file class_libentry.cpp.

References GetValueField(), m_aliases, m_name, and LIB_FIELD::SetText().

Referenced by LIB_EDIT_FRAME::EditField(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), RESCUE_CACHE_CANDIDATE::PerformAction(), LIB_VIEW_FRAME::RedrawActiveWindow(), RemoveAlias(), and LIB_FIELD::SetText().

304 {
305  m_name = aName;
306  GetValueField().SetText( aName );
307 
308  // The LIB_ALIAS that is the LIB_PART name has to be created so create it.
309  if( m_aliases.size() == 0 )
310  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
311  else
312  m_aliases[0]->SetName( aName );
313 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
LIB_FIELD & GetValueField()
Return reference to the value field.
wxString m_name
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:679
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 211 of file base_struct.h.

Referenced by DHEAD::append(), DHEAD::insert(), SCH_EDIT_FRAME::PutDataInPreviousState(), and DHEAD::remove().

211 { Pnext = aNext; }
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:164
void LIB_PART::SetNormal ( )
inline

Definition at line 394 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

394 { m_options = ENTRY_NORMAL; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void LIB_PART::SetOffset ( const wxPoint aOffset)

Move the part aOffset.

Parameters
aOffset- Offset displacement.

Definition at line 1392 of file class_libentry.cpp.

References drawings.

1393 {
1394  for( LIB_ITEM& item : drawings )
1395  {
1396  item.SetOffset( aOffset );
1397  }
1398 }
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 213 of file base_struct.h.

Referenced by MODULE::Add(), BOARD::Add(), BOARD_NETLIST_UPDATER::addNewComponent(), LIB_FIELD::Copy(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), SCH_EDIT_FRAME::CreateSheet(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_PART(), SCH_SHEET::Load(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_MODULE_BOARD_EDITOR::OnEditReference(), DIALOG_MODULE_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), MODULE_EDITOR_TOOLS::PasteItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), SCH_COMPONENT::SCH_COMPONENT(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SetFields(), SetSchItemParent(), PCB_EDIT_FRAME::StartMoveModule(), BOARD_ITEM::SwapData(), SCH_COMPONENT::SwapData(), and SCH_SHEET::SwapData().

213 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:168
void LIB_PART::SetPinNameOffset ( int  aOffset)
inline

Set the offset in mils of the pin name text from the pin symbol.

Set the offset to 0 to draw the pin name above the pin symbol.

Parameters
aOffset- The offset in mils.

Definition at line 763 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

763 { m_pinNameOffset = aOffset; }
int m_pinNameOffset
The offset in mils to draw the pin name.
void LIB_PART::SetPower ( )
inline

Definition at line 393 of file class_libentry.h.

References ENTRY_POWER.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

393 { m_options = ENTRY_POWER; }
LIBRENTRYOPTIONS m_options
Special part features such as POWER or NORMAL.)
void EDA_ITEM::SetSelected ( )
inlineinherited

Definition at line 227 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by SELECTION_TOOL::selectVisually().

227 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:120
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
void LIB_PART::SetShowPinNames ( bool  aShow)
inline

Set or clear the pin name visibility flag.

Parameters
aShow- True to make the part pin names visible.

Definition at line 772 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

772 { m_showPinNames = aShow; }
bool m_showPinNames
Determines if part pin names are visible.
void LIB_PART::SetShowPinNumbers ( bool  aShow)
inline

Set or clear the pin number visibility flag.

Parameters
aShow- True to make the part pin numbers visible.

Definition at line 781 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::CreateNewLibraryPart(), and DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

781 { m_showPinNumbers = aShow; }
bool m_showPinNumbers
Determines if part pin numbers are visible.
void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited
void LIB_PART::SetSubpartIdNotation ( int  aSep,
int  aFirstId 
)
static

Set the separator char between the subpart id and the reference 0 (no separator) or '.

' , '-' and '_' and the ascii char value to calculate the subpart symbol id from the part number: 'A' or '1' only are allowed. (to print U1.A or U1.1) if this is a digit, a number is used as id symbol Note also if the subpart symbol is a digit, the separator cannot be null.

Parameters
aSep= the separator symbol (0 (no separator) or '.' , '-' and '_')
aFirstId= the Id of the first part ('A' or '1')

Definition at line 1898 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::LoadProjectFile(), and SCH_EDIT_FRAME::OnPreferencesOptions().

1899 {
1900  m_subpartFirstId = 'A';
1902 
1903  if( aSep == '.' || aSep == '-' || aSep == '_' )
1904  m_subpartIdSeparator = aSep;
1905 
1906  if( aFirstId == '1' && aSep != 0 )
1907  m_subpartFirstId = aFirstId;
1908 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only 'A'...
void EDA_ITEM::SetTimeStamp ( time_t  aNewTimeStamp)
inlineinherited

Definition at line 203 of file base_struct.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::FootprintSave(), DIALOG_MODULE_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), SCH_SHEET::Load(), LEGACY_PLUGIN::loadMODULE(), PCB_BASE_FRAME::LoadModuleFromLibrary(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), EDA_ITEM::operator=(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), SCH_EDIT_FRAME::PasteListOfItems(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), BOARD::ReplaceNetlist(), SCH_SHEET::SCH_SHEET(), SCH_COMPONENT::SetTimeStamp(), SimilarLabelsDiagnose(), BOARD_ITEM::SwapData(), and TestDuplicateSheetNames().

203 { m_TimeStamp = aNewTimeStamp; }
time_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:169
void LIB_PART::SetUnitCount ( int  count)

Set the units per part count.

If the count is greater than the current count, then the all of the current draw items are duplicated for each additional part. If the count is less than the current count, all draw objects for units greater that count are removed from the part.

Parameters
count- Number of units per package.

Definition at line 1630 of file class_libentry.cpp.

References EDA_ITEM::Clone(), drawings, LIB_ITEM::m_Unit, and m_unitCount.

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::ChangeNbUnitsPerPackage(), and LIB_EDIT_FRAME::CreateNewLibraryPart().

1631 {
1632  if( m_unitCount == aCount )
1633  return;
1634 
1635  if( aCount < m_unitCount )
1636  {
1637  LIB_ITEMS::iterator i;
1638  i = drawings.begin();
1639 
1640  while( i != drawings.end() )
1641  {
1642  if( i->m_Unit > aCount )
1643  i = drawings.erase( i );
1644  else
1645  i++;
1646  }
1647  }
1648  else
1649  {
1650  int prevCount = m_unitCount;
1651 
1652  // We cannot use an iterator here, because when adding items in vector
1653  // the buffer can be reallocated, that change the previous value of
1654  // .begin() and .end() iterators and invalidate others iterators
1655  unsigned imax = drawings.size();
1656 
1657  for( unsigned ii = 0; ii < imax; ii++ )
1658  {
1659  if( drawings[ii].m_Unit != 1 )
1660  continue;
1661 
1662  for( int j = prevCount + 1; j <= aCount; j++ )
1663  {
1664  LIB_ITEM* newItem = (LIB_ITEM*) drawings[ii].Clone();
1665  newItem->m_Unit = j;
1666  drawings.push_back( newItem );
1667  }
1668  }
1669 
1670  drawings.sort();
1671  }
1672 
1673  m_unitCount = aCount;
1674 }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
int m_unitCount
Number of units (parts) per package.
int m_Unit
Unit identification for multiple parts per package.
Class LIB_ITEM is the base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:77
LIB_ITEMS drawings
How to draw this part.
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 226 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

226 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:253
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:117
PART_SPTR LIB_PART::SharedPtr ( )
inline

Definition at line 264 of file class_libentry.h.

References m_me.

Referenced by SCH_COMPONENT::SCH_COMPONENT().

265  {
266  // clone a shared pointer
267  return m_me;
268  }
PART_SPTR m_me
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared ...
bool LIB_PART::ShowPinNames ( )
inline

Definition at line 774 of file class_libentry.h.

References m_showPinNames.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and LIB_EDIT_FRAME::SaveOneSymbol().

774 { return m_showPinNames; }
bool m_showPinNames
Determines if part pin names are visible.
bool LIB_PART::ShowPinNumbers ( )
inline

Definition at line 783 of file class_libentry.h.

References m_showPinNumbers.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and LIB_EDIT_FRAME::SaveOneSymbol().

783 { return m_showPinNumbers; }
bool m_showPinNumbers
Determines if part pin numbers are visible.
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 463 of file base_struct.h.

Referenced by PART_LIB::GetEntryTypePowerNames().

463 { return *aLeft < *aRight; }
static int* LIB_PART::SubpartFirstIdPtr ( )
inlinestatic

return a reference to m_subpartFirstId, only for read/save setting functions

Definition at line 730 of file class_libentry.h.

References m_subpartFirstId.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

730 { return &m_subpartFirstId; }
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only 'A'...
static int* LIB_PART::SubpartIdSeparatorPtr ( )
inlinestatic

return a reference to m_subpartIdSeparator, only for read/save setting functions

Definition at line 724 of file class_libentry.h.

References m_subpartIdSeparator.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

724 { return &m_subpartIdSeparator; }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
wxString LIB_PART::SubReference ( int  aUnit,
bool  aAddSeparator = true 
)
static

Function SubReference.

Returns
the sub reference for part having multiple units per part. The sub reference identify the part (or unit)
Parameters
aUnit= the part identifier ( 1 to max count)
aAddSeparator= true (default) to prpebd the sub ref by the separator symbol (if any) Note: this is a static function.

Definition at line 271 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

Referenced by AddMenusForEditComponent(), SCH_REFERENCE_LIST::CheckAnnotation(), CMP_TREE_NODE_UNIT::CMP_TREE_NODE_UNIT(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), LIB_FIELD::GetFullText(), SCH_FIELD::GetFullyQualifiedText(), SCH_FIELD::Matches(), and LIB_EDIT_FRAME::UpdatePartSelectList().

272 {
273  wxString subRef;
274 
275  if( m_subpartIdSeparator != 0 && aAddSeparator )
276  subRef << wxChar( m_subpartIdSeparator );
277 
278  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
279  subRef << aUnit;
280  else
281  {
282  // use letters as notation. To allow more than 26 units, the sub ref
283  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
284  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
285  int u;
286  aUnit -= 1; // Unit number starts to 1. now to 0.
287 
288  while( aUnit >= 26 ) // more than one letter are needed
289  {
290  u = aUnit / 26;
291  subRef << wxChar( m_subpartFirstId + u -1 );
292  aUnit %= 26;
293  }
294 
295  u = m_subpartFirstId + aUnit;
296  subRef << wxChar( u );
297  }
298 
299  return subRef;
300 }
static int m_subpartIdSeparator
the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or ...
static int m_subpartFirstId
the ascii char value to calculate the subpart symbol id from the part number: only 'A'...
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 198 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), MODULE::Add(), BOARD::Add(), RN_DATA::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), RN_DATA::AddBlocked(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), RN_DATA::AddSimple(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Autoroute(), PCB_EDIT_FRAME::Begin_Route(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Duplicate(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), SCH_SCREENS::BuildScreenList(), SCH_SHEET_LIST::BuildSheetList(), HIERARCHY_NAVIG_DLG::BuildSheetsTree(), calcArea(), calcMaxArea(), calcMinArea(), DIALOG_EXCHANGE_MODULE::changeAllFootprints(), DIALOG_EXCHANGE_MODULE::changeSameFootprints(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), MODULE::ClassOf(), D_PAD::ClassOf(), NETINFO_ITEM::ClassOf(), BOARD::ClassOf(), VIA::ClassOf(), SCH_SHEET::CleanupSheet(), Collect_TrackSegmentsToDrag(), LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_POLYLINE::compare(), LIB_TEXT::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), SCH_SHEET::ComponentCount(), GRID_HELPER::computeAnchors(), CopySelectedItems(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), CINFO3D_VISU::createLayers(), BOARD::CreateLockPoint(), SCH_EDIT_FRAME::CreateNewText(), CINFO3D_VISU::createNewTrack(), PCB_EDIT_FRAME::createPopupMenuForTracks(), CreateRoutesSection(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), D_PAD::D_PAD(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_SCREENS::DeleteAllMarkers(), SCH_SCREEN::DeleteItem(), LIB_EDIT_FRAME::deleteItem(), deleteItem(), SCH_EDIT_FRAME::DeleteItem(), DeleteItemsInList(), DeleteNullTrackSegments(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), EDIT_TOOL::Duplicate(), BOARD::Duplicate(), MODULE::Duplicate(), PCB_EDIT_FRAME::duplicateItems(), DuplicateItemsInList(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditSymbolText(), SCH_EDIT_FRAME::EndSegment(), PCB_EDIT_FRAME::EraseRedundantTrack(), ExitSheet(), SCH_SCREEN::ExtractWires(), DRC::fillMarker(), find_vias_and_tracks_at(), SCH_EDIT_FRAME::FindComponentAndItem(), NETLIST_EXPORTER::findNextComponent(), NETLIST_EXPORTER::findNextComponentAndCreatePinList(), SCH_SHEET_PATH::FindNextItem(), SCH_SHEET_LIST::FindNextItem(), SCH_SHEET_PATH::FindPreviousItem(), SCH_SHEET_LIST::FindPreviousItem(), POINT_EDITOR::finishItem(), FootprintWriteShape(), FormatProbeItem(), genPlacementRoutingMatrix(), POINT_EDITOR::get45DegConstrainer(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), GetBodyBoundingBox(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), GetNextDrawItem(), RN_NET::GetNodes(), CONNECTED_POINT::GetPad(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), CONNECTED_POINT::GetTrack(), GetUnitBoundingBox(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), SCH_SHEET::HasUndefinedPins(), SCH_EDIT_FRAME::ImportSheetPin(), DIALOG_LABEL_EDITOR::InitDialog(), ROUTER_TOOL::InlineDrag(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), SCH_FIND_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsDraggableJunction(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), SCH_SHEET::Load(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), SCH_EDIT_FRAME::LocateAndShowItem(), SCH_EDIT_FRAME::LocateItem(), SCH_SHEET::LocatePathOfScreen(), Magnetize(), EDIT_POINTS_FACTORY::Make(), SCH_SCREEN::MarkConnections(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::merge_collinear_of_track(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), LIB_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyDuplicateItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyMoveItemExact(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), FOOTPRINT_EDIT_FRAME::OnHotkeyRotateItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_LINE::operator<(), LIB_ITEM::operator<(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), SCH_BITMAP::operator=(), SCH_COMPONENT::operator=(), SCH_SHEET::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), MODULE_EDITOR_TOOLS::PasteItems(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), PCB_EDIT_FRAME::PrintPage(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::Process_Special_Functions(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), RedrawWhileMovingCursor(), MODULE::Remove(), BOARD::Remove(), RN_DATA::Remove(), TRACKS_CLEANER::remove_duplicates_of_track(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), RemoveDrawItem(), SCH_SHEET::RemovePin(), FOOTPRINT_EDIT_FRAME::RemoveStruct(), PCB_EDIT_FRAME::RemoveStruct(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SCREEN::ReplaceWires(), SELECTION_TOOL::RequestSelection(), PCB_EDIT_FRAME::Reset_All_Tracks_And_Vias_To_Netclass_Values(), PCB_BASE_FRAME::ResetTextSize(), SCH_EDIT_FRAME::ReSizeSheet(), BOARD_COMMIT::Revert(), SCH_EDIT_FRAME::RotateField(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), CONNECTIONS::SearchConnectedTracks(), SCH_SHEET::SearchHierarchy(), SELECTION_TOOL::select(), SELECTION_TOOL::selectable(), SCH_SCREEN::SelectBlockItems(), PCB_EDIT_FRAME::SelectHighLight(), SELECTION_TOOL::selectVisually(), ITEM_PICKER::SetItem(), SetSchItemParent(), DIALOG_LABEL_EDITOR::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PCB_EDIT_FRAME::Show_1_Ratsnest(), Show_MoveNode(), ShowClearance(), ShowNewTrackWhenMovingCursor(), SortByTimeStamp(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), LIB_EDIT_FRAME::StartMoveDrawSymbol(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), BOARD_ITEM::SwapData(), SCH_COMPONENT::SwapData(), SCH_SHEET::SwapData(), PCB_EDIT_FRAME::SwitchLayer(), BOARD::Test_Connections_To_Copper_Areas(), TestDuplicateSheetNames(), TEXTE_MODULE::TEXTE_MODULE(), TraceSegmentPcb(), TRACK::TransformShapeWithClearanceToPolygon(), SELECTION_TOOL::unselectVisually(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), PCB_BRIGHT_BOX::ViewDraw(), TRACK::Visit(), EDA_ITEM::Visit(), SCH_COMPONENT::Visit(), and SCH_SHEET::Visit().

199  {
200  return m_StructType;
201  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:160
bool LIB_PART::UnitsLocked ( ) const
inline
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

Implements KIGFX::VIEW_ITEM.

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

Definition at line 267 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by SELECTION_TOOL::selectMultiple(), BRIGHT_BOX::ViewBBox(), DIMENSION::ViewBBox(), DRAWSEGMENT::ViewBBox(), BRIGHT_BOX::ViewDraw(), and COMMON_TOOLS::ZoomFitScreen().

268 {
269  // Basic fallback
270  return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
271  VECTOR2I( GetBoundingBox().GetSize() ) );
272 }
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
VECTOR2< int > VECTOR2I
Definition: vector2d.h:590
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
aGalpointer to the GAL device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::PREVIEW::RULER_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, and PCB_BRIGHT_BOX.

Definition at line 114 of file view_item.h.

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

115  {}
void EDA_ITEM::ViewGetLayers ( int  aLayers[],
int &  aCount 
) const
overridevirtualinherited

Implements KIGFX::VIEW_ITEM.

Reimplemented in MODULE, D_PAD, EDIT_POINTS, VIA, BOARD_ITEM, TRACK, TEXTE_MODULE, MARKER_PCB, KIGFX::WORKSHEET_VIEWITEM, ROUTER_PREVIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, BRIGHT_BOX, KIGFX::ORIGIN_VIEWITEM, KIGFX::RATSNEST_VIEWITEM, and KIGFX::PREVIEW::RULER_ITEM.

Definition at line 275 of file base_struct.cpp.

276 {
277  // Basic fallback
278  aCount = 1;
279  aLayers[0] = 0;
280 }
virtual unsigned int KIGFX::VIEW_ITEM::ViewGetLOD ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

Function ViewGetLOD() Returns the level of detail 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.

Reimplemented in MODULE, D_PAD, TRACK, and TEXTE_MODULE.

Definition at line 133 of file view_item.h.

Referenced by KIGFX::VIEW::drawItem::operator()().

134  {
135  // By default always show the item
136  return 0;
137  }
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_SHEET, MODULE, SCH_COMPONENT, and TRACK.

Definition at line 151 of file base_struct.cpp.

References EOT, EDA_ITEM::GetClass(), SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Type().

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

152 {
153  KICAD_T stype;
154 
155 #if 0 && defined(DEBUG)
156  std::cout << GetClass().mb_str() << ' ';
157 #endif
158 
159  for( const KICAD_T* p = scanTypes; (stype = *p) != EOT; ++p )
160  {
161  // If caller wants to inspect my type
162  if( stype == Type() )
163  {
164  if( SEARCH_QUIT == inspector( this, testData ) )
165  return SEARCH_QUIT;
166 
167  break;
168  }
169  }
170 
171  return SEARCH_CONTINUE;
172 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
search types array terminator (End Of Types)
Definition: typeinfo.h:94
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:90
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Friends And Related Function Documentation

friend class LIB_ALIAS
friend

Definition at line 224 of file class_libentry.h.

Referenced by AddAlias(), LIB_PART(), Load(), LoadAliases(), and SetAliases().

friend class PART_LIB
friend

Definition at line 223 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnExportPart().

friend class SCH_LEGACY_PLUGIN_CACHE
friend

Definition at line 225 of file class_libentry.h.

Member Data Documentation

LIB_ALIASES LIB_PART::m_aliases
private

List of alias object pointers associated with the part.

Definition at line 242 of file class_libentry.h.

Referenced by AddAlias(), GetAlias(), GetAliasNames(), HasAlias(), LIB_PART(), Load(), LoadAliases(), RemoveAlias(), RemoveAllAliases(), Save(), SetAliases(), SetName(), and ~LIB_PART().

long LIB_PART::m_dateModified
private

Date the part was last modified.

Definition at line 236 of file class_libentry.h.

Referenced by LIB_PART(), LoadDateAndTime(), and SaveDateAndTime().

STATUS_FLAGS EDA_ITEM::m_Flags
protectedinherited

Flag bits for editing and other uses.

Definition at line 175 of file base_struct.h.

Referenced by LIB_CIRCLE::BeginEdit(), LIB_RECTANGLE::BeginEdit(), LIB_POLYLINE::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_ARC::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_CIRCLE::calcEdit(), LIB_POLYLINE::calcEdit(), LIB_RECTANGLE::calcEdit(), LIB_TEXT::calcEdit(), LIB_ARC::calcEdit(), LIB_FIELD::calcEdit(), LIB_TEXT::Clone(), LIB_CIRCLE::ContinueEdit(), LIB_RECTANGLE::ContinueEdit(), LIB_POLYLINE::ContinueEdit(), LIB_TEXT::ContinueEdit(), LIB_ARC::ContinueEdit(), LIB_FIELD::ContinueEdit(), SCH_LINE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), D_PAD::Draw(), SEGZONE::Draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_ARC::drawGraphic(), DRAWSEGMENT::DRAWSEGMENT(), LIB_CIRCLE::EndEdit(), LIB_RECTANGLE::EndEdit(), LIB_POLYLINE::EndEdit(), LIB_TEXT::EndEdit(), LIB_ARC::EndEdit(), LIB_FIELD::EndEdit(), LIB_ITEM::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), SCH_COMPONENT::Load(), SCH_LINE::Move(), EDA_ITEM::operator=(), SCH_COMPONENT::SCH_COMPONENT(), LIB_PIN::SetConversion(), LIB_PIN::SetLength(), LIB_PIN::SetName(), LIB_PIN::SetNameTextSize(), LIB_PIN::SetNumberTextSize(), LIB_PIN::SetOrientation(), LIB_PIN::SetPartNumber(), LIB_PIN::SetPinPosition(), LIB_PIN::SetShape(), LIB_PIN::SetType(), and LIB_PIN::SetVisible().

wxArrayString LIB_PART::m_FootprintList
private

List of suitable footprint names for the part (wild card names accepted).

Definition at line 240 of file class_libentry.h.

Referenced by GetFootPrints(), LIB_PART(), LoadFootprints(), and Save().

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 172 of file base_struct.h.

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

LIB_ID LIB_PART::m_libId
private

Definition at line 229 of file class_libentry.h.

Referenced by GetLibId().

PART_LIB* LIB_PART::m_library
private

Library the part belongs to if any.

Definition at line 244 of file class_libentry.h.

Referenced by GetLib(), GetLibraryName(), LIB_PART(), and SetAliases().

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 166 of file base_struct.h.

Referenced by EDA_ITEM::GetList(), EDA_ITEM::initVars(), and BOARD_ITEM::SwapData().

wxString LIB_PART::m_name
private

Definition at line 228 of file class_libentry.h.

Referenced by GetName(), LIB_PART(), Load(), LoadField(), RemoveAlias(), and SetName().

LIBRENTRYOPTIONS LIB_PART::m_options
private

Special part features such as POWER or NORMAL.)

Definition at line 237 of file class_libentry.h.

Referenced by LIB_PART(), Load(), and Save().

int LIB_PART::m_pinNameOffset
private

The offset in mils to draw the pin name.

Set to 0 to draw the pin name above the pin.

Definition at line 230 of file class_libentry.h.

Referenced by GetPinNameOffset(), LIB_PART(), Load(), and Save().

bool LIB_PART::m_showPinNames
private

Determines if part pin names are visible.

Definition at line 234 of file class_libentry.h.

Referenced by LIB_PART(), Load(), Save(), and ShowPinNames().

bool LIB_PART::m_showPinNumbers
private

Determines if part pin numbers are visible.

Definition at line 235 of file class_libentry.h.

Referenced by LIB_PART(), Load(), Save(), and ShowPinNumbers().

int LIB_PART::m_subpartFirstId = 'A'
staticprivate

the ascii char value to calculate the subpart symbol id from the part number: only 'A', 'a' or '1' can be used, other values have no sense.

Definition at line 249 of file class_libentry.h.

Referenced by GetSubpartFirstId(), SetSubpartIdNotation(), SubpartFirstIdPtr(), and SubReference().

int LIB_PART::m_subpartIdSeparator = 0
staticprivate

the separator char between the subpart id and the reference like U1A ( m_subpartIdSeparator = 0 ) or U1.A or U1-A

Definition at line 246 of file class_libentry.h.

Referenced by GetSubpartIdSeparator(), SetSubpartIdNotation(), SubpartIdSeparatorPtr(), and SubReference().

int LIB_PART::m_unitCount
private

Number of units (parts) per package.

Definition at line 238 of file class_libentry.h.

Referenced by GetBodyBoundingBox(), GetUnitBoundingBox(), GetUnitCount(), LIB_PART(), Load(), Save(), and SetUnitCount().

bool LIB_PART::m_unitsLocked
private

True if part has multiple units and changing one unit does not automatically change another unit.

Definition at line 232 of file class_libentry.h.

Referenced by LIB_PART(), Load(), Save(), SelectItems(), and UnitsLocked().


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