Define a library symbol object. More...

#include <lib_symbol.h>

Inheritance diagram for LIB_SYMBOL:

Classes
struct	LOGICAL_PIN
	Logical pins: Return expanded logical pins based on stacked-pin notation. More...

Public Types
enum	COMPARE_FLAGS : int { UNIT = 0x01 , EQUALITY = 0x02 , ERC = 0x04 , SKIP_TST_POS = 0x08 }
	The list of flags used by the compare function. More...

enum class	RETURN_CODE : int { OK , FILE_NOT_FOUND , PERMISSIONS_ERROR , FILE_ALREADY_EXISTS , OUT_OF_MEMORY , CHECKSUM_ERROR }

using	FILE_ADDED_CALLBACK = std::function<void( EMBEDDED_FILE* )>

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 ()=default

LIB_SYMBOL_SPTR	SharedPtr () const
	http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared.

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

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.

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

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

virtual void	SetName (const wxString &aName)

wxString	GetName () const override

LIB_ID	GetLIB_ID () const override

wxString	GetDesc () override

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

const 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.

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

wxString	GetDescription () const override

void	SetKeyWords (const wxString &aKeyWords)

wxString	GetKeyWords () const override

std::vector< SEARCH_TERM >	GetSearchTerms () override

wxString	GetFootprint () override
	For items with footprint fields.

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.

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

bool	IsDerived () 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

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

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

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

BOX2I	GetBodyBoundingBox () const override
	Return a bounding box for the symbol body but not the pins or fields.

BOX2I	GetBodyAndPinsBoundingBox () const override
	Return a bounding box for the symbol body and pins but not the fields.

bool	IsGlobalPower () const override

bool	IsLocalPower () const override

bool	IsPower () const override

bool	IsNormal () const override

void	SetGlobalPower ()

void	SetLocalPower ()

void	SetNormal ()

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

bool	UnitsLocked () const
	Check whether symbol units are interchangeable.

void	SetFields (const std::vector< SCH_FIELD > &aFieldsList)
	Overwrite all the existing fields in this symbol with fields supplied in aFieldsList.

void	GetFields (std::vector< SCH_FIELD * > &aList, bool aVisibleOnly=false) const override
	Populate a std::vector with SCH_FIELDs, sorted in ordinal order.

void	CopyFields (std::vector< SCH_FIELD > &aList)
	Create a copy of the SCH_FIELDs, sorted in ordinal order.

void	AddField (SCH_FIELD *aField)
	Add a field.

void	AddField (SCH_FIELD &aField)

int	GetNextFieldOrdinal () const
	Return the next ordinal for a user field for this symbol.

SCH_FIELD *	GetField (const wxString &aFieldName)
	Find a field within this symbol matching aFieldName; return nullptr if not found.

const SCH_FIELD *	GetField (const wxString &aFieldName) const

SCH_FIELD *	FindFieldCaseInsensitive (const wxString &aFieldName)

const SCH_FIELD *	GetField (FIELD_T aFieldType) const

SCH_FIELD *	GetField (FIELD_T aFieldType)

SCH_FIELD &	GetValueField ()
	Return reference to the value field.

const SCH_FIELD &	GetValueField () const

SCH_FIELD &	GetReferenceField ()
	Return reference to the reference designator field.

const SCH_FIELD &	GetReferenceField () const

SCH_FIELD &	GetFootprintField ()
	Return reference to the footprint field.

const SCH_FIELD &	GetFootprintField () const

SCH_FIELD &	GetDatasheetField ()
	Return reference to the datasheet field.

const SCH_FIELD &	GetDatasheetField () const

SCH_FIELD &	GetDescriptionField ()
	Return reference to the description field.

const SCH_FIELD &	GetDescriptionField () const

wxString	GetPrefix ()

const wxString	GetRef (const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override

const wxString	GetValue (bool aResolve, const SCH_SHEET_PATH *aPath, bool aAllowExtraText) const override

std::set< KIFONT::OUTLINE_FONT * >	GetFonts () const override

EMBEDDED_FILES *	GetEmbeddedFiles () override

const EMBEDDED_FILES *	GetEmbeddedFiles () const

void	EmbedFonts () override

void	AutoplaceFields (SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
	Automatically orient all the fields in the symbol.

void	RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode) override

bool	ResolveTextVar (wxString *token, int aDepth=0) const
	Resolve any references to system tokens supported by the symbol.

void	Plot (PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
	Plot the item to aPlotter.

void	PlotFields (PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed)
	Plot symbol fields.

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

void	RemoveDrawItem (SCH_ITEM *aItem)
	Remove draw aItem from list.

void	RemoveField (SCH_FIELD *aField)

std::vector< SCH_PIN * >	GetGraphicalPins (int aUnit=0, int aBodyStyle=0) const
	Graphical pins: Return schematic pin objects as drawn (unexpanded), filtered by unit/body.

std::vector< LOGICAL_PIN >	GetLogicalPins (int aUnit, int aBodyStyle) const
	Return all logical pins (expanded) filtered by unit/body.

std::vector< SCH_PIN * >	GetPins () const override

int	GetPinCount () override

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

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.

void	Move (const VECTOR2I &aOffset) override
	Move the symbol aOffset.

bool	HasLegacyAlternateBodyStyle () const
	Before V10 we didn't store the number of body styles in a symbol – we just looked through all its drawings each time we wanted to know.

int	GetMaxPinNumber () const

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

void	ClearEditFlags () override

SCH_ITEM *	LocateDrawItem (int aUnit, int aBodyStyle, KICAD_T aType, const VECTOR2I &aPoint)
	Locate a draw object.

SCH_ITEM *	LocateDrawItem (int aUnit, int aBodyStyle, KICAD_T aType, const VECTOR2I &aPoint, const TRANSFORM &aTransform)
	Locate a draw object (overlaid)

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

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.

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.

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

int	GetUnitCount () const override

wxString	GetUnitName (int aUnit) const override
	For items with units, return an identifier for unit x.

wxString	GetUnitDisplayName (int aUnit, bool aLabel) const override
	Return the user-defined display name for aUnit for symbols with units.

wxString	GetBodyStyleDescription (int aBodyStyle, bool aLabel) const override

std::map< int, wxString > &	GetUnitDisplayNames ()

const std::map< int, wxString > &	GetUnitDisplayNames () const

bool	GetDuplicatePinNumbersAreJumpers () const

void	SetDuplicatePinNumbersAreJumpers (bool aEnabled)

std::vector< std::set< wxString > > &	JumperPinGroups ()
	Each jumper pin group is a set of pin numbers that should be treated as internally connected.

const std::vector< std::set< wxString > > &	JumperPinGroups () const

std::optional< const std::set< wxString > >	GetJumperPinGroup (const wxString &aPinNumber) const
	Retrieves the jumper group containing the specified pin number, if one exists.

bool	IsMultiUnit () const override

bool	IsMultiBodyStyle () const override

int	GetBodyStyleCount () const override

bool	HasDeMorganBodyStyles () const override

void	SetHasDeMorganBodyStyles (bool aFlag)

const std::vector< wxString > &	GetBodyStyleNames () const

void	SetBodyStyleNames (const std::vector< wxString > &aBodyStyleNames)

void	SetBodyStyleCount (int aCount, bool aDuplicateDrawItems, bool aDuplicatePins)
	Set or clear the alternate body style (DeMorgan) for the symbol.

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

const LIB_SYMBOL &	operator= (const LIB_SYMBOL &aSymbol)

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

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

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

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

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

int	GetPinNameOffset () const

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

virtual bool	GetShowPinNames () const

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

virtual bool	GetShowPinNumbers () const

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

bool	GetExcludedFromSim () const override

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

bool	GetExcludedFromBOM () const override

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

bool	GetExcludedFromBoard () const override

bool	GetDNP () const override
	Set or clear the 'Do Not Populate' flag.

void	SetDNP (bool aDNP) override

virtual int	GetOrientation () const

const TRANSFORM &	GetTransform () const

TRANSFORM &	GetTransform ()

void	SetTransform (const TRANSFORM &aTransform)

void	SetPreviewUnit (int aUnit)

void	SetPreviewBodyStyle (int aBodyStyle)

std::vector< int >	ViewGetLayers () const override
	Return the layers the item is drawn on (which may be more than its "home" layer)

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

bool	IsGroupableType () const

void	SwapItemData (SCH_ITEM *aImage)
	Swap data between aItem and aImage.

void	SwapFlags (SCH_ITEM *aItem)
	Swap the non-temp and non-edit flags.

SCH_ITEM *	Duplicate (bool addToParentGroup, SCH_COMMIT *aCommit=nullptr, bool doClone=false) const
	Routine to create a new copy of given item.

virtual void	SetUnit (int aUnit)

int	GetUnit () const

virtual void	SetBodyStyle (int aBodyStyle)

int	GetBodyStyle () const

virtual void	SetBodyStyleProp (const wxString &aBodyStyle)

virtual wxString	GetBodyStyleProp () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

bool	ResolveExcludedFromSim () const

bool	ResolveExcludedFromBOM () const

bool	ResolveExcludedFromBoard () const

bool	ResolveDNP () const

virtual bool	IsMovableFromAnchorPoint () const
	Check if object is movable from the anchor point.

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

SCHEMATIC *	Schematic () const
	Search the item hierarchy to find a SCHEMATIC.

const SYMBOL *	GetParentSymbol () const

SYMBOL *	GetParentSymbol ()

virtual bool	IsHypertext () const
	Allow items to support hypertext actions when hovered/clicked.

virtual void	DoHypertextAction (EDA_DRAW_FRAME *aFrame) const

SCH_LAYER_ID	GetLayer () const
	Return the layer this item is on.

void	SetLayer (SCH_LAYER_ID aLayer)

virtual int	GetPenWidth () const

int	GetEffectivePenWidth (const SCH_RENDER_SETTINGS *aSettings) const

const wxString &	GetDefaultFont (const RENDER_SETTINGS *aSettings) const

const KIFONT::METRICS &	GetFontMetrics () const

bool	RenderAsBitmap (double aWorldScale) const override

double	SimilarityBase (const SCH_ITEM &aItem) const
	Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.

virtual void	MirrorHorizontally (int aCenter)
	Mirror item horizontally about aCenter.

virtual void	MirrorVertically (int aCenter)
	Mirror item vertically about aCenter.

virtual void	Rotate (const VECTOR2I &aCenter, bool aRotateCCW)
	Rotate the item around aCenter 90 degrees in the clockwise direction.

virtual void	BeginEdit (const VECTOR2I &aPosition)
	Begin drawing a symbol library draw item at aPosition.

virtual bool	ContinueEdit (const VECTOR2I &aPosition)
	Continue an edit in progress at aPosition.

virtual void	EndEdit (bool aClosed=false)
	End an object editing action.

virtual void	CalcEdit (const VECTOR2I &aPosition)
	Calculate the attributes of an item at aPosition when it is being edited.

virtual void	GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList)
	Add the schematic item end points to aItemList if the item has end points.

virtual bool	UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, const SCH_SHEET_PATH *aSheet=nullptr)
	Test the schematic item to aItemList to check if it's dangling state has changed.

virtual bool	IsEndPoint (const VECTOR2I &aPt) const
	Test if aPt is an end point of this schematic object.

virtual bool	IsDangling () const

virtual bool	CanConnect (const SCH_ITEM *aItem) const

virtual bool	IsConnectable () const

virtual bool	IsPointClickableAnchor (const VECTOR2I &aPos) const

virtual std::vector< VECTOR2I >	GetConnectionPoints () const
	Add all the connection points for this item to aPoints.

bool	IsConnected (const VECTOR2I &aPoint) const
	Test the item to see if it is connected to aPoint.

SCH_CONNECTION *	Connection (const SCH_SHEET_PATH *aSheet=nullptr) const
	Retrieve the connection associated with this object in the given sheet.

const SCH_ITEM_VEC &	ConnectedItems (const SCH_SHEET_PATH &aPath)
	Retrieve the set of items connected to this item on the given sheet.

void	AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
	Add a connection link between this item and another.

void	ClearConnectedItems (const SCH_SHEET_PATH &aPath)
	Clear all connections to this item.

SCH_CONNECTION *	InitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
	Create a new connection object associated with this object.

SCH_CONNECTION *	GetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)

virtual bool	ConnectionPropagatesTo (const EDA_ITEM *aItem) const
	Return true if this item should propagate connection info to aItem.

bool	IsConnectivityDirty () const

void	SetConnectivityDirty (bool aDirty=true)

virtual bool	HasConnectivityChanges (const SCH_ITEM aItem, const SCH_SHEET_PATH aInstance=nullptr) const
	Check if aItem has connectivity changes against this object.

void	SetConnectionGraph (CONNECTION_GRAPH *aGraph)
	Update the connection graph for all connections in this item.

virtual bool	HasCachedDriverName () const

virtual const wxString &	GetCachedDriverName () const

virtual void	SetLastResolvedState (const SCH_ITEM *aItem)

std::shared_ptr< NETCLASS >	GetEffectiveNetClass (const SCH_SHEET_PATH *aSheet=nullptr) const

AUTOPLACE_ALGO	GetFieldsAutoplaced () const
	Return whether the fields have been automatically placed.

void	SetFieldsAutoplaced (AUTOPLACE_ALGO aAlgo)

virtual void	ClearCaches ()

virtual bool	HasLineStroke () const
	Check if this schematic item has line stoke properties.

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

void	ClearRuleAreasCache ()
	Reset the cache of rule areas (called prior to schematic connectivity computation)

void	AddRuleAreaToCache (SCH_RULE_AREA *aRuleArea)
	Add a rule area to the item's cache.

const std::unordered_set< SCH_RULE_AREA * > &	GetRuleAreaCache () const
	Get the cache of rule areas enclosing this item.

const std::vector< wxString > *	GetEmbeddedFonts () override

virtual bool	operator== (const SCH_ITEM &aOther) const

virtual bool	operator< (const SCH_ITEM &aItem) const

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetIsRollover (bool aIsRollover)

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

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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.

bool	IsForceVisible () const

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.

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

virtual bool	HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const
	Test if aPoly intersects this item.

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.

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

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

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

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

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

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

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.

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

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

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue, bool aNotify=true)

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

bool	Set (PROPERTY_BASE *aProperty, wxVariant aValue, bool aNotify=true)

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

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

virtual void	Serialize (google::protobuf::Any &aContainer) const
	Serializes this object to the given Any message.

virtual bool	Deserialize (const google::protobuf::Any &aContainer)
	Deserializes the given protobuf message into this object.

void	SetFileAddedCallback (FILE_ADDED_CALLBACK callback)

FILE_ADDED_CALLBACK	GetFileAddedCallback () const

EMBEDDED_FILE *	AddFile (const wxFileName &aName, bool aOverwrite)
	Load a file from disk and adds it to the collection.

void	AddFile (EMBEDDED_FILE *aFile)
	Append a file to the collection.

void	RemoveFile (const wxString &name, bool aErase=true)
	Remove a file from the collection and frees the memory.

void	WriteEmbeddedFiles (OUTPUTFORMATTER &aOut, bool aWriteData) const
	Output formatter for the embedded files.

wxString	GetEmbeddedFileLink (const EMBEDDED_FILE &aFile) const
	Return the link for an embedded file.

bool	HasFile (const wxString &name) const

bool	IsEmpty () const

virtual void	RunOnNestedEmbeddedFiles (const std::function< void(EMBEDDED_FILES *)> &aFunction)
	Provide access to nested embedded files, such as symbols in schematics and footprints in boards.

const std::vector< wxString > *	UpdateFontFiles ()
	Helper function to get a list of fonts for fontconfig to add to the library.

const std::vector< wxString > *	GetFontFiles () const
	If we just need the cached version of the font files, we can use this function which is const and will not update the font files.

void	ClearEmbeddedFonts ()
	Remove all embedded fonts from the collection.

EMBEDDED_FILE *	GetEmbeddedFile (const wxString &aName) const
	Returns the embedded file with the given name or nullptr if it does not exist.

const std::map< wxString, EMBEDDED_FILE * > &	EmbeddedFileMap () const

wxFileName	GetTemporaryFileName (const wxString &aName) const

wxFileName	GetTemporaryFileName (EMBEDDED_FILE *aFile) const

void	ClearEmbeddedFiles (bool aDeleteFiles=true)

void	SetAreFontsEmbedded (bool aEmbedFonts)

bool	GetAreFontsEmbedded () const

Static Public Member Functions
static LIB_SYMBOL *	GetDummy ()
	Returns a dummy LIB_SYMBOL, used when one is missing in the schematic.

static bool	ClassOf (const EDA_ITEM *aItem)

static wxString	LetterSubReference (int aUnit, wxChar aInitialLetter)

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.

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.

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.

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.

static RETURN_CODE	CompressAndEncode (EMBEDDED_FILE &aFile)
	Take data from the #decompressedData buffer and compresses it using ZSTD into the #compressedEncodedData buffer.

static RETURN_CODE	DecompressAndDecode (EMBEDDED_FILE &aFile)
	Takes data from the #compressedEncodedData buffer and Base64 decodes it.

static uint32_t	Seed ()

Public Attributes
const KIID	m_Uuid

Protected Member Functions
virtual void	swapData (SCH_ITEM *aItem)
	Swap the internal data structures aItem with the schematic item.

SCH_RENDER_SETTINGS *	getRenderSettings (PLOTTER *aPlotter) const

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

EDA_ITEM *	findParent (KICAD_T aType) const

