KiCad PCB EDA Suite
LIB_PART Class Reference

Define a library symbol 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)
 
timestamp_t GetDateLastEdition () const
 
void AddAlias (const wxString &aName)
 Add an alias aName to the part. 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
 Get the bounding box for the symbol. More...
 
const EDA_RECT GetBodyBoundingBox (int aUnit, int aConvert) const
 Get the symbol bounding box excluding fields. 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)
 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)
 Write the data structures out to aFormatter in the part library "*.lib" format. More...
 
bool IsPower () const
 
bool IsNormal () const
 
void SetPower ()
 
void SetNormal ()
 
void LockUnits (bool aLockUnits)
 Set interchangeable the property for part units. More...
 
bool UnitsLocked () const
 Check whether part units are interchangeable. More...
 
void SetFields (const std::vector< LIB_FIELD > &aFieldsList)
 Overwrite all the existing fields in this symbol with fields supplied in aFieldsList. More...
 
void GetFields (LIB_FIELDS &aList)
 Return a list of fields withing this part. More...
 
LIB_FIELDFindField (const wxString &aFieldName)
 Findd 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...
 
LIB_FIELDGetFootprintField ()
 Return reference to the footprint 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)
 Return 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 aSyncPinEdit)
 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_ITEMS_CONTAINERGetDrawItems ()
 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
 
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 (timestamp_t aNewTimeStamp)
 
timestamp_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
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static wxString SubReference (int aUnit, bool aAddSeparator=true)
 
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...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void 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...
 
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...
 
timestamp_t m_dateLastEdition
 Date of the last modification. 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_CONTAINER m_drawings
 Drawing items of 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...
 

Detailed Description

Define a library symbol object.

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

Definition at line 214 of file class_libentry.h.

Constructor & Destructor Documentation

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

Definition at line 148 of file class_libentry.cpp.

References DATASHEET, ENTRY_NORMAL, FOOTPRINT, LIB_FIELD_T, m_dateLastEdition, m_drawings, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), REFERENCE, SetLib(), SetName(), and VALUE.

Referenced by LIB_EDIT_FRAME::TempCopyComponent().

148  :
149  EDA_ITEM( LIB_PART_T ),
150  m_me( this, null_deleter() )
151 {
152  m_dateLastEdition = 0;
153  m_unitCount = 1;
154  m_pinNameOffset = 40;
156  m_unitsLocked = false;
157  m_showPinNumbers = true;
158  m_showPinNames = true;
159 
160  // Add the MANDATORY_FIELDS in RAM only. These are assumed to be present
161  // when the field editors are invoked.
166 
167  SetLib( aLibrary );
168  SetName( aName );
169 }
timestamp_t m_dateLastEdition
Date of the last modification.
void SetLib(PART_LIB *aLibrary)
name of datasheet
bool m_showPinNumbers
Determines if part pin numbers are visible.
int m_unitCount
Number of units (parts) per package.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
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.
void push_back(T *aItem)
Definition: multivector.h:169
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 ...
virtual void SetName(const wxString &aName)
bool m_showPinNames
Determines if part pin names are visible.
#define VALUE
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 172 of file class_libentry.cpp.

References EDA_ITEM::Clone(), EDA_ITEM::IsNew(), m_aliases, m_dateLastEdition, m_drawings, m_FootprintList, m_libId, m_library, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and EDA_ITEM::SetParent().

172  :
173  EDA_ITEM( aPart ),
174  m_me( this, null_deleter() )
175 {
176  LIB_ITEM* newItem;
177 
178  m_library = aLibrary;
180  m_unitCount = aPart.m_unitCount;
186  m_options = aPart.m_options;
187  m_libId = aPart.m_libId;
188 
189  for( LIB_ITEM& oldItem : aPart.m_drawings )
190  {
191  if( oldItem.IsNew() )
192  continue;
193 
194  newItem = (LIB_ITEM*) oldItem.Clone();
195  newItem->SetParent( this );
196  m_drawings.push_back( newItem );
197  }
198 
199  for( size_t i = 0; i < aPart.m_aliases.size(); i++ )
200  {
201  LIB_ALIAS* alias = new LIB_ALIAS( *aPart.m_aliases[i], this );
202  m_aliases.push_back( alias );
203  }
204 }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool m_showPinNumbers
Determines if part pin numbers are visible.
bool IsNew() const
Definition: base_struct.h:245
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.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
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...
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
int m_pinNameOffset
The offset in mils to draw the pin name.
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:242
void push_back(T *aItem)
Definition: multivector.h:169
wxArrayString m_FootprintList
List of suitable footprint names for the part (wild card names accepted).
LIB_ID m_libId
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 ...
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 207 of file class_libentry.cpp.

References GetChars(), m_aliases, and traceSchLibMem.

208 {
209  wxLogTrace( traceSchLibMem,
210  wxT( "%s: destroying symbol with alias list count of %llu" ),
211  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
212  (long long unsigned) m_aliases.size() );
213 
214  // If the part is being deleted directly rather than through the library,
215  // delete all of the aliases.
216  while( m_aliases.size() )
217  {
218  LIB_ALIAS* alias = m_aliases.back();
219  m_aliases.pop_back();
220  delete alias;
221  }
222 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
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 wxChar traceSchLibMem[]
Flag to enable schematic library memory deletion debug output.

Member Function Documentation

void LIB_PART::AddAlias ( const wxString &  aName)

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 1354 of file class_libentry.cpp.

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

1355 {
1356  wxCHECK_RET( !HasAlias( aName ),
1357  wxT( "Symbol <" ) + GetName() + wxT( "> already has an alias <" ) +
1358  aName + wxT( ">. Bad programmer." ) );
1359 
1360  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
1361 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool HasAlias(const wxString &aName) const
Test if alias aName is in part alias list.
const wxString & GetName() const
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 554 of file class_libentry.cpp.

References m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back().

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

555 {
556  wxASSERT( aItem != NULL );
557 
558  m_drawings.push_back( aItem );
559 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void push_back(T *aItem)
Definition: multivector.h:169
EDA_ITEM* EDA_ITEM::Back ( ) const
inlineinherited

Definition at line 236 of file base_struct.h.

References EDA_ITEM::Pback.

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

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

Definition at line 262 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

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

Definition at line 283 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(), 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(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), 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(), EraseDragList(), 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_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_EAGLE_PLUGIN::loadSheet(), 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(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCBNEW_CONTROL::placeBoardItems(), 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(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::savePin(), 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().

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

Definition at line 261 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

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

Clears all the draw items marked by a block select.

Definition at line 975 of file class_libentry.cpp.

References m_drawings.

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

976 {
977  for( LIB_ITEM& item : m_drawings )
978  {
979  item.m_Flags = 0;
980  }
981 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void LIB_PART::ClearStatus ( )

Clears the status flag all draw objects in this part.

Definition at line 919 of file class_libentry.cpp.

References m_drawings.

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

920 {
921  for( LIB_ITEM& item : m_drawings )
922  {
923  item.m_Flags = 0;
924  }
925 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, TEXTE_PCB, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, LIB_BEZIER, LIB_CIRCLE, SCH_MARKER, SCH_NO_CONNECT, PCB_TARGET, SCH_JUNCTION, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 125 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), BOARD::Duplicate(), DuplicateStruct(), SCH_SCREEN::ExtractWires(), EDA_ITEM::HitTest(), LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), 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 1008 of file class_libentry.cpp.

References EDA_ITEM::Clone(), LIB_FIELD_T, m_drawings, MoveSelectedItems(), SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::HandleBlockPlace().

1009 {
1010  std::vector< LIB_ITEM* > tmp;
1011 
1012  for( LIB_ITEM& item : m_drawings )
1013  {
1014  // We *do not* copy fields because they are unique for the whole component
1015  // so skip them (do not duplicate) if they are flagged selected.
1016  if( item.Type() == LIB_FIELD_T )
1017  item.ClearFlags( SELECTED );
1018 
1019  if( !item.IsSelected() )
1020  continue;
1021 
1022  item.ClearFlags( SELECTED );
1023  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1024  newItem->SetFlags( SELECTED );
1025 
1026  // When push_back elements in buffer, a memory reallocation can happen
1027  // and will break pointers.
1028  // So, push_back later.
1029  tmp.push_back( newItem );
1030  }
1031 
1032  for( auto item : tmp )
1033  m_drawings.push_back( item );
1034 
1035  MoveSelectedItems( aOffset );
1036 }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:282
void MoveSelectedItems(const wxPoint &aOffset)
Move the selected draw items marked by a block select.
void LIB_PART::deleteAllFields ( )
private

Definition at line 750 of file class_libentry.cpp.

References LIB_FIELD_T, and m_drawings.

Referenced by SetFields().

751 {
752  m_drawings[ LIB_FIELD_T ].clear();
753 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of 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 984 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), LIB_FIELD_T, m_drawings, and SELECTED.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

985 {
987 
988  // We *do not* remove the 2 mandatory fields: reference and value
989  // so skip them (do not remove) if they are flagged selected.
990  // Skip also not visible items.
991  // But I think fields must not be deleted by a block delete command or other global command
992  // because they are not really graphic items
993  while( item != m_drawings.end() )
994  {
995  if( item->Type() == LIB_FIELD_T )
996  {
997  item->ClearFlags( SELECTED );
998  }
999 
1000  if( !item->IsSelected() )
1001  ++item;
1002  else
1003  item = m_drawings.erase( item );
1004  }
1005 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
#define SELECTED
Definition: base_struct.h:134
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
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 296 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, 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, m_drawings, 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().

298 {
299  BASE_SCREEN* screen = aPanel ? aPanel->GetScreen() : NULL;
300 
301  GRSetDrawMode( aDc, aOpts.draw_mode );
302 
303  /* draw background for filled items using background option
304  * Solid lines will be drawn after the background
305  * Note also, background is not drawn when:
306  * printing in black and white
307  * If the color is not the default color (aColor != -1 )
308  */
309  if( ! ( screen && screen->m_IsPrinting && GetGRForceBlackPenState() )
310  && ( aOpts.color == COLOR4D::UNSPECIFIED ) )
311  {
312  for( LIB_ITEM& drawItem : m_drawings )
313  {
314  if( drawItem.m_Fill != FILLED_WITH_BG_BODYCOLOR )
315  continue;
316 
317  if( aOpts.only_selected && !drawItem.IsSelected() )
318  continue;
319 
320  // Do not draw an item while moving (the cursor handler does that)
321  if( drawItem.m_Flags & IS_MOVED )
322  continue;
323 
324  // Do not draw items not attached to the current part
325  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
326  continue;
327 
328  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
329  continue;
330 
331  if( drawItem.Type() == LIB_FIELD_T )
332  continue;
333 
334  if( drawItem.Type() == LIB_FIELD_T ) // TODO dead code?
335  {
336  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
337  aOpts.draw_mode, (void*) NULL, aOpts.transform );
338  }
339 
340  // Now, draw only the background for items with
341  // m_Fill == FILLED_WITH_BG_BODYCOLOR:
342  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
343  aOpts.draw_mode, (void*) false, aOpts.transform );
344  }
345  }
346 
347  // Track the index into the dangling pins list
348  size_t pin_index = 0;
349 
350  for( LIB_ITEM& drawItem : m_drawings )
351  {
352  if( aOpts.only_selected && !drawItem.IsSelected() )
353  continue;
354 
355  // Do not draw an item while moving (the cursor handler does that)
356  if( drawItem.m_Flags & IS_MOVED )
357  continue;
358 
359  // Do not draw items not attached to the current part
360  if( aMulti && drawItem.m_Unit && ( drawItem.m_Unit != aMulti ) )
361  continue;
362 
363  if( aConvert && drawItem.m_Convert && ( drawItem.m_Convert != aConvert ) )
364  continue;
365 
366  if( drawItem.Type() == LIB_FIELD_T )
367  {
368  LIB_FIELD& field = dynamic_cast<LIB_FIELD&>( drawItem );
369 
370  if( field.IsVisible() && !aOpts.draw_visible_fields )
371  continue;
372 
373  if( !field.IsVisible() && !aOpts.draw_hidden_fields )
374  continue;
375  }
376 
377  if( drawItem.Type() == LIB_PIN_T )
378  {
379  LIB_PIN& pin = dynamic_cast<LIB_PIN&>( drawItem );
380 
381  uintptr_t flags = 0;
382  if( aOpts.show_pin_text )
383  flags |= PIN_DRAW_TEXTS;
384 
385  if( aOpts.show_elec_type )
387 
388  if( aOpts.PinIsDangling( pin_index ) )
389  flags |= PIN_DRAW_DANGLING;
390 
391  if( pin.IsPowerConnection() && IsPower() )
392  flags |= PIN_DANGLING_HIDDEN;
393 
394  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
395  aOpts.draw_mode, (void*) flags, aOpts.transform );
396 
397  ++pin_index;
398  }
399  else if( drawItem.Type() == LIB_FIELD_T )
400  {
401  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
402  aOpts.draw_mode, (void*) NULL, aOpts.transform );
403  }
404  else
405  {
406  bool forceNoFill = drawItem.m_Fill == FILLED_WITH_BG_BODYCOLOR;
407  drawItem.Draw( aPanel, aDc, aOffset, aOpts.color,
408  aOpts.draw_mode, (void*) forceNoFill,
409  aOpts.transform );
410  }
411  }
412 
413  // Enable this to draw the anchor of the component.
414 #if 0
415  int len = aDc->DeviceToLogicalXRel( 3 );
416  EDA_RECT* const clipbox = aPanel ? aPanel->GetClipBox() : NULL;
417 
418  GRLine( clipbox, aDc, aOffset.x, aOffset.y - len, aOffset.x,
419  aOffset.y + len, 0, aOpts.color );
420  GRLine( clipbox, aDc, aOffset.x - len, aOffset.y, aOffset.x + len,
421  aOffset.y, 0, aOpts.color );
422 #endif
423 
424  /* Enable this to draw the bounding box around the component to validate
425  * the bounding box calculations. */
426 #if 0
427  EDA_RECT bBox = GetUnitBoundingBox( aMulti, aConvert );
428  bBox.RevertYAxis();
429  bBox = aOpts.transform.TransformCoordinate( bBox );
430  bBox.Move( aOffset );
431  GRRect( aPanel ? aPanel->GetClipBox() : NULL, aDc, bBox, 0, LIGHTMAGENTA );
432 #endif
433 }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
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:318
bool IsPower() const
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
Definition: eda_rect.h:144
bool draw_hidden_fields
Whether to draw "hidden" fields.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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:1098
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
EDA_RECT * GetClipBox()
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color, wxPenStyle aStyle)
Definition: gr_basic.cpp:380
bool m_IsPrinting
Definition: base_screen.h:220
GR_DRAWMODE draw_mode
Device context drawing mode, see wxDC.
COLOR4D color
Color to draw part in.
bool IsVisible() const
Definition: lib_field.h:164
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool show_pin_text
Whether to show pin texts.
BASE_SCREEN * GetScreen()
Definition: draw_panel.cpp:194
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:367
bool draw_visible_fields
Whether to draw "visible" fields.
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:309
TRANSFORM transform
Coordinate adjustment settings.
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
LIB_FIELD * LIB_PART::FindField ( const wxString &  aFieldName)

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

Definition at line 817 of file class_libentry.cpp.

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

818 {
819  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
820  {
821  LIB_FIELD* field = ( LIB_FIELD* ) &item;
822 
823  if( field->GetName() == aFieldName )
824  return field;
825  }
826 
827  return NULL;
828 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:432
LIB_ALIAS * LIB_PART::GetAlias ( const wxString &  aName)

Definition at line 1330 of file class_libentry.cpp.

References GetName(), and m_aliases.

1331 {
1332  wxCHECK2_MSG( !aName.IsEmpty(), return NULL,
1333  wxT( "Cannot get alias with an empty name. Bad programmer!" ) );
1334 
1335  for( size_t i = 0; i < m_aliases.size(); i++ )
1336  {
1337  if( aName == m_aliases[i]->GetName() )
1338  return m_aliases[i];
1339  }
1340 
1341  return NULL;
1342 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const wxString & GetName() const
wxArrayString LIB_PART::GetAliasNames ( bool  aIncludeRoot = true) const

Definition at line 1209 of file class_libentry.cpp.

References m_aliases.

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

1210 {
1211  wxArrayString names;
1212 
1213  LIB_ALIASES::const_iterator it;
1214 
1215  for( it=m_aliases.begin(); it != m_aliases.end(); ++it )
1216  {
1217  if( !aIncludeRoot && (*it)->IsRoot() )
1218  continue;
1219 
1220  names.Add( (*it)->GetName() );
1221  }
1222 
1223  return names;
1224 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
const EDA_RECT LIB_PART::GetBodyBoundingBox ( int  aUnit,
int  aConvert 
) const

Get the symbol bounding box excluding fields.

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 720 of file class_libentry.cpp.

References LIB_FIELD_T, m_drawings, m_unitCount, and EDA_RECT::Merge().

Referenced by SCH_COMPONENT::GetBodyBoundingBox().

721 {
722  EDA_RECT bBox;
723  bool initialized = false;
724 
725  for( const LIB_ITEM& item : m_drawings )
726  {
727  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
728  && ( aUnit != item.m_Unit ) ) )
729  continue;
730 
731  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
732  continue;
733 
734  if( item.Type() == LIB_FIELD_T )
735  continue;
736 
737  if( initialized )
738  bBox.Merge( item.GetBoundingBox() );
739  else
740  {
741  bBox = item.GetBoundingBox();
742  initialized = true;
743  }
744  }
745 
746  return bBox;
747 }
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.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
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 339 of file class_libentry.h.

References Save.

340  {
341  return GetUnitBoundingBox( 0, 0 );
342  }
const EDA_RECT GetUnitBoundingBox(int aUnit, int aConvert) const
Get the bounding box for the symbol.
virtual wxString LIB_PART::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 258 of file class_libentry.h.

References LIB_ALIAS::GetName(), and LIB_ALIAS::SetName().

259  {
260  return wxT( "LIB_PART" );
261  }
timestamp_t LIB_PART::GetDateLastEdition ( ) const
inline

Definition at line 284 of file class_libentry.h.

Referenced by SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

284 { return m_dateLastEdition; }
timestamp_t m_dateLastEdition
Date of the last modification.
LIB_ITEMS_CONTAINER& LIB_PART::GetDrawItems ( )
inline

Return a reference to the draw item list.

Returns
LIB_ITEMS_CONTAINER& - Reference to the draw item object container.

Definition at line 666 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::LoadOneSymbol(), LIB_EDIT_FRAME::locateItem(), LIB_EDIT_FRAME::SaveOneSymbol(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

667  {
668  return m_drawings;
669  }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of 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 803 of file class_libentry.cpp.

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

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

804 {
805  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
806  {
807  LIB_FIELD* field = ( LIB_FIELD* ) &item;
808 
809  if( field->GetId() == aId )
810  return field;
811  }
812 
813  return NULL;
814 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
int GetId() const
Definition: lib_field.h:138
void LIB_PART::GetFields ( LIB_FIELDS aList)

Return 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 771 of file class_libentry.cpp.

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

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), SCH_EAGLE_PLUGIN::loadInstance(), NETLIST_EXPORTER_GENERIC::makeLibParts(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and ALIAS_INFO_GENERATOR::SetHtmlFieldTable().

772 {
773  LIB_FIELD* field;
774 
775  // The only caller of this function is the library field editor, so it
776  // establishes policy here.
777 
778  // Grab the MANDATORY_FIELDS first, in expected order given by
779  // enum NumFieldType
780  for( int id=0; id<MANDATORY_FIELDS; ++id )
781  {
782  field = GetField( id );
783 
784  // the MANDATORY_FIELDS are exactly that in RAM.
785  wxASSERT( field );
786 
787  aList.push_back( *field );
788  }
789 
790  // Now grab all the rest of fields.
791  for( LIB_ITEM& item : m_drawings[ LIB_FIELD_T ] )
792  {
793  field = ( LIB_FIELD* ) &item;
794 
795  if( (unsigned) field->GetId() < MANDATORY_FIELDS )
796  continue; // was added above
797 
798  aList.push_back( *field );
799  }
800 }
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...
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
int GetId() const
Definition: lib_field.h:138
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 284 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(), SCH_EDIT_FRAME::copyBlockItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), LIB_EDIT_FRAME::copySelectedItems(), 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(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), 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(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), 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(), EDA_DRAW_PANEL::OnMouseEvent(), 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(), SCH_EDIT_FRAME::OrientComponent(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), TRACKS_CLEANER::removeDuplicatesOfTrack(), 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(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), 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_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

284 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
LIB_FIELD & LIB_PART::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 847 of file class_libentry.cpp.

References FOOTPRINT, and GetField().

Referenced by CMP_TREE_NODE_LIB_ID::Update().

848 {
849  LIB_FIELD* field = GetField( FOOTPRINT );
850  wxASSERT( field != NULL );
851  return *field;
852 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
Field Name Module PCB, i.e. "16DIP300".
wxArrayString& LIB_PART::GetFootprints ( )
inline
PART_LIB* LIB_PART::GetLib ( )
inline

Definition at line 272 of file class_libentry.h.

Referenced by LIB_MANAGER::LIB_BUFFER::CreateBuffer(), PART_LIB::FindAlias(), and LIB_ALIAS::GetLib().

272 { return m_library; }
PART_LIB * m_library
Library the part belongs to if any.
const wxString LIB_PART::GetLibraryName ( )

Definition at line 225 of file class_libentry.cpp.

References PART_LIB::GetName(), and m_library.

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

226 {
227  if( m_library )
228  return m_library->GetName();
229 
230  return wxString( _( "none" ) );
231 }
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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, SCH_GLOBALLABEL, TRACK, DRAWSEGMENT, SCH_LABEL, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, EDGE_MODULE, LIB_POLYLINE, 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, EDA_ITEM::GetClass(), operator<<(), wxPoint::x, and wxPoint::y.

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SELECTION_TOOL::disambiguationMenu(), EDA_ITEM::HitTest(), 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, SCH_SHEET, SCH_COMPONENT, GERBER_DRAW_ITEM, LIB_ITEM, NETINFO_ITEM, TRACK, DIMENSION, SCH_TEXT, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, EDGE_MODULE, MARKER_PCB, LIB_BEZIER, LIB_ARC, ZONE_CONTAINER, LIB_TEXT, SCH_MARKER, LIB_POLYLINE, TEXTE_PCB, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 306 of file base_struct.h.

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

307  {
308  }
const wxString & LIB_PART::GetName ( ) const

Definition at line 266 of file class_libentry.cpp.

References dummy(), and m_aliases.

Referenced by AddAlias(), SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_MANAGER::LIB_BUFFER::CreateBuffer(), LIB_EDIT_FRAME::DisplayCmpDoc(), GetAlias(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), HasAlias(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::initDlg(), LIB_ALIAS::IsRoot(), LIB_EDIT_FRAME::LIB_EDIT_FRAME(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), NETLIST_EXPORTER_GENERIC::makeLibParts(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnExportPart(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick(), LIB_EDIT_FRAME::OnPasteDuplicatePart(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), SCH_EDIT_FRAME::OnSelectUnit(), LIB_EDIT_FRAME::OnUpdateViewDoc(), LIB_PART_LESS_THAN::operator()(), LIB_VIEW_FRAME::RedrawActiveWindow(), RemoveAlias(), RemoveDrawItem(), PART_LIB::ReplacePart(), LIB_EDIT_FRAME::SaveOneSymbol(), SCH_COMPONENT::SCH_COMPONENT(), LIB_EDIT_FRAME::SetCurPart(), ALIAS_INFO_GENERATOR::SetHtmlAliasOf(), LIB_FIELD::SetText(), SCH_REFERENCE_LIST::SortByReferenceOnly(), LIB_MANAGER::UpdatePart(), and LIB_MANAGER::UpdatePartAfterRename().

267 {
268  static wxString dummy;
269 
270  wxCHECK_MSG( m_aliases.size(), dummy, "no aliases defined for symbol" );
271 
272  return m_aliases[0]->GetName();
273 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
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 562 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::empty(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), m_drawings, EDA_ITEM::Type(), and TYPE_NOT_INIT.

563 {
564  if( m_drawings.empty( aType ) )
565  return NULL;
566 
567  if( aItem == NULL )
568  return &( *( m_drawings.begin( aType ) ) );
569 
570  // Search for the last item, assume aItem is of type aType
571  wxASSERT( ( aType == TYPE_NOT_INIT ) || ( aType == aItem->Type() ) );
573 
574  while( ( it != m_drawings.end( aType ) ) && ( aItem != &( *it ) ) )
575  ++it;
576 
577  // Search the next item
578  if( it != m_drawings.end( aType ) )
579  {
580  ++it;
581 
582  if( it != m_drawings.end( aType ) )
583  return &( *it );
584  }
585 
586  return NULL;
587 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
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 501 of file class_libentry.h.

References LIB_PIN_T.

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

502  {
503  return (LIB_PIN*) GetNextDrawItem( (LIB_ITEM*) aItem, LIB_PIN_T );
504  }
LIB_ITEM * GetNextDrawItem(LIB_ITEM *aItem=NULL, KICAD_T aType=TYPE_NOT_INIT)
Return the next draw object pointer.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 616 of file class_libentry.cpp.

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

617 {
618  LIB_PINS pinList;
619 
620  GetPins( pinList, aUnit, aConvert );
621 
622  for( size_t i = 0; i < pinList.size(); i++ )
623  {
624  wxASSERT( pinList[i]->Type() == LIB_PIN_T );
625 
626  if( aNumber == pinList[i]->GetNumber() )
627  return pinList[i];
628  }
629 
630  return NULL;
631 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
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:60
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 590 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::empty(), LIB_PIN_T, and m_drawings.

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().

591 {
592  if( m_drawings.empty( LIB_PIN_T ) )
593  return;
594 
595  /* Notes:
596  * when aUnit == 0: no unit filtering
597  * when aConvert == 0: no convert (shape selection) filtering
598  * when .m_Unit == 0, the body item is common to units
599  * when .m_Convert == 0, the body item is common to shapes
600  */
601  for( LIB_ITEM& item : m_drawings[ LIB_PIN_T ] )
602  {
603  // Unit filtering:
604  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
605  continue;
606 
607  // Shape filtering:
608  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
609  continue;
610 
611  aList.push_back( (LIB_PIN*) &item );
612  }
613 }
bool empty(int aType=UNDEFINED_TYPE)
Definition: multivector.h:224
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
LIB_FIELD & LIB_PART::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 839 of file class_libentry.cpp.

References GetField(), and REFERENCE.

Referenced by LIB_EDIT_FRAME::OnCreateNewPart(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and SCH_COMPONENT::SCH_COMPONENT().

840 {
841  LIB_FIELD* field = GetField( REFERENCE );
842  wxASSERT( field != NULL );
843  return *field;
844 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
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 D_PAD, SCH_COMPONENT, MODULE, ZONE_CONTAINER, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, DELETED_SCH_ITEM, GERBER_DRAW_ITEM, SCH_GLOBALLABEL, TRACK, DRAWSEGMENT, SCH_LABEL, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_TEXT, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, LIB_TEXT, SCH_BITMAP, 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 SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), EDA_ITEM::HitTest(), 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 279 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

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

Definition at line 709 of file class_libentry.h.

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

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

Definition at line 702 of file class_libentry.h.

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

702 { 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

Get the bounding box for the symbol.

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 690 of file class_libentry.cpp.

References LIB_FIELD_T, m_drawings, m_unitCount, and EDA_RECT::Merge().

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

691 {
692  EDA_RECT bBox;
693  bool initialized = false;
694 
695  for( const LIB_ITEM& item : m_drawings )
696  {
697  if( ( item.m_Unit > 0 ) && ( ( m_unitCount > 1 ) && ( aUnit > 0 )
698  && ( aUnit != item.m_Unit ) ) )
699  continue;
700 
701  if( item.m_Convert > 0 && ( ( aConvert > 0 ) && ( aConvert != item.m_Convert ) ) )
702  continue;
703 
704  if ( ( item.Type() == LIB_FIELD_T ) && !( ( LIB_FIELD& ) item ).IsVisible() )
705  continue;
706 
707  if( initialized )
708  bBox.Merge( item.GetBoundingBox() );
709  else
710  {
711  bBox = item.GetBoundingBox();
712  initialized = true;
713  }
714  }
715 
716  return bBox;
717 }
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.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
LIB_FIELD & LIB_PART::GetValueField ( )

Return reference to the value field.

Definition at line 831 of file class_libentry.cpp.

References GetField(), and VALUE.

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), and SetName().

832 {
833  LIB_FIELD* field = GetField( VALUE );
834  wxASSERT( field != NULL );
835  return *field;
836 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Field object used in symbol libraries.
Definition: lib_field.h:59
#define VALUE
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 1227 of file class_libentry.cpp.

References GetName(), and m_aliases.

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

1228 {
1229  wxCHECK2_MSG( !aName.IsEmpty(), return false,
1230  wxT( "Cannot get alias with an empty name, bad programmer." ) );
1231 
1232  for( size_t i = 0; i < m_aliases.size(); i++ )
1233  {
1234  if( aName == m_aliases[i]->GetName() )
1235  return true;
1236  }
1237 
1238  return false;
1239 }
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 907 of file class_libentry.cpp.

References m_drawings.

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

908 {
909  for( const LIB_ITEM& item : m_drawings )
910  {
911  if( item.m_Convert > 1 )
912  return true;
913  }
914 
915  return false;
916 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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, MODULE, VIA, SCH_ITEM, BOARD_ITEM, GERBER_DRAW_ITEM, ZONE_CONTAINER, TRACK, LIB_ITEM, DIMENSION, DRAWSEGMENT, TEXTE_MODULE, LIB_FIELD, LIB_PIN, MARKER_PCB, LIB_ARC, PCB_TARGET, LIB_TEXT, TEXTE_PCB, LIB_BEZIER, LIB_POLYLINE, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 317 of file base_struct.h.

References EDA_ITEM::Clone(), EDA_ITEM::GetBoundingBox(), EDA_ITEM::GetClass(), EDA_ITEM::GetMenuImage(), EDA_ITEM::GetSelectMenuText(), EDA_ITEM::IterateForward(), and EDA_ITEM::Visit().

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

318  {
319  return false; // derived classes should override this function
320  }
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 253 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

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

Definition at line 252 of file base_struct.h.

References HIGHLIGHTED.

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

Definition at line 246 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

246 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:123
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
bool LIB_PART::IsMulti ( ) const
inline
Returns
true if the part has multiple units per part. When true, the reference has a sub reference to identify part.

Definition at line 689 of file class_libentry.h.

Referenced by LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), LIB_EDIT_FRAME::SetCurPart(), LIB_EDIT_FRAME::SynchronizePins(), and CMP_TREE_NODE_LIB_ID::Update().

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

Definition at line 245 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(), LIB_PART(), 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().

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

Definition at line 365 of file class_libentry.h.

References ENTRY_NORMAL.

Referenced by AddMenusForEditComponent().

365 { 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_FIELD, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 473 of file base_struct.h.

References EDA_ITEM::operator<().

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

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

Definition at line 251 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

251 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:128
bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 250 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

250 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:134
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 249 of file base_struct.h.

References IS_WIRE_IMAGE.

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

249 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:204
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(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), 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:180
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:193
bool LIB_PART::LoadDateAndTime ( char *  aLine)

Definition at line 875 of file class_libentry.cpp.

References m_dateLastEdition, and min.

876 {
877  int year, mon, day, hour, min, sec;
878 
879  year = mon = day = hour = min = sec = 0;
880  strtok( aLine, " \r\t\n" );
881  strtok( NULL, " \r\t\n" );
882 
883  if( sscanf( aLine, "%d/%d/%d %d:%d:%d", &year, &mon, &day, &hour, &min, &sec ) != 6 )
884  return false;
885 
886  m_dateLastEdition = ( sec & 63 ) + ( ( min & 63 ) << 6 ) +
887  ( ( hour & 31 ) << 12 ) + ( ( day & 31 ) << 17 ) +
888  ( ( mon & 15 ) << 22 ) + ( ( year - 1990 ) << 26 );
889 
890  return true;
891 }
timestamp_t m_dateLastEdition
Date of the last modification.
#define min(a, b)
Definition: auxiliary.h:85
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 1078 of file class_libentry.cpp.

References m_drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

1080 {
1081  for( LIB_ITEM& item : m_drawings )
1082  {
1083  if( ( aUnit && item.m_Unit && ( aUnit != item.m_Unit) )
1084  || ( aConvert && item.m_Convert && ( aConvert != item.m_Convert ) )
1085  || ( ( item.Type() != aType ) && ( aType != TYPE_NOT_INIT ) ) )
1086  continue;
1087 
1088  if( item.HitTest( aPoint ) )
1089  return &item;
1090  }
1091 
1092  return NULL;
1093 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 1096 of file class_libentry.cpp.

References DefaultTransform, and LocateDrawItem().

1098 {
1099  /* we use LocateDrawItem( int aUnit, int convert, KICAD_T type, const
1100  * wxPoint& pt ) to search items.
1101  * because this function uses DefaultTransform as orient/mirror matrix
1102  * we temporary copy aTransform in DefaultTransform
1103  */
1104  LIB_ITEM* item;
1105  TRANSFORM transform = DefaultTransform;
1106  DefaultTransform = aTransform;
1107 
1108  item = LocateDrawItem( aUnit, aConvert, aType, aPoint );
1109 
1110  // Restore matrix
1111  DefaultTransform = transform;
1112 
1113  return item;
1114 }
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
LIB_ITEM * LocateDrawItem(int aUnit, int aConvert, KICAD_T aType, const wxPoint &aPoint)
Locate a draw object.
void LIB_PART::LockUnits ( bool  aLockUnits)
inline

Set interchangeable the property for part units.

Parameters
aLockUnitswhen true then units are set as not interchangeable.

Definition at line 374 of file class_libentry.h.

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

374 { 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_COMPONENT, SCH_SHEET, SCH_SHEET_PIN, SCH_FIELD, SCH_TEXT, LIB_PIN, and SCH_MARKER.

Definition at line 429 of file base_struct.h.

References EDA_ITEM::Replace().

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

430  {
431  return false;
432  }
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:473
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 1039 of file class_libentry.cpp.

References m_drawings.

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

1040 {
1041  for( LIB_ITEM& item : m_drawings )
1042  {
1043  if( !item.IsSelected() )
1044  continue;
1045 
1046  item.MirrorHorizontal( aCenter );
1047  item.m_Flags = 0;
1048  }
1049 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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 1052 of file class_libentry.cpp.

References m_drawings.

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

1053 {
1054  for( LIB_ITEM& item : m_drawings )
1055  {
1056  if( !item.IsSelected() )
1057  continue;
1058 
1059  item.MirrorVertical( aCenter );
1060  item.m_Flags = 0;
1061  }
1062 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void LIB_PART::MoveSelectedItems ( const wxPoint aOffset)

Move the selected draw items marked by a block select.

Definition at line 962 of file class_libentry.cpp.

References m_drawings.

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

963 {
964  for( LIB_ITEM& item : m_drawings )
965  {
966  if( !item.IsSelected() )
967  continue;
968 
969  item.SetOffset( aOffset );
970  item.m_Flags = 0;
971  }
972 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
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().

Referenced by EDA_ITEM::IsReplaceable(), and LIB_ALIAS::operator==().

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 769 of file class_libentry.h.

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

Return 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 634 of file class_libentry.cpp.

References GetPins().

Referenced by RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

636 {
637  LIB_PINS thisPinList;
638  GetPins( thisPinList, /* aUnit */ 0, /* aConvert */ 0 );
639 
640  for( LIB_PIN* eachThisPin : thisPinList )
641  {
642  wxASSERT( eachThisPin );
643  LIB_PINS otherPinList;
644  aOtherPart.GetPins( otherPinList, /* aUnit */ 0, /* aConvert */ 0 );
645  bool foundMatch = false;
646 
647  for( LIB_PIN* eachOtherPin : otherPinList )
648  {
649  wxASSERT( eachOtherPin );
650  // Same position?
651  if( eachThisPin->GetPosition() != eachOtherPin->GetPosition() )
652  continue;
653 
654  // Same number?
655  if( aTestNums && ( eachThisPin->GetNumber() != eachOtherPin->GetNumber() ))
656  continue;
657 
658  // Same name?
659  if( aTestNames && ( eachThisPin->GetName() != eachOtherPin->GetName() ))
660  continue;
661 
662  // Same electrical type?
663  if( aTestType && ( eachThisPin->GetType() != eachOtherPin->GetType() ))
664  continue;
665 
666  // Same orientation?
667  if( aTestOrientation && ( eachThisPin->GetOrientation() != eachOtherPin->GetOrientation() ))
668  continue;
669 
670  // Same length?
671  if( aTestLength && ( eachThisPin->GetLength() != eachOtherPin->GetLength() ))
672  continue;
673 
674  foundMatch = true;
675  }
676 
677  if( !foundMatch )
678  {
679  // This means there was not an identical (according to the arguments)
680  // pin at the same position in the other component.
681  return true;
682  }
683  }
684 
685  // The loop never gave up, so no conflicts were found.
686  return false;
687 }
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:60
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 436 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

438 {
439  wxASSERT( aPlotter != NULL );
440 
441  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
442  bool fill = aPlotter->GetColorMode();
443 
444  // draw background for filled items using background option
445  // Solid lines will be drawn after the background
446  for( LIB_ITEM& item : m_drawings )
447  {
448  // Lib Fields are not plotted here, because this plot function
449  // is used to plot schematic items, which have they own fields
450  if( item.Type() == LIB_FIELD_T )
451  continue;
452 
453  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
454  continue;
455 
456  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
457  continue;
458 
459  if( item.m_Fill == FILLED_WITH_BG_BODYCOLOR )
460  item.Plot( aPlotter, aOffset, fill, aTransform );
461  }
462 
463  // Not filled items and filled shapes are now plotted
464  // (plot only items which are not already plotted)
465  for( LIB_ITEM& item : m_drawings )
466  {
467  if( item.Type() == LIB_FIELD_T )
468  continue;
469 
470  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
471  continue;
472 
473  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
474  continue;
475 
476  if( item.m_Fill != FILLED_WITH_BG_BODYCOLOR )
477  item.Plot( aPlotter, aOffset, fill, aTransform );
478  }
479 }
virtual void SetColor(COLOR4D color)=0
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
bool GetColorMode() const
Definition: plotter.h:130
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 482 of file class_libentry.cpp.

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

Referenced by LIB_EDIT_FRAME::SVG_PlotComponent().

484 {
485  wxASSERT( aPlotter != NULL );
486 
487  aPlotter->SetColor( GetLayerColor( LAYER_FIELDS ) );
488  bool fill = aPlotter->GetColorMode();
489 
490  for( LIB_ITEM& item : m_drawings )
491  {
492  if( item.Type() != LIB_FIELD_T )
493  continue;
494 
495  if( aUnit && item.m_Unit && ( item.m_Unit != aUnit ) )
496  continue;
497 
498  if( aConvert && item.m_Convert && ( item.m_Convert != aConvert ) )
499  continue;
500 
501  // The reference is a special case: we should change the basic text
502  // to add '?' and the part id
503  LIB_FIELD& field = (LIB_FIELD&) item;
504  wxString tmp = field.GetShownText();
505  if( field.GetId() == REFERENCE )
506  {
507  wxString text = field.GetFullText( aUnit );
508  field.SetText( text );
509  }
510  item.Plot( aPlotter, aOffset, fill, aTransform );
511  field.SetText( tmp );
512  }
513 }
virtual void SetColor(COLOR4D color)=0
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:356
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:167
Field Reference of part, i.e. "IC21".
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
virtual wxString GetShownText() const
Returns the string actually shown after processing of the base text.
Definition: eda_text.h:133
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:502
int GetId() const
Definition: lib_field.h:138
bool GetColorMode() const
Definition: plotter.h:130
void LIB_PART::RemoveAlias ( const wxString &  aName)

Definition at line 1275 of file class_libentry.cpp.

References GetAlias().

Referenced by SCH_LEGACY_PLUGIN_CACHE::DeleteAlias(), SCH_LEGACY_PLUGIN_CACHE::removeAlias(), and LIB_ALIAS::~LIB_ALIAS().

1276 {
1277  LIB_ALIAS* a = GetAlias( aName );
1278 
1279  if( a )
1280  RemoveAlias( a );
1281 }
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 1284 of file class_libentry.cpp.

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

1285 {
1286  wxCHECK_MSG( aAlias, NULL, wxT( "Cannot remove alias by NULL pointer." ) );
1287 
1288  LIB_ALIAS* nextAlias = NULL;
1289 
1290  LIB_ALIASES::iterator it = find( m_aliases.begin(), m_aliases.end(), aAlias );
1291 
1292  if( it != m_aliases.end() )
1293  {
1294  bool rename = aAlias->IsRoot();
1295 
1296  wxLogTrace( traceSchLibMem,
1297  wxT( "%s: symbol:'%s', alias:'%s', alias count %llu, reference count %ld." ),
1298  GetChars( wxString::FromAscii( __WXFUNCTION__ ) ),
1299  GetChars( GetName() ),
1300  GetChars( aAlias->GetName() ),
1301  (long long unsigned) m_aliases.size(),
1302  m_me.use_count() );
1303 
1304  it = m_aliases.erase( it );
1305 
1306  if( !m_aliases.empty() )
1307  {
1308  if( it == m_aliases.end() )
1309  it = m_aliases.begin();
1310 
1311  nextAlias = *it;
1312 
1313  if( rename )
1314  SetName( nextAlias->GetName() );
1315  }
1316  }
1317 
1318  return nextAlias;
1319 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
bool IsRoot() 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
const wxChar traceSchLibMem[]
Flag to enable schematic library memory deletion debug output.
const wxString & GetName() const
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 1322 of file class_libentry.cpp.

References m_aliases.

Referenced by RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), and LIB_EDIT_FRAME::SaveOneSymbol().

1323 {
1324  // Remove all of the aliases except the root alias.
1325  while( m_aliases.size() > 1 )
1326  m_aliases.pop_back();
1327 }
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 516 of file class_libentry.cpp.

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

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

517 {
518  wxASSERT( aItem != NULL );
519 
520  // none of the MANDATORY_FIELDS may be removed in RAM, but they may be
521  // omitted when saving to disk.
522  if( aItem->Type() == LIB_FIELD_T )
523  {
524  LIB_FIELD* field = (LIB_FIELD*) aItem;
525 
526  if( field->GetId() < MANDATORY_FIELDS )
527  {
528  wxLogWarning( _(
529  "An attempt was made to remove the %s field from component %s in library %s." ),
530  GetChars( field->GetName() ), GetChars( GetName() ),
531  GetChars( GetLibraryName() ) );
532  return;
533  }
534  }
535 
536  LIB_ITEMS& items = m_drawings[ aItem->Type() ];
537 
538  for( LIB_ITEMS::iterator i = items.begin(); i != items.end(); i++ )
539  {
540  if( *i == aItem )
541  {
542  if( aDc != NULL )
543  aItem->Draw( aPanel, aDc, wxPoint( 0, 0 ), COLOR4D::UNSPECIFIED,
544  g_XorMode, NULL, DefaultTransform );
545 
546  items.erase( i );
547  SetModified();
548  break;
549  }
550  }
551 }
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:73
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
void SetModified()
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
LIB_ITEMS_CONTAINER::ITEM_PTR_VECTOR LIB_ITEMS
int GetId() const
Definition: lib_field.h:138
wxString GetName(bool aTranslate=true) const
Returns the field name.
Definition: lib_field.cpp:432
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:58
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.
const wxString & GetName() const
void LIB_PART::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 901 of file class_libentry.cpp.

References m_drawings, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::unique().

Referenced by LIB_EDIT_FRAME::LoadOneSymbol().

902 {
903  m_drawings.unique();
904 }
void unique()
Remove duplicate elements in list.
Definition: multivector.h:238
LIB_ITEMS_CONTAINER m_drawings
Drawing items of 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(), EDA_ITEM::IsReplaceable(), and traceFindReplace.

Referenced by EDA_ITEM::Matches(), 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:473
const wxString traceFindReplace
Flag to enable find and replace debug tracing.
Definition: base_struct.cpp:58
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 461 of file base_struct.h.

461 { 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 1065 of file class_libentry.cpp.

References m_drawings.

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

1066 {
1067  for( LIB_ITEM& item : m_drawings )
1068  {
1069  if( !item.IsSelected() )
1070  continue;
1071 
1072  item.Rotate( aCenter );
1073  item.m_Flags = 0;
1074  }
1075 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
bool LIB_PART::Save ( OUTPUTFORMATTER aFormatter)

Write 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.
bool LIB_PART::SaveDateAndTime ( OUTPUTFORMATTER aFormatter)

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 855 of file class_libentry.cpp.

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

856 {
857  int year, mon, day, hour, min, sec;
858 
859  if( m_dateLastEdition == 0 )
860  return true;
861 
862  sec = m_dateLastEdition & 63;
863  min = ( m_dateLastEdition >> 6 ) & 63;
864  hour = ( m_dateLastEdition >> 12 ) & 31;
865  day = ( m_dateLastEdition >> 17 ) & 31;
866  mon = ( m_dateLastEdition >> 22 ) & 15;
867  year = ( m_dateLastEdition >> 26 ) + 1990;
868 
869  aFormatter.Print( 0, "Ti %d/%d/%d %d:%d:%d\n", year, mon, day, hour, min, sec );
870 
871  return true;
872 }
timestamp_t m_dateLastEdition
Date of the last modification.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
#define min(a, b)
Definition: auxiliary.h:85
int LIB_PART::SelectItems ( EDA_RECT aRect,
int  aUnit,
int  aConvert,
bool  aSyncPinEdit 
)

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.
aSyncPinEdit- Enable pin selection in other units.
Returns
The number of draw objects found inside the block select rectangle.

Definition at line 928 of file class_libentry.cpp.

References LIB_PIN_T, m_drawings, m_unitsLocked, and SELECTED.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd().

929 {
930  int itemCount = 0;
931 
932  for( LIB_ITEM& item : m_drawings )
933  {
934  item.ClearFlags( SELECTED );
935 
936  if( ( item.m_Unit && item.m_Unit != aUnit )
937  || ( item.m_Convert && item.m_Convert != aConvert ) )
938  {
939  if( item.Type() != LIB_PIN_T )
940  continue;
941 
942  // Specific rules for pins:
943  // - do not select pins in other units when synchronized pin edit mode is disabled
944  // - do not select pins in other units when units are not interchangeable
945  // - in other cases verify if the pin belongs to the requested unit
946  if( !aSyncPinEdit || m_unitsLocked
947  || ( item.m_Convert && item.m_Convert != aConvert ) )
948  continue;
949  }
950 
951  if( item.Inside( aRect ) )
952  {
953  item.SetFlags( SELECTED );
954  itemCount++;
955  }
956  }
957 
958  return itemCount;
959 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
#define SELECTED
Definition: base_struct.h:134
void LIB_PART::SetAliases ( const wxArrayString &  aAliasList)

Definition at line 1242 of file class_libentry.cpp.

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

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnOkClick().

1243 {
1244  wxCHECK_RET( !m_library,
1245  wxT( "Symbol aliases cannot be changed when they are owned by a library." ) );
1246  wxCHECK_RET( !aAliasList.IsEmpty(), wxT( "Alias list cannot be empty" ) );
1247 
1248  if( aAliasList == GetAliasNames() )
1249  return;
1250 
1251  // Add names not existing in the current component alias list.
1252  for( size_t i = 0; i < aAliasList.GetCount(); i++ )
1253  {
1254  if( HasAlias( aAliasList[ i ] ) )
1255  continue;
1256 
1257  m_aliases.push_back( new LIB_ALIAS( aAliasList[ i ], this ) );
1258  }
1259 
1260  // Remove names in the current component that are not in the new alias list.
1261  LIB_ALIASES::iterator it = m_aliases.begin();
1262 
1263  while( it != m_aliases.end() )
1264  {
1265  int index = aAliasList.Index( (*it)->GetName(), false );
1266 
1267  if( index != wxNOT_FOUND || (*it)->IsRoot() )
1268  ++it;
1269  else
1270  it = m_aliases.erase( it );
1271  }
1272 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
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
void EDA_ITEM::SetBack ( EDA_ITEM aBack)
inlineinherited

Definition at line 241 of file base_struct.h.

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

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

Definition at line 258 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::disambiguationMenu().

258 { SetFlags( BRIGHTENED ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:282
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
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 1164 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), HasConversion(), LIB_PIN_T, LIB_ITEM::m_Convert, and m_drawings.

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

1165 {
1166  if( aSetConvert == HasConversion() )
1167  return;
1168 
1169  // Duplicate items to create the converted shape
1170  if( aSetConvert )
1171  {
1172  std::vector< LIB_ITEM* > tmp; // Temporarily store the duplicated pins here.
1173 
1174  for( LIB_ITEM& item : m_drawings )
1175  {
1176  // Only pins are duplicated.
1177  if( item.Type() != LIB_PIN_T )
1178  continue;
1179 
1180  if( item.m_Convert == 1 )
1181  {
1182  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1183  newItem->m_Convert = 2;
1184  tmp.push_back( newItem );
1185  }
1186  }
1187 
1188  // Transfer the new pins to the LIB_PART.
1189  for( unsigned i = 0; i < tmp.size(); i++ )
1190  m_drawings.push_back( tmp[i] );
1191  }
1192  else
1193  {
1194  // Delete converted shape items because the converted shape does
1195  // not exist
1196  LIB_ITEMS_CONTAINER::ITERATOR i = m_drawings.begin();
1197 
1198  while( i != m_drawings.end() )
1199  {
1200  if( i->m_Convert > 1 )
1201  i = m_drawings.erase( i );
1202  else
1203  ++i;
1204  }
1205  }
1206 }
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.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
int m_Convert
Shape identification for alternate body styles.
void LIB_PART::SetFields ( const std::vector< LIB_FIELD > &  aFieldsList)

Overwrite all the existing fields in this symbol 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 756 of file class_libentry.cpp.

References deleteAllFields(), m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and EDA_ITEM::SetParent().

Referenced by DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick().

757 {
758  deleteAllFields();
759 
760  for( unsigned i=0; i<aFields.size(); ++i )
761  {
762  // drawings is a ptr_vector, new and copy an object on the heap.
763  LIB_FIELD* field = new LIB_FIELD( aFields[i] );
764 
765  field->SetParent( this );
766  m_drawings.push_back( field );
767  }
768 }
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
void deleteAllFields()
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:242
void push_back(T *aItem)
Definition: multivector.h:169
void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 282 of file base_struct.h.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_SCREEN::addConnectedItemsToBlock(), AddSegmentToDragList(), PCBNEW_CONTROL::AppendBoard(), 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(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), CopySelectedItems(), LIB_EDIT_FRAME::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(), SCH_EDIT_FRAME::DeleteItem(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), 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_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::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(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), 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(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_SCREEN::SelectBlockItems(), EDA_ITEM::SetBrightened(), LIB_PIN::SetConversion(), BLOCK_SELECTOR::SetFlags(), EDA_ITEM::SetHighlighted(), EDA_ITEM::SetModified(), 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().

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

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

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

Definition at line 257 of file base_struct.h.

References HIGHLIGHTED, and EDA_ITEM::SetFlags().

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

Definition at line 274 of file class_libentry.h.

Referenced by LEGACY_RESCUER::AddPart(), PART_LIB::FindAlias(), LIB_PART(), and PART_LIB::LoadLibrary().

274 { 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 268 of file class_libentry.h.

References LIB_ALIAS::GetLibraryName().

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction().

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

Definition at line 243 of file base_struct.h.

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

243 { m_List = aList; }
DHEAD * m_List
which DLIST I am on.
Definition: base_struct.h:195
void EDA_ITEM::SetModified ( )
inherited
void LIB_PART::SetName ( const wxString &  aName)
virtual

Definition at line 276 of file class_libentry.cpp.

References EDA_TEXT::GetText(), GetValueField(), m_aliases, m_libId, LIB_ID::SetLibItemName(), and LIB_FIELD::SetText().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibrary(), LIB_EDIT_FRAME::EditField(), LIB_EDIT_FRAME::fixDuplicateAliases(), LIB_PART(), DIALOG_CHOOSE_COMPONENT::OnSchViewPaint(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), LIB_VIEW_FRAME::RedrawActiveWindow(), RemoveAlias(), and LIB_FIELD::SetText().

277 {
278  m_libId.SetLibItemName( aName, false );
279 
280  // The LIB_ALIAS that is the LIB_PART name has to be created so create it.
281  if( m_aliases.size() == 0 )
282  m_aliases.push_back( new LIB_ALIAS( aName, this ) );
283  else
284  m_aliases[0]->SetName( aName );
285 
286  LIB_FIELD& valueField = GetValueField();
287 
288  // LIB_FIELD::SetText() calls LIB_PART::SetName(),
289  // the following if-clause is to break an infinite loop
290  if( valueField.GetText() != aName )
291  valueField.SetText( aName );
292 
293 }
LIB_ALIASES m_aliases
List of alias object pointers associated with the part.
Part library alias object definition.
Field object used in symbol libraries.
Definition: lib_field.h:59
LIB_FIELD & GetValueField()
Return reference to the value field.
void SetText(const wxString &aText) override
Sets the field text to aText.
Definition: lib_field.cpp:502
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:128
LIB_ID m_libId
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:232
void EDA_ITEM::SetNext ( EDA_ITEM aNext)
inlineinherited

Definition at line 240 of file base_struct.h.

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

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

Definition at line 368 of file class_libentry.h.

References ENTRY_NORMAL.

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

368 { 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 894 of file class_libentry.cpp.

References m_drawings.

895 {
896  for( LIB_ITEM& item : m_drawings )
897  item.SetOffset( aOffset );
898 }
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlineinherited

Definition at line 242 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(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), DIALOG_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), LIB_PART(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), MODULE::MODULE(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditReference(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnEditValue(), DIALOG_LIB_EDIT_PIN::OnPaintShowPanel(), MODULE::operator=(), SCH_COMPONENT::operator=(), PCB_PARSER::parseMODULE_unchecked(), LIB_EDIT_FRAME::pasteClipboard(), PCBNEW_CONTROL::PasteItemsFromClipboard(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), 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(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

242 { m_Parent = aParent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:197
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 747 of file class_libentry.h.

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

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

Definition at line 367 of file class_libentry.h.

References ENTRY_POWER.

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

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

Definition at line 256 of file base_struct.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by LIB_EDIT_FRAME::pasteClipboard(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SELECTION_TOOL::selectVisually().

256 { SetFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:134
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:282
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 756 of file class_libentry.h.

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

756 { 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 765 of file class_libentry.h.

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

765 { 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 1364 of file class_libentry.cpp.

References m_subpartFirstId, and m_subpartIdSeparator.

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

1365 {
1366  m_subpartFirstId = 'A';
1368 
1369  if( aSep == '.' || aSep == '-' || aSep == '_' )
1370  m_subpartIdSeparator = aSep;
1371 
1372  if( aFirstId == '1' && aSep != 0 )
1373  m_subpartFirstId = aFirstId;
1374 }
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 &#39;A&#39;...
void EDA_ITEM::SetTimeStamp ( timestamp_t  aNewTimeStamp)
inlineinherited

Definition at line 232 of file base_struct.h.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::CreateSheet(), Diagnose(), DuplicateItemsInList(), DuplicateStruct(), EDIT_TOOL::editFootprintInFpEditor(), PCB_EDIT_FRAME::Exchange_Module(), DIALOG_FOOTPRINT_BOARD_EDITOR::GotoModuleEditor(), EDA_ITEM::initVars(), BOARD::InsertArea(), 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(), PCB_PARSER::parseDIMENSION(), 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(), SwapItemData(), and TestDuplicateSheetNames().

232 { m_TimeStamp = aNewTimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:198
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 1117 of file class_libentry.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), EDA_ITEM::Clone(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), m_drawings, LIB_ITEM::m_Unit, and m_unitCount.

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

1118 {
1119  if( m_unitCount == aCount )
1120  return;
1121 
1122  if( aCount < m_unitCount )
1123  {
1125 
1126  while( i != m_drawings.end() )
1127  {
1128  if( i->m_Unit > aCount )
1129  i = m_drawings.erase( i );
1130  else
1131  ++i;
1132  }
1133  }
1134  else
1135  {
1136  int prevCount = m_unitCount;
1137 
1138  // Temporary storage for new items, as adding new items directly to
1139  // m_drawings may cause the buffer reallocation which invalidates the
1140  // iterators
1141  std::vector< LIB_ITEM* > tmp;
1142 
1143  for( LIB_ITEM& item : m_drawings )
1144  {
1145  if( item.m_Unit != 1 )
1146  continue;
1147 
1148  for( int j = prevCount + 1; j <= aCount; j++ )
1149  {
1150  LIB_ITEM* newItem = (LIB_ITEM*) item.Clone();
1151  newItem->m_Unit = j;
1152  tmp.push_back( newItem );
1153  }
1154  }
1155 
1156  for( auto item : tmp )
1157  m_drawings.push_back( item );
1158  }
1159 
1160  m_unitCount = aCount;
1161 }
ITERATOR begin(int aType=UNDEFINED_TYPE)
Definition: multivector.h:183
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.
LIB_ITEMS_CONTAINER m_drawings
Drawing items of this part.
int m_Unit
Unit identification for multiple parts per package.
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:66
ITERATOR end(int aType=UNDEFINED_TYPE)
Definition: multivector.h:189
ITERATOR erase(const ITERATOR &aIterator)
Definition: multivector.h:174
ITERATOR_BASE< LIB_ITEM, MULTIVECTOR< LIB_ITEM, FIRST_TYPE_VAL, LAST_TYPE_VAL >, typename ITEM_PTR_VECTOR::iterator > ITERATOR
The non-const iterator
Definition: multivector.h:160
void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 255 of file base_struct.h.

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

Referenced by moveItemWithMouseCursor().

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

Definition at line 252 of file class_libentry.h.

Referenced by SCH_COMPONENT::Resolve(), SCH_COMPONENT::SCH_COMPONENT(), and SCH_COMPONENT::SetLibId().

253  {
254  // clone a shared pointer
255  return m_me;
256  }
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 758 of file class_libentry.h.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

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

Definition at line 767 of file class_libentry.h.

Referenced by LIB_PIN::drawGraphic(), LIB_PIN::GetBoundingBox(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), and SCH_LEGACY_PLUGIN_CACHE::saveSymbol().

767 { 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 492 of file base_struct.h.

References EDA_ITEM::Matches(), EDA_ITEM::operator=(), EDA_ITEM::ViewBBox(), and EDA_ITEM::ViewGetLayers().

Referenced by PART_LIB::GetEntryTypePowerNames().

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

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

Definition at line 713 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

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

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

Definition at line 707 of file class_libentry.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParametersList().

707 { 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
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 234 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(), TestMultiunitFootprints(), and LIB_EDIT_FRAME::UpdatePartSelectList().

235 {
236  wxString subRef;
237 
238  if( m_subpartIdSeparator != 0 && aAddSeparator )
239  subRef << wxChar( m_subpartIdSeparator );
240 
241  if( m_subpartFirstId >= '0' && m_subpartFirstId <= '9' )
242  subRef << aUnit;
243  else
244  {
245  // use letters as notation. To allow more than 26 units, the sub ref
246  // use one letter if letter = A .. Z or a ... z, and 2 letters otherwise
247  // first letter is expected to be 'A' or 'a' (i.e. 26 letters are available)
248  int u;
249  aUnit -= 1; // Unit number starts to 1. now to 0.
250 
251  while( aUnit >= 26 ) // more than one letter are needed
252  {
253  u = aUnit / 26;
254  subRef << wxChar( m_subpartFirstId + u -1 );
255  aUnit %= 26;
256  }
257 
258  u = m_subpartFirstId + aUnit;
259  subRef << wxChar( u );
260  }
261 
262  return subRef;
263 }
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 &#39;A&#39;...
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 227 of file base_struct.h.

References EDA_ITEM::m_StructType.

Referenced by Abort_Move_ModuleOutline(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), MODULE::Add(), CN_CLUSTER::Add(), BOARD::Add(), CN_CONNECTIVITY_ALGO::Add(), PCB_EDIT_FRAME::Add45DegreeSegment(), SCH_SCREEN::addConnectedItemsToBlock(), POINT_EDITOR::addCorner(), POINT_EDITOR::addCornerCondition(), SCH_EDIT_FRAME::addCurrentItemToList(), AddMenusForComponent(), AddMenusForEditComponent(), SCH_SHEET::AddPin(), 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(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SCREENS::buildScreenList(), SCH_SHEET_LIST::BuildSheetList(), calcArea(), calcMaxArea(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), ROUTER_TOOL::CanInlineDrag(), DIALOG_EXCHANGE_FOOTPRINTS::changeSameFootprints(), SCH_SCREENS::ChangeSymbolLibNickname(), SCH_EDIT_FRAME::CheckListConnections(), TEXTE_PCB::ClassOf(), EDGE_MODULE::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), TEXTE_MODULE::ClassOf(), DRAWSEGMENT::ClassOf(), TRACK::ClassOf(), NETINFO_ITEM::ClassOf(), MODULE::ClassOf(), D_PAD::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(), SCH_SCREEN::CountConnectedItems(), SCH_SHEET::CountSheets(), MODULE::CoverageRatio(), LIB_EDIT_FRAME::CreateGraphicItem(), 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(), DeleteNullTrackSegments(), PYTHON_ACTION_PLUGINS::deregister_action(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), DIALOG_ERC::DisplayERC_MarkersList(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DrawMovePin(), DrawMovingBlockOutlines(), drawPickedItems(), CN_ITEM::Dump(), 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(), EDIT_TOOL::FootprintFilter(), FootprintWriteShape(), PCB_IO::Format(), PCB_IO::format(), FormatProbeItem(), POINT_EDITOR::get45DegConstrainer(), getAnchorPoint(), TRACK::GetBestInsertPoint(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetClearance(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), NETLIST_OBJECT::GetComponentParent(), SCH_SCREEN::GetConnection(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetEndPoints(), SCH_SHEET::GetEndPoints(), GetFirstTrack(), GetFirstVia(), SCH_SCREEN::GetHierarchicalItems(), SCH_SCREENS::GetLibNicknames(), TEXTE_PCB::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), BOARD_CONNECTED_ITEM::GetNetClass(), CONNECTIVITY_DATA::GetNetItems(), GetNextDrawItem(), DRAWSEGMENT::GetParentModule(), SCH_SCREEN::GetPin(), GetPin(), SCH_COMPONENT::GetPinPhysicalPosition(), getRect(), SELECTION::GetTopLeftItem(), LIB_EDIT_FRAME::GlobalSetPins(), SELECTION_TOOL::guessSelectionCandidates(), hash_eda(), SCH_SCREENS::HasNoFullyDefinedLibIds(), 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(), CN_ANCHOR::IsDangling(), SCH_TEXT::IsDanglingStateChanged(), SCH_COLLECTOR::IsNode(), TRACK::IsNull(), SCH_LINE::IsParallel(), SCH_SCREEN::IsTerminalPoint(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), CLIPBOARD_IO::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(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MarkItemsInBloc(), BOARD::MarkTrace(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), TRACKS_CLEANER::MergeCollinearTracks(), SCH_LINE::MergeOverlap(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), moveItemWithMouseCursor(), MoveMarkedItems(), MoveMarkedItemsExactly(), ROUTER_TOOL::NeighboringSegmentFilter(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), 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_SHEET::operator=(), SCH_COMPONENT::operator=(), LIB_ITEM::operator==(), OrCell_Trace(), SCH_EDIT_FRAME::OrientComponent(), BOARD_COMMIT::parentObject(), PCBNEW_CONTROL::PasteItemsFromClipboard(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), LIB_EDIT_FRAME::PlacePin(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), SCH_EDIT_FRAME::PrepareMoveItem(), GAL_ARRAY_CREATOR::prePushAction(), 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(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), MODULE::Remove(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), POINT_EDITOR::removeCorner(), POINT_EDITOR::removeCornerCondition(), RemoveDrawItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), 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(), GERBVIEW_SELECTION_TOOL::RequestSelection(), 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(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_EDIT_FRAME::SaveUndoItemInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), CN_CONNECTIVITY_ALGO::searchConnections(), 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_NO_CONNECT::SwapData(), SCH_JUNCTION::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_FIELD::SwapData(), SCH_SHEET_PIN::SwapData(), TEXTE_PCB::SwapData(), DIMENSION::SwapData(), DRAWSEGMENT::SwapData(), TRACK::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), VIA::SwapData(), ZONE_CONTAINER::SwapData(), MODULE::SwapData(), D_PAD::SwapData(), SwapItemData(), PCB_EDIT_FRAME::SwitchLayer(), TestDuplicateSheetNames(), TRACKS_CLEANER::testTrackEndpointDangling(), TEXTE_MODULE::TEXTE_MODULE(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), 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(), GERBER_DRAW_ITEM::Visit(), EDA_ITEM::Visit(), SCH_SHEET::Visit(), and SCH_COMPONENT::Visit().

228  {
229  return m_StructType;
230  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:189
bool LIB_PART::UnitsLocked ( ) const
inline

Check whether part units are interchangeable.

Returns
False when interchangeable, true otherwise.

Definition at line 380 of file class_libentry.h.

References TYPE_NOT_INIT.

Referenced by DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyOptionsToPanel(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::InitBasicPanel(), SCH_REFERENCE::IsUnitsLocked(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), LIB_EDIT_FRAME::OnEditComponentProperties(), LIB_EDIT_FRAME::OnUpdateSyncPinEdit(), SCH_LEGACY_PLUGIN_CACHE::saveSymbol(), LIB_EDIT_FRAME::SetCurPart(), and LIB_EDIT_FRAME::SynchronizePins().

380 { return m_unitsLocked; }
bool m_unitsLocked
True if part has multiple units and changing one unit does not automatically change another unit...
const BOX2I EDA_ITEM::ViewBBox ( ) const
overridevirtualinherited

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

Returns
BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

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

Definition at line 267 of file base_struct.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by SELECTION_TOOL::selectable(), SELECTION_TOOL::selectMultiple(), EDA_ITEM::Sort(), 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:589
virtual void KIGFX::VIEW_ITEM::ViewDraw ( int  aLayer,
VIEW aView 
) const
inlinevirtualinherited

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

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

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

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

Definition at line 115 of file view_item.h.

References KIGFX::VIEW_ITEM::ViewGetLayers().

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

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

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

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

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

Implements KIGFX::VIEW_ITEM.

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

Definition at line 275 of file base_struct.cpp.

Referenced by EDA_ITEM::Sort().

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 (LOD) of the item.

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

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

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

Definition at line 139 of file view_item.h.

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

140  {
141  // By default always show the item
142  return 0;
143  }
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, MODULE, SCH_COMPONENT, SCH_SHEET, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, TRACK, and GBR_LAYOUT.

Definition at line 151 of file base_struct.cpp.

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

Referenced by SCH_SHEET::CanConnect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), EDA_ITEM::HitTest(), 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:227
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
virtual wxString GetClass() const =0
Function GetClass returns the class name.

Member Data Documentation

LIB_ALIASES LIB_PART::m_aliases
private

List of alias object pointers associated with the part.

Definition at line 230 of file class_libentry.h.

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

timestamp_t LIB_PART::m_dateLastEdition
private

Date of the last modification.

Definition at line 224 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 204 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(), 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_ITEM::EndEdit(), LIB_FIELD::EndEdit(), EDA_ITEM::GetFlags(), TRACK::GetMsgPanelInfoBase_Common(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), GERBER_DRAW_ITEM::HitTest(), SCH_COMPONENT::HitTest(), LIB_ITEM::InEditMode(), EDA_ITEM::initVars(), SCH_ITEM::IsConnected(), 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 228 of file class_libentry.h.

Referenced by LIB_PART().

bool EDA_ITEM::m_forceVisible
protectedinherited

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

Definition at line 201 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 217 of file class_libentry.h.

Referenced by LIB_PART(), and SetName().

PART_LIB* LIB_PART::m_library
private

Library the part belongs to if any.

Definition at line 232 of file class_libentry.h.

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

DHEAD* EDA_ITEM::m_List
protectedinherited

which DLIST I am on.

Definition at line 195 of file base_struct.h.

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

LIBRENTRYOPTIONS LIB_PART::m_options
private

Special part features such as POWER or NORMAL.)

Definition at line 225 of file class_libentry.h.

Referenced by LIB_PART().

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 218 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNames
private

Determines if part pin names are visible.

Definition at line 222 of file class_libentry.h.

Referenced by LIB_PART().

bool LIB_PART::m_showPinNumbers
private

Determines if part pin numbers are visible.

Definition at line 223 of file class_libentry.h.

Referenced by LIB_PART().

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 237 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), 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 234 of file class_libentry.h.

Referenced by SetSubpartIdNotation(), and SubReference().

int LIB_PART::m_unitCount
private

Number of units (parts) per package.

Definition at line 226 of file class_libentry.h.

Referenced by GetBodyBoundingBox(), GetUnitBoundingBox(), LIB_PART(), 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 220 of file class_libentry.h.

Referenced by LIB_PART(), and SelectItems().

EDA_ITEM* EDA_ITEM::Pback
protectedinherited

previous in linked list

Definition at line 194 of file base_struct.h.

Referenced by SCH_LINE::Back(), TRACK::Back(), BOARD_ITEM::Back(), EDA_ITEM::Back(), EDA_ITEM::initVars(), and TRACK::SetBack().


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