Define a library symbol object. More...

#include <lib_symbol.h>

Inheritance diagram for LIB_SYMBOL:

Public Member Functions
	LIB_SYMBOL (const wxString &aName, LIB_SYMBOL aParent=nullptr, SYMBOL_LIB aLibrary=nullptr)

	LIB_SYMBOL (const LIB_SYMBOL &aSymbol, SYMBOL_LIB *aLibrary=nullptr)

virtual	~LIB_SYMBOL ()
	http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared More...

LIB_SYMBOL_SPTR	SharedPtr () const

virtual LIB_SYMBOL *	Duplicate () const
	Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children. More...

void	SetParent (LIB_SYMBOL *aParent=nullptr)

LIB_SYMBOL_REF &	GetParent ()

const LIB_SYMBOL_REF &	GetParent () const

unsigned	GetInheritanceDepth () const
	Get the number of parents for this symbol. More...

LIB_SYMBOL_SPTR	GetRootSymbol () const
	Get the parent symbol that does not have another parent. More...

void	ClearCaches ()

virtual wxString	GetClass () const override
	Return the class name. More...

virtual void	SetName (const wxString &aName)

wxString	GetName () const override

LIB_ID &	LibId ()

LIB_ID	GetLibId () const override

void	SetLibId (const LIB_ID &aLibId)

LIB_ID	GetSourceLibId () const

void	SetSourceLibId (const LIB_ID &aLibId)

wxString	GetLibNickname () const override
	Sets the Description field text value. More...

void	SetDescription (const wxString &aDescription)
	Gets the Description field text value *‍/. More...

wxString	GetDescription () override

void	SetKeyWords (const wxString &aKeyWords)

wxString	GetKeyWords () const

std::vector< SEARCH_TERM >	GetSearchTerms () override

wxString	GetFootprint () override
	For items with footprint fields. More...

void	GetChooserFields (std::map< wxString, wxString > &aColumnMap) override
	Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc. More...

bool	IsRoot () const override
	For symbols derived from other symbols, IsRoot() indicates no derivation. More...

bool	IsAlias () const

const wxString	GetLibraryName () const

SYMBOL_LIB *	GetLib () const

void	SetLib (SYMBOL_LIB *aLibrary)

timestamp_t	GetLastModDate () const

void	SetFPFilters (const wxArrayString &aFilters)

wxArrayString	GetFPFilters () const

void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

const BOX2I	GetUnitBoundingBox (int aUnit, int aConvert, bool aIgnoreHiddenFields=true) const
	Get the bounding box for the symbol. More...

const BOX2I	GetBodyBoundingBox (int aUnit, int aConvert, bool aIncludePins, bool aIncludePrivateItems) const
	Get the symbol bounding box excluding fields. More...

const BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...

bool	IsPower () const

bool	IsNormal () const

void	SetPower ()

void	SetNormal ()

void	LockUnits (bool aLockUnits)
	Set interchangeable the property for symbol units. More...

bool	UnitsLocked () const
	Check whether symbol 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 (std::vector< LIB_FIELD * > &aList)
	Return a list of fields within this symbol. More...

void	GetFields (std::vector< LIB_FIELD > &aList)

void	AddField (LIB_FIELD *aField)
	Add a field. More...

void	AddField (LIB_FIELD &aField)

LIB_FIELD *	FindField (const wxString &aFieldName, bool aCaseInsensitive=false)
	Find a field within this symbol matching aFieldName and returns it or NULL if not found. More...

const LIB_FIELD *	FindField (const wxString &aFieldName, const bool aCaseInsensitive=false) const

LIB_FIELD *	GetFieldById (int aId) const
	Return pointer to the requested field. More...

LIB_FIELD &	GetValueField ()
	Return reference to the value field. More...

LIB_FIELD &	GetReferenceField ()
	Return reference to the reference designator field. More...

LIB_FIELD &	GetFootprintField ()
	Return reference to the footprint field. More...

LIB_FIELD &	GetDatasheetField ()
	Return reference to the datasheet field. More...

LIB_FIELD &	GetDescriptionField ()
	Return reference to the description field. More...

wxString	GetPrefix ()

void	RunOnChildren (const std::function< void(LIB_ITEM *)> &aFunction)

int	UpdateFieldOrdinals ()
	Order optional field indices. More...

int	GetNextAvailableFieldId () const

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, int aMulti, int aConvert, const LIB_SYMBOL_OPTIONS &aOpts, bool aDimmed)
	Print symbol. More...

void	PrintBackground (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, int aMulti, int aConvert, const LIB_SYMBOL_OPTIONS &aOpts, bool aDimmed)
	Print just the background fills of a symbol. More...

void	Plot (PLOTTER *aPlotter, int aUnit, int aConvert, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed) const
	Plot lib symbol to plotter. More...

void	PlotLibFields (PLOTTER *aPlotter, int aUnit, int aConvert, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed, bool aPlotHidden=true)
	Plot Lib Fields only of the symbol to plotter. More...

void	AddDrawItem (LIB_ITEM *aItem, bool aSort=true)
	Add a new draw aItem to the draw object list and sort according to aSort. More...

void	RemoveDrawItem (LIB_ITEM *aItem)
	Remove draw aItem from list. More...

void	RemoveField (LIB_FIELD *aField)

size_t	GetFieldCount () const

void	GetPins (LIB_PINS &aList, int aUnit=0, int aConvert=0) const
	Return a list of pin object pointers from the draw item list. More...

std::vector< LIB_PIN * >	GetAllLibPins () const
	Return a list of pin pointers for all units / converts. More...

int	GetPinCount () override

LIB_PIN *	GetPin (const wxString &aNumber, int aUnit=0, int aConvert=0) const
	Return pin object with the requested pin aNumber. More...

bool	PinsConflictWith (const LIB_SYMBOL &aOtherSymbol, bool aTestNums, bool aTestNames, bool aTestType, bool aTestOrientation, bool aTestLength) const
	Return true if this symbol's pins do not match another symbol's pins. More...

void	SetOffset (const VECTOR2I &aOffset)
	Move the symbol aOffset. More...

void	RemoveDuplicateDrawItems ()
	Remove duplicate draw items from list. More...

bool	HasConversion () const
	Test if symbol has more than one body conversion type (DeMorgan). More...

int	GetMaxPinNumber () const

void	ClearTempFlags ()
	Clears the status flag all draw objects in this symbol. More...

void	ClearEditFlags ()

LIB_ITEM *	LocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const VECTOR2I &aPoint)
	Locate a draw object. More...

LIB_ITEM *	LocateDrawItem (int aUnit, int aConvert, KICAD_T aType, const VECTOR2I &aPoint, const TRANSFORM &aTransform)
	Locate a draw object (overlaid) More...

LIB_ITEMS_CONTAINER &	GetDrawItems ()
	Return a reference to the draw item list. More...

const LIB_ITEMS_CONTAINER &	GetDrawItems () const

void	FixupDrawItems ()
	This function finds the filled draw items that are covering up smaller draw items and replaces their body fill color with the background fill color. More...

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

void	SetUnitCount (int aCount, bool aDuplicateDrawItems=true)
	Set the units per symbol count. More...

int	GetUnitCount () const override
	For items with units, return the number of units. More...

wxString	GetUnitReference (int aUnit) override
	Return an identifier for aUnit for symbols with units. More...

bool	HasUnitDisplayName (int aUnit) override
	Return true if the given unit aUnit has a display name defined. More...

wxString	GetUnitDisplayName (int aUnit) override
	Return the user-defined display name for aUnit for symbols with units. More...

void	CopyUnitDisplayNames (std::map< int, wxString > &aTarget) const
	Copy all unit display names into the given map aTarget. More...

void	SetUnitDisplayName (int aUnit, const wxString &aName)
	Set the user-defined display name for aUnit to aName for symbols with units. More...

bool	IsMulti () const

void	SetConversion (bool aSetConvert, bool aDuplicatePins=true)
	Set or clear the alternate body style (DeMorgan) for the symbol. More...

void	SetPinNameOffset (int aOffset)
	Set the offset in mils of the pin name text from the pin symbol. More...

int	GetPinNameOffset () const

void	SetShowPinNames (bool aShow)
	Set or clear the pin name visibility flag. More...

bool	ShowPinNames () const

void	SetShowPinNumbers (bool aShow)
	Set or clear the pin number visibility flag. More...

bool	ShowPinNumbers () const

void	SetExcludedFromSim (bool aExcludeFromSim)
	Set or clear the exclude from simulation flag. More...

bool	GetExcludedFromSim () const

void	SetExcludedFromBOM (bool aExcludeFromBOM)
	Set or clear the exclude from schematic bill of materials flag. More...

bool	GetExcludedFromBOM () const

void	SetExcludedFromBoard (bool aExcludeFromBoard)
	Set or clear exclude from board netlist flag. More...

bool	GetExcludedFromBoard () const

int	Compare (const LIB_SYMBOL &aRhs, int aCompareFlags=0, REPORTER *aReporter=nullptr) const
	Comparison test that can be used for operators. More...

bool	operator== (const LIB_SYMBOL *aSymbol) const

bool	operator== (const LIB_SYMBOL &aSymbol) const

bool	operator!= (const LIB_SYMBOL &aSymbol) const

const LIB_SYMBOL &	operator= (const LIB_SYMBOL &aSymbol)

std::unique_ptr< LIB_SYMBOL >	Flatten () const
	Return a flattened symbol inheritance to the caller. More...

std::vector< struct LIB_SYMBOL_UNIT >	GetUnitDrawItems ()
	Return a list of LIB_ITEM objects separated by unit and convert number. More...

std::vector< struct LIB_SYMBOL_UNIT >	GetUniqueUnits ()
	Return a list of unit numbers that are unique to this symbol. More...

std::vector< LIB_ITEM * >	GetUnitDrawItems (int aUnit, int aConvert)
	Return a list of item pointers for aUnit and aConvert for this symbol. More...

double	Similarity (const LIB_SYMBOL &aSymbol) const
	Return a measure of similarity between this symbol and aSymbol. More...

KICAD_T	Type () const
	Returns the type of object. More...

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

EDA_ITEM_FLAGS	GetTempFlags () const

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const std::vector< KICAD_T > &aScanTypes) const
	Check whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

virtual wxString	GetFriendlyName () const

virtual bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const
	Test if aPosition is inside or on the boundary of this item. More...

virtual bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const
	Test if aRect intersects this item. More...

virtual VECTOR2I	GetPosition () const

virtual void	SetPosition (const VECTOR2I &aPos)

virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

virtual EDA_ITEM *	Clone () const
	Create a duplicate of this item with linked list members set to NULL. More...

wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const
	Return a user-visible description string of this item. More...

virtual BITMAPS	GetMenuImage () const
	Return a pointer to an image to be used in menus. More...

virtual bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

virtual bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty) const

template<typename T >
T	Get (PROPERTY_BASE *aProperty) const

template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static wxString	LetterSubReference (int aUnit, int aFirstId)

template<class T >
static INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Protected Member Functions
bool	Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
void	deleteAllFields ()

virtual void	SetParent (EDA_ITEM *aParent)

Private Attributes
LIB_SYMBOL_SPTR	m_me

LIB_SYMBOL_REF	m_parent
	Use for inherited symbols. More...

LIB_ID	m_libId

LIB_ID	m_sourceLibId
	For database library symbols; the original symbol. More...

timestamp_t	m_lastModDate

int	m_unitCount
	Number of units (parts) per package. More...

bool	m_unitsLocked
	True if symbol has multiple units and changing one unit does not automatically change another unit. More...

int	m_pinNameOffset
	The offset in mils to draw the pin name. More...

bool	m_showPinNames

bool	m_showPinNumbers

bool	m_excludedFromSim

bool	m_excludedFromBOM

bool	m_excludedFromBoard

LIBRENTRYOPTIONS	m_options
	Special symbol features such as POWER or NORMAL.) More...

LIB_ITEMS_CONTAINER	m_drawings

SYMBOL_LIB *	m_library

wxString	m_name

wxString	m_keyWords
	Search keywords. More...

wxArrayString	m_fpFilters
	List of suitable footprint names for the symbol (wild card names accepted). More...

std::map< int, wxString >	m_unitDisplayNames

KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

Detailed Description

Define a library symbol object.

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

Definition at line 98 of file lib_symbol.h.

Constructor & Destructor Documentation

◆ LIB_SYMBOL() [1/2]

LIB_SYMBOL::LIB_SYMBOL	(	const wxString &	aName,
		LIB_SYMBOL *	aParent = `nullptr`,
		SYMBOL_LIB *	aLibrary = `nullptr`
	)

Definition at line 98 of file lib_symbol.cpp.

References DEFAULT_PIN_NAME_OFFSET, ENTRY_NORMAL, LIB_FIELD_T, m_drawings, m_lastModDate, m_options, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitsLocked, MANDATORY_FIELDS, EDA_IU_SCALE::MilsToIU(), schIUScale, SetLib(), SetName(), and SetParent().

◆ LIB_SYMBOL() [2/2]

LIB_SYMBOL::LIB_SYMBOL	(	const LIB_SYMBOL &	aSymbol,
		SYMBOL_LIB *	aLibrary = `nullptr`
	)

◆ ~LIB_SYMBOL()

virtual LIB_SYMBOL::~LIB_SYMBOL ( )

inlinevirtual

http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared

Definition at line 106 of file lib_symbol.h.

Member Function Documentation

◆ AddDrawItem()

void LIB_SYMBOL::AddDrawItem	(	LIB_ITEM *	aItem,
		bool	aSort = `true`
	)

Add a new draw aItem to the draw object list and sort according to aSort.

Parameters

aItem	is the new draw object to add to the symbol.
aSort	is the flag to determine if the newly added item should be sorted.

Definition at line 1026 of file lib_symbol.cpp.

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

◆ AddField() [1/2]

void LIB_SYMBOL::AddField ( LIB_FIELD & aField )

inline

Definition at line 307 of file lib_symbol.h.

References AddField().

Referenced by AddField().

◆ AddField() [2/2]

void LIB_SYMBOL::AddField ( LIB_FIELD * aField )

Add a field.

Takes ownership of the pointer.

Definition at line 1260 of file lib_symbol.cpp.

References AddDrawItem().

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), and SCH_DATABASE_PLUGIN::loadSymbolFromRow().

◆ ClassOf()

static bool LIB_SYMBOL::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 154 of file lib_symbol.h.

References LIB_SYMBOL_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearCaches()

void LIB_SYMBOL::ClearCaches ( )

Definition at line 682 of file lib_symbol.cpp.

References m_drawings.

Referenced by SYMBOL_EDIT_FRAME::CommonSettingsChanged(), and SYMBOL_EDIT_FRAME::HardRedraw().

◆ ClearEditFlags()

void LIB_SYMBOL::ClearEditFlags ( )

Definition at line 1545 of file lib_symbol.cpp.

References m_drawings.

Referenced by SYMBOL_EDIT_FRAME::SaveCopyInUndoList().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 125 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConnectBoardShapes(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void LIB_SYMBOL::ClearTempFlags ( )

Clears the status flag all draw objects in this symbol.

Definition at line 1538 of file lib_symbol.cpp.

References m_drawings.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreatePin(), and SYMBOL_EDIT_FRAME::SaveCopyInUndoList().

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

Create 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 LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, FOOTPRINT, PCB_TUNING_PATTERN, NETINFO_ITEM, PAD, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_FIELD, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 82 of file eda_item.cpp.

References EDA_ITEM::GetClass().

Referenced by LIB_ITEM::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), LIB_SYMBOL(), SCH_COMMIT::makeImage(), BOARD_COMMIT::makeImage(), new_clone(), operator=(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ Compare()

int LIB_SYMBOL::Compare	(	const LIB_SYMBOL &	aRhs,
		int	aCompareFlags = `0`,
		REPORTER *	aReporter = `nullptr`
	)		const

Comparison test that can be used for operators.

Parameters

aRhs	is the right hand side symbol used for comparison.

Returns: -1 if this symbol is less than aRhs 1 if this symbol is greater than aRhs 0 if this symbol is the same as aRhs

Definition at line 248 of file lib_symbol.cpp.

References _, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), LIB_ID::compare(), LIB_FIELD::compare(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), ENTRY_NORMAL, LIB_ITEM::ERC, FindField(), LIB_ITEM::GetConvert(), GetFieldById(), LIB_FIELD::GetId(), LIB_FIELD::GetName(), LIB_PIN::GetNumber(), GetPin(), LIB_ITEM::GetUnit(), ITEM_DESC, LIB_FIELD_T, LIB_PIN_T, LIB_SHAPE_T, m_drawings, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, m_fpFilters, m_keyWords, m_libId, m_me, m_name, m_options, m_parent, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, m_unitDisplayNames, m_unitsLocked, MANDATORY_FIELDS, REPORT, and schIUScale.

Referenced by BOOST_AUTO_TEST_CASE(), and operator!=().

◆ CopyUnitDisplayNames()

void LIB_SYMBOL::CopyUnitDisplayNames ( std::map< int, wxString > & aTarget ) const

Copy all unit display names into the given map aTarget.

Definition at line 564 of file lib_symbol.cpp.

References m_unitDisplayNames.

Referenced by LIB_SYMBOL(), and operator=().

◆ deleteAllFields()

void LIB_SYMBOL::deleteAllFields ( )

private

Definition at line 1254 of file lib_symbol.cpp.

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

Referenced by SetFields().

◆ Duplicate()

virtual LIB_SYMBOL * LIB_SYMBOL::Duplicate ( ) const

inlinevirtual

Create a copy of a LIB_SYMBOL and assigns unique KIIDs to the copy and its children.

Definition at line 115 of file lib_symbol.h.

References m_drawings, m_library, and EDA_ITEM::m_Uuid.

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), and SCH_DATABASE_PLUGIN::loadSymbolFromRow().

◆ FindField() [1/2]

LIB_FIELD * LIB_SYMBOL::FindField	(	const wxString &	aFieldName,
		bool	aCaseInsensitive = `false`
	)

Find a field within this symbol matching aFieldName and returns it or NULL if not found.

Parameters

aFieldName	is the name of the field to find.
aCaseInsensitive	ignore the filed name case if true.

Returns: the field if found or NULL if the field was not found.

Definition at line 1331 of file lib_symbol.cpp.

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

Referenced by Compare(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), and FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable().

◆ FindField() [2/2]

const LIB_FIELD * LIB_SYMBOL::FindField	(	const wxString &	aFieldName,
		const bool	aCaseInsensitive = `false`
	)		const

Definition at line 1351 of file lib_symbol.cpp.

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

◆ FixupDrawItems()

void LIB_SYMBOL::FixupDrawItems ( )

This function finds the filled draw items that are covering up smaller draw items and replaces their body fill color with the background fill color.

Definition at line 958 of file lib_symbol.cpp.

References EDA_SHAPE::GetFillMode(), LIB_SHAPE_T, and m_drawings.

Referenced by SCH_ALTIUM_PLUGIN::ParseLibFile().

◆ Flatten()

std::unique_ptr< LIB_SYMBOL > LIB_SYMBOL::Flatten ( ) const

Return a flattened symbol inheritance to the caller.

If the symbol does not inherit from another symbol, a copy of the symbol is returned.

Returns: a flattened symbol on the heap

Definition at line 605 of file lib_symbol.cpp.

References GetFieldById(), LIB_FIELD::GetName(), EDA_TEXT::GetText(), IsAlias(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, m_drawings, m_fpFilters, m_keyWords, m_libId, m_name, m_parent, MANDATORY_FIELDS, and EDA_ITEM::SetParent().

Referenced by SCH_SCREEN::Append(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDIT_FRAME::GetDocumentExtents(), RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_SYMBOL::SCH_SYMBOL(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SCH_SCREEN::UpdateSymbolLinks().

◆ Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString & aProperty ) const

inlineinherited

Definition at line 104 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PROPERTIES_PANEL::getItemValue(), and PCBEXPR_VAR_REF::GetValue().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetAllLibPins()

std::vector< LIB_PIN * > LIB_SYMBOL::GetAllLibPins ( ) const

Return a list of pin pointers for all units / converts.

Used primarily for SPICE where we want to treat all unit as a single part.

Definition at line 1064 of file lib_symbol.cpp.

References GetPins().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDIT_FRAME::FocusOnItem(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), DIALOG_LIB_EDIT_PIN_TABLE::OnCellSelected(), operator==(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), Similarity(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow().

◆ GetBodyBoundingBox()

const BOX2I LIB_SYMBOL::GetBodyBoundingBox	(	int	aUnit,
		int	aConvert,
		bool	aIncludePins,
		bool	aIncludePrivateItems
	)		const

Get the symbol bounding box excluding fields.

Returns: the symbol 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 1210 of file lib_symbol.cpp.

References LIB_FIELD_T, LIB_PIN_T, m_drawings, BOX2< Vec >::Merge(), and pin.

◆ GetBoundingBox()

const BOX2I LIB_SYMBOL::GetBoundingBox ( ) const

inlineoverridevirtual

Return 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 264 of file lib_symbol.h.

References GetUnitBoundingBox().

Referenced by LTSPICE_SCH_PARSER::CreateKicadSYMBOLs(), and LTSPICE_SCHEMATIC::Load().

◆ GetChooserFields()

void LIB_SYMBOL::GetChooserFields ( std::map< wxString, wxString > & aColumnMap )

overridevirtual

Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

Reimplemented from LIB_TREE_ITEM.

Definition at line 71 of file lib_symbol.cpp.

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

Referenced by GetSearchTerms().

◆ GetClass()

virtual wxString LIB_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 149 of file lib_symbol.h.

◆ GetDatasheetField()

LIB_FIELD & LIB_SYMBOL::GetDatasheetField ( )

Return reference to the datasheet field.

Definition at line 1397 of file lib_symbol.cpp.

References DATASHEET_FIELD, and GetFieldById().

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetDescription()

wxString LIB_SYMBOL::GetDescription ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 178 of file lib_symbol.h.

References GetDescriptionField(), EDA_TEXT::GetText(), IsAlias(), and m_parent.

Referenced by GetSearchTerms(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_INFO_GENERATOR::SetHtmlDesc(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetDescriptionField()

LIB_FIELD & LIB_SYMBOL::GetDescriptionField ( )

Return reference to the description field.

Definition at line 1405 of file lib_symbol.cpp.

References DESCRIPTION_FIELD, and GetFieldById().

Referenced by BOOST_AUTO_TEST_CASE(), GetDescription(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), and SetDescription().

◆ GetDrawItems() [1/2]

LIB_ITEMS_CONTAINER & LIB_SYMBOL::GetDrawItems ( )

inline

Return a reference to the draw item list.

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

Definition at line 544 of file lib_symbol.h.

References m_drawings.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CheckLibSymbolGraphics(), EE_SELECTION_TOOL::CollectHits(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), KIGFX::SCH_VIEW::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SYMBOL_EDIT_FRAME::HardRedraw(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SYMBOL_DIFF_WIDGET::onSlider(), KIGFX::orientSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SYMBOL::Plot(), SCH_SYMBOL::Print(), EE_SELECTION_TOOL::RebuildSelection(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), and SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetDrawItems() [2/2]

const LIB_ITEMS_CONTAINER & LIB_SYMBOL::GetDrawItems ( ) const

inline

Definition at line 545 of file lib_symbol.h.

References m_drawings.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetExcludedFromBoard()

bool LIB_SYMBOL::GetExcludedFromBoard ( ) const

inline

Definition at line 665 of file lib_symbol.h.

References m_excludedFromBoard.

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetExcludedFromBOM()

bool LIB_SYMBOL::GetExcludedFromBOM ( ) const

inline

Definition at line 657 of file lib_symbol.h.

References m_excludedFromBOM.

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetExcludedFromSim()

bool LIB_SYMBOL::GetExcludedFromSim ( ) const

inline

Definition at line 649 of file lib_symbol.h.

References m_excludedFromSim.

Referenced by SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetFieldById()

LIB_FIELD * LIB_SYMBOL::GetFieldById ( int aId ) const

Return pointer to the requested field.

Parameters

aId	- Id of field to return.

Returns: The field if found, otherwise NULL.

Definition at line 1317 of file lib_symbol.cpp.

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

Referenced by Compare(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), Flatten(), GetDatasheetField(), GetDescriptionField(), GetFields(), GetFootprintField(), GetNextAvailableFieldId(), GetPrefix(), GetReferenceField(), GetValueField(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_EAGLE_PLUGIN::loadInstance(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), and PANEL_SYMBOL_CHOOSER::showFootprintFor().

◆ GetFieldCount()

size_t LIB_SYMBOL::GetFieldCount ( ) const

inline

Definition at line 433 of file lib_symbol.h.

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

◆ GetFields() [1/2]

void LIB_SYMBOL::GetFields ( std::vector< LIB_FIELD * > & aList )

Return a list of fields within this symbol.

Parameters

aList - List to add fields to

Definition at line 1283 of file lib_symbol.cpp.

References GetFieldById(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, m_drawings, and MANDATORY_FIELDS.

Referenced by SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList().

◆ GetFields() [2/2]

void LIB_SYMBOL::GetFields ( std::vector< LIB_FIELD > & aList )

Definition at line 1300 of file lib_symbol.cpp.

References GetFieldById(), LIB_FIELD::IsMandatory(), LIB_FIELD_T, m_drawings, and MANDATORY_FIELDS.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_PIN::GetMsgPanelInfo(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 246 of file eda_item.h.

References EDA_ITEM::GetPosition().

Referenced by SYMBOL_EDIT_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetFootprint()

wxString LIB_SYMBOL::GetFootprint ( )

inlineoverridevirtual

For items with footprint fields.

Reimplemented from LIB_TREE_ITEM.

Definition at line 204 of file lib_symbol.h.

References GetFootprintField(), and EDA_TEXT::GetText().

◆ GetFootprintField()

LIB_FIELD & LIB_SYMBOL::GetFootprintField ( )

Return reference to the footprint field.

Definition at line 1389 of file lib_symbol.cpp.

References FOOTPRINT_FIELD, and GetFieldById().

Referenced by GetFootprint(), GetSearchTerms(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and SCH_EASYEDAPRO_PARSER::ParseSchematic().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 157 of file view_item.h.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

◆ GetFPFilters()

wxArrayString LIB_SYMBOL::GetFPFilters ( ) const

inline

Definition at line 226 of file lib_symbol.h.

References IsAlias(), m_fpFilters, and m_parent.

Referenced by DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in SCH_LINE, PCB_TUNING_PATTERN, PCB_SHAPE, PCB_TEXTBOX, PCB_TRACK, and ZONE.

Definition at line 329 of file eda_item.cpp.

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetInheritanceDepth()

unsigned LIB_SYMBOL::GetInheritanceDepth ( ) const

Get the number of parents for this symbol.

Returns: the inhertance depth for this symbol.

Definition at line 229 of file lib_symbol.cpp.

References GetParent().

◆ GetItemDescription()

wxString EDA_ITEM::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

virtualinherited

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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 LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, BOARD, FOOTPRINT, PCB_TUNING_PATTERN, PAD, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GENERATOR, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 108 of file eda_item.cpp.

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::collectAllDriverValues(), DIALOG_GROUP_PROPERTIES::DoAddMember(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::getItemDescription(), RC_ITEM::GetJsonViolation(), PCB_MARKER::GetMsgPanelInfo(), ERC_TREE_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), PNS::SHOVE::shoveIteration(), RC_ITEM::ShowReport(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetKeyWords()

wxString LIB_SYMBOL::GetKeyWords ( ) const

inline

Definition at line 191 of file lib_symbol.h.

References IsAlias(), m_keyWords, and m_parent.

Referenced by GetSearchTerms(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetLastModDate()

timestamp_t LIB_SYMBOL::GetLastModDate ( ) const

inline

Definition at line 222 of file lib_symbol.h.

References m_lastModDate.

Referenced by SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetLib()

SYMBOL_LIB * LIB_SYMBOL::GetLib ( ) const

inline

Definition at line 219 of file lib_symbol.h.

References m_library.

Referenced by LIB_BUFFER::CreateBuffer(), and SYMBOL_LIB::FindSymbol().

◆ GetLibId()

LIB_ID LIB_SYMBOL::GetLibId ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 163 of file lib_symbol.h.

References m_libId.

◆ GetLibNickname()

wxString LIB_SYMBOL::GetLibNickname ( ) const

inlineoverridevirtual

Sets the Description field text value.

Implements LIB_TREE_ITEM.

Definition at line 169 of file lib_symbol.h.

References GetLibraryName().

Referenced by SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary().

◆ GetLibraryName()

const wxString LIB_SYMBOL::GetLibraryName ( ) const

Definition at line 695 of file lib_symbol.cpp.

References LIB_ID::GetLibNickname(), SYMBOL_LIB::GetName(), m_libId, and m_library.

Referenced by GetLibNickname().

◆ GetMaxPinNumber()

int LIB_SYMBOL::GetMaxPinNumber ( ) const

Returns: the highest pin number of the symbol's pins. If none of the pins has pin number assigned it returns 0.

Definition at line 1519 of file lib_symbol.cpp.

References LIB_PIN_T, m_drawings, m_parent, and pin.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Duplicate().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Return 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 LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 288 of file eda_item.cpp.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

virtual void EDA_ITEM::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

inlinevirtualinherited

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented in LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, DS_DRAW_ITEM_BASE, PCB_GROUP, BOARD, FOOTPRINT, PCB_TUNING_PATTERN, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_DIM_ALIGNED, PCB_DIM_LEADER, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 199 of file eda_item.h.

Referenced by SCH_SHAPE::GetMsgPanelInfo(), EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetName()

wxString LIB_SYMBOL::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 160 of file lib_symbol.h.

References m_name.

◆ GetNextAvailableFieldId()

int LIB_SYMBOL::GetNextAvailableFieldId ( ) const

Definition at line 1474 of file lib_symbol.cpp.

References GetFieldById(), and MANDATORY_FIELDS.

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

◆ GetParent() [1/2]

LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( )

inline

Definition at line 127 of file lib_symbol.h.

References m_parent.

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_VIEWER_FRAME::GetDocumentExtents(), GetInheritanceDepth(), SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetParent() [2/2]

const LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( ) const

inline

Definition at line 128 of file lib_symbol.h.

References m_parent.

◆ GetPin()

LIB_PIN * LIB_SYMBOL::GetPin	(	const wxString &	aNumber,
		int	aUnit = `0`,
		int	aConvert = `0`
	)		const

Return pin object with the requested pin aNumber.

Parameters

aNumber	- Number of the pin to find.
aUnit	- Unit filter. Set to 0 if a specific unit number is not required.
aConvert	- DeMorgan variant filter. Set to 0 if no specific DeMorgan variant is required.

Returns: The pin object if found. Otherwise NULL.

Definition at line 1082 of file lib_symbol.cpp.

References GetPins(), LIB_PIN_T, and pin.

Referenced by Compare().

◆ GetPinCount()

int LIB_SYMBOL::GetPinCount ( )

overridevirtual

Returns: a count of pins for all units / converts.

Reimplemented from LIB_TREE_ITEM.

Definition at line 1073 of file lib_symbol.cpp.

References GetPins().

Referenced by DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES().

◆ GetPinNameOffset()

int LIB_SYMBOL::GetPinNameOffset ( ) const

inline

Definition at line 625 of file lib_symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), KIGFX::SCH_PAINTER::draw(), LIB_PIN::GetBoundingBox(), LIB_PIN::print(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetPins()

void LIB_SYMBOL::GetPins	(	LIB_PINS &	aList,
		int	aUnit = `0`,
		int	aConvert = `0`
	)		const

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

Note pin objects are owned by the draw list of the symbol. 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 pins to collect. Set to 0 to get pins from any symbol unit.
aConvert	- Convert number of pins to collect. Set to 0 to get pins from any DeMorgan variant of symbol.

Definition at line 1037 of file lib_symbol.cpp.

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

Referenced by CheckLibSymbol(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), GetAllLibPins(), GetPin(), GetPinCount(), PinsConflictWith(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SCH_SYMBOL::Print(), and ERC_TESTER::TestMissingUnits().

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, GERBER_DRAW_ITEM, DELETED_BOARD_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_GENERATOR, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, PCB_VIA, and ZONE.

Definition at line 239 of file eda_item.h.

Referenced by SCH_MOVE_TOOL::AlignElements(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), TEARDROP_MANAGER::areItemsInSameZone(), SCH_EDIT_TOOL::ChangeTextType(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreatePolys(), SCH_EDIT_FRAME::DeleteJunction(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNetclassConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), BOARD_ITEM::GetFPRelativePosition(), RC_ITEM::GetJsonViolation(), getMinDist(), SCH_FIELD::GetParentPosition(), EDA_ITEM::GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), SCH_ITEM::operator<(), PAD::PAD(), SCH_EDITOR_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), SCH_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), DRC_TEST_PROVIDER_MISC::testTextVars(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and PL_EDIT_TOOL::updateModificationPoint().

◆ GetPrefix()

wxString LIB_SYMBOL::GetPrefix ( )

Definition at line 1413 of file lib_symbol.cpp.

References GetFieldById(), EDA_TEXT::GetText(), and REFERENCE_FIELD.

◆ GetReferenceField()

LIB_FIELD & LIB_SYMBOL::GetReferenceField ( )

Return reference to the reference designator field.

Definition at line 1381 of file lib_symbol.cpp.

References GetFieldById(), and REFERENCE_FIELD.

Referenced by CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), and SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

◆ GetRootSymbol()

LIB_SYMBOL_SPTR LIB_SYMBOL::GetRootSymbol ( ) const

Get the parent symbol that does not have another parent.

Now that derived symbols can be derived from other derived symbols, this method provides way to get to the base symbol in the derivation change.

Returns: the weak_ptr to the root symbol of this symbol.

Definition at line 527 of file lib_symbol.cpp.

References m_me, and m_parent.

Referenced by KIGFX::SCH_VIEW::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

◆ GetSearchTerms()

std::vector< SEARCH_TERM > LIB_SYMBOL::GetSearchTerms ( )

overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 40 of file lib_symbol.cpp.

References GetChooserFields(), GetDescription(), GetFootprintField(), GetKeyWords(), GetName(), EDA_TEXT::GetText(), name, and text.

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 255 of file eda_item.h.

References EDA_ITEM::GetPosition().

◆ GetSourceLibId()

LIB_ID LIB_SYMBOL::GetSourceLibId ( ) const

inline

Definition at line 166 of file lib_symbol.h.

References m_sourceLibId.

Referenced by SYMBOL_EDIT_FRAME::LoadSymbol().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References CANDIDATE, IS_LINKED, EDA_ITEM::m_flags, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by EDA_ITEM::ClearTempFlags(), and SCH_ITEM::SwapFlags().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 320 of file eda_item.cpp.

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetUniqueUnits()

std::vector< struct LIB_SYMBOL_UNIT > LIB_SYMBOL::GetUniqueUnits ( )

Return a list of unit numbers that are unique to this symbol.

If the symbol is inherited (alias), the unique units of the parent symbol are returned. When comparing pins, the pin number is ignored.

Returns: a list of unique unit numbers and their associated draw items.

Definition at line 1774 of file lib_symbol.cpp.

References GetUnitCount(), GetUnitDrawItems(), HasConversion(), LIB_SYMBOL_UNIT::m_convert, LIB_SYMBOL_UNIT::m_items, LIB_SYMBOL_UNIT::m_unit, LIB_ITEM::UNIT, and UnitsLocked().

◆ GetUnitBoundingBox()

const BOX2I LIB_SYMBOL::GetUnitBoundingBox	(	int	aUnit,
		int	aConvert,
		bool	aIgnoreHiddenFields = `true`
	)		const

Get the bounding box for the symbol.

Returns: the symbol 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
aIgnoreHiddenFields	default true, ignores any hidden fields

Definition at line 1167 of file lib_symbol.cpp.

References LIB_FIELD::GetBoundingBox(), LIB_FIELD_T, m_drawings, m_unitCount, and BOX2< Vec >::Merge().

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), and GetBoundingBox().

◆ GetUnitCount()

int LIB_SYMBOL::GetUnitCount ( ) const

overridevirtual

For items with units, return the number of units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 1658 of file lib_symbol.cpp.

References m_parent, and m_unitCount.

Referenced by SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_REFERENCE_LIST::CheckAnnotation(), CheckLibSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), NETLIST_EXPORTER_BASE::findNextSymbol(), GetUniqueUnits(), LIB_FIELD::HitTest(), SCH_REFERENCE::IsMultiUnit(), SYMBOL_VIEWER_FRAME::onUpdateUnitChoice(), SYMBOL_EDIT_FRAME::OnUpdateUnitNumber(), SYMBOL_EDIT_FRAME::RebuildSymbolUnitsList(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_EDIT_FRAME::SelectUnit(), SetUnitDisplayName(), PIN_TABLE_DATA_MODEL::SetValue(), ERC_TESTER::TestMissingUnits(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ GetUnitDisplayName()

wxString LIB_SYMBOL::GetUnitDisplayName ( int aUnit )

overridevirtual

Return the user-defined display name for aUnit for symbols with units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 551 of file lib_symbol.cpp.

References _, GetUnitReference(), HasUnitDisplayName(), and m_unitDisplayNames.

Referenced by SYMBOL_VIEWER_FRAME::onUpdateUnitChoice(), SYMBOL_EDIT_FRAME::RebuildSymbolUnitsList(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName(), and ERC_TESTER::TestMissingUnits().

◆ GetUnitDrawItems() [1/2]

std::vector< struct LIB_SYMBOL_UNIT > LIB_SYMBOL::GetUnitDrawItems ( )

Return a list of LIB_ITEM objects separated by unit and convert number.

Note: This does not include LIB_FIELD objects since they are not associated with unit and/or convert numbers.

Definition at line 1738 of file lib_symbol.cpp.

References convert, LIB_FIELD_T, LIB_SYMBOL_UNIT::m_convert, m_drawings, LIB_SYMBOL_UNIT::m_items, and LIB_SYMBOL_UNIT::m_unit.

Referenced by GetUniqueUnits(), and SCH_SEXPR_PLUGIN_CACHE::SaveSymbol().

◆ GetUnitDrawItems() [2/2]

std::vector< LIB_ITEM * > LIB_SYMBOL::GetUnitDrawItems	(	int	aUnit,
		int	aConvert
	)

Return a list of item pointers for aUnit and aConvert for this symbol.

Note: LIB_FIELD objects are not included.

Parameters

aUnit	is the unit number of the item, -1 includes all units.
aConvert	is the alternate body styple of the item, -1 includes all body styles.

Returns: a list of unit items.

Definition at line 1717 of file lib_symbol.cpp.

References LIB_FIELD_T, and m_drawings.

◆ GetUnitReference()

wxString LIB_SYMBOL::GetUnitReference ( int aUnit )

overridevirtual

Return an identifier for aUnit for symbols with units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 539 of file lib_symbol.cpp.

References LetterSubReference().

Referenced by CheckLibSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), GetUnitDisplayName(), and SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName().

◆ GetValueField()

LIB_FIELD & LIB_SYMBOL::GetValueField ( )

Return reference to the value field.

Definition at line 1373 of file lib_symbol.cpp.

References GetFieldById(), and VALUE_FIELD.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SCH_ALTIUM_PLUGIN::ParseLibFile(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ HasConversion()

bool LIB_SYMBOL::HasConversion ( ) const

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

Returns: True if symbol has more than one conversion.

Definition at line 1498 of file lib_symbol.cpp.

References LIB_ITEM::BASE, m_drawings, and m_parent.

Referenced by CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), GetUniqueUnits(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SetConversion(), SYMBOL_VIEWER_FRAME::setupUIConditions(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ HasUnitDisplayName()

bool LIB_SYMBOL::HasUnitDisplayName ( int aUnit )

overridevirtual

Return true if the given unit aUnit has a display name defined.

Reimplemented from LIB_TREE_ITEM.

Definition at line 545 of file lib_symbol.cpp.

References m_unitDisplayNames.

Referenced by GetUnitDisplayName(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), and SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName().

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented in PCB_TUNING_PATTERN, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_DIMENSION_BASE, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, PCB_ARC, ZONE, and GERBER_DRAW_ITEM.

Definition at line 225 of file eda_item.h.

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a VECTOR2I object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented in RATSNEST_VIEW_ITEM, SCH_SHEET, PCB_DIMENSION_BASE, PCB_TEXT, PCB_TEXTBOX, LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PCB_TUNING_PATTERN, PAD, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TARGET, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and GERBER_DRAW_ITEM.

Definition at line 212 of file eda_item.h.

Referenced by PCB_GRID_HELPER::AlignToNearestPad(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), LIB_ITEM::HitTest(), DS_DRAW_ITEM_BASE::HitTest(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectMultiple().

◆ IsAlias()

bool LIB_SYMBOL::IsAlias ( ) const

inline

Definition at line 215 of file lib_symbol.h.

References m_parent.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), Flatten(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), GetDescription(), SYMBOL_VIEWER_FRAME::GetDocumentExtents(), GetFPFilters(), GetKeyWords(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), LIB_BUFFER::SaveBuffer(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 191 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsMulti()

bool LIB_SYMBOL::IsMulti ( ) const

inline

Returns: true if the symbol has multiple units per symbol. When true, the reference has a sub reference to identify symbol.

Definition at line 599 of file lib_symbol.h.

References m_unitCount.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EE_SELECTION_TOOL::Init(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::SynchronizePins(), DIALOG_LIB_EDIT_PIN_TABLE::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsNormal()

bool LIB_SYMBOL::IsNormal ( ) const

Definition at line 732 of file lib_symbol.cpp.

References ENTRY_NORMAL, m_options, and m_parent.

◆ IsPower()

bool LIB_SYMBOL::IsPower ( ) const

Definition at line 704 of file lib_symbol.cpp.

References ENTRY_POWER, m_options, and m_parent.

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), SCH_DATABASE_PLUGIN::EnumerateSymbolLib(), SCH_HTTP_LIB_PLUGIN::EnumerateSymbolLib(), LIB_PIN::IsGlobalPower(), SCH_EAGLE_PLUGIN::loadInstance(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 410 of file eda_item.h.

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsRoot()

bool LIB_SYMBOL::IsRoot ( ) const

inlineoverridevirtual

For symbols derived from other symbols, IsRoot() indicates no derivation.

Reimplemented from LIB_TREE_ITEM.

Definition at line 214 of file lib_symbol.h.

References m_parent.

Referenced by SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), SYMBOL_EDIT_FRAME::IsSymbolAlias(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), SCH_SYMBOL::SetLibSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_COMMIT::Stage(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), HIERARCHY_PANE::UpdateHierarchySelection(), PCB_TUNING_PATTERN::ViewDraw(), PCB_FIELD::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 164 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 172 of file eda_item.h.

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), PAD::IsType(), PCB_FIELD::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_COMMIT::Stage(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IterateForward() [1/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

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

Definition at line 292 of file eda_item.h.

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 312 of file eda_item.h.

References EDA_ITEM::Visit().

◆ LetterSubReference()

wxString LIB_SYMBOL::LetterSubReference	(	int	aUnit,
		int	aFirstId
	)

static

Definition at line 760 of file lib_symbol.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), LIB_FIELD::GetFullText(), LIB_ITEM::GetMsgPanelInfo(), GetUnitReference(), PIN_TABLE_DATA_MODEL::GetValue(), PIN_TABLE_DATA_MODEL::SetValue(), SCH_SYMBOL::SubReference(), and SCHEMATIC_SETTINGS::SubReference().

◆ LibId()

LIB_ID & LIB_SYMBOL::LibId ( )

inline

Definition at line 162 of file lib_symbol.h.

References m_libId.

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), and SCH_DATABASE_PLUGIN::loadSymbolFromRow().

◆ LocateDrawItem() [1/2]

LIB_ITEM * LIB_SYMBOL::LocateDrawItem	(	int	aUnit,
		int	aConvert,
		KICAD_T	aType,
		const VECTOR2I &	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 1552 of file lib_symbol.cpp.

References m_drawings, and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

◆ LocateDrawItem() [2/2]

LIB_ITEM * LIB_SYMBOL::LocateDrawItem	(	int	aUnit,
		int	aConvert,
		KICAD_T	aType,
		const VECTOR2I &	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 1572 of file lib_symbol.cpp.

References DefaultTransform, and LocateDrawItem().

◆ LockUnits()

void LIB_SYMBOL::LockUnits ( bool aLockUnits )

inline

Set interchangeable the property for symbol units.

Parameters

aLockUnits when true then units are set as not interchangeable.

Definition at line 279 of file lib_symbol.h.

References m_unitsLocked.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData
	)		const

inlinevirtualinherited

Compare 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

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 372 of file eda_item.h.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), TEXT_SEARCH_HANDLER::Search(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 123 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, and text.

◆ operator!=()

bool LIB_SYMBOL::operator!= ( const LIB_SYMBOL & aSymbol ) const

inline

Definition at line 681 of file lib_symbol.h.

References Compare(), and LIB_ITEM::EQUALITY.

◆ operator<()

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 249 of file eda_item.cpp.

References EDA_ITEM::GetClass().

◆ operator=()

const LIB_SYMBOL & LIB_SYMBOL::operator= ( const LIB_SYMBOL & aSymbol )

◆ operator==() [1/2]

bool LIB_SYMBOL::operator== ( const LIB_SYMBOL & aSymbol ) const

Definition at line 1878 of file lib_symbol.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), GetAllLibPins(), m_drawings, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, EDA_ITEM::m_flags, m_libId, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::size().

◆ operator==() [2/2]

bool LIB_SYMBOL::operator== ( const LIB_SYMBOL * aSymbol ) const

inline

Definition at line 679 of file lib_symbol.h.

◆ PinsConflictWith()

bool LIB_SYMBOL::PinsConflictWith	(	const LIB_SYMBOL &	aOtherSymbol,
		bool	aTestNums,
		bool	aTestNames,
		bool	aTestType,
		bool	aTestOrientation,
		bool	aTestLength
	)		const

Return true if this symbol's pins do not match another symbol's pins.

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

Parameters

aOtherSymbol	- The other library symbol 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 1100 of file lib_symbol.cpp.

References GetPins().

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

◆ Plot()

void LIB_SYMBOL::Plot	(	PLOTTER *	aPlotter,
		int	aUnit,
		int	aConvert,
		bool	aBackground,
		const VECTOR2I &	aOffset,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)		const

Plot lib symbol 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	- Symbol symbol to plot.
aConvert	- Symbol alternate body style to plot.
aBackground	- A poor-man's Z-order.
aOffset	- Distance to shift the plot coordinates.
aTransform	- Symbol plot transform matrix.
aDimmed	- Reduce brightness of symbol

Definition at line 865 of file lib_symbol.cpp.

References color, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetLayerColor(), LAYER_DEVICE, LIB_FIELD_T, m_drawings, PLOTTER::RenderSettings(), and PLOTTER::SetColor().

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SCH_SYMBOL::Plot(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ PlotLibFields()

void LIB_SYMBOL::PlotLibFields	(	PLOTTER *	aPlotter,
		int	aUnit,
		int	aConvert,
		bool	aBackground,
		const VECTOR2I &	aOffset,
		const TRANSFORM &	aTransform,
		bool	aDimmed,
		bool	aPlotHidden = `true`
	)

Plot Lib Fields only of the symbol to plotter.

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

Parameters

aPlotter	- Plotter object to plot to.
aUnit	- Symbol to plot.
aConvert	- Symbol alternate body style to plot.
aBackground	- A poor-man's Z-order.
aOffset	- Distance to shift the plot coordinates.
aTransform	- Symbol plot transform matrix.
aDimmed	- reduce brightness of fields

Definition at line 906 of file lib_symbol.cpp.

References color, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), LIB_FIELD::GetFullText(), LIB_FIELD::GetId(), KIGFX::RENDER_SETTINGS::GetLayerColor(), LIB_FIELD::GetShownText(), LAYER_FIELDS, LIB_FIELD_T, LIB_ITEM::m_convert, m_drawings, LIB_ITEM::m_unit, LIB_FIELD::Plot(), REFERENCE_FIELD, PLOTTER::RenderSettings(), PLOTTER::SetColor(), EDA_TEXT::SetText(), and text.

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ Print()

void LIB_SYMBOL::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		int	aMulti,
		int	aConvert,
		const LIB_SYMBOL_OPTIONS &	aOpts,
		bool	aDimmed
	)

Print symbol.

Parameters

aOffset	- Position of symbol.
aMulti	- unit if multiple units per symbol.
aConvert	- Symbol conversion (DeMorgan) if available.
aOpts	- Drawing options
aDimmed	- Reduce brightness of symbol

Definition at line 814 of file lib_symbol.cpp.

References LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::draw_visible_fields, EDA_SHAPE::GetFillMode(), EDA_TEXT::IsVisible(), LIB_FIELD_T, LIB_PIN_T, LIB_SHAPE_T, m_drawings, LIB_ITEM::Print(), and LIB_SYMBOL_OPTIONS::transform.

Referenced by SCH_SYMBOL::Print(), and SYMBOL_EDIT_FRAME::PrintPage().

◆ PrintBackground()

void LIB_SYMBOL::PrintBackground	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		int	aMulti,
		int	aConvert,
		const LIB_SYMBOL_OPTIONS &	aOpts,
		bool	aDimmed
	)

Print just the background fills of a symbol.

Parameters

aOffset	- Position of symbol.
aMulti	- unit if multiple units per symbol.
aConvert	- Symbol conversion (DeMorgan) if available.
aOpts	- Drawing options
aDimmed	- Reduce brightness of symbol

Definition at line 779 of file lib_symbol.cpp.

References EDA_SHAPE::GetFillMode(), GetGRForceBlackPenState(), LIB_SHAPE_T, LIB_ITEM::m_convert, m_drawings, LIB_ITEM::m_unit, LIB_ITEM::Print(), and LIB_SYMBOL_OPTIONS::transform.

Referenced by SYMBOL_EDIT_FRAME::PrintPage().

◆ RemoveDrawItem()

void LIB_SYMBOL::RemoveDrawItem ( LIB_ITEM * aItem )

Remove draw aItem from list.

Parameters

aItem - Draw item to remove from list.

Definition at line 1001 of file lib_symbol.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), LIB_FIELD_T, m_drawings, and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), RemoveField(), and DIALOG_LIB_EDIT_PIN_TABLE::TransferDataFromWindow().

◆ RemoveDuplicateDrawItems()

void LIB_SYMBOL::RemoveDuplicateDrawItems ( )

Remove duplicate draw items from list.

Definition at line 1492 of file lib_symbol.cpp.

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

◆ RemoveField()

void LIB_SYMBOL::RemoveField ( LIB_FIELD * aField )

inline

Definition at line 431 of file lib_symbol.h.

References RemoveDrawItem().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 154 of file eda_item.h.

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData = `nullptr`
	)

inlinevirtualinherited

Perform 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

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A 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 LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 399 of file eda_item.h.

◆ Replace() [2/2]

bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	aSearchData,
		wxString &	aText
	)

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 186 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, and text.

Referenced by EDA_TEXT::Replace(), SCH_FIELD::Replace(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), and SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext().

◆ RunOnChildren()

void LIB_SYMBOL::RunOnChildren ( const std::function< void(LIB_ITEM *)> & aFunction )

Definition at line 1439 of file lib_symbol.cpp.

References m_drawings.

Referenced by SCH_COMMIT::pushLibEdit().

◆ Set() [1/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 66 of file inspectable.h.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 54 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxAny &	aValue
	)

inlineinherited

Definition at line 42 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConversion()

void LIB_SYMBOL::SetConversion	(	bool	aSetConvert,
		bool	aDuplicatePins = `true`
	)

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

If the symbol 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 symbol.

Parameters

aSetConvert	- Set or clear the symbol alternate body style.
aDuplicatePins	- Duplicate all pins from original body style if true.

Definition at line 1667 of file lib_symbol.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), LIB_ITEM::Duplicate(), 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, m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetDescription()

void LIB_SYMBOL::SetDescription ( const wxString & aDescription )

inline

Gets the Description field text value *‍/.

Definition at line 172 of file lib_symbol.h.

References GetDescriptionField(), and EDA_TEXT::SetText().

Referenced by BOOST_AUTO_TEST_CASE(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseLibComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), and SCH_EASYEDAPRO_PARSER::ParseSymbol().

◆ SetExcludedFromBoard()

void LIB_SYMBOL::SetExcludedFromBoard ( bool aExcludeFromBoard )

inline

Set or clear exclude from board netlist flag.

Parameters

aExcludeFromBoard true to exclude symbol from the board netlist

Definition at line 664 of file lib_symbol.h.

References m_excludedFromBoard.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetExcludedFromBOM()

void LIB_SYMBOL::SetExcludedFromBOM ( bool aExcludeFromBOM )

inline

Set or clear the exclude from schematic bill of materials flag.

Parameters

aExcludeFromBOM true to exclude symbol from schematic bill of materials

Definition at line 656 of file lib_symbol.h.

References m_excludedFromBOM.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetExcludedFromSim()

void LIB_SYMBOL::SetExcludedFromSim ( bool aExcludeFromSim )

inline

Set or clear the exclude from simulation flag.

Parameters

aExcludeFromSim true to exclude symbol from simulation

Definition at line 648 of file lib_symbol.h.

References m_excludedFromSim.

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetFields()

void LIB_SYMBOL::SetFields ( const std::vector< LIB_FIELD > & aFieldsList )

Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.

Parameters

aFieldsList is a set of fields to import, removing all previous fields.

Definition at line 1266 of file lib_symbol.cpp.

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

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 123 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 152 of file view_item.h.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

aEnable True 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 190 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetFPFilters()

void LIB_SYMBOL::SetFPFilters ( const wxArrayString & aFilters )

inline

Definition at line 224 of file lib_symbol.h.

References m_fpFilters.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 156 of file eda_item.h.

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

◆ SetKeyWords()

void LIB_SYMBOL::SetKeyWords ( const wxString & aKeyWords )

inline

Definition at line 189 of file lib_symbol.h.

References m_keyWords.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetLib()

void LIB_SYMBOL::SetLib ( SYMBOL_LIB * aLibrary )

inline

Definition at line 220 of file lib_symbol.h.

References m_library.

Referenced by LEGACY_RESCUER::AddSymbol(), SYMBOL_LIB::FindSymbol(), LIB_SYMBOL(), and SYMBOL_LIB::LoadSymbolLibrary().

◆ SetLibId()

void LIB_SYMBOL::SetLibId ( const LIB_ID & aLibId )

inline

Definition at line 164 of file lib_symbol.h.

References m_libId.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), LIB_BUFFER::CreateBuffer(), SYMBOL_LIB_TABLE::LoadSymbol(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseLibComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SYMBOL_BUFFER::SetOriginal(), SYMBOL_BUFFER::SetSymbol(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), and EDA_ITEM::SetModified().

◆ SetName()

void LIB_SYMBOL::SetName ( const wxString & aName )

virtual

Definition at line 589 of file lib_symbol.cpp.

References m_libId, m_name, and LIB_ID::SetLibItemName().

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::ensureUniqueName(), SYMBOL_EDIT_FRAME::ImportSymbol(), LIB_SYMBOL(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), SCH_ALTIUM_PLUGIN::ParseComponent(), SCH_ALTIUM_PLUGIN::ParseLibComponent(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties().

◆ SetNormal()

void LIB_SYMBOL::SetNormal ( )

Definition at line 746 of file lib_symbol.cpp.

References ENTRY_NORMAL, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetOffset()

void LIB_SYMBOL::SetOffset ( const VECTOR2I & aOffset )

Move the symbol aOffset.

Parameters

aOffset - Offset displacement.

Definition at line 1485 of file lib_symbol.cpp.

References m_drawings.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor().

◆ SetParent() [1/2]

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlineprivatevirtual

Reimplemented from EDA_ITEM.

Definition at line 100 of file eda_item.h.

◆ SetParent() [2/2]

void LIB_SYMBOL::SetParent ( LIB_SYMBOL * aParent = nullptr )

Definition at line 596 of file lib_symbol.cpp.

References m_parent, and SharedPtr().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), operator=(), LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetPinNameOffset()

void LIB_SYMBOL::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 624 of file lib_symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetPosition()

virtual void EDA_ITEM::SetPosition ( const VECTOR2I & aPos )

inlinevirtualinherited

Reimplemented in DELETED_SHEET_ITEM, DELETED_BOARD_ITEM, PCB_GROUP, PCB_VIA, LIB_PIN, SCH_SHAPE, GERBER_DRAW_ITEM, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, BOARD, FOOTPRINT, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_GENERATOR, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TRACK, PCB_ARC, ZONE, LIB_ITEM, LIB_SHAPE, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, KIGFX::ORIGIN_VIEWITEM, and PCB_REFERENCE_IMAGE.

Definition at line 240 of file eda_item.h.

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_ITEM::SetFPRelativePosition(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetPower()

void LIB_SYMBOL::SetPower ( )

Definition at line 718 of file lib_symbol.cpp.

References ENTRY_POWER, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), LTSPICE_SCH_PARSER::CreatePowerSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetShowPinNames()

void LIB_SYMBOL::SetShowPinNames ( bool aShow )

inline

Set or clear the pin name visibility flag.

Parameters

aShow - True to make the symbol pin names visible.

Definition at line 632 of file lib_symbol.h.

References m_showPinNames.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetShowPinNumbers()

void LIB_SYMBOL::SetShowPinNumbers ( bool aShow )

inline

Set or clear the pin number visibility flag.

Parameters

aShow - True to make the symbol pin numbers visible.

Definition at line 640 of file lib_symbol.h.

References m_showPinNumbers.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LTSPICE_SCH_PARSER::CreateSymbol(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetSourceLibId()

void LIB_SYMBOL::SetSourceLibId ( const LIB_ID & aLibId )

inline

Definition at line 167 of file lib_symbol.h.

References m_sourceLibId.

Referenced by SCH_HTTP_LIB_PLUGIN::loadSymbolFromPart(), and SCH_DATABASE_PLUGIN::loadSymbolFromRow().

◆ SetUnitCount()

void LIB_SYMBOL::SetUnitCount	(	int	aCount,
		bool	aDuplicateDrawItems = `true`
	)

Set the units per symbol count.

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

Parameters

aCount	- Number of units per package.
aDuplicateDrawItems	Create duplicate draw items of unit 1 for each additionl unit.

Definition at line 1610 of file lib_symbol.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), LIB_ITEM::Duplicate(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), m_drawings, LIB_ITEM::m_unit, m_unitCount, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), SCH_ALTIUM_PLUGIN::ParseLibComponent(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ SetUnitDisplayName()

void LIB_SYMBOL::SetUnitDisplayName	(	int	aUnit,
		const wxString &	aName
	)

Set the user-defined display name for aUnit to aName for symbols with units.

Definition at line 573 of file lib_symbol.cpp.

References GetUnitCount(), and m_unitDisplayNames.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName().

◆ SharedPtr()

LIB_SYMBOL_SPTR LIB_SYMBOL::SharedPtr ( ) const

inline

Definition at line 110 of file lib_symbol.h.

References m_me.

Referenced by SYMBOL_LIB::AddSymbol(), SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), SYMBOL_VIEWER_FRAME::GetDocumentExtents(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), and SetParent().

◆ ShowPinNames()

bool LIB_SYMBOL::ShowPinNames ( ) const

inline

Definition at line 633 of file lib_symbol.h.

References m_showPinNames.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN::print(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ ShowPinNumbers()

bool LIB_SYMBOL::ShowPinNumbers ( ) const

inline

Definition at line 641 of file lib_symbol.h.

References m_showPinNumbers.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN::print(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ Similarity()

double LIB_SYMBOL::Similarity ( const LIB_SYMBOL & aSymbol ) const

Return a measure of similarity between this symbol and aSymbol.

Parameters

aSymbol is the symbol to compare to.

Returns: a measure of similarity from 1.0 (identical) to 0.0 (no similarity).

Definition at line 1939 of file lib_symbol.cpp.

References GetAllLibPins(), m_drawings, m_excludedFromBoard, m_excludedFromBOM, m_excludedFromSim, EDA_ITEM::m_flags, m_pinNameOffset, m_showPinNames, m_showPinNumbers, m_unitCount, EDA_ITEM::m_Uuid, and pin.

◆ Sort()

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

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 428 of file eda_item.h.

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns: the type of object.

Definition at line 97 of file eda_item.h.

References EDA_ITEM::m_structType.

◆ UnitsLocked()

bool LIB_SYMBOL::UnitsLocked ( ) const

inline

Check whether symbol units are interchangeable.

Returns: False when interchangeable, true otherwise.

Definition at line 285 of file lib_symbol.h.

References m_unitsLocked.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GetUniqueUnits(), SCH_REFERENCE::IsUnitsLocked(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::SynchronizePins(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ UpdateFieldOrdinals()

int LIB_SYMBOL::UpdateFieldOrdinals ( )

Order optional field indices.

It's possible when calling LIB_SYMBOL::Flatten that there can be gaps and/or duplicate optional field indices. This method correctly orders the indices so there are no gaps and/or duplicate indices.

Definition at line 1446 of file lib_symbol.cpp.

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

Referenced by SCH_SEXPR_PARSER::ParseSchematic().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_PIN, SCH_PIN, GERBER_DRAW_ITEM, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, PCB_TUNING_PATTERN, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 273 of file eda_item.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), and PCB_SHAPE::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects 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

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, PCB_TUNING_PATTERN, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 115 of file view_item.h.

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

◆ ViewGetLayers()

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

overridevirtual

Return the all the layers within the VIEW the object is painted on.

For instance, a 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[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Reimplemented from EDA_ITEM.

Definition at line 1196 of file lib_symbol.cpp.

References LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_FIELDS, LAYER_NOTES_BACKGROUND, LAYER_PRIVATE_NOTES, LAYER_REFERENCEPART, LAYER_SELECTION_SHADOWS, and LAYER_VALUEPART.

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD	(	int	aLayer,
		VIEW *	aView
	)		const

inlinevirtualinherited

Return 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

aLayer	is the current drawing layer.
aView	is a pointer 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 SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_FIELD, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 141 of file view_item.h.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

◆ Visit()

INSPECT_RESULT LIB_SYMBOL::Visit	(	INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	aScanTypes
	)

overridevirtual

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 aScanTypes, and may use IterateForward() to do so on lists of such data.

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: #SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 1593 of file lib_symbol.cpp.

References m_drawings.

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 124 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ m_drawings

LIB_ITEMS_CONTAINER LIB_SYMBOL::m_drawings

private

◆ m_excludedFromBoard

bool LIB_SYMBOL::m_excludedFromBoard

private

Definition at line 762 of file lib_symbol.h.

Referenced by Compare(), GetExcludedFromBoard(), LIB_SYMBOL(), operator=(), operator==(), SetExcludedFromBoard(), and Similarity().

◆ m_excludedFromBOM

bool LIB_SYMBOL::m_excludedFromBOM

private

Definition at line 761 of file lib_symbol.h.

Referenced by Compare(), GetExcludedFromBOM(), LIB_SYMBOL(), operator=(), operator==(), SetExcludedFromBOM(), and Similarity().

◆ m_excludedFromSim

bool LIB_SYMBOL::m_excludedFromSim

private

Definition at line 760 of file lib_symbol.h.

Referenced by Compare(), GetExcludedFromSim(), LIB_SYMBOL(), operator=(), operator==(), SetExcludedFromSim(), and Similarity().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 487 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::GetTempFlags(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), LIB_PIN::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), PCB_SHAPE::operator==(), operator==(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::Similarity(), Similarity(), PCB_SHAPE::swapData(), PCB_REFERENCE_IMAGE::swapData(), SCH_ITEM::SwapFlags(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 166 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 486 of file eda_item.h.

Referenced by ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsForceVisible(), EDA_ITEM::operator=(), PCB_SHAPE::operator==(), EDA_ITEM::SetForceVisible(), PCB_SHAPE::Similarity(), PCB_SHAPE::swapData(), and PCB_REFERENCE_IMAGE::swapData().

◆ m_fpFilters

wxArrayString LIB_SYMBOL::m_fpFilters

private

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

Definition at line 770 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetFPFilters(), LIB_SYMBOL(), operator=(), and SetFPFilters().

◆ m_keyWords

wxString LIB_SYMBOL::m_keyWords

private

Search keywords.

Definition at line 769 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetKeyWords(), LIB_SYMBOL(), operator=(), and SetKeyWords().

◆ m_lastModDate

timestamp_t LIB_SYMBOL::m_lastModDate

private

Definition at line 749 of file lib_symbol.h.

Referenced by GetLastModDate(), LIB_SYMBOL(), and operator=().

◆ m_libId

LIB_ID LIB_SYMBOL::m_libId

private

Definition at line 747 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetLibId(), GetLibraryName(), LIB_SYMBOL(), LibId(), operator=(), operator==(), SetLibId(), and SetName().

◆ m_library

SYMBOL_LIB* LIB_SYMBOL::m_library

private

Definition at line 767 of file lib_symbol.h.

Referenced by Duplicate(), GetLib(), GetLibraryName(), LIB_SYMBOL(), operator=(), and SetLib().

◆ m_me

LIB_SYMBOL_SPTR LIB_SYMBOL::m_me

private

Definition at line 745 of file lib_symbol.h.

Referenced by Compare(), GetRootSymbol(), and SharedPtr().

◆ m_name

wxString LIB_SYMBOL::m_name

private

Definition at line 768 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetName(), LIB_SYMBOL(), operator=(), and SetName().

◆ m_options

LIBRENTRYOPTIONS LIB_SYMBOL::m_options

private

Special symbol features such as POWER or NORMAL.)

Definition at line 763 of file lib_symbol.h.

Referenced by Compare(), IsNormal(), IsPower(), LIB_SYMBOL(), operator=(), SetNormal(), and SetPower().

◆ m_parent

LIB_SYMBOL_REF LIB_SYMBOL::m_parent

private

Use for inherited symbols.

Definition at line 746 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetDescription(), GetFPFilters(), GetKeyWords(), GetMaxPinNumber(), GetParent(), GetPins(), GetRootSymbol(), GetUnitCount(), HasConversion(), IsAlias(), IsNormal(), IsPower(), IsRoot(), LIB_SYMBOL(), operator=(), SetNormal(), SetParent(), and SetPower().

◆ m_pinNameOffset

int LIB_SYMBOL::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 755 of file lib_symbol.h.

Referenced by Compare(), GetPinNameOffset(), LIB_SYMBOL(), operator=(), operator==(), SetPinNameOffset(), and Similarity().

◆ m_showPinNames

bool LIB_SYMBOL::m_showPinNames

private

Definition at line 757 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), operator=(), operator==(), SetShowPinNames(), ShowPinNames(), and Similarity().

◆ m_showPinNumbers

bool LIB_SYMBOL::m_showPinNumbers

private

Definition at line 758 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), operator=(), operator==(), SetShowPinNumbers(), ShowPinNumbers(), and Similarity().

◆ m_sourceLibId

LIB_ID LIB_SYMBOL::m_sourceLibId

private

For database library symbols; the original symbol.

Definition at line 748 of file lib_symbol.h.

Referenced by GetSourceLibId(), and SetSourceLibId().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

Run time identification, keep private so it can never be changed after a ctor sets it.

See comment near SetType() regarding virtual functions.

Definition at line 494 of file eda_item.h.

Referenced by EDA_ITEM::IsType(), EDA_ITEM::operator=(), and EDA_ITEM::Type().

◆ m_unitCount

int LIB_SYMBOL::m_unitCount

private

Number of units (parts) per package.

Definition at line 751 of file lib_symbol.h.

Referenced by Compare(), GetUnitBoundingBox(), GetUnitCount(), IsMulti(), LIB_SYMBOL(), operator=(), operator==(), SetUnitCount(), and Similarity().

◆ m_unitDisplayNames

std::map<int, wxString> LIB_SYMBOL::m_unitDisplayNames

private

Definition at line 773 of file lib_symbol.h.

Referenced by Compare(), CopyUnitDisplayNames(), GetUnitDisplayName(), HasUnitDisplayName(), LIB_SYMBOL(), operator=(), and SetUnitDisplayName().

◆ m_unitsLocked

bool LIB_SYMBOL::m_unitsLocked

private

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

Definition at line 752 of file lib_symbol.h.

Referenced by Compare(), LIB_SYMBOL(), LockUnits(), operator=(), and UnitsLocked().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 482 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 165 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LIB_SYMBOL() [1/2]

◆ LIB_SYMBOL() [2/2]

◆ ~LIB_SYMBOL()

Member Function Documentation

◆ AddDrawItem()

◆ AddField() [1/2]

◆ AddField() [2/2]

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ CopyUnitDisplayNames()

◆ deleteAllFields()

◆ Duplicate()

◆ FindField() [1/2]

◆ FindField() [2/2]

◆ FixupDrawItems()

◆ Flatten()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllLibPins()

◆ GetBodyBoundingBox()

◆ GetBoundingBox()

◆ GetChooserFields()

◆ GetClass()

◆ GetDatasheetField()

◆ GetDescription()

◆ GetDescriptionField()

◆ GetDrawItems() [1/2]

◆ GetDrawItems() [2/2]

◆ GetEditFlags()

◆ GetExcludedFromBoard()

◆ GetExcludedFromBOM()

◆ GetExcludedFromSim()

◆ GetFieldById()

◆ GetFieldCount()

◆ GetFields() [1/2]

◆ GetFields() [2/2]

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFootprint()

◆ GetFootprintField()

◆ GetForcedTransparency()

◆ GetFPFilters()

◆ GetFriendlyName()

◆ GetInheritanceDepth()

◆ GetItemDescription()

◆ GetKeyWords()

◆ GetLastModDate()

◆ GetLib()

◆ GetLibId()

◆ GetLibNickname()

◆ GetLibraryName()

◆ GetMaxPinNumber()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetNextAvailableFieldId()

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPin()

◆ GetPinCount()

◆ GetPinNameOffset()

◆ GetPins()

◆ GetPosition()