Static Protected Member Functions
static double	lodScaleForThreshold (const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
	Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

Protected Attributes
TRANSFORM	m_transform
	The rotation/mirror transformation.

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

bool	m_showPinNames

bool	m_showPinNumbers

bool	m_excludedFromSim

bool	m_excludedFromBOM

bool	m_excludedFromBoard

bool	m_DNP
	True if symbol is set to 'Do Not Populate'.

int	m_previewUnit = 1

int	m_previewBodyStyle = 1

SCH_LAYER_ID	m_layer

int	m_unit

int	m_bodyStyle

bool	m_private

AUTOPLACE_ALGO	m_fieldsAutoplaced

VECTOR2I	m_storedPos

std::map< SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP >	m_connected_items
	Store pointers to other items that are connected to this one, per sheet.

std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * >	m_connection_map
	Store connectivity information, per sheet.

bool	m_connectivity_dirty

std::unordered_set< SCH_RULE_AREA * >	m_rule_areas_cache
	Store pointers to rule areas which this item is contained within.

EDA_ITEM_FLAGS	m_flags

EDA_GROUP *	m_group
	The group this item belongs to, if any. No ownership implied.

bool	m_forceVisible

bool	m_isRollover

bool	m_embedFonts = false
	If set, fonts will be embedded in the element on save.

Static Protected Attributes
static constexpr double	LOD_HIDE = std::numeric_limits<double>::max()
	Return this constant from ViewGetLOD() to hide the item unconditionally.

static constexpr double	LOD_SHOW = 0.0
	Return this constant from ViewGetLOD() to show the item unconditionally.

Private Member Functions
int	compare (const SCH_ITEM &aOther, int aCompareFlags=SCH_ITEM::COMPARE_FLAGS::EQUALITY) const override
	The library symbol specific sort order is as follows:

void	deleteAllFields ()

virtual void	SetParent (EDA_ITEM *aParent)

virtual bool	doIsConnected (const VECTOR2I &aPosition) const
	Provide the object specific test to see if it is connected to aPosition.

Private Attributes
LIB_SYMBOL_SPTR	m_me

LIB_SYMBOL_REF	m_parent
	Use for inherited symbols.

LIB_ID	m_libId

LIB_ID	m_sourceLibId
	For database library symbols; the original symbol.

timestamp_t	m_lastModDate

int	m_unitCount
	Number of units (parts) per package.

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

bool	m_demorgan
	True if there are two body styles: normal and De Morgan If false, the body style count is taken from m_bodyStyleNames size.

LIBRENTRYOPTIONS	m_options
	Special symbol features such as POWER or NORMAL.

LIB_ITEMS_CONTAINER	m_drawings

SYMBOL_LIB *	m_library

wxString	m_name

wxString	m_keyWords
	Search keywords.

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

std::vector< std::set< wxString > >	m_jumperPinGroups
	A list of jumper pin groups, each of which is a set of pin numbers that should be jumpered together (treated as internally connected for the purposes of connectivity)

bool	m_duplicatePinNumbersAreJumpers
	Flag that this symbol should automatically treat sets of two or more pins with the same number as jumpered pin groups.

std::map< int, wxString >	m_unitDisplayNames

std::vector< wxString >	m_bodyStyleNames

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

std::map< wxString, EMBEDDED_FILE * >	m_files

std::vector< wxString >	m_fontFiles

FILE_ADDED_CALLBACK	m_fileAddedCallback

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

Member Typedef Documentation

◆ FILE_ADDED_CALLBACK

using EMBEDDED_FILES::FILE_ADDED_CALLBACK = std::function<void( EMBEDDED_FILE* )>

inherited

Definition at line 113 of file embedded_files.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum SCH_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, body-style and pin-number constraints. It is used for SCH_ITEM object unit comparisons.

EQUALITY This flag relaxes ordering constraints so that fields, etc. don't have to appear in the same order to be considered equal.

ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

SKIP_TST_POS This flag relaxes comparisons on position (mainly for fields) for ERC.

Enumerator
UNIT
EQUALITY
ERC
SKIP_TST_POS

Definition at line 666 of file sch_item.h.

◆ RETURN_CODE

enum class EMBEDDED_FILES::RETURN_CODE : int

stronginherited

Enumerator
OK	Success.
FILE_NOT_FOUND	File not found on disk.
PERMISSIONS_ERROR	Could not read/write file.
FILE_ALREADY_EXISTS	File already exists in the collection.
OUT_OF_MEMORY	Could not allocate memory.
CHECKSUM_ERROR	Checksum in file does not match data.

Definition at line 92 of file embedded_files.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 93 of file lib_symbol.cpp.

References DATASHEET, DEFAULT_PIN_NAME_OFFSET, DESCRIPTION, ENTRY_NORMAL, FOOTPRINT, LIB_SYMBOL(), LIB_SYMBOL_T, m_demorgan, m_drawings, m_duplicatePinNumbersAreJumpers, m_lastModDate, m_me, m_options, SYMBOL::m_pinNameOffset, m_unitCount, m_unitsLocked, REFERENCE, SCH_FIELD_T, schIUScale, SetLib(), SetName(), SetParent(), EDA_TEXT::SetVisible(), SYMBOL::SYMBOL(), and VALUE.

Referenced by Compare(), compare(), Duplicate(), GetDummy(), LIB_SYMBOL(), LIB_SYMBOL(), operator=(), PinsConflictWith(), SetParent(), and Similarity().

◆ LIB_SYMBOL() [2/2]

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

◆ ~LIB_SYMBOL()

virtual LIB_SYMBOL::~LIB_SYMBOL ( )

virtualdefault

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo	(	const SCH_SHEET_PATH &	aPath,
		SCH_ITEM *	aItem )

inherited

Add a connection link between this item and another.

Definition at line 388 of file sch_item.cpp.

References m_connected_items, and SCH_ITEM().

Referenced by SCH_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ AddDrawItem()

void LIB_SYMBOL::AddDrawItem	(	SCH_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 771 of file lib_symbol.cpp.

References m_drawings, SCH_ITEM::SCH_ITEM(), and EDA_ITEM::SetParent().

◆ AddField() [1/2]

void LIB_SYMBOL::AddField ( SCH_FIELD & aField )

inline

Definition at line 317 of file lib_symbol.h.

References AddField().

Referenced by AddField().

◆ AddField() [2/2]

void LIB_SYMBOL::AddField ( SCH_FIELD * aField )

Add a field.

Takes ownership of the pointer.

Definition at line 1039 of file lib_symbol.cpp.

References AddDrawItem().

Referenced by SCH_IO_HTTP_LIB::loadSymbolFromPart(), and SCH_EASYEDAPRO_PARSER::ParseSymbol().

◆ AddFile() [1/2]

EMBEDDED_FILES::EMBEDDED_FILE * EMBEDDED_FILES::AddFile	(	const wxFileName &	aName,
		bool	aOverwrite )

inherited

Load a file from disk and adds it to the collection.

Parameters

aName	is the name of the file to load.
aOverwrite	is true if the file should be overwritten if it already exists.

Definition at line 42 of file embedded_files.cpp.

References CompressAndEncode(), EMBEDDED_FILES::EMBEDDED_FILE::DATASHEET, EMBEDDED_FILES::EMBEDDED_FILE::FONT, HasFile(), m_fileAddedCallback, m_files, EMBEDDED_FILES::EMBEDDED_FILE::MODEL, OK, result, and EMBEDDED_FILES::EMBEDDED_FILE::WORKSHEET.

Referenced by PCB_CONTROL::CollectAndEmbed3DModels(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), BOARD::EmbedFonts(), FOOTPRINT::EmbedFonts(), LIB_SYMBOL::EmbedFonts(), SCHEMATIC::EmbedFonts(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), ALTIUM_PCB::ParseComponentsBodies6Data(), and EMBEDDED_FILES_PARSER::ParseEmbedded().

◆ AddFile() [2/2]

void EMBEDDED_FILES::AddFile ( EMBEDDED_FILE * aFile )

inherited

Append a file to the collection.

Definition at line 114 of file embedded_files.cpp.

References m_fileAddedCallback, m_files, and EMBEDDED_FILES::EMBEDDED_FILE::name.

◆ AddRuleAreaToCache()

void SCH_ITEM::AddRuleAreaToCache ( SCH_RULE_AREA * aRuleArea )

inlineinherited

Add a rule area to the item's cache.

Definition at line 640 of file sch_item.h.

References m_rule_areas_cache.

Referenced by SCH_RULE_AREA::addContainedItem().

◆ AutoplaceFields()

void LIB_SYMBOL::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		AUTOPLACE_ALGO	aAlgo )

overridevirtual

Automatically orient all the fields in the symbol.

Parameters

aScreen is the SCH_SCREEN associated with the current instance of the symbol. Required when aAlgo is AUTOPLACE_MANUAL; optional otherwise.

Reimplemented from SCH_ITEM.

Definition at line 741 of file autoplace_fields.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_MANUAL, AUTOPLACER::DoAutoplace(), and SCH_ITEM::m_fieldsAutoplaced.

◆ BeginEdit()

virtual void SCH_ITEM::BeginEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

Begin drawing a symbol library draw item at aPosition.

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

Parameters

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

Reimplemented in SCH_FIELD, SCH_SHAPE, and SCH_TEXT.

Definition at line 403 of file sch_item.h.

◆ CalcEdit()

virtual void SCH_ITEM::CalcEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

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

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

Parameters

aPosition The current mouse position in drawing coordinates.

Reimplemented in SCH_FIELD, SCH_PIN, SCH_SHAPE, and SCH_TEXT.

Definition at line 433 of file sch_item.h.

◆ CanConnect()

virtual bool SCH_ITEM::CanConnect ( const SCH_ITEM * aItem ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 488 of file sch_item.h.

References GetLayer(), m_layer, and SCH_ITEM().

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ ClassOf()

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

inlinestatic

Definition at line 142 of file lib_symbol.h.

References EDA_ITEM::EDA_ITEM(), LIB_SYMBOL_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 138 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 497 of file sch_item.cpp.

References NO_RECURSE, RunOnChildren(), SCH_ITEM(), and text.

◆ ClearConnectedItems()

void SCH_ITEM::ClearConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Clear all connections to this item.

Definition at line 373 of file sch_item.cpp.

References m_connected_items.

Referenced by CONNECTION_GRAPH::updateGenericItemConnectivity(), CONNECTION_GRAPH::updatePinConnectivity(), and CONNECTION_GRAPH::updateSymbolConnectivity().

◆ ClearEditFlags()

void LIB_SYMBOL::ClearEditFlags ( )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1310 of file lib_symbol.cpp.

References EDA_ITEM::ClearEditFlags(), m_drawings, and SCH_ITEM::SCH_ITEM().

Referenced by SYMBOL_EDIT_FRAME::PushSymbolToUndoList().

◆ ClearEmbeddedFiles()

void EMBEDDED_FILES::ClearEmbeddedFiles ( bool aDeleteFiles = true )

inlineinherited

Definition at line 242 of file embedded_files.h.

References m_files.

Referenced by PCB_IO_KICAD_SEXPR::format(), operator=(), and operator=().

◆ ClearEmbeddedFonts()

void EMBEDDED_FILES::ClearEmbeddedFonts ( )

inherited

Remove all embedded fonts from the collection.

Definition at line 138 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::FONT, and m_files.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 144 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, and m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::ApplyDesignBlockLayout(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_EDIT_FRAME::ExchangeFootprint(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), GERBVIEW_FRAME::RemapLayers(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearRuleAreasCache()

void SCH_ITEM::ClearRuleAreasCache ( )

inlineinherited

Reset the cache of rule areas (called prior to schematic connectivity computation)

Definition at line 635 of file sch_item.h.

References m_rule_areas_cache.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), ARRAY_TOOL::onDialogClosed(), SCH_COMMIT::Revert(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void LIB_SYMBOL::ClearTempFlags ( )

overridevirtual

Clears the status flag all draw objects in this symbol.

Reimplemented from EDA_ITEM.

Definition at line 1301 of file lib_symbol.cpp.

References EDA_ITEM::ClearTempFlags(), m_drawings, and SCH_ITEM::SCH_ITEM().

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

◆ 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 BOARD_BOUNDING_BOX, FOOTPRINT, KIGFX::ANCHOR_DEBUG, KIGFX::ORIGIN_VIEWITEM, KIGFX::SNAP_INDICATOR, MOCK_BOARD_ITEM, NETINFO_ITEM, PAD, PCB_ARC, PCB_BOARD_OUTLINE, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_FIELD, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TABLECELL, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, SCH_BITMAP, SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GLOBALLABEL, SCH_GROUP, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_RULE_AREA, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, SCH_TEXT, SCH_TEXTBOX, TEST_EDA_ITEM, TEST_EDA_ITEM, and ZONE.

Definition at line 118 of file eda_item.cpp.

References EDA_ITEM(), and KIGFX::VIEW_ITEM::GetClass().

Referenced by BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_COMMIT::MakeImage(), SCH_COMMIT::makeImage(), TEST_COMMIT::makeImage(), new_clone(), PCB_POINT_EDITOR::OnSelectionChange(), LIB_SYMBOL::operator=(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), and SCH_DRAWING_TOOLS::SingleClickPlace().

◆ 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 1547 of file lib_symbol.cpp.

References _, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), ENTRY_NORMAL, SCH_ITEM::EQUALITY, SCH_ITEM::ERC, GetField(), GetPin(), EDA_TEXT::GetText(), ITEM_DESC, LIB_SYMBOL(), m_bodyStyleNames, m_drawings, SYMBOL::m_excludedFromBoard, SYMBOL::m_excludedFromBOM, SYMBOL::m_excludedFromSim, m_fpFilters, m_keyWords, m_libId, m_me, m_name, m_options, m_parent, SYMBOL::m_pinNameOffset, SYMBOL::m_showPinNames, SYMBOL::m_showPinNumbers, m_unitCount, m_unitDisplayNames, m_unitsLocked, MM, REPORT, SCH_FIELD_T, SCH_PIN_T, SCH_SHAPE_T, and schIUScale.

Referenced by BOOST_AUTO_TEST_CASE(), and compare().

◆ compare()

int LIB_SYMBOL::compare	(	const SCH_ITEM &	aOther,
		int	aCompareFlags = SCH_ITEM::COMPARE_FLAGS::EQUALITY ) const

overrideprivatevirtual

The library symbol specific sort order is as follows:

The result of SCH_ITEM::compare()

Reimplemented from SCH_ITEM.

Definition at line 1862 of file lib_symbol.cpp.

References Compare(), LIB_SYMBOL(), SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

◆ CompressAndEncode()

EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::CompressAndEncode ( EMBEDDED_FILE & aFile )

staticinherited

Take data from the #decompressedData buffer and compresses it using ZSTD into the #compressedEncodedData buffer.

The data is then Base64 encoded. This call is used when adding a new file to the collection from disk.

Definition at line 218 of file embedded_files.cpp.

References MMH3_HASH::add(), EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::decompressedData, MMH3_HASH::digest(), OK, OUT_OF_MEMORY, Seed(), and HASH_128::ToString().

Referenced by AddFile(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), and ALTIUM_PCB::ParseComponentsBodies6Data().

◆ ConnectedItems()

const SCH_ITEM_VEC & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Retrieve the set of items connected to this item on the given sheet.

Definition at line 382 of file sch_item.cpp.

References m_connected_items.

Referenced by addConnections(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Retrieve the connection associated with this object in the given sheet.

Note: The returned value can be nullptr.

Definition at line 323 of file sch_item.cpp.

References SCHEMATIC::CurrentSheet(), IsConnectable(), m_connection_map, and Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_SUBGRAPH::ExchangeItem(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), CONNECTION_GRAPH::GetBusesNeedingMigration(), GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), GetOrInitConnection(), highlightNet(), InitializeConnection(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_EDITOR_CONTROL::SimProbe(), BUS_UNFOLD_MENU::update(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM * aItem ) const

inlinevirtualinherited

Return true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_LINE, and SCH_PIN.

Definition at line 552 of file sch_item.h.

References EDA_ITEM::EDA_ITEM().

◆ ContinueEdit()

virtual bool SCH_ITEM::ContinueEdit ( const VECTOR2I & aPosition )

inlinevirtualinherited

Continue an edit in progress at aPosition.

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

Parameters

aPosition The position of the mouse left click in drawing coordinates.

Returns: True if additional mouse clicks are required to complete the edit in progress.

Reimplemented in SCH_SHAPE.

Definition at line 415 of file sch_item.h.

◆ CopyFields()

void LIB_SYMBOL::CopyFields ( std::vector< SCH_FIELD > & aList )

Create a copy of the SCH_FIELDs, sorted in ordinal order.

Definition at line 1085 of file lib_symbol.cpp.

References GetFields().

◆ DecompressAndDecode()

EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::DecompressAndDecode ( EMBEDDED_FILE & aFile )

staticinherited

Takes data from the #compressedEncodedData buffer and Base64 decodes it.

The data is then decompressed using ZSTD and stored in the #decompressedData buffer. This call is used when loading the embedded files using the parsers.

Definition at line 253 of file embedded_files.cpp.

References MMH3_HASH::add(), CHECKSUM_ERROR, EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::decompressedData, MMH3_HASH::digest(), EMBEDDED_FILES::EMBEDDED_FILE::name, OK, OUT_OF_MEMORY, Seed(), and HASH_128::ToString().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and EMBEDDED_FILES_PARSER::ParseEmbedded().

◆ deleteAllFields()

void LIB_SYMBOL::deleteAllFields ( )

private

Definition at line 1033 of file lib_symbol.cpp.

References m_drawings, and SCH_FIELD_T.

Referenced by SetFields().

◆ Deserialize()

bool SERIALIZABLE::Deserialize ( const google::protobuf::Any & aContainer )

virtualinherited

Deserializes the given protobuf message into this object.

Parameters

aContainer is an Any which should have a concrete type matching this object

Returns: true if unpacking and deserialization succeeded

Reimplemented in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 30 of file serializable.cpp.

Referenced by ~SERIALIZABLE().

◆ DoHypertextAction()

virtual void SCH_ITEM::DoHypertextAction ( EDA_DRAW_FRAME * aFrame ) const

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 304 of file sch_item.h.

◆ doIsConnected()

virtual bool SCH_ITEM::doIsConnected ( const VECTOR2I & aPosition ) const

inlineprivatevirtualinherited

Provide the object specific test to see if it is connected to aPosition.

Note: Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.

Parameters

aPosition is a reference to a VECTOR2I object containing the test position.

Returns: True if connection to aPosition exists.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 736 of file sch_item.h.

Referenced by IsConnected().

◆ Duplicate() [1/2]

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

References LIB_SYMBOL(), SCH_ITEM::LIB_SYMBOL, m_drawings, m_library, EDA_ITEM::m_Uuid, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_IO_HTTP_LIB::loadSymbolFromPart(), and SCH_IO_DATABASE::loadSymbolFromRow().

◆ Duplicate() [2/2]

SCH_ITEM * SCH_ITEM::Duplicate	(	bool	addToParentGroup,
		SCH_COMMIT *	aCommit = nullptr,
		bool	doClone = false ) const

inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters

addToParentGroup	Indicates whether or not the new item is added to the group (if any) containing the old item. If true, aCommit must be provided.
aDoClone	(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 137 of file sch_item.cpp.

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::m_Uuid, COMMIT::Modify(), NO_RECURSE, RunOnChildren(), SCH_ITEM(), and SELECTED.

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), SCH_LINE::BreakAt(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_GROUP::DeepDuplicate(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_IO_EAGLE::loadSchematic(), SCH_LINE::NonGroupAware_BreakAt(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ EmbeddedFileMap()

const std::map< wxString, EMBEDDED_FILE * > & EMBEDDED_FILES::EmbeddedFileMap ( ) const

inlineinherited

Definition at line 233 of file embedded_files.h.

References m_files.

Referenced by BOARD::FixupEmbeddedData(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ EmbedFonts()

void LIB_SYMBOL::EmbedFonts ( )

overridevirtual

Reimplemented from EMBEDDED_FILES.

Definition at line 1998 of file lib_symbol.cpp.

References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::EMBEDDED_FILE::FONT, fonts, GetEmbeddedFiles(), GetFonts(), and EMBEDDED_FILES::EMBEDDED_FILE::type.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ EndEdit()

virtual void SCH_ITEM::EndEdit ( bool aClosed = false )

inlinevirtualinherited

End an object editing action.

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

Reimplemented in SCH_SHAPE.

Definition at line 422 of file sch_item.h.

◆ FindFieldCaseInsensitive()

SCH_FIELD * LIB_SYMBOL::FindFieldCaseInsensitive ( const wxString & aFieldName )

Definition at line 1163 of file lib_symbol.cpp.

References SCH_FIELD::GetCanonicalName(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

Referenced by NETLIST_EXPORTER_ALLEGRO::getGroupField(), and SCH_EASYEDAPRO_PARSER::ParseSymbol().

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 75 of file eda_item.cpp.

References EDA_ITEM(), GetParent(), and Type().

Referenced by BOARD_ITEM::GetBoard(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParentFootprint(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetParentSymbol(), and SCH_ITEM::Schematic().

◆ 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 704 of file lib_symbol.cpp.

References FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, EDA_SHAPE::GetFillMode(), m_drawings, SCH_ITEM::SCH_ITEM(), and SCH_SHAPE_T.

Referenced by SCH_IO_ALTIUM::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 330 of file lib_symbol.cpp.

References AddDrawItem(), Flatten(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromSim(), GetField(), GetFPFilters(), GetKeyWords(), SCH_FIELD::GetName(), IsDerived(), EMBEDDED_FILES::IsEmpty(), SCH_FIELD::IsMandatory(), m_drawings, m_fpFilters, m_keyWords, m_libId, m_name, m_parent, MANDATORY_FIELDS, RemoveDrawItem(), SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), SYMBOL::SetExcludedFromBoard(), SYMBOL::SetExcludedFromBOM(), SYMBOL::SetExcludedFromSim(), SetFPFilters(), SetKeyWords(), SetLibId(), and EDA_ITEM::SetParent().

Referenced by SCH_SCREEN::Append(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_INSPECTION_TOOL::DiffSymbol(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), Flatten(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), 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 141 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 121 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(), PCBEXPR_VAR_REF::GetValue(), and SCHEMATIC::SCHEMATIC().

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 129 of file inspectable.h.

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

◆ GetAreFontsEmbedded()

bool EMBEDDED_FILES::GetAreFontsEmbedded ( ) const

inlineinherited

Definition at line 265 of file embedded_files.h.

References m_embedFonts.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetBodyAndPinsBoundingBox()

BOX2I LIB_SYMBOL::GetBodyAndPinsBoundingBox ( ) const

inlineoverridevirtual

Return a bounding box for the symbol body and pins but not the fields.

Implements SYMBOL.

Definition at line 267 of file lib_symbol.h.

References GetBodyBoundingBox(), SYMBOL::m_previewBodyStyle, and SYMBOL::m_previewUnit.

◆ GetBodyBoundingBox() [1/2]

BOX2I LIB_SYMBOL::GetBodyBoundingBox ( ) const

inlineoverridevirtual

Return a bounding box for the symbol body but not the pins or fields.

Implements SYMBOL.

Definition at line 262 of file lib_symbol.h.

References GetBodyBoundingBox(), SYMBOL::m_previewBodyStyle, and SYMBOL::m_previewUnit.

Referenced by GetBodyAndPinsBoundingBox(), and GetBodyBoundingBox().

◆ GetBodyBoundingBox() [2/2]

const BOX2I LIB_SYMBOL::GetBodyBoundingBox	(	int	aUnit,
		int	aBodyStyle,
		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
aBodyStyle	= body style selection = 0, or 1..n If aUnit == 0, unit is not used if aBodyStyle == 0, body style is not used Fields are not taken in account

Definition at line 989 of file lib_symbol.cpp.

References m_drawings, BOX2< Vec >::Merge(), pin, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), and SCH_PIN_T.

Referenced by SCH_SYMBOL::doGetBoundingBox().

◆ GetBodyStyle()

int SCH_ITEM::GetBodyStyle ( ) const

inlineinherited

Definition at line 244 of file sch_item.h.

References m_bodyStyle.

◆ GetBodyStyleCount()

int LIB_SYMBOL::GetBodyStyleCount ( ) const

inlineoverridevirtual

Returns: the number of body styles defined for the symbol.

Implements SYMBOL.

Definition at line 596 of file lib_symbol.h.

References m_bodyStyleNames, and m_demorgan.

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg(), IsMultiBodyStyle(), SYMBOL_VIEWER_FRAME::onUpdateBodyStyleChoice(), SCH_EDIT_FRAME::SelectBodyStyle(), SetBodyStyleCount(), Similarity(), and PIN_INFO_FORMATTER::UpdatePin().

◆ GetBodyStyleDescription()

wxString LIB_SYMBOL::GetBodyStyleDescription	(	int	aBodyStyle,
		bool	aLabel ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 295 of file lib_symbol.cpp.

References _, _HKI, BASE, DEMORGAN, HasDeMorganBodyStyles(), IsMultiBodyStyle(), and m_bodyStyleNames.

Referenced by CheckDuplicatePins(), and CheckLibSymbol().

◆ GetBodyStyleNames()

const std::vector< wxString > & LIB_SYMBOL::GetBodyStyleNames ( ) const

inline

Definition at line 607 of file lib_symbol.h.

References m_bodyStyleNames.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), LIB_SYMBOL(), SYMBOL_VIEWER_FRAME::onUpdateBodyStyleChoice(), operator=(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetBodyStyleProp()

wxString SCH_ITEM::GetBodyStyleProp ( ) const

virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 211 of file sch_item.cpp.

References GetBodyStyleDescription(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ 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 244 of file lib_symbol.h.

References GetUnitBoundingBox().

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

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const

virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 443 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ 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 66 of file lib_symbol.cpp.

References SCH_FIELD::GetName(), m_drawings, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), and SCH_FIELD::ShowInChooser().

◆ GetClass()

virtual wxString LIB_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements KIGFX::VIEW_ITEM.

Definition at line 137 of file lib_symbol.h.

◆ GetConnectionPoints()

virtual std::vector< VECTOR2I > SCH_ITEM::GetConnectionPoints ( ) const

inlinevirtualinherited

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters

aPoints is the list of connection points to add to.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 508 of file sch_item.h.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), SCH_SCREEN::GetNeededJunctions(), SCH_EDITOR_CONTROL::Paste(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), and CONNECTION_GRAPH::updateGenericItemConnectivity().

◆ GetDatasheetField() [1/2]

SCH_FIELD & LIB_SYMBOL::GetDatasheetField ( )

inline

Return reference to the datasheet field.

Definition at line 348 of file lib_symbol.h.

References DATASHEET, and GetField().

Referenced by SCH_IO_HTTP_LIB::loadSymbolFromPart(), SYMBOL_VIEWER_FRAME::setupUIConditions(), and SCH_INSPECTION_TOOL::ShowDatasheet().

◆ GetDatasheetField() [2/2]

const SCH_FIELD & LIB_SYMBOL::GetDatasheetField ( ) const

Definition at line 1201 of file lib_symbol.cpp.

References DATASHEET, and GetField().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( const RENDER_SETTINGS * aSettings ) const

inherited

Definition at line 580 of file sch_item.cpp.

References GetAppSettings(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), and KICAD_FONT_NAME.

Referenced by SCH_FIELD::GetDrawFont(), SCH_TEXT::GetDrawFont(), and SCH_TEXTBOX::GetDrawFont().

◆ GetDesc()

wxString LIB_SYMBOL::GetDesc ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 151 of file lib_symbol.h.

References GetDescription().

Referenced by FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf().

◆ GetDescription()

wxString LIB_SYMBOL::GetDescription ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 169 of file lib_symbol.h.

References GetDescriptionField(), EDA_TEXT::GetText(), IsDerived(), EMBEDDED_FILES::IsEmpty(), and m_parent.

Referenced by GetDesc(), GetSearchTerms(), SCH_DRAWING_TOOLS::PlaceSymbol(), and ResolveTextVar().

◆ GetDescriptionField() [1/2]

SCH_FIELD & LIB_SYMBOL::GetDescriptionField ( )

inline

Return reference to the description field.

Definition at line 352 of file lib_symbol.h.

References DESCRIPTION, and GetField().

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

◆ GetDescriptionField() [2/2]

const SCH_FIELD & LIB_SYMBOL::GetDescriptionField ( ) const

Definition at line 1209 of file lib_symbol.cpp.

References DESCRIPTION, and GetField().

◆ GetDNP()

bool SYMBOL::GetDNP ( ) const

inlineoverridevirtualinherited

Set or clear the 'Do Not Populate' flag.

Reimplemented from SCH_ITEM.

Definition at line 197 of file symbol.h.

References m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), LIB_SYMBOL::ResolveTextVar(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ 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 532 of file lib_symbol.h.

References m_drawings.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CheckLibSymbolGraphics(), SCH_SELECTION_TOOL::CollectHits(), ConvertImageToLibShapes(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), KIGFX::SCH_VIEW::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_COMMIT::makeImage(), OrientAndMirrorSymbolItems(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SYMBOL::Plot(), SCH_SELECTION_TOOL::RebuildSelection(), SCH_IO_LIB_CACHE::removeSymbol(), and SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol().

◆ GetDrawItems() [2/2]

const LIB_ITEMS_CONTAINER & LIB_SYMBOL::GetDrawItems ( ) const

inline

Definition at line 533 of file lib_symbol.h.

References m_drawings.

◆ GetDummy()

LIB_SYMBOL * LIB_SYMBOL::GetDummy ( )

static

Returns a dummy LIB_SYMBOL, used when one is missing in the schematic.

Used as a dummy LIB_SYMBOL when one is not found in library or imported schematic.

This symbol is a 400 mils square with the text "??"

Definition at line 232 of file lib_symbol.cpp.

References AddDrawItem(), LAYER_DEVICE, LIB_SYMBOL(), SCH_ITEM::LIB_SYMBOL, RECTANGLE, schIUScale, square(), and text.

Referenced by SCH_SYMBOL::doGetBoundingBox(), KIGFX::SCH_PAINTER::draw(), and SCH_SYMBOL::GetMsgPanelInfo().

◆ GetDuplicatePinNumbersAreJumpers()

bool LIB_SYMBOL::GetDuplicatePinNumbersAreJumpers ( ) const

inline

Definition at line 573 of file lib_symbol.h.

References m_duplicatePinNumbersAreJumpers.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and CONNECTION_GRAPH::updateSymbolConnectivity().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveNetClass()

std::shared_ptr< NETCLASS > SCH_ITEM::GetEffectiveNetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

◆ GetEffectivePenWidth()

int SCH_ITEM::GetEffectivePenWidth ( const SCH_RENDER_SETTINGS * aSettings ) const

inherited

Definition at line 602 of file sch_item.cpp.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), EDA_ITEM::GetParent(), GetPenWidth(), LIB_SYMBOL_T, SCH_RENDER_SETTINGS::m_SymbolLineWidth, and EDA_ITEM::Type().

Referenced by KIGFX::SCH_PAINTER::getLineWidth(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TEXTBOX::Plot(), and SCH_PIN::PlotPinType().

◆ GetEmbeddedFile()

EMBEDDED_FILE * EMBEDDED_FILES::GetEmbeddedFile ( const wxString & aName ) const

inlineinherited

Returns the embedded file with the given name or nullptr if it does not exist.

Definition at line 226 of file embedded_files.h.

References m_files.

Referenced by BOARD::FixupEmbeddedData(), and SCH_SCREEN::FixupEmbeddedData().

◆ GetEmbeddedFileLink()

wxString EMBEDDED_FILES::GetEmbeddedFileLink ( const EMBEDDED_FILE & aFile ) const

inlineinherited

Return the link for an embedded file.

Parameters

aFile is the file to get the link for.

Returns: the link for the file to be used in a hyperlink.

Definition at line 161 of file embedded_files.h.

References EMBEDDED_FILES::EMBEDDED_FILE::GetLink().

Referenced by ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), and ALTIUM_PCB::ParseComponentsBodies6Data().

◆ GetEmbeddedFiles() [1/2]

const EMBEDDED_FILES * LIB_SYMBOL::GetEmbeddedFiles ( ) const

Definition at line 1962 of file lib_symbol.cpp.

References EMBEDDED_FILES::EMBEDDED_FILES().

◆ GetEmbeddedFiles() [2/2]

EMBEDDED_FILES * LIB_SYMBOL::GetEmbeddedFiles ( )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1956 of file lib_symbol.cpp.

References EMBEDDED_FILES::EMBEDDED_FILES().

Referenced by EmbedFonts(), SCH_SYMBOL::GetEmbeddedFiles(), SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetEmbeddedFonts()

const std::vector< wxString > * SCH_ITEM::GetEmbeddedFonts ( )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 655 of file sch_item.cpp.

References GetParentSymbol(), and Schematic().

◆ GetEndPoints()

virtual void SCH_ITEM::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

inlinevirtualinherited

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters

aItemList is the list of DANGLING_END_ITEMS to add to.

Reimplemented in SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 445 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ GetExcludedFromBoard()

bool SYMBOL::GetExcludedFromBoard ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 192 of file symbol.h.

References m_excludedFromBoard.

Referenced by BACK_ANNOTATE::checkForUnusedSymbols(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), LIB_SYMBOL::Flatten(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_SYMBOL::GetMsgPanelInfo(), LIB_SYMBOL::ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_PADS::WriteNetlist().

◆ GetExcludedFromBOM()

bool SYMBOL::GetExcludedFromBOM ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 186 of file symbol.h.

References m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), LIB_SYMBOL::Flatten(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), LIB_SYMBOL::ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ GetExcludedFromSim()

bool SYMBOL::GetExcludedFromSim ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 180 of file symbol.h.

References m_excludedFromSim.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_SYMBOL::Flatten(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), LIB_SYMBOL::ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ GetField() [1/4]

SCH_FIELD * LIB_SYMBOL::GetField ( const wxString & aFieldName )

Find a field within this symbol matching aFieldName; return nullptr if not found.

Definition at line 1149 of file lib_symbol.cpp.

References SCH_FIELD::GetName(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

Referenced by Compare(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), Flatten(), GetDatasheetField(), GetDatasheetField(), GetDescriptionField(), GetDescriptionField(), GetFootprintField(), GetFootprintField(), GetPrefix(), GetReferenceField(), GetReferenceField(), GetValueField(), GetValueField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SCH_IO_LIB_CACHE::removeSymbol(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField().

◆ GetField() [2/4]

const SCH_FIELD * LIB_SYMBOL::GetField ( const wxString & aFieldName ) const

Definition at line 1135 of file lib_symbol.cpp.

References SCH_FIELD::GetName(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

◆ GetField() [3/4]

SCH_FIELD * LIB_SYMBOL::GetField ( FIELD_T aFieldType )

Definition at line 1121 of file lib_symbol.cpp.

References SCH_FIELD::GetId(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

◆ GetField() [4/4]

const SCH_FIELD * LIB_SYMBOL::GetField ( FIELD_T aFieldType ) const

Definition at line 1107 of file lib_symbol.cpp.

References SCH_FIELD::GetId(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

◆ GetFields()

void LIB_SYMBOL::GetFields	(	std::vector< SCH_FIELD * > &	aList,
		bool	aVisibleOnly = false ) const

overridevirtual

Populate a std::vector with SCH_FIELDs, sorted in ordinal order.

Parameters

aList is the vector to populate.

Implements SYMBOL.

Definition at line 1062 of file lib_symbol.cpp.

References EDA_TEXT::GetText(), EDA_TEXT::IsVisible(), m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

Referenced by CopyFields(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), SCH_IO_EAGLE::loadInstance(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetFieldsAutoplaced()

AUTOPLACE_ALGO SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 592 of file sch_item.h.

References m_fieldsAutoplaced.

Referenced by SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveText(), and SCH_EDIT_FRAME::SelectUnit().

◆ GetFileAddedCallback()

FILE_ADDED_CALLBACK EMBEDDED_FILES::GetFileAddedCallback ( ) const

inlineinherited

Definition at line 120 of file embedded_files.h.

References m_fileAddedCallback.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

References m_flags.

Referenced by BuildBoardPolygonOutlines(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), findNext(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and PCB_TUNING_PATTERN::Update().

◆ 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_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 279 of file eda_item.h.

References GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

◆ GetFontFiles()

const std::vector< wxString > * EMBEDDED_FILES::GetFontFiles ( ) const

inherited

If we just need the cached version of the font files, we can use this function which is const and will not update the font files.

Definition at line 529 of file embedded_files.cpp.

References m_fontFiles.

Referenced by SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

◆ GetFontMetrics()

const KIFONT::METRICS & SCH_ITEM::GetFontMetrics ( ) const

inherited

◆ GetFonts()

std::set< KIFONT::OUTLINE_FONT * > LIB_SYMBOL::GetFonts ( ) const

overridevirtual

Reimplemented from EMBEDDED_FILES.

Definition at line 1968 of file lib_symbol.cpp.

References fonts, KIFONT::OUTLINE_FONT::GetEmbeddingPermission(), m_drawings, SCH_ITEM::SCH_ITEM(), SCH_TEXT_T, and text.

Referenced by EmbedFonts().

◆ GetFootprint()

wxString LIB_SYMBOL::GetFootprint ( )

inlineoverridevirtual

For items with footprint fields.

Reimplemented from LIB_TREE_ITEM.

Definition at line 195 of file lib_symbol.h.

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

Referenced by GetSearchTerms(), and SCH_EASYEDAPRO_PARSER::ParseSchematic().

◆ GetFootprintField() [1/2]

SCH_FIELD & LIB_SYMBOL::GetFootprintField ( )

inline

Return reference to the footprint field.

Definition at line 344 of file lib_symbol.h.

References FOOTPRINT, and GetField().

Referenced by GetFootprint(), GetSearchTerms(), SCH_IO_EASYEDAPRO::LoadAllDataFromProject(), loadSymbol(), and SCH_IO_HTTP_LIB::loadSymbolFromPart().

◆ GetFootprintField() [2/2]

const SCH_FIELD & LIB_SYMBOL::GetFootprintField ( ) const

Definition at line 1193 of file lib_symbol.cpp.

References FOOTPRINT, and GetField().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 171 of file view_item.h.

References m_forcedTransparency.

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

◆ GetFPFilters()

wxArrayString LIB_SYMBOL::GetFPFilters ( ) const

inline

Definition at line 217 of file lib_symbol.h.

References IsDerived(), m_fpFilters, and m_parent.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), Flatten(), netList(), netList(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), DIALOG_LIB_FIELDS_TABLE::SetupColumnProperties(), NETLIST_EXPORTER_ALLEGRO::toAllegroPackages(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, SCH_FIELD, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_TEXT, and ZONE.

Definition at line 401 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_PCB::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), and PROPERTIES_PANEL::rebuildProperties().

◆ GetGraphicalPins()

std::vector< SCH_PIN * > LIB_SYMBOL::GetGraphicalPins	(	int	aUnit = 0,
		int	aBodyStyle = 0 ) const

Graphical pins: Return schematic pin objects as drawn (unexpanded), filtered by unit/body.

Note: pin objects are owned by the symbol's draw list; do not delete them.

Parameters

aUnit	Unit number to collect; 0 = all units
aBodyStyle	Alternate body style to collect; 0 = all body styles

Definition at line 785 of file lib_symbol.cpp.

References Format(), GetLibId(), m_drawings, m_parent, pin, SCH_ITEM::SCH_ITEM(), and SCH_PIN_T.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), RECTANGLE_POINT_EDIT_BEHAVIOR::dragPinsOnEdge(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), GetLogicalPins(), GetPin(), GetPinCount(), GetPins(), netList(), netList(), PinsConflictWith(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), DIALOG_LIB_FIELDS_TABLE::SetupColumnProperties(), and ERC_TESTER::TestMissingUnits().

◆ GetInheritanceDepth()

unsigned LIB_SYMBOL::GetInheritanceDepth ( ) const

Get the number of parents for this symbol.

Returns: the inheritance depth for this symbol.

Definition at line 256 of file lib_symbol.cpp.

References GetParent().

◆ GetItemDescription()

wxString EDA_ITEM::GetItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) 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.

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented in BOARD, DELETED_BOARD_ITEM, DELETED_SHEET_ITEM, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GENERATOR, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TABLECELL, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, SCH_BITMAP, SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GLOBALLABEL, SCH_GROUP, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_RULE_AREA, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 144 of file eda_item.cpp.

References KIGFX::VIEW_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(), SCH_MARKER::GetMsgPanelInfo(), ERC_TREE_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), PNS::SHOVE::shoveIteration(), RC_ITEM::ShowReport(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetJumperPinGroup()

std::optional< const std::set< wxString > > LIB_SYMBOL::GetJumperPinGroup ( const wxString & aPinNumber ) const

Retrieves the jumper group containing the specified pin number, if one exists.

Definition at line 2010 of file lib_symbol.cpp.

References group, and m_jumperPinGroups.

◆ GetKeyWords()

wxString LIB_SYMBOL::GetKeyWords ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 182 of file lib_symbol.h.

References IsDerived(), m_keyWords, and m_parent.

Referenced by Flatten(), GetSearchTerms(), SCH_DRAWING_TOOLS::PlaceSymbol(), ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField().

◆ GetLastModDate()

timestamp_t LIB_SYMBOL::GetLastModDate ( ) const

inline

Definition at line 213 of file lib_symbol.h.

References m_lastModDate.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 309 of file sch_item.h.

References m_layer.

Referenced by JUNCTION_HELPERS::AnalyzePoint(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckDanglingWireEndpoints(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_LINE::GetFriendlyName(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), GetNetNavigatorItemText(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BUS_ENTRY_BASE::operator==(), SCH_LINE::operator==(), SCH_TEXT::operator==(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_IO_KICAD_LEGACY::saveBusEntry(), SCH_IO_KICAD_LEGACY::saveLine(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_LEGACY::saveText(), SCH_LINE::Serialize(), SCH_BUS_ENTRY_BASE::Similarity(), SCH_LINE::Similarity(), SCH_TEXT::Similarity(), SCH_EDIT_FRAME::TrimWire(), CONNECTION_GRAPH::updateGenericItemConnectivity(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLib()

SYMBOL_LIB * LIB_SYMBOL::GetLib ( ) const

inline

Definition at line 210 of file lib_symbol.h.

References m_library.

Referenced by SYMBOL_LIB::FindSymbol().

◆ GetLIB_ID()

LIB_ID LIB_SYMBOL::GetLIB_ID ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 150 of file lib_symbol.h.

References m_libId.

Referenced by GetSearchTerms().

◆ GetLibId()

const LIB_ID & LIB_SYMBOL::GetLibId ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 154 of file lib_symbol.h.

References m_libId.

Referenced by SCH_SCREEN::AddLibSymbol(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CheckForParentalChainConflicts(), CheckSavingIntoOwnInheritance(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), SYMBOL_EDITOR_CONTROL::EditLibrarySymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), RESCUE_CACHE_CANDIDATE::FindRescues(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), GetGraphicalPins(), GetPinCount(), SYMBOL_EDIT_FRAME::IsCurrentSymbol(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_LIB_TABLE::LoadSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), RESOLVE_DRIVERS_FIXTURE::MakePin(), LIB_SYMBOL_LESS_THAN::operator()(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_DRAWING_TOOLS::PlaceSymbol(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_EDIT_FRAME::Revert(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SYMBOL_LIB_TABLE::SaveSymbol(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

◆ GetLibNickname()

wxString LIB_SYMBOL::GetLibNickname ( ) const

inlineoverridevirtual

Sets the Description field text value.

Implements LIB_TREE_ITEM.

Definition at line 160 of file lib_symbol.h.

References GetLibraryName().

Referenced by GetSearchTerms(), and DIALOG_LIB_FIELDS_TABLE::TransferDataFromWindow().

◆ GetLibraryName()

const wxString LIB_SYMBOL::GetLibraryName ( ) const

Definition at line 400 of file lib_symbol.cpp.

References m_libId, and m_library.

Referenced by GetLibNickname(), and DIALOG_LIB_FIELDS_TABLE::loadSymbols().

◆ GetLogicalPins()

std::vector< LIB_SYMBOL::LOGICAL_PIN > LIB_SYMBOL::GetLogicalPins	(	int	aUnit,
		int	aBodyStyle ) const

Return all logical pins (expanded) filtered by unit/body.

For non-stacked pins, the single logical pin's number equals the base pin number.

Definition at line 822 of file lib_symbol.cpp.

References GetGraphicalPins(), and pin.

◆ 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 1282 of file lib_symbol.cpp.

References m_drawings, m_parent, pin, SCH_ITEM::SCH_ITEM(), and SCH_PIN_T.

◆ 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 FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, SCH_BITMAP, SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_FIELD, SCH_GLOBALLABEL, SCH_GROUP, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 360 of file eda_item.cpp.

References dummy_item.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

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

overridevirtualinherited

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 from EDA_ITEM.

Reimplemented in SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_PIN, SCH_RULE_AREA, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 637 of file sch_item.cpp.

References _, GetBodyStyle(), GetBodyStyleDescription(), GetParentSymbol(), GetUnit(), GetUnitDisplayName(), IsPrivate(), and LIB_SYMBOL.

Referenced by SCH_PIN::GetMsgPanelInfo(), SCH_SHAPE::GetMsgPanelInfo(), SCH_TABLE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), and SCH_TEXTBOX::GetMsgPanelInfo().

◆ GetName()

wxString LIB_SYMBOL::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 148 of file lib_symbol.h.

References m_name.

Referenced by SCH_IO_LIB_CACHE::AddSymbol(), SCH_SCREEN::Append(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), CheckForParentalChainConflicts(), CheckSavingIntoOwnInheritance(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbol(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbolImmediate(), LIB_BUFFER::DeleteBuffer(), LIB_FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), SYMBOL_SAVE_AS_HANDLER::DoSave(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDIT_FRAME::ensureUniqueName(), SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SCH_SYMBOL::GetMsgPanelInfo(), GetSearchTerms(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), LIB_BUFFER::GetSymbolNames(), LIB_BUFFER::HasDerivedSymbols(), SYMBOL_EDIT_FRAME::ImportSymbol(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), DIALOG_LIB_FIELDS_TABLE::loadSymbols(), operator<(), SCH_IO_KICAD_SEXPR_PARSER::ParseLib(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), LIB_BUFFER::removeChildSymbols(), SYMBOL_LIB::RemoveSymbol(), SCH_IO_LIB_CACHE::removeSymbol(), SYMBOL_LIB::ReplaceSymbol(), SYMBOL_LIBRARY_MANAGER::RevertSymbol(), LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), DIALOG_LIB_FIELDS_TABLE::setScope(), DIALOG_LIB_FIELDS_TABLE::TransferDataFromWindow(), SYMBOL_LIBRARY_MANAGER::UpdateSymbol(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetNextFieldOrdinal()

int LIB_SYMBOL::GetNextFieldOrdinal ( ) const

Return the next ordinal for a user field for this symbol.

Definition at line 1096 of file lib_symbol.cpp.

References m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

◆ GetOrientation()

virtual int SYMBOL::GetOrientation ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 200 of file symbol.h.

References SYM_NORMAL.

◆ GetOrInitConnection()

SCH_CONNECTION * SCH_ITEM::GetOrInitConnection	(	const SCH_SHEET_PATH &	aPath,
		CONNECTION_GRAPH *	aGraph )

inherited

Definition at line 428 of file sch_item.cpp.

References Connection(), CONNECTION_GRAPH, InitializeConnection(), and IsConnectable().

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTION_SUBGRAPH::ExchangeItem(), and RESOLVE_DRIVERS_FIXTURE::MakeLabel().

◆ GetParent() [1/2]

LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( )

inline

Definition at line 117 of file lib_symbol.h.

References m_parent.

Referenced by SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), LIB_BUFFER::GetDerivedSymbolNames(), SYMBOL_VIEWER_FRAME::GetDocumentExtents(), GetInheritanceDepth(), GetParentChain(), LIB_BUFFER::SaveBuffer(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

◆ GetParent() [2/2]

const LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( ) const

inline

Definition at line 118 of file lib_symbol.h.

References m_parent.

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_MOVE_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), BOARD_ITEM::IsLocked(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), PNS_KICAD_IFACE::RemoveItem(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 91 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

Referenced by ITEM_PICKER::SetItem(), and ITEM_PICKER::SetLink().

◆ GetParentSymbol() [1/2]

SYMBOL * SCH_ITEM::GetParentSymbol ( )

inherited

Definition at line 235 of file sch_item.cpp.

References EDA_ITEM::findParent(), LIB_SYMBOL, LIB_SYMBOL_T, and SCH_SYMBOL_T.

◆ GetParentSymbol() [2/2]

const SYMBOL * SCH_ITEM::GetParentSymbol ( ) const

inherited

Definition at line 223 of file sch_item.cpp.

References EDA_ITEM::findParent(), LIB_SYMBOL, LIB_SYMBOL_T, and SCH_SYMBOL_T.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PIN::compare(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::EditField(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckNoConnects(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), GetBodyStyleDescription(), SCH_PIN::GetDefaultNetName(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetEmbeddedFonts(), SCH_FIELD::GetFullText(), SCH_PIN::GetItemDescription(), GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_PIN::GetPinRoot(), SCH_PIN::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), GetUnitDisplayName(), SCH_PIN::IsGlobalPower(), SCH_PIN::IsLocalPower(), SCH_PIN::MirrorHorizontally(), SCH_PIN::MirrorVertically(), NETLIST_EXPORTER_ALLEGRO::NET_NODE::operator<(), SCH_FIELD::operator==(), orientLabel(), SCH_PIN::Plot(), SCH_PIN::Replace(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_PIN::Rotate(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SetBodyStyleProp(), SCH_SHAPE::SetFilled(), and SCH_EDITOR_CONTROL::SimProbe().

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const

inlinevirtualinherited

Returns: the size of the "pen" that be used to draw or plot this item

Reimplemented in SCH_BUS_BUS_ENTRY, SCH_BUS_ENTRY_BASE, SCH_BUS_WIRE_ENTRY, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 320 of file sch_item.h.

Referenced by EE_RTREE::contains(), GetEffectivePenWidth(), EE_RTREE::insert(), and EE_RTREE::remove().

◆ GetPin()

SCH_PIN * LIB_SYMBOL::GetPin	(	const wxString &	aNumber,
		int	aUnit = 0,
		int	aBodyStyle = 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.
aBodyStyle	- Body style filter. Set to 0 if no specific body style is not required.

Returns: The pin object if found. Otherwise NULL.

Definition at line 876 of file lib_symbol.cpp.

References GetGraphicalPins(), and pin.

Referenced by Compare(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol().

◆ GetPinCount()

int LIB_SYMBOL::GetPinCount ( )

overridevirtual

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

Reimplemented from LIB_TREE_ITEM.

Definition at line 854 of file lib_symbol.cpp.

References Format(), GetGraphicalPins(), GetLibId(), and pin.

◆ GetPinNameOffset()

int SYMBOL::GetPinNameOffset ( ) const

inlineinherited

Definition at line 158 of file symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PIN::Plot(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetPins()

std::vector< SCH_PIN * > LIB_SYMBOL::GetPins ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 949 of file lib_symbol.cpp.

References GetGraphicalPins().

Referenced by SCH_IO_EAGLE::addImplicitConnections(), CheckDuplicatePins(), CheckLibSymbol(), SYMBOL_EDITOR_EDIT_TOOL::ConvertStackedPins(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), Similarity(), and NETLIST_EXPORTER_ALLEGRO::toAllegroPackages().

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

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

Definition at line 272 of file eda_item.h.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), TEARDROP_MANAGER::areItemsInSameZone(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::compare(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreatePolys(), SCH_EDIT_FRAME::DeleteJunction(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), CONNECTION_GRAPH::ercCheckSingleGlobalLabel(), PCB_SELECTION_TOOL::FindItem(), GERBVIEW_SELECTION::GetCenter(), SCH_MOVE_TOOL::getConnectedDragItems(), GetFocusPosition(), BOARD_ITEM::GetFPRelativePosition(), RC_ITEM::GetJsonViolation(), getMinDist(), GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), SCH_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_FIND_REPLACE_TOOL::nextMatch(), ARRAY_TOOL::onDialogClosed(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), PAD::PAD(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), 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(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), RC_ITEM::ShowReport(), EDIT_TOOL::Swap(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), ERC_TESTER::TestTextVars(), DRC_TEST_PROVIDER_MISC::testTextVars(), TransformItem(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), DIALOG_CREATE_ARRAY::UpdatePickedItem(), DIALOG_POSITION_RELATIVE::UpdatePickedItem(), and SCH_SELECTION_TOOL::updateReferencePoint().

◆ GetPrefix()

wxString LIB_SYMBOL::GetPrefix ( )

Definition at line 1217 of file lib_symbol.cpp.

References GetField(), EDA_TEXT::GetText(), and REFERENCE.

◆ GetRef()

const wxString LIB_SYMBOL::GetRef	(	const SCH_SHEET_PATH *	aSheet,
		bool	aIncludeUnit = false ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 357 of file lib_symbol.h.

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

◆ GetReferenceField() [1/2]

SCH_FIELD & LIB_SYMBOL::GetReferenceField ( )

inline

Return reference to the reference designator field.

Definition at line 340 of file lib_symbol.h.

References GetField(), and REFERENCE.

Referenced by CheckLibSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CONNECTION_SUBGRAPH::GetDriverPriority(), GetRef(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), loadSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), and SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol().

◆ GetReferenceField() [2/2]

const SCH_FIELD & LIB_SYMBOL::GetReferenceField ( ) const

Definition at line 1185 of file lib_symbol.cpp.

References GetField(), and REFERENCE.

◆ getRenderSettings()

SCH_RENDER_SETTINGS * SCH_ITEM::getRenderSettings ( PLOTTER * aPlotter ) const

inlineprotectedinherited

Definition at line 688 of file sch_item.h.

References PLOTTER::RenderSettings().

Referenced by LIB_SYMBOL::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_PIN::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_SYMBOL::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_SYMBOL::PlotDNP(), LIB_SYMBOL::PlotFields(), SCH_SYMBOL::PlotPins(), and SCH_PIN::PlotPinType().

◆ 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 272 of file lib_symbol.cpp.

References GetRootSymbol(), m_me, and m_parent.

Referenced by KIGFX::SCH_VIEW::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), GetRootSymbol(), and DIALOG_LIB_FIELDS_TABLE::setScope().

◆ GetRuleAreaCache()

const std::unordered_set< SCH_RULE_AREA * > & SCH_ITEM::GetRuleAreaCache ( ) const

inlineinherited

Get the cache of rule areas enclosing this item.

Definition at line 645 of file sch_item.h.

References m_rule_areas_cache.

Referenced by CONNECTION_SUBGRAPH::GetNetclassesForDriver().

◆ GetSearchTerms()

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

overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 40 of file lib_symbol.cpp.

References Format(), GetDescription(), GetFootprint(), GetFootprintField(), GetKeyWords(), GetLIB_ID(), GetLibNickname(), and GetName().

◆ GetShowPinNames()

virtual bool SYMBOL::GetShowPinNames ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 164 of file symbol.h.

References m_showPinNames.

Referenced by SCH_PIN::Plot(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ GetShowPinNumbers()

virtual bool SYMBOL::GetShowPinNumbers ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 170 of file symbol.h.

References m_showPinNumbers.

Referenced by SCH_PIN::Plot(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ 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 288 of file eda_item.h.

References GetPosition().

◆ GetSourceLibId()

LIB_ID LIB_SYMBOL::GetSourceLibId ( ) const

inline

Definition at line 157 of file lib_symbol.h.

References m_sourceLibId.

Referenced by SYMBOL_EDIT_FRAME::LoadSymbol().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 279 of file sch_item.h.

References m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 610 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetSubUnitCount()

int LIB_SYMBOL::GetSubUnitCount ( ) const

inlineoverridevirtual

For items with units, return the number of units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 152 of file lib_symbol.h.

References GetUnitCount().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 161 of file eda_item.h.

References CANDIDATE, CONNECTIVITY_CANDIDATE, IS_LINKED, m_flags, SELECTED_BY_DRAG, SELECTION_CANDIDATE, and SKIP_STRUCT.

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

◆ GetTemporaryFileName() [1/2]

wxFileName EMBEDDED_FILES::GetTemporaryFileName ( const wxString & aName ) const

inherited

Definition at line 484 of file embedded_files.cpp.

References PATHS::EnsurePathExists(), PATHS::GetUserCachePath(), and m_files.

Referenced by UpdateFontFiles().

◆ GetTemporaryFileName() [2/2]

wxFileName EMBEDDED_FILES::GetTemporaryFileName ( EMBEDDED_FILE * aFile ) const

inherited

◆ GetTransform() [1/2]

TRANSFORM & SYMBOL::GetTransform ( )

inlineinherited

Definition at line 203 of file symbol.h.

References m_transform.

◆ GetTransform() [2/2]

const TRANSFORM & SYMBOL::GetTransform ( ) const

inlineinherited

Definition at line 202 of file symbol.h.

References m_transform.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::GetDrawRotation(), SCH_SYMBOL::GetOrientation(), SCH_FIELD::GetPosition(), GetRelativePosition(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_MOVE_TOOL::moveItem(), SCH_SYMBOL::operator==(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_FIELD::SetPosition(), and ERC_TESTER::TestTextVars().

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

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

Referenced by EDIT_TOOL::doMoveSelection(), and GetFriendlyName().

◆ GetUnit()

int SCH_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 238 of file sch_item.h.

References m_unit.

◆ GetUnitBoundingBox()

const BOX2I LIB_SYMBOL::GetUnitBoundingBox	(	int	aUnit,
		int	aBodyStyle,
		bool	aIgnoreHiddenFields = true,
		bool	aIgnoreLabelsOnInvisiblePins = 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
aBodyStyle	= body style selection = 0, or 1..n If aUnit == 0, unit is not used if aBodyStyle == 0, body style is not used
aIgnoreHiddenFields	default true, ignores any hidden fields
aIgnoreLabelsOnInvisiblePins	default true, ignores pin number and pin name of invisible pins

Definition at line 956 of file lib_symbol.cpp.

References m_drawings, m_unitCount, BOX2< Vec >::Merge(), pin, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), and SCH_PIN_T.

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), and GetBoundingBox().

◆ GetUnitCount()

int LIB_SYMBOL::GetUnitCount ( ) const

overridevirtual

Returns: the number of units defined for the symbol.

Implements SYMBOL.

Definition at line 1428 of file lib_symbol.cpp.

References m_parent, and m_unitCount.

Referenced by SCH_IO_EAGLE::addImplicitConnections(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), SCH_REFERENCE_LIST::CheckAnnotation(), CheckLibSymbol(), NETLIST_EXPORTER_BASE::CreatePinList(), 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(), GetSubUnitCount(), SCH_REFERENCE::IsMultiUnit(), SCH_IO_EAGLE::loadInstance(), SYMBOL_VIEWER_FRAME::onUpdateUnitChoice(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_EDIT_FRAME::SelectUnit(), ERC_TESTER::TestMissingUnits(), SYMBOL_UNIT_MENU::update(), and PIN_INFO_FORMATTER::UpdatePin().

◆ GetUnitDisplayName()

wxString LIB_SYMBOL::GetUnitDisplayName	(	int	aUnit,
		bool	aLabel ) const

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 284 of file lib_symbol.cpp.

References _, LetterSubReference(), and m_unitDisplayNames.

Referenced by CheckDuplicatePins(), GetUnitName(), SYMBOL_VIEWER_FRAME::onUpdateUnitChoice(), SCH_EDIT_FRAME::SelectUnit(), and ERC_TESTER::TestMissingUnits().

◆ GetUnitDisplayNames() [1/2]

std::map< int, wxString > & LIB_SYMBOL::GetUnitDisplayNames ( )

inline

Definition at line 570 of file lib_symbol.h.

References m_unitDisplayNames.

Referenced by LIB_SYMBOL(), operator=(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetUnitDisplayNames() [2/2]

const std::map< int, wxString > & LIB_SYMBOL::GetUnitDisplayNames ( ) const

inline

Definition at line 571 of file lib_symbol.h.

References m_unitDisplayNames.

◆ GetUnitDrawItems() [1/2]

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

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

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

Definition at line 1506 of file lib_symbol.cpp.

References LIB_SYMBOL_UNIT::m_bodyStyle, m_drawings, LIB_SYMBOL_UNIT::m_items, LIB_SYMBOL_UNIT::m_unit, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ GetUnitDrawItems() [2/2]

std::vector< SCH_ITEM * > LIB_SYMBOL::GetUnitDrawItems	(	int	aUnit,
		int	aBodyStyle )

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

Note: SCH_FIELD objects are not included.

Parameters

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

Returns: a list of unit items.

Definition at line 1485 of file lib_symbol.cpp.

References m_drawings, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

◆ GetUnitName()

wxString LIB_SYMBOL::GetUnitName ( int aUnit ) const

inlineoverridevirtual

For items with units, return an identifier for unit x.

Reimplemented from LIB_TREE_ITEM.

Definition at line 558 of file lib_symbol.h.

References GetUnitDisplayName().

◆ GetValue()

const wxString LIB_SYMBOL::GetValue	(	bool	aResolve,
		const SCH_SHEET_PATH *	aPath,
		bool	aAllowExtraText ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 362 of file lib_symbol.h.

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

◆ GetValueField() [1/2]

SCH_FIELD & LIB_SYMBOL::GetValueField ( )

inline

Return reference to the value field.

Definition at line 336 of file lib_symbol.h.

References GetField(), and VALUE.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_SAVE_AS_HANDLER::DoSave(), GetValue(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and SYMBOL_EDIT_FRAME::saveSymbolCopyAs().

◆ GetValueField() [2/2]

const SCH_FIELD & LIB_SYMBOL::GetValueField ( ) const

Definition at line 1177 of file lib_symbol.cpp.

References GetField(), and VALUE.

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 582 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasConnectivityChanges()

virtual bool SCH_ITEM::HasConnectivityChanges	(	const SCH_ITEM *	aItem,
		const SCH_SHEET_PATH *	aInstance = nullptr ) const

inlinevirtualinherited

Check if aItem has connectivity changes against this object.

This provides granular per object connectivity change testing to prevent the need to rebuild the CONNECTION_GRAPH when object properties that have nothing to do with the schematic connectivity changes i.e. color, thickness, fill type. etc.

Note: Developers should override this method for all objects that are connectable.

Parameters

aItem	is the item to test for connectivity changes.
aInstance	is the instance to test for connectivity changes. This parameter is only meaningful for SCH_SYMBOL objects.

Returns: true if there are connectivity changes otherwise false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 573 of file sch_item.h.

References SCH_ITEM().

Referenced by SCH_COMMIT::pushSchEdit(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ HasDeMorganBodyStyles()

bool LIB_SYMBOL::HasDeMorganBodyStyles ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 604 of file lib_symbol.h.

References m_demorgan.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GetBodyStyleDescription(), SYMBOL_VIEWER_FRAME::onUpdateBodyStyleChoice(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ HasFile()

bool EMBEDDED_FILES::HasFile ( const wxString & name ) const

inlineinherited

Definition at line 166 of file embedded_files.h.

References m_files, and name.

Referenced by AddFile(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 146 of file eda_item.h.

References m_flags.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), PCB_TUNING_PATTERN::Rotate(), SCH_EDIT_TOOL::Rotate(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), SCH_SELECTION_TOOL::SelectMultiple(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasLegacyAlternateBodyStyle()

bool LIB_SYMBOL::HasLegacyAlternateBodyStyle ( ) const

Before V10 we didn't store the number of body styles in a symbol – we just looked through all its drawings each time we wanted to know.

This is now only used to set the count when a legacy symbol is first read. (Legacy symbols also didn't support arbitrary body styles, so the count is always 1 or 2, and when 2 it is always a De Morgan pair.)

Definition at line 1261 of file lib_symbol.cpp.

References BASE, m_drawings, m_parent, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases().

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

Returns: true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 608 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HitTest() [1/3]

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 DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_ARC, PCB_DIMENSION_BASE, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 246 of file eda_item.h.

◆ HitTest() [2/3]

virtual bool EDA_ITEM::HitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

inlinevirtualinherited

Test if aPoly intersects this item.

Parameters

aPoly	A reference to a SHAPE_LINE_CHAIN object containing the polygon or polyline to test.
aContained	Set to true to test for containment instead of an intersection.

Returns: True if aPoly contains or intersects the item.

Reimplemented in FOOTPRINT, PAD, PCB_DIMENSION_BASE, PCB_GROUP, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 258 of file eda_item.h.

◆ HitTest() [3/3]

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 DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_BITMAP, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_ARC, PCB_DIMENSION_BASE, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, RATSNEST_VIEW_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 233 of file eda_item.h.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), PL_SELECTION_TOOL::guessSelectionCandidates(), DS_DRAW_ITEM_BASE::HitTest(), GENERAL_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), SCH_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_GRID_HELPER::SnapToPad().

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection	(	const SCH_SHEET_PATH &	aPath,
		CONNECTION_GRAPH *	aGraph )

inherited

Create a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize.

Definition at line 404 of file sch_item.cpp.

References Connection(), CONNECTION_GRAPH, m_connection_map, SCH_CONNECTION::Reset(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

Referenced by GetOrInitConnection(), and CONNECTION_GRAPH::updateGenericItemConnectivity().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::BestSnapAnchor(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), PCB_BASE_FRAME::FocusOnItem(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), BOARD_COMMIT::undoLevelItem(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), KIGFX::PCB_VIEW::UpdateCollidingItems(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

References BRIGHTENED, and m_flags.

◆ IsConnectable()

virtual bool SCH_ITEM::IsConnectable ( ) const

inlinevirtualinherited

Returns: true if the schematic item can connect to another schematic item.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 493 of file sch_item.h.

Referenced by SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_JUNCTION::CanConnect(), Connection(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_EDIT_TOOL::DoDelete(), SCH_SCREEN::GetNeededJunctions(), GetOrInitConnection(), SCH_SELECTION::GetTopLeftItem(), SCH_LABEL_BASE::HasConnectivityChanges(), SCH_EDIT_TOOL::Mirror(), EE_GRID_HELPER::nearestAnchor(), SCH_EDITOR_CONTROL::Paste(), SCHEMATIC::RecalculateConnections(), SCH_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Swap(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const VECTOR2I & aPoint ) const

inherited

Test the item to see if it is connected to aPoint.

Parameters

aPoint is a reference to a VECTOR2I object containing the coordinates to test.

Returns: True if connection to aPoint exists.

Definition at line 314 of file sch_item.cpp.

References doIsConnected(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by JUNCTION_HELPERS::AnalyzePoint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( ) const

inlineinherited

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 486 of file sch_item.h.

◆ IsDerived()

bool LIB_SYMBOL::IsDerived ( ) const

inline

◆ IsEmpty()

bool EMBEDDED_FILES::IsEmpty ( ) const

inlineinherited

Definition at line 173 of file embedded_files.h.

References m_files.

Referenced by LIB_SYMBOL::Flatten(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), and LIB_SYMBOL::GetDescription().

◆ IsEndPoint()

virtual bool SCH_ITEM::IsEndPoint ( const VECTOR2I & aPt ) const

inlinevirtualinherited

Test if aPt is an end point of this schematic object.

Note: The end point test doe not imply electrical connectivity. See IsConnectable(). In other words all connection points are end points but not all end points are connection points such as graphical lines and arcs. Override this method for all objects that have end points.

Parameters

aPt	is the coordinate to test for an end point.

Return values

true	if aPt is an end point.
false	if aPt is not an end point.

Reimplemented in SCH_LINE, and SCH_SHAPE.

Definition at line 484 of file sch_item.h.

Referenced by SCH_SCREEN::MarkConnections().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 128 of file eda_item.h.

References ENTERED, and m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and KIGFX::SCH_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 211 of file eda_item.h.

References m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIELD::Plot(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ IsGlobalPower()

bool LIB_SYMBOL::IsGlobalPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 439 of file lib_symbol.cpp.

References ENTRY_GLOBAL_POWER, m_options, and m_parent.

Referenced by SCH_IO_EAGLE::addImplicitConnections(), CheckLibSymbol(), LEGACY_POWER_SYMBOLS_TEST_FIXTURE::CheckSymbols(), SCH_SCREEN::FixLegacyPowerSymbolMismatches(), IsPower(), SCH_IO_EAGLE::loadInstance(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ IsGroupableType()

bool SCH_ITEM::IsGroupableType ( ) const

inherited

Definition at line 105 of file sch_item.cpp.

References SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_GROUP_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_PIN_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_PIN_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TEXT_T, SCH_TEXTBOX_T, and EDA_ITEM::Type().

Referenced by SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_GROUP_TOOL::Group(), SCH_COMMIT::pushSchEdit(), and SCH_EDIT_TOOL::RepeatDrawItem().

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 302 of file sch_item.h.

Referenced by RenderAsBitmap().

◆ IsLocalPower()

bool LIB_SYMBOL::IsLocalPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 409 of file lib_symbol.cpp.

References ENTRY_LOCAL_POWER, m_options, and m_parent.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), IsPower(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ IsLocked()

virtual bool EDA_ITEM::IsLocked ( ) const

inlinevirtualinherited

Reimplemented in BOARD_ITEM, FOOTPRINT, and PAD.

Definition at line 120 of file eda_item.h.

Referenced by DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), SCH_IO_KICAD_SEXPR::saveGroup(), and SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( ) const

inlinevirtualinherited

Check if object is movable from the anchor point.

Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols).

Return values

true	for items which are moved with the anchor point at mouse cursor.
false	for items moved with no reference to anchor.

Reimplemented in SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 277 of file sch_item.h.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsMultiBodyStyle()

bool LIB_SYMBOL::IsMultiBodyStyle ( ) const

inlineoverridevirtual

Returns: true if the symbol has multiple body styles available.

Implements SYMBOL.

Definition at line 594 of file lib_symbol.h.

References GetBodyStyleCount().

Referenced by CheckDuplicatePins(), CheckLibSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), GetBodyStyleDescription(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ IsMultiUnit()

bool LIB_SYMBOL::IsMultiUnit ( ) const

inlineoverridevirtual

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

Implements SYMBOL.

Definition at line 590 of file lib_symbol.h.

References m_unitCount.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

◆ IsNormal()

bool LIB_SYMBOL::IsNormal ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 475 of file lib_symbol.cpp.

References ENTRY_NORMAL, m_options, and m_parent.

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const VECTOR2I & aPos ) const

inlinevirtualinherited

Returns: true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 499 of file sch_item.h.

Referenced by SCH_SELECTION_TOOL::autostartEvent().

◆ IsPower()

bool LIB_SYMBOL::IsPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 455 of file lib_symbol.cpp.

References IsGlobalPower(), and IsLocalPower().

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), CheckLibSymbol(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), SCH_IO_DATABASE::EnumerateSymbolLib(), SCH_IO_HTTP_LIB::EnumerateSymbolLib(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), highlightNet(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ IsPrivate()

bool SCH_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 250 of file sch_item.h.

References m_private.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), compare(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), FIELDS_GRID_TABLE::getField(), FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), FIELDS_GRID_TABLE::getVisibleRowCount(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), DIALOG_CHANGE_SYMBOLS::processSymbols(), EE_GRID_HELPER::queryVisible(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCH_SHAPE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

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

Definition at line 439 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References m_isRollover.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), and SCH_SELECTION_TOOL::Main().

◆ 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 205 of file lib_symbol.h.

References m_parent.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), LIB_BUFFER::GetSymbolNames(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), and SCH_SYMBOL::SetLibSymbol().

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

References m_isSCH_ITEM.

Referenced by EDA_ITEM::EDA_ITEM(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 127 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsType()

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

inlineoverridevirtualinherited

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 from EDA_ITEM.

Reimplemented in SCH_LABEL_BASE, and SCH_LINE.

Definition at line 182 of file sch_item.h.

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, m_layer, SCH_ITEM_LOCATE_BUS_T, SCH_ITEM_LOCATE_GRAPHIC_LINE_T, SCH_ITEM_LOCATE_WIRE_T, SCH_LINE_T, and EDA_ITEM::Type().

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::IsType(), SCH_LABEL_BASE::IsType(), SCH_LINE::IsType(), SCH_SELECTION_TOOL::RequestSelection(), GROUP_SEARCH_HANDLER::Search(), LABEL_SEARCH_HANDLER::Search(), SCH_MARKER::SerializeToString(), SCH_EDIT_FRAME::UpdateHopOveredWires(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ 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 325 of file eda_item.h.

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

Referenced by BOARD::Visit(), FOOTPRINT::Visit(), and 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 345 of file eda_item.h.

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

◆ JumperPinGroups() [1/2]

std::vector< std::set< wxString > > & LIB_SYMBOL::JumperPinGroups ( )

inline

Each jumper pin group is a set of pin numbers that should be treated as internally connected.

Returns: The list of jumper pin groups in this symbols

Definition at line 580 of file lib_symbol.h.

References m_jumperPinGroups.

Referenced by CONNECTION_GRAPH::boost_test_update_symbol_connectivity, SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and CONNECTION_GRAPH::updateSymbolConnectivity().

◆ JumperPinGroups() [2/2]

const std::vector< std::set< wxString > > & LIB_SYMBOL::JumperPinGroups ( ) const

inline

Definition at line 581 of file lib_symbol.h.

References m_jumperPinGroups.

◆ LetterSubReference()

wxString LIB_SYMBOL::LetterSubReference	(	int	aUnit,
		wxChar	aInitialLetter )

static

Definition at line 503 of file lib_symbol.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SCH_FIELD::GetFullText(), GetUnitDisplayName(), SCH_SYMBOL::SubReference(), SCHEMATIC_SETTINGS::SubReference(), and DIALOG_LIB_SYMBOL_PROPERTIES::updateUnitCount().

◆ LocateDrawItem() [1/2]

SCH_ITEM * LIB_SYMBOL::LocateDrawItem	(	int	aUnit,
		int	aBodyStyle,
		KICAD_T	aType,
		const VECTOR2I &	aPoint )

Locate a draw object.

Parameters

aUnit	- Unit number of draw item.
aBodyStyle	- 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 1319 of file lib_symbol.cpp.

References m_drawings, SCH_ITEM::SCH_ITEM(), and TYPE_NOT_INIT.

Referenced by LocateDrawItem().

◆ LocateDrawItem() [2/2]

SCH_ITEM * LIB_SYMBOL::LocateDrawItem	(	int	aUnit,
		int	aBodyStyle,
		KICAD_T	aType,
		const VECTOR2I &	aPoint,
		const TRANSFORM &	aTransform )

Locate a draw object (overlaid)

Parameters

aUnit	- Unit number of draw item.
aBodyStyle	- 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 1339 of file lib_symbol.cpp.

References DefaultTransform, LocateDrawItem(), and SCH_ITEM::SCH_ITEM().

◆ 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 285 of file lib_symbol.h.

References m_unitsLocked.

Referenced by BOOST_AUTO_TEST_CASE().

◆ lodScaleForThreshold()

double VIEW_ITEM::lodScaleForThreshold	(	const KIGFX::VIEW *	aView,
		int	aWhatIu,
		int	aThresholdIu )

staticprotectedinherited

Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

This is useful when a level-of-detail is defined in terms of a threshold size (i.e. 'only draw X when it will be bigger than Y size on screen').

E.g. if aWhatIu is 1000 and aThresholdIu is 100, then the item will be the same size as the threshold at 0.1 scale. Returning that 0.1 as the LoD will hide the item when the scale is less than 0.1 - i.e. smaller than the threshold.

Because even at zoom 1.0, 1mm in KiCad may not be exactly 1mm on a physical screen, the threshold may not be exact in practice.

Definition at line 39 of file view_item.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::RENDER_SETTINGS::IsPrinting(), LOD_HIDE, LOD_SHOW, and VIEW.

Referenced by GERBER_DRAW_ITEM::ViewGetLOD(), PAD::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and SCH_LINE::ViewGetLOD().

◆ 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 FOOTPRINT, NETINFO_ITEM, PCB_FIELD, PCB_GROUP, PCB_MARKER, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, SCH_FIELD, SCH_GROUP, SCH_LABEL_BASE, SCH_MARKER, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 401 of file eda_item.h.

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::HasMatch(), FOOTPRINT::Matches(), NETINFO_ITEM::Matches(), PCB_GROUP::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_GROUP::Matches(), SCH_LABEL_BASE::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_SYMBOL::Matches(), SCH_TEXT::Matches(), SCH_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 158 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, flag, IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), PERMISSIVE, REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ MirrorHorizontally()

virtual void SCH_ITEM::MirrorHorizontally ( int aCenter )

inlinevirtualinherited

Mirror item horizontally about aCenter.

Reimplemented in DELETED_SHEET_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 373 of file sch_item.h.

References GetClass().

Referenced by SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), and SCH_EASYEDAPRO_PARSER::ParseSchematic().

◆ MirrorVertically()

virtual void SCH_ITEM::MirrorVertically ( int aCenter )

inlinevirtualinherited

Mirror item vertically about aCenter.

Reimplemented in DELETED_SHEET_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 381 of file sch_item.h.

References GetClass().

Referenced by SCH_EDIT_TOOL::Mirror(), and SYMBOL_EDITOR_EDIT_TOOL::Mirror().

◆ Move()

void LIB_SYMBOL::Move ( const VECTOR2I & aOffset )

overridevirtual

Move the symbol aOffset.

Parameters

aOffset - Offset displacement.

Reimplemented from SCH_ITEM.

Definition at line 1250 of file lib_symbol.cpp.

References m_drawings, and SCH_ITEM::SCH_ITEM().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor().

◆ operator<() [1/2]

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 319 of file eda_item.cpp.

References EDA_ITEM(), and KIGFX::VIEW_ITEM::GetClass().

◆ operator<() [2/2]

bool SCH_ITEM::operator< ( const SCH_ITEM & aItem ) const

virtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LINE, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 526 of file sch_item.cpp.

References compare(), SCH_ITEM(), and EDA_ITEM::Type().

◆ operator=()

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

◆ operator==()

bool SCH_ITEM::operator== ( const SCH_ITEM & aOther ) const

virtualinherited

Reimplemented in DELETED_SHEET_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 517 of file sch_item.cpp.

References compare(), EQUALITY, SCH_ITEM(), and EDA_ITEM::Type().

Referenced by SCH_SHAPE::operator==(), and SCH_SHEET_PIN::operator==().

◆ 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 888 of file lib_symbol.cpp.

References GetGraphicalPins(), LIB_SYMBOL(), and pin.

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

◆ Plot()

void LIB_SYMBOL::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground,
		const SCH_PLOT_OPTS &	aPlotOpts,
		int	aUnit,
		int	aBodyStyle,
		const VECTOR2I &	aOffset,
		bool	aDimmed )

overridevirtual

Plot the item to aPlotter.

Parameters

aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.
aUnit	- which unit to print.
aBodyStyle	- which body style to print.
aOffset	relative offset.
aDimmed	reduce brightness of item.

Reimplemented from SCH_ITEM.

Definition at line 623 of file lib_symbol.cpp.

References color, SCH_RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_ITEM::getRenderSettings(), LAYER_DEVICE, m_drawings, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), PLOTTER::SetColor(), COLOR4D::UNSPECIFIED, and COLOR4D::WHITE.

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

◆ PlotFields()

void LIB_SYMBOL::PlotFields	(	PLOTTER *	aPlotter,
		bool	aBackground,
		const SCH_PLOT_OPTS &	aPlotOpts,
		int	aUnit,
		int	aBodyStyle,
		const VECTOR2I &	aOffset,
		bool	aDimmed )

Plot symbol fields.

Definition at line 665 of file lib_symbol.cpp.

References color, SCH_RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), SCH_FIELD::GetFullText(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_ITEM::getRenderSettings(), EDA_TEXT::GetText(), EDA_TEXT::IsVisible(), LAYER_FIELDS, m_drawings, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), PLOTTER::SetColor(), SCH_FIELD::SetText(), COLOR4D::UNSPECIFIED, and COLOR4D::WHITE.

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg().

◆ RemoveDrawItem()

void LIB_SYMBOL::RemoveDrawItem ( SCH_ITEM * aItem )

Remove draw aItem from list.

Parameters

aItem - Draw item to remove from list.

Definition at line 746 of file lib_symbol.cpp.

References m_drawings, SCH_FIELD_T, SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_EDIT_TOOL::ConvertStackedPins(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), Flatten(), and RemoveField().

◆ RemoveField()

void LIB_SYMBOL::RemoveField ( SCH_FIELD * aField )

inline

Definition at line 416 of file lib_symbol.h.

References RemoveDrawItem().

◆ RemoveFile()

void EMBEDDED_FILES::RemoveFile	(	const wxString &	name,
		bool	aErase = true )

inherited

Remove a file from the collection and frees the memory.

Parameters

aName is the name of the file to remove.

Definition at line 124 of file embedded_files.cpp.

References m_files, and name.

Referenced by PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 625 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, IsHypertext(), and text.

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

◆ 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 SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET_PIN, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 428 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 236 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, flag, isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::replaceString, result, text, and WHOLEWORD.

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

◆ ResolveDNP()

bool SCH_ITEM::ResolveDNP ( ) const

inherited

Definition at line 292 of file sch_item.cpp.

References GetDNP(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), and NETLIST_EXPORTER_XML::makeSymbols().

◆ ResolveExcludedFromBoard()

bool SCH_ITEM::ResolveExcludedFromBoard ( ) const

inherited

Definition at line 277 of file sch_item.cpp.

References GetExcludedFromBoard(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), and NETLIST_EXPORTER_XML::makeSymbols().

◆ ResolveExcludedFromBOM()

bool SCH_ITEM::ResolveExcludedFromBOM ( ) const

inherited

Definition at line 262 of file sch_item.cpp.

References GetExcludedFromBOM(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), and NETLIST_EXPORTER_XML::makeSymbols().

◆ ResolveExcludedFromSim()

bool SCH_ITEM::ResolveExcludedFromSim ( ) const

inherited

Definition at line 247 of file sch_item.cpp.

References GetExcludedFromSim(), and m_rule_areas_cache.

Referenced by SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), and ERC_TESTER::TestSimModelIssues().

◆ ResolveTextVar()

bool LIB_SYMBOL::ResolveTextVar	(	wxString *	token,
		int	aDepth = 0 ) const

Resolve any references to system tokens supported by the symbol.

Parameters

aDepth a counter to limit recursion and circular references.

Definition at line 522 of file lib_symbol.cpp.

References _, FOOTPRINT, SCH_FIELD::GetCanonicalName(), GetDescription(), SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromSim(), SCH_FIELD::GetId(), GetKeyWords(), SCH_FIELD::GetName(), SCH_FIELD::GetShownText(), m_drawings, m_libId, SCH_FIELD_T, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_FIELD::GetShownText().

◆ Rotate()

virtual void SCH_ITEM::Rotate	(	const VECTOR2I &	aCenter,
		bool	aRotateCCW )

inlinevirtualinherited

Rotate the item around aCenter 90 degrees in the clockwise direction.

Reimplemented in DELETED_SHEET_ITEM, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 389 of file sch_item.h.

References GetClass().

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EDIT_TOOL::Rotate(), and SYMBOL_EDITOR_EDIT_TOOL::Rotate().

◆ RunOnChildren()

void LIB_SYMBOL::RunOnChildren	(	const std::function< void(SCH_ITEM *)> &	aFunction,
		RECURSE_MODE	aMode )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1243 of file lib_symbol.cpp.

References m_drawings, and SCH_ITEM::SCH_ITEM().

Referenced by SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol(), SCH_COMMIT::pushLibEdit(), and ERC_TESTER::TestTextVars().

◆ RunOnNestedEmbeddedFiles()

virtual void EMBEDDED_FILES::RunOnNestedEmbeddedFiles ( const std::function< void(EMBEDDED_FILES *)> & aFunction )

inlinevirtualinherited

Provide access to nested embedded files, such as symbols in schematics and footprints in boards.

Reimplemented in BOARD, and SCHEMATIC.

Definition at line 182 of file embedded_files.h.

References EMBEDDED_FILES().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Search the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note: This hierarchy is not the same as the sheet hierarchy!

Returns: the parent schematic this item lives on, or nullptr.

Definition at line 217 of file sch_item.cpp.

References EDA_ITEM::findParent(), and SCHEMATIC_T.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), SCH_FIELD::DoHypertextAction(), KIGFX::SCH_PAINTER::draw(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), SCH_SHEET::GetContextualTextVars(), GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_SHAPE::GetEffectiveWidth(), GetEmbeddedFonts(), GetFontMetrics(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_SHAPE::getMaxError(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRefProp(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_SYMBOL::GetUnitProp(), GetUnplacedUnitsForSymbol(), SCH_SYMBOL::GetValueProp(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), SCH_POINT_EDITOR::makePointsAndBehavior(), SIM_MODEL::MigrateSimModel(), SCH_FIELD::OnScintillaCharAdded(), PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_SCREEN::Plot(), SCH_SYMBOL::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_COMMIT::pushSchEdit(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::Revert(), SCH_FIELD::SCH_FIELD(), SCH_EDIT_FRAME::SelectUnit(), SCH_MARKER::SerializeToString(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SCH_SYMBOL::SetUnitProp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SCH_EDITOR_CONTROL::SimTune(), SCH_SYMBOL::SubReference(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_MARKER::ViewGetLayers(), and ~SCH_ITEM().

◆ Seed()

static uint32_t EMBEDDED_FILES::Seed ( )

inlinestaticinherited

Definition at line 270 of file embedded_files.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CompressAndEncode(), DecompressAndDecode(), and EMBEDDED_FILES::EMBEDDED_FILE::Validate().

◆ Serialize()

void SERIALIZABLE::Serialize ( google::protobuf::Any & aContainer ) const

virtualinherited

Serializes this object to the given Any message.

The Any message's concrete type will be specific to the object in question.

Parameters

aContainer will be filled with a message describing this object

Reimplemented in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 24 of file serializable.cpp.

Referenced by API_HANDLER_PCB::handleCreateUpdateItemsInternal(), and ~SERIALIZABLE().

◆ Set() [1/4]

template<typename T>

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

inlineinherited

Definition at line 98 of file inspectable.h.

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

◆ Set() [2/4]

template<typename T>

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

inlineinherited

Definition at line 60 of file inspectable.h.

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

◆ Set() [3/4]

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

inlineinherited

Definition at line 43 of file inspectable.h.

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

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

◆ Set() [4/4]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxVariant	aValue,
		bool	aNotify = true )

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ SetAreFontsEmbedded()

void EMBEDDED_FILES::SetAreFontsEmbedded ( bool aEmbedFonts )

inlineinherited

Definition at line 260 of file embedded_files.h.

References m_embedFonts.

Referenced by SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

◆ SetBodyStyle()

virtual void SCH_ITEM::SetBodyStyle ( int aBodyStyle )

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 243 of file sch_item.h.

References m_bodyStyle.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), and PIN_INFO_FORMATTER::UpdatePin().

◆ SetBodyStyleCount()

void LIB_SYMBOL::SetBodyStyleCount	(	int	aCount,
		bool	aDuplicateDrawItems,
		bool	aDuplicatePins )

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

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

Parameters

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

Definition at line 1437 of file lib_symbol.cpp.

References GetBodyStyleCount(), IGNORE_PARENT_GROUP, SCH_ITEM::m_bodyStyle, m_drawings, SCH_ITEM::SCH_ITEM(), and SCH_PIN_T.

◆ SetBodyStyleNames()

void LIB_SYMBOL::SetBodyStyleNames ( const std::vector< wxString > & aBodyStyleNames )

inline

Definition at line 608 of file lib_symbol.h.

References m_bodyStyleNames.

◆ SetBodyStyleProp()

void SCH_ITEM::SetBodyStyleProp ( const wxString & aBodyStyle )

virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 189 of file sch_item.cpp.

References _HKI, BASE, DEMORGAN, GetParentSymbol(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 135 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

◆ SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH * aGraph )

inherited

Update the connection graph for all connections in this item.

Definition at line 340 of file sch_item.cpp.

References CONNECTION_GRAPH, m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 556 of file sch_item.h.

References m_connectivity_dirty.

Referenced by SCH_LINE::BreakAt(), SCH_EDIT_TOOL::editFieldText(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::MergeOverlap(), SCH_LINE::NonGroupAware_BreakAt(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_COMMIT::Revert(), and SCH_TOOL_BASE< T >::saveCopyInUndoList().

◆ SetDescription()

void LIB_SYMBOL::SetDescription ( const wxString & aDescription )

inline

Gets the Description field text value *‍/.

Definition at line 163 of file lib_symbol.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), SCH_IO_EASYEDAPRO::LoadAllDataFromProject(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), loadSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ SetDNP()

void SYMBOL::SetDNP ( bool aDNP )

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 198 of file symbol.h.

References m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetDuplicatePinNumbersAreJumpers()

void LIB_SYMBOL::SetDuplicatePinNumbersAreJumpers ( bool aEnabled )

inline

Definition at line 574 of file lib_symbol.h.

References m_duplicatePinNumbersAreJumpers.

Referenced by CONNECTION_GRAPH::boost_test_update_symbol_connectivity.

◆ SetExcludedFromBoard()

void SYMBOL::SetExcludedFromBoard ( bool aExcludeFromBoard )

inlineoverridevirtualinherited

Set or clear exclude from board netlist flag.

Reimplemented from SCH_ITEM.

Definition at line 191 of file symbol.h.

References m_excludedFromBoard.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Flatten(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetExcludedFromBOM()

void SYMBOL::SetExcludedFromBOM ( bool aExcludeFromBOM )

inlineoverridevirtualinherited

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

Reimplemented from SCH_ITEM.

Definition at line 185 of file symbol.h.

References m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Flatten(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetExcludedFromSim()

void SYMBOL::SetExcludedFromSim ( bool aExcludeFromSim )

inlineoverridevirtualinherited

Set or clear the exclude from simulation flag.

Reimplemented from SCH_ITEM.

Definition at line 175 of file symbol.h.

References m_excludedFromSim.

Referenced by LIB_SYMBOL::Flatten(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetFields()

void LIB_SYMBOL::SetFields ( const std::vector< SCH_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 1045 of file lib_symbol.cpp.

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

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( AUTOPLACE_ALGO aAlgo )

inlineinherited

Definition at line 593 of file sch_item.h.

References m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_EDIT_TOOL::Rotate(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetFileAddedCallback()

void EMBEDDED_FILES::SetFileAddedCallback ( FILE_ADDED_CALLBACK callback )

inlineinherited

Definition at line 115 of file embedded_files.h.

References m_fileAddedCallback.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 166 of file view_item.h.

References m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), 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 210 of file eda_item.h.

References 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 215 of file lib_symbol.h.

References m_fpFilters.

Referenced by BOOST_AUTO_TEST_CASE(), Flatten(), and SCH_IO_HTTP_LIB::loadSymbolFromPart().

◆ SetGlobalPower()

void LIB_SYMBOL::SetGlobalPower ( )

Definition at line 461 of file lib_symbol.cpp.

References ENTRY_GLOBAL_POWER, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), RESOLVE_DRIVERS_FIXTURE::MakeGlobalPowerPin(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetHasDeMorganBodyStyles()

void LIB_SYMBOL::SetHasDeMorganBodyStyles ( bool aFlag )

inline

Definition at line 605 of file lib_symbol.h.

References m_demorgan.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover )

inlineinherited

Definition at line 132 of file eda_item.h.

References m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 176 of file eda_item.h.

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

◆ SetKeyWords()

void LIB_SYMBOL::SetKeyWords ( const wxString & aKeyWords )

inline

Definition at line 180 of file lib_symbol.h.

References m_keyWords.

Referenced by BOOST_AUTO_TEST_CASE(), Flatten(), SCH_IO_EASYEDAPRO::LoadAllDataFromProject(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), loadSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM * aItem )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 585 of file sch_item.h.

References SCH_ITEM().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Definition at line 310 of file sch_item.h.

References m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_LTSPICE_PARSER::CreateWire(), SCH_LINE::Deserialize(), SCH_MOVE_TOOL::getConnectedDragItems(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_RULE_AREA::SCH_RULE_AREA(), SCH_SHAPE::SCH_SHAPE(), SCH_TABLE::SCH_TABLE(), and SCH_FIELD::setId().

◆ SetLib()

void LIB_SYMBOL::SetLib ( SYMBOL_LIB * aLibrary )

inline

Definition at line 211 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 155 of file lib_symbol.h.

References m_libId.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), Flatten(), SCH_IO_EASYEDAPRO::LoadAllDataFromProject(), SYMBOL_LIB_TABLE::LoadSymbol(), loadSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_IO_ALTIUM::ParsePowerPort(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbol().

◆ SetLocalPower()

void LIB_SYMBOL::SetLocalPower ( )

Definition at line 425 of file lib_symbol.cpp.

References ENTRY_LOCAL_POWER, m_options, and m_parent.

Referenced by RESOLVE_DRIVERS_FIXTURE::MakeLocalPowerPin(), SCH_DRAWING_TOOLS::PlaceSymbol(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetLocked()

virtual void EDA_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Reimplemented in BOARD_ITEM, FOOTPRINT, and PCB_GROUP.

Definition at line 121 of file eda_item.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), SCH_IO_ALTIUM::ParseASCIISchematic(), and SCH_IO_ALTIUM::ParseFileHeader().

◆ SetName()

void LIB_SYMBOL::SetName ( const wxString & aName )

virtual

Definition at line 314 of file lib_symbol.cpp.

References m_libId, and m_name.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), SYMBOL_EDIT_FRAME::ensureUniqueName(), SYMBOL_EDIT_FRAME::ImportSymbol(), LIB_SYMBOL(), SCH_IO_EASYEDAPRO::LoadAllDataFromProject(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), loadSymbol(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_IO_ALTIUM::ParsePowerPort(), and SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ SetNormal()

void LIB_SYMBOL::SetNormal ( )

Definition at line 489 of file lib_symbol.cpp.

References ENTRY_NORMAL, m_options, and m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), RESOLVE_DRIVERS_FIXTURE::MakeRegularPin(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetParent() [1/2]

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlineprivatevirtual

Reimplemented from EDA_ITEM.

Definition at line 113 of file eda_item.h.

◆ SetParent() [2/2]

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

Definition at line 321 of file lib_symbol.cpp.

References LIB_SYMBOL(), m_parent, and SharedPtr().

Referenced by BOOST_AUTO_TEST_CASE(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), LIB_SYMBOL(), LIB_SYMBOL(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), operator=(), LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and SCH_SYMBOL::SCH_SYMBOL().

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), EDA_GROUP::RemoveItem(), SaveCopyOfZones(), and CLIPBOARD_IO::SaveSelection().

◆ SetPinNameOffset()

void SYMBOL::SetPinNameOffset ( int aOffset )

inlineinherited

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 157 of file symbol.h.

References m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), and PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ SetPosition()

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

inlinevirtualinherited

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

Definition at line 273 of file eda_item.h.

Referenced by BOARD_EDITOR_CONTROL::DoSetDrillOrigin(), PCB_CONTROL::DoSetGridOrigin(), DRAWING_TOOL::DrawVia(), ARRAY_TOOL::onDialogClosed(), PL_DRAWING_TOOLS::PlaceItem(), PAD_TOOL::PlacePad(), BOARD_ITEM::SetFPRelativePosition(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), SCH_DRAWING_TOOLS::SingleClickPlace(), POINT_PLACER::SnapItem(), EDIT_TOOL::Swap(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ SetPreviewBodyStyle()

void SYMBOL::SetPreviewBodyStyle ( int aBodyStyle )

inlineinherited

Definition at line 207 of file symbol.h.

References m_previewBodyStyle.

◆ SetPreviewUnit()

void SYMBOL::SetPreviewUnit ( int aUnit )

inlineinherited

Definition at line 206 of file symbol.h.

References m_previewUnit.

◆ SetPrivate()

void SCH_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 249 of file sch_item.h.

References m_private.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_ITEM_DESC::SCH_ITEM_DESC(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), and SCH_SYMBOL::UpdateFields().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 134 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetShowPinNames()

virtual void SYMBOL::SetShowPinNames ( bool aShow )

inlinevirtualinherited

Set or clear the pin name visibility flag.

Reimplemented in SCH_SYMBOL.

Definition at line 163 of file symbol.h.

References m_showPinNames.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_ALTIUM::fixupSymbolPinNameNumbers(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetShowPinNumbers()

virtual void SYMBOL::SetShowPinNumbers ( bool aShow )

inlinevirtualinherited

Set or clear the pin number visibility flag.

Reimplemented in SCH_SYMBOL.

Definition at line 169 of file symbol.h.

References m_showPinNumbers.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_LTSPICE_PARSER::CreateSymbol(), SCH_IO_ALTIUM::fixupSymbolPinNameNumbers(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().

◆ SetSourceLibId()

void LIB_SYMBOL::SetSourceLibId ( const LIB_ID & aLibId )

inline

Definition at line 158 of file lib_symbol.h.

References m_sourceLibId.

Referenced by SCH_IO_HTTP_LIB::loadSymbolFromPart().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos )

inlineinherited

Definition at line 280 of file sch_item.h.

References m_storedPos.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 612 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetTransform()

void SYMBOL::SetTransform ( const TRANSFORM & aTransform )

inlineinherited

Definition at line 204 of file symbol.h.

References m_transform.

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit )

inlinevirtualinherited

Definition at line 237 of file sch_item.h.

References m_unit.

◆ SetUnitCount()

void LIB_SYMBOL::SetUnitCount	(	int	aCount,
		bool	aDuplicateDrawItems )

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 additional unit.

Definition at line 1376 of file lib_symbol.cpp.

References MULTIVECTOR< SCH_ITEM, SCH_SHAPE_T, SCH_PIN_T >::FIRST_TYPE, IGNORE_PARENT_GROUP, MULTIVECTOR< SCH_ITEM, SCH_SHAPE_T, SCH_PIN_T >::LAST_TYPE, m_drawings, SCH_ITEM::m_unit, m_unitCount, and SCH_ITEM::SCH_ITEM().

Referenced by BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), and SCH_EASYEDAPRO_PARSER::ParseSymbol().

◆ SharedPtr()

LIB_SYMBOL_SPTR LIB_SYMBOL::SharedPtr ( ) const

inline

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

Definition at line 95 of file lib_symbol.h.

References m_me.

Referenced by SYMBOL_LIB::AddSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), LIB_BUFFER::GetDerivedSymbolNames(), SYMBOL_VIEWER_FRAME::GetDocumentExtents(), GetParentChain(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and SetParent().

◆ Similarity()

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

overridevirtual

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

Reimplemented from SCH_ITEM.

Definition at line 1873 of file lib_symbol.cpp.

References GetBodyStyleCount(), GetPins(), LIB_SYMBOL(), LIB_SYMBOL_T, m_bodyStyleNames, m_drawings, SYMBOL::m_excludedFromBoard, SYMBOL::m_excludedFromBOM, SYMBOL::m_excludedFromSim, EDA_ITEM::m_flags, SYMBOL::m_pinNameOffset, SYMBOL::m_showPinNames, SYMBOL::m_showPinNumbers, m_unitCount, EDA_ITEM::m_Uuid, pin, SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

◆ SimilarityBase()

double SCH_ITEM::SimilarityBase ( const SCH_ITEM & aItem ) const

inlineinherited

Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.

Definition at line 346 of file sch_item.h.

References m_bodyStyle, m_private, m_unit, and SCH_ITEM().

Referenced by SCH_FIELD::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::Similarity().

◆ 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 457 of file eda_item.h.

References EDA_ITEM().

◆ swapData()

void SCH_ITEM::swapData ( SCH_ITEM * aItem )

protectedvirtualinherited

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me.

Parameters

aItem The item to swap the data structures with.

Reimplemented in SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GROUP, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 450 of file sch_item.cpp.

References GetClass(), SCH_ITEM(), and UNIMPLEMENTED_FOR.

Referenced by SCH_SHEET_PIN::swapData(), and SwapItemData().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 476 of file sch_item.cpp.

References EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearTempFlags(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetTempFlags(), EDA_ITEM::m_flags, SCH_ITEM(), and EDA_ITEM::SetFlags().

Referenced by SwapItemData().

◆ SwapItemData()

void SCH_ITEM::SwapItemData ( SCH_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters

aImage the item image which contains data to swap.

Definition at line 456 of file sch_item.cpp.

References EDA_ITEM::EDA_ITEM(), EDA_ITEM::GetParent(), m_bodyStyle, m_fieldsAutoplaced, EDA_ITEM::m_group, m_layer, m_private, m_unit, SCH_ITEM(), EDA_ITEM::SetParent(), swapData(), and SwapFlags().

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_COMMIT::Revert().

◆ 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 110 of file eda_item.h.

References m_structType.

◆ UnitsLocked()

bool LIB_SYMBOL::UnitsLocked ( ) const

inline

Check whether symbol units are interchangeable.

Returns: False when interchangeable, true otherwise.

Definition at line 291 of file lib_symbol.h.

References m_unitsLocked.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_REFERENCE::IsUnitsLocked(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

◆ UpdateDanglingState()

virtual bool SCH_ITEM::UpdateDanglingState	(	std::vector< DANGLING_END_ITEM > &	aItemListByType,
		std::vector< DANGLING_END_ITEM > &	aItemListByPos,
		const SCH_SHEET_PATH *	aSheet = nullptr )

inlinevirtualinherited

Test the schematic item to aItemList to check if it's dangling state has changed.

Note that the return value only true when the state of the test has changed. Use the IsDangling() method to get the current dangling state of the item. Some of the schematic objects cannot be tested for a dangling state, the default method always returns false. Only override the method if the item can be tested for a dangling state.

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overridden method can optionally use it to update sheet-local connectivity information

Parameters

aItemListByType	is the list of items to test item against. It's sorted by item type, keeping WIRE_END pairs together.
aItemListByPos	is the same list but sorted first by Y then by X.
aSheet	is the sheet path to update connections for.

Returns: True if the dangling state has changed from it's current setting.

Reimplemented in SCH_BUS_BUS_ENTRY, SCH_BUS_WIRE_ENTRY, SCH_LABEL_BASE, SCH_LINE, SCH_SHEET, and SCH_SYMBOL.

Definition at line 465 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ UpdateFontFiles()

const std::vector< wxString > * EMBEDDED_FILES::UpdateFontFiles ( )

inherited

Helper function to get a list of fonts for fontconfig to add to the library.

This is necessary because EMBEDDED_FILES lives in common at the moment and fontconfig is in libkicommon. This will create the cache files in the KiCad cache directory (if they do not already exist) and return the temp files names

Definition at line 535 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::FONT, GetTemporaryFileName(), m_files, m_fontFiles, and name.

Referenced by SCH_SCREEN::FixupEmbeddedData(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), and SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol().

◆ 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 DS_PROXY_VIEW_ITEM, EDIT_POINTS, FOOTPRINT, GERBER_DRAW_ITEM, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ANGLE_ITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, MY_DRAWING, PAD, PCB_DIM_CENTER, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_TUNING_PATTERN, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, SCH_PIN, and TUNING_STATUS_VIEW_ITEM.

Definition at line 345 of file eda_item.cpp.

References GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), 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, EDIT_POINTS, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, MY_DRAWING, PCB_TUNING_PATTERN, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, TUNING_STATUS_VIEW_ITEM, and VIEW_OVERLAY.

Definition at line 127 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > SYMBOL::ViewGetLayers ( ) const

overridevirtualinherited

Return the layers the item is drawn on (which may be more than its "home" layer)

Reimplemented from SCH_ITEM.

Definition at line 28 of file symbol.cpp.

References LAYER_DANGLING, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_FIELDS, LAYER_NOTES_BACKGROUND, LAYER_OP_CURRENTS, LAYER_PRIVATE_NOTES, LAYER_REFERENCEPART, LAYER_SELECTION_SHADOWS, LAYER_SHAPES_BACKGROUND, LAYER_VALUEPART, LIB_SYMBOL_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD	(	int	aLayer,
		const 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.

Use LOD_HIDE and LOD_SHOW constants to hide or show the item unconditionally.

Use lodScaleForThreshold() to calculate the LOD scale for when the item passes a certain threshold size on screen.

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 shows the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_FIELD, PCB_GROUP, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_GROUP, SCH_LINE, and ZONE.

Definition at line 155 of file view_item.h.

References LOD_SHOW, and VIEW.

Referenced by PCB_GRID_HELPER::computeAnchors(), 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 1359 of file lib_symbol.cpp.

References CONTINUE, m_drawings, QUIT, and SCH_ITEM::SCH_ITEM().

◆ WriteEmbeddedFiles()

void EMBEDDED_FILES::WriteEmbeddedFiles	(	OUTPUTFORMATTER &	aOut,
		bool	aWriteData ) const

inherited

Output formatter for the embedded files.

Parameters

aOut	is the output formatter.
aWriteData	is true if the actual data should be written. This is false when writing an element that is already embedded in a file that itself has embedded files (boards, schematics, etc.).

Definition at line 156 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::DATASHEET, EMBEDDED_FILES::EMBEDDED_FILE::FONT, m_files, MIME_BASE64_LENGTH, EMBEDDED_FILES::EMBEDDED_FILE::MODEL, EMBEDDED_FILES::EMBEDDED_FILE::name, name, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), EMBEDDED_FILES::EMBEDDED_FILE::type, and EMBEDDED_FILES::EMBEDDED_FILE::WORKSHEET.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 143 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

double KIGFX::VIEW_ITEM::LOD_HIDE = std::numeric_limits<double>::max()

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to hide the item unconditionally.

Definition at line 180 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to show the item unconditionally.

Definition at line 185 of file view_item.h.

Referenced by lodScaleForThreshold(), FOOTPRINT::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_bodyStyle

int SCH_ITEM::m_bodyStyle

protectedinherited

◆ m_bodyStyleNames

std::vector<wxString> LIB_SYMBOL::m_bodyStyleNames

private

Definition at line 725 of file lib_symbol.h.

Referenced by Compare(), GetBodyStyleCount(), GetBodyStyleDescription(), GetBodyStyleNames(), LIB_SYMBOL(), operator=(), SetBodyStyleNames(), and Similarity().

◆ m_connected_items

std::map<SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP> SCH_ITEM::m_connected_items

protectedinherited

Store pointers to other items that are connected to this one, per sheet.

Definition at line 748 of file sch_item.h.

Referenced by AddConnectionTo(), ClearConnectedItems(), ConnectedItems(), and SCH_LABEL_BASE::IsType().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map

protectedinherited

Store connectivity information, per sheet.

Definition at line 751 of file sch_item.h.

Referenced by Connection(), InitializeConnection(), SetConnectionGraph(), and ~SCH_ITEM().

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty

protectedinherited

Definition at line 753 of file sch_item.h.

Referenced by IsConnectivityDirty(), operator=(), SCH_ITEM(), SCH_ITEM(), and SetConnectivityDirty().

◆ m_demorgan

bool LIB_SYMBOL::m_demorgan

private

True if there are two body styles: normal and De Morgan If false, the body style count is taken from m_bodyStyleNames size.

Definition at line 702 of file lib_symbol.h.

Referenced by GetBodyStyleCount(), HasDeMorganBodyStyles(), LIB_SYMBOL(), LIB_SYMBOL(), operator=(), and SetHasDeMorganBodyStyles().

◆ m_DNP

bool SYMBOL::m_DNP

protectedinherited

True if symbol is set to 'Do Not Populate'.

Definition at line 232 of file symbol.h.

Referenced by GetDNP(), operator=(), SCH_SYMBOL::Plot(), SCH_SYMBOL::SCH_SYMBOL(), SetDNP(), SCH_SYMBOL::swapData(), SYMBOL(), SYMBOL(), and SCH_SYMBOL::SyncOtherUnits().

◆ m_drawings

LIB_ITEMS_CONTAINER LIB_SYMBOL::m_drawings

private

◆ m_duplicatePinNumbersAreJumpers

bool LIB_SYMBOL::m_duplicatePinNumbersAreJumpers

private

Flag that this symbol should automatically treat sets of two or more pins with the same number as jumpered pin groups.

Definition at line 722 of file lib_symbol.h.

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

◆ m_embedFonts

bool EMBEDDED_FILES::m_embedFonts = false

protectedinherited

If set, fonts will be embedded in the element on save.

Otherwise, font files embedded in the element will be removed on save.

Definition at line 284 of file embedded_files.h.

Referenced by EMBEDDED_FILES(), EMBEDDED_FILES(), FOOTPRINT::FOOTPRINT(), FOOTPRINT::FOOTPRINT(), GetAreFontsEmbedded(), operator=(), operator=(), and SetAreFontsEmbedded().

◆ m_excludedFromBoard

bool SYMBOL::m_excludedFromBoard

protectedinherited

Definition at line 231 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), GetExcludedFromBoard(), operator=(), SCH_SYMBOL::SCH_SYMBOL(), SetExcludedFromBoard(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), SYMBOL(), and SCH_SYMBOL::SyncOtherUnits().

◆ m_excludedFromBOM

bool SYMBOL::m_excludedFromBOM

protectedinherited

Definition at line 230 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), GetExcludedFromBOM(), operator=(), SCH_SYMBOL::SCH_SYMBOL(), SetExcludedFromBOM(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), SYMBOL(), and SCH_SYMBOL::SyncOtherUnits().

◆ m_excludedFromSim

bool SYMBOL::m_excludedFromSim

protectedinherited

Definition at line 229 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), GetExcludedFromSim(), operator=(), SCH_SYMBOL::SCH_SYMBOL(), SetExcludedFromSim(), LIB_SYMBOL::Similarity(), SCH_SYMBOL::swapData(), SYMBOL(), and SYMBOL().

◆ m_fieldsAutoplaced

AUTOPLACE_ALGO SCH_ITEM::m_fieldsAutoplaced

protectedinherited

◆ m_fileAddedCallback

FILE_ADDED_CALLBACK EMBEDDED_FILES::m_fileAddedCallback

privateinherited

Definition at line 281 of file embedded_files.h.

Referenced by AddFile(), AddFile(), EMBEDDED_FILES(), EMBEDDED_FILES(), GetFileAddedCallback(), operator=(), operator=(), and SetFileAddedCallback().

◆ m_files

std::map<wxString, EMBEDDED_FILE*> EMBEDDED_FILES::m_files

privateinherited

Definition at line 279 of file embedded_files.h.

Referenced by AddFile(), AddFile(), ClearEmbeddedFiles(), ClearEmbeddedFonts(), EMBEDDED_FILES(), EMBEDDED_FILES(), EmbeddedFileMap(), GetEmbeddedFile(), GetTemporaryFileName(), HasFile(), IsEmpty(), operator=(), operator=(), RemoveFile(), UpdateFontFiles(), WriteEmbeddedFiles(), and ~EMBEDDED_FILES().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 527 of file eda_item.h.

Referenced by ClearFlags(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_PIN::GetBoundingBox(), GetEditFlags(), GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), GetTempFlags(), HasFlag(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_JUNCTION::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_LINE::HitTest(), SCH_PIN::HitTest(), SCH_PIN::HitTest(), SCH_SHAPE::HitTest(), SCH_SHAPE::HitTest(), SCH_SYMBOL::HitTest(), SCH_SYMBOL::HitTest(), SCH_TEXT::HitTest(), SCH_TEXT::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), IsBrightened(), SCH_ITEM::IsConnected(), IsEntered(), IsModified(), IsMoving(), IsNew(), IsSelected(), IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), operator=(), PCB_SHAPE::operator==(), SCH_LINE::Rotate(), SetFlags(), LIB_SYMBOL::Similarity(), PCB_SHAPE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), SCH_ITEM::SwapFlags(), SCH_PIN::ViewBBox(), and XorFlags().

◆ m_fontFiles

std::vector<wxString> EMBEDDED_FILES::m_fontFiles

privateinherited

Definition at line 280 of file embedded_files.h.

Referenced by EMBEDDED_FILES(), EMBEDDED_FILES(), GetFontFiles(), operator=(), operator=(), and UpdateFontFiles().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 210 of file view_item.h.

Referenced by GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), SetForcedTransparency(), and VIEW_ITEM().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 530 of file eda_item.h.

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

◆ m_fpFilters

wxArrayString LIB_SYMBOL::m_fpFilters

private

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

Definition at line 713 of file lib_symbol.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

The group this item belongs to, if any. No ownership implied.

Definition at line 529 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), SetParentGroup(), and SCH_ITEM::SwapItemData().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 208 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 531 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsRollover(), operator=(), and SetIsRollover().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 207 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_jumperPinGroups

std::vector<std::set<wxString> > LIB_SYMBOL::m_jumperPinGroups

private

A list of jumper pin groups, each of which is a set of pin numbers that should be jumpered together (treated as internally connected for the purposes of connectivity)

Definition at line 718 of file lib_symbol.h.

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

◆ m_keyWords

wxString LIB_SYMBOL::m_keyWords

private

Search keywords.

Definition at line 712 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 696 of file lib_symbol.h.

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

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 739 of file sch_item.h.

Referenced by CanConnect(), SCH_LINE::CanConnect(), SCH_LINE::doIsConnected(), SCH_LINE::GetItemDescription(), GetLayer(), SCH_TEXTBOX::GetLegacyTextMargin(), SCH_LINE::GetMenuImage(), SCH_TEXT::GetMsgPanelInfo(), SCH_LINE::GetPenWidth(), SCH_SYMBOL::Init(), SCH_LINE::IsConnectable(), IsType(), SCH_LINE::IsType(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), operator=(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_BUS_WIRE_ENTRY::SCH_BUS_WIRE_ENTRY(), SCH_DIRECTIVE_LABEL::SCH_DIRECTIVE_LABEL(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_ITEM(), SCH_ITEM(), SCH_JUNCTION::SCH_JUNCTION(), SCH_LABEL::SCH_LABEL(), SCH_LINE::SCH_LINE(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_PIN::SCH_PIN(), SCH_SHEET::SCH_SHEET(), SCH_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SetLayer(), SwapItemData(), SCH_JUNCTION::ViewGetLayers(), SCH_LINE::ViewGetLayers(), SCH_SHAPE::ViewGetLayers(), and SCH_TEXT::ViewGetLayers().

◆ m_libId

LIB_ID LIB_SYMBOL::m_libId

private

Definition at line 694 of file lib_symbol.h.

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

◆ m_library

SYMBOL_LIB* LIB_SYMBOL::m_library

private

Definition at line 710 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 692 of file lib_symbol.h.

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

◆ m_name

wxString LIB_SYMBOL::m_name

private

Definition at line 711 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 706 of file lib_symbol.h.

Referenced by Compare(), IsGlobalPower(), IsLocalPower(), IsNormal(), LIB_SYMBOL(), LIB_SYMBOL(), operator=(), SetGlobalPower(), SetLocalPower(), and SetNormal().

◆ m_parent

LIB_SYMBOL_REF LIB_SYMBOL::m_parent

private

Use for inherited symbols.

Definition at line 693 of file lib_symbol.h.

Referenced by Compare(), Flatten(), GetDescription(), GetFPFilters(), GetGraphicalPins(), GetKeyWords(), GetMaxPinNumber(), GetParent(), GetParent(), GetRootSymbol(), GetUnitCount(), HasLegacyAlternateBodyStyle(), IsDerived(), IsGlobalPower(), IsLocalPower(), IsNormal(), IsRoot(), LIB_SYMBOL(), operator=(), SetGlobalPower(), SetLocalPower(), SetNormal(), and SetParent().

◆ m_pinNameOffset

int SYMBOL::m_pinNameOffset

protectedinherited

The offset in mils to draw the pin name.

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

Definition at line 224 of file symbol.h.

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

◆ m_previewBodyStyle

int SYMBOL::m_previewBodyStyle = 1

protectedinherited

Definition at line 235 of file symbol.h.

Referenced by LIB_SYMBOL::GetBodyAndPinsBoundingBox(), LIB_SYMBOL::GetBodyBoundingBox(), and SetPreviewBodyStyle().

◆ m_previewUnit

int SYMBOL::m_previewUnit = 1

protectedinherited

Definition at line 234 of file symbol.h.

Referenced by LIB_SYMBOL::GetBodyAndPinsBoundingBox(), LIB_SYMBOL::GetBodyBoundingBox(), and SetPreviewUnit().

◆ m_private

bool SCH_ITEM::m_private

protectedinherited

Definition at line 742 of file sch_item.h.

Referenced by IsPrivate(), SCH_FIELD::operator=(), operator=(), SCH_FIELD::SCH_FIELD(), SCH_ITEM(), SCH_ITEM(), SetPrivate(), SimilarityBase(), and SwapItemData().

◆ m_rule_areas_cache

std::unordered_set<SCH_RULE_AREA*> SCH_ITEM::m_rule_areas_cache

protectedinherited

Store pointers to rule areas which this item is contained within.

Definition at line 756 of file sch_item.h.

Referenced by AddRuleAreaToCache(), ClearRuleAreasCache(), SCH_SYMBOL::GetComponentClassNames(), GetRuleAreaCache(), ResolveDNP(), ResolveExcludedFromBoard(), ResolveExcludedFromBOM(), and ResolveExcludedFromSim().

◆ m_showPinNames

bool SYMBOL::m_showPinNames

protectedinherited

Definition at line 226 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), GetShowPinNames(), operator=(), SetShowPinNames(), LIB_SYMBOL::Similarity(), SYMBOL(), and SYMBOL().

◆ m_showPinNumbers

bool SYMBOL::m_showPinNumbers

protectedinherited

Definition at line 227 of file symbol.h.

Referenced by LIB_SYMBOL::Compare(), GetShowPinNumbers(), operator=(), SetShowPinNumbers(), LIB_SYMBOL::Similarity(), SYMBOL(), and SYMBOL().

◆ m_sourceLibId

LIB_ID LIB_SYMBOL::m_sourceLibId

private

For database library symbols; the original symbol.

Definition at line 695 of file lib_symbol.h.

Referenced by GetSourceLibId(), and SetSourceLibId().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 744 of file sch_item.h.

Referenced by GetStoredPos(), and SetStoredPos().

◆ 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 524 of file eda_item.h.

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

◆ m_transform

TRANSFORM SYMBOL::m_transform

protectedinherited

The rotation/mirror transformation.

Definition at line 222 of file symbol.h.

Referenced by SCH_SYMBOL::doGetBoundingBox(), SCH_SYMBOL::doIsConnected(), SCH_SYMBOL::GetConnectionPoints(), SCH_SYMBOL::GetDrawItem(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPinPhysicalPosition(), GetTransform(), GetTransform(), SCH_SYMBOL::Init(), SCH_SYMBOL::operator=(), SCH_SYMBOL::SCH_SYMBOL(), SCH_SYMBOL::SetOrientation(), SetTransform(), SCH_SYMBOL::swapData(), and SCH_SYMBOL::UpdateDanglingState().

◆ m_unit

int SCH_ITEM::m_unit

protectedinherited

◆ m_unitCount

int LIB_SYMBOL::m_unitCount

private

Number of units (parts) per package.

Definition at line 698 of file lib_symbol.h.

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

◆ m_unitDisplayNames

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

private

Definition at line 724 of file lib_symbol.h.

Referenced by Compare(), GetUnitDisplayName(), GetUnitDisplayNames(), GetUnitDisplayNames(), LIB_SYMBOL(), and operator=().

◆ 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 699 of file lib_symbol.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 516 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 209 of file view_item.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FILE_ADDED_CALLBACK

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ RETURN_CODE

Constructor & Destructor Documentation

◆ LIB_SYMBOL() [1/2]

◆ LIB_SYMBOL() [2/2]

◆ ~LIB_SYMBOL()

Member Function Documentation

◆ AddConnectionTo()

◆ AddDrawItem()

◆ AddField() [1/2]

◆ AddField() [2/2]

◆ AddFile() [1/2]

◆ AddFile() [2/2]

◆ AddRuleAreaToCache()

◆ AutoplaceFields()

◆ BeginEdit()

◆ CalcEdit()

◆ CanConnect()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnectedItems()

◆ ClearEditFlags()

◆ ClearEmbeddedFiles()

◆ ClearEmbeddedFonts()

◆ ClearFlags()

◆ ClearRuleAreasCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ compare()

◆ CompressAndEncode()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ ContinueEdit()

◆ CopyFields()

◆ DecompressAndDecode()

◆ deleteAllFields()

◆ Deserialize()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate() [1/2]

◆ Duplicate() [2/2]

◆ EmbeddedFileMap()

◆ EmbedFonts()

◆ EndEdit()

◆ FindFieldCaseInsensitive()

◆ findParent()

◆ FixupDrawItems()

◆ Flatten()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAreFontsEmbedded()

◆ GetBodyAndPinsBoundingBox()

◆ GetBodyBoundingBox() [1/2]

◆ GetBodyBoundingBox() [2/2]

◆ GetBodyStyle()

◆ GetBodyStyleCount()

◆ GetBodyStyleDescription()

◆ GetBodyStyleNames()

◆ GetBodyStyleProp()

◆ GetBoundingBox()