Define a library symbol object. More...

#include <lib_symbol.h>

Inheritance diagram for LIB_SYMBOL:

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 }

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

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

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

LIB_SYMBOL_SPTR	SharedPtr () const

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

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	IsAlias () const

const wxString	GetLibraryName () const

SYMBOL_LIB *	GetLib () const

void	SetLib (SYMBOL_LIB *aLibrary)

timestamp_t	GetLastModDate () const

void	SetFPFilters (const wxArrayString &aFilters)

wxArrayString	GetFPFilters () const

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

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

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

bool	IsPower () const override

bool	IsNormal () const override

void	SetPower ()

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)
	Return a list of fields within this symbol.

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

void	AddField (SCH_FIELD *aField)
	Add a field.

void	AddField (SCH_FIELD &aField)

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

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

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

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

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

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

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

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

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

EMBEDDED_FILES *	GetEmbeddedFiles () override

const EMBEDDED_FILES *	GetEmbeddedFiles () const

void	EmbedFonts () override

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

int	UpdateFieldOrdinals ()
	Order optional field indices.

int	GetNextAvailableFieldId () const

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

void	Print (const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aForceNoFill, bool aDimmed) override
	Print an item.

void	PrintBackground (const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
	Print just the background fills.

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)

size_t	GetFieldCount () const

std::vector< SCH_PIN * >	GetPins (int aUnit=0, int aBodyStyle=0) const
	Return a list of pin object pointers from the draw item list.

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

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	HasAlternateBodyStyle () const override
	Test if symbol has more than one body conversion type (DeMorgan).

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=true)
	Set the units per symbol count.

int	GetUnitCount () const override

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

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

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

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

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

bool	IsMulti () const override

void	SetHasAlternateBodyStyle (bool aHasAlternate, bool aDuplicatePins=true)
	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)
	Set or clear the exclude from schematic bill of materials flag.

bool	GetExcludedFromBOM () const

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

bool	GetExcludedFromBoard () const

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

void	SetDNP (bool aDNP)

void	ViewGetLayers (int aLayers[], int &aCount) 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.

virtual void	SwapData (SCH_ITEM *aItem)
	Swap the internal data structures aItem with the schematic item.

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

SCH_ITEM *	Duplicate (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

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

virtual bool	IsMovableFromAnchorPoint () const

VECTOR2I &	GetStoredPos ()

void	SetStoredPos (const VECTOR2I &aPos)

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

const SYMBOL *	GetParentSymbol () const

SYMBOL *	GetParentSymbol ()

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

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

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

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

void	SetFieldsAutoplaced ()

void	ClearFieldsAutoplaced ()

void	AutoAutoplaceFields (SCH_SCREEN *aScreen)
	Autoplace fields only if correct to do so automatically.

virtual void	AutoplaceFields (SCH_SCREEN *aScreen, bool aManual)

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	ClearRuleAreasCache ()
	Reset the cache of rule areas (called prior to schematic connectivity recomputation)

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

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

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.

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

EDA_ITEM_FLAGS	GetTempFlags () const

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

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

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.

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

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

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

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

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

bool	HasFile (const wxString &name) const

bool	IsEmpty () const

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 ()
	Removes 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 bool	ClassOf (const EDA_ITEM *aItem)

static wxString	LetterSubReference (int aUnit, int aFirstId)

static wxString	GetUnitDescription (int aUnit)

static wxString	GetBodyStyleDescription (int aBodyStyle)

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)
	Takes 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
SCH_RENDER_SETTINGS *	getRenderSettings (PLOTTER *aPlotter) const

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

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

Protected Attributes
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'.

SCH_LAYER_ID	m_layer

int	m_unit

int	m_bodyStyle

bool	m_private

FIELDS_AUTOPLACED	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

bool	m_forceVisible

bool	m_embedFonts = false

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.

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::map< int, wxString >	m_unitDisplayNames

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

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

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 77 of file lib_symbol.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 657 of file sch_item.h.

◆ RETURN_CODE

enum class EMBEDDED_FILES::RETURN_CODE : int

stronginherited

Enumerator
OK
FILE_NOT_FOUND
PERMISSIONS_ERROR
FILE_ALREADY_EXISTS
OUT_OF_MEMORY
CHECKSUM_ERROR

Definition at line 85 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 98 of file lib_symbol.cpp.

References DEFAULT_PIN_NAME_OFFSET, ENTRY_NORMAL, GetDatasheetField(), GetDescriptionField(), GetFootprintField(), GetReferenceField(), GetValueField(), m_drawings, m_lastModDate, m_options, SYMBOL::m_pinNameOffset, m_unitCount, m_unitsLocked, MANDATORY_FIELDS, EDA_IU_SCALE::MilsToIU(), SCH_FIELD_T, schIUScale, SetLib(), SetName(), SetParent(), and EDA_TEXT::SetVisible().

◆ LIB_SYMBOL() [2/2]

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

Definition at line 135 of file lib_symbol.cpp.

References EDA_ITEM::ClearSelected(), EDA_ITEM::Clone(), CopyUnitDisplayNames(), EDA_ITEM::GetFlags(), IS_NEW, m_drawings, m_fpFilters, m_keyWords, m_lastModDate, m_libId, m_library, m_name, m_options, m_parent, m_unitCount, m_unitDisplayNames, m_unitsLocked, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), EDA_ITEM::SetParent(), SetParent(), and STRUCT_DELETED.

◆ ~LIB_SYMBOL()

virtual LIB_SYMBOL::~LIB_SYMBOL ( )

inlinevirtual

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

Definition at line 85 of file lib_symbol.h.

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 286 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

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

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

◆ AddField() [1/2]

void LIB_SYMBOL::AddField ( SCH_FIELD & aField )

inline

Definition at line 286 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 1007 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

Loads 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 43 of file embedded_files.cpp.

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

Referenced by EMBED_TOOL::AddFile(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), EmbedFonts(), SCHEMATIC::EmbedFonts(), BOARD::EmbedFonts(), FOOTPRINT::EmbedFonts(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PANEL_EMBEDDED_FILES::onAddEmbeddedFile(), TEXT_BUTTON_URL::OnButtonClick(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), PANEL_EMBEDDED_FILES::PANEL_EMBEDDED_FILES(), ALTIUM_PCB::ParseComponentsBodies6Data(), EMBEDDED_FILES_PARSER::ParseEmbedded(), PANEL_EMBEDDED_FILES::TransferDataFromWindow(), and PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow().

◆ AddFile() [2/2]

void EMBEDDED_FILES::AddFile ( EMBEDDED_FILE * aFile )

inherited

Appends a file to the collection.

Definition at line 111 of file embedded_files.cpp.

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

◆ AddRuleAreaToCache()

void SCH_ITEM::AddRuleAreaToCache ( SCH_RULE_AREA * aRuleArea )

inlineinherited

Adds a rule area to the item's cache.

Definition at line 633 of file sch_item.h.

References SCH_ITEM::m_rule_areas_cache.

Referenced by SCH_RULE_AREA::addContainedItem().

◆ AutoAutoplaceFields()

void SCH_ITEM::AutoAutoplaceFields ( SCH_SCREEN * aScreen )

inlineinherited

Autoplace fields only if correct to do so automatically.

Fields that have been moved by hand are not automatically placed.

Parameters

aScreen is the SCH_SCREEN associated with the current instance of the symbol.

Definition at line 560 of file sch_item.h.

References SCH_ITEM::AutoplaceFields(), FIELDS_AUTOPLACED_MANUAL, and SCH_ITEM::GetFieldsAutoplaced().

Referenced by SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), SCH_SHEET::SCH_SHEET(), SCH_EDIT_FRAME::SelectUnit(), and DIALOG_LABEL_PROPERTIES::TransferDataFromWindow().

◆ AutoplaceFields()

virtual void SCH_ITEM::AutoplaceFields	(	SCH_SCREEN *	aScreen,
		bool	aManual
	)

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE, SCH_DIRECTIVE_LABEL, SCH_SHEET, and SCH_SYMBOL.

Definition at line 566 of file sch_item.h.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ 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 373 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 403 of file sch_item.h.

◆ CanConnect()

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

inlinevirtualinherited

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

Definition at line 444 of file sch_item.h.

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

Referenced by SCH_MOVE_TOOL::getConnectedDragItems().

◆ ClassOf()

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

inlinestatic

Definition at line 131 of file lib_symbol.h.

References LIB_SYMBOL_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 123 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::unhighlight(), EE_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 375 of file sch_item.cpp.

References SCH_ITEM::RunOnChildren(), and text.

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

◆ ClearConnectedItems()

void SCH_ITEM::ClearConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Clear all connections to this item.

Definition at line 271 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ ClearEditFlags()

void LIB_SYMBOL::ClearEditFlags ( )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1287 of file lib_symbol.cpp.

References EDA_ITEM::ClearEditFlags(), and m_drawings.

Referenced by SYMBOL_EDIT_FRAME::PushSymbolToUndoList().

◆ ClearEmbeddedFiles()

void EMBEDDED_FILES::ClearEmbeddedFiles ( bool aDeleteFiles = true )

inlineinherited

Definition at line 207 of file embedded_files.h.

References EMBEDDED_FILES::m_files.

Referenced by PCB_IO_KICAD_SEXPR::format(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ ClearEmbeddedFonts()

void EMBEDDED_FILES::ClearEmbeddedFonts ( )

inherited

Removes all embedded fonts from the collection.

Definition at line 131 of file embedded_files.cpp.

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

Referenced by SCH_IO_KICAD_SEXPR::Format(), FP_CACHE::Save(), PCB_IO_KICAD_SEXPR::SaveBoard(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ ClearFieldsAutoplaced()

void SCH_ITEM::ClearFieldsAutoplaced ( )

inlineinherited

Definition at line 551 of file sch_item.h.

References FIELDS_AUTOPLACED_NO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_LABEL_BASE::SCH_LABEL_BASE(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 129 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignToGrid(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConnectBoardShapes(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::GuessSelectionCandidates(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), GERBVIEW_FRAME::RemapLayers(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_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 recomputation)

Definition at line 628 of file sch_item.h.

References SCH_ITEM::m_rule_areas_cache.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 122 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), LIB_SYMBOL(), ARRAY_TOOL::onDialogClosed(), SCH_COMMIT::Revert(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), PL_SELECTION_TOOL::unhighlight(), EE_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 1278 of file lib_symbol.cpp.

References EDA_ITEM::ClearTempFlags(), and m_drawings.

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

Definition at line 85 of file eda_item.cpp.

References EDA_ITEM::GetClass().

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

◆ Compare()

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

Comparison test that can be used for operators.

Parameters

aRhs	is the right hand side symbol used for comparison.

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

Definition at line 1517 of file lib_symbol.cpp.

References _, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), LIB_ID::compare(), SCH_FIELD::compare(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), ENTRY_NORMAL, SCH_ITEM::ERC, FindField(), SCH_ITEM::GetBodyStyle(), GetFieldById(), SCH_FIELD::GetId(), SCH_FIELD::GetName(), SCH_PIN::GetNumber(), GetPin(), SCH_ITEM::GetUnit(), SCH_FIELD::IsMandatory(), ITEM_DESC, 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, 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 1788 of file lib_symbol.cpp.

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

◆ CompressAndEncode()

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

staticinherited

Takes 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 213 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(), EMBEDDED_FILES::OK, EMBEDDED_FILES::OUT_OF_MEMORY, EMBEDDED_FILES::Seed(), and HASH_128::ToString().

Referenced by EMBEDDED_FILES::AddFile(), 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 280 of file sch_item.cpp.

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), 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 221 of file sch_item.cpp.

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

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_SUBGRAPH::ExchangeItem(), SCH_DRAWING_TOOLS::findWireLabelDriverName(), CONNECTION_GRAPH::GetBusesNeedingMigration(), SCH_ITEM::GetEffectiveNetClass(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), SCH_ITEM::GetOrInitConnection(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_LABEL_BASE::Print(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCH_EDIT_FRAME::RecalculateConnections(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_LABEL_BASE::ResolveTextVar(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDITOR_CONTROL::SimProbe(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), 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 508 of file sch_item.h.

◆ 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 385 of file sch_item.h.

◆ CopyUnitDisplayNames()

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

Copy all unit display names into the given map aTarget.

Definition at line 269 of file lib_symbol.cpp.

References m_unitDisplayNames.

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

◆ 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 246 of file embedded_files.cpp.

References MMH3_HASH::add(), EMBEDDED_FILES::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, EMBEDDED_FILES::OK, EMBEDDED_FILES::OUT_OF_MEMORY, EMBEDDED_FILES::Seed(), and HASH_128::ToString().

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

◆ deleteAllFields()

void LIB_SYMBOL::deleteAllFields ( )

private

Definition at line 1001 of file lib_symbol.cpp.

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

Referenced by SetFields().

◆ Deserialize()

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

inlinevirtualinherited

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 SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, BOARD_STACKUP, FOOTPRINT, PAD, PADSTACK, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_ARC, and PCB_VIA.

Definition at line 53 of file serializable.h.

◆ DoHypertextAction()

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

inlinevirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 276 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_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 720 of file sch_item.h.

Referenced by SCH_ITEM::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 94 of file lib_symbol.h.

References m_drawings, m_library, and EDA_ITEM::m_Uuid.

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

◆ Duplicate() [2/2]

SCH_ITEM * SCH_ITEM::Duplicate ( 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

doClone (default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 131 of file sch_item.cpp.

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), SCH_LINE::BreakAt(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_IO_EAGLE::loadSchematic(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SetHasAlternateBodyStyle(), SetUnitCount(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ EmbeddedFileMap()

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

inlineinherited

Definition at line 198 of file embedded_files.h.

References EMBEDDED_FILES::m_files.

Referenced by FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), EMBED_TOOL::GetFileList(), PANEL_EMBEDDED_FILES::onExportFiles(), PANEL_EMBEDDED_FILES::PANEL_EMBEDDED_FILES(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), PANEL_EMBEDDED_FILES::TransferDataFromWindow(), PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow(), and PANEL_EMBEDDED_FILES::TransferDataToWindow().

◆ EmbedFonts()

void LIB_SYMBOL::EmbedFonts ( )

overridevirtual

Reimplemented from EMBEDDED_FILES.

Definition at line 1889 of file lib_symbol.cpp.

References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::EMBEDDED_FILE::FONT, fonts, GetEmbeddedFiles(), m_drawings, SCH_TEXT_T, text, 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 392 of file sch_item.h.

◆ FindField() [1/2]

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

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

Parameters

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

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

Definition at line 1078 of file lib_symbol.cpp.

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

Referenced by Compare(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_IO_LIB_CACHE::removeSymbol(), and FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable().

◆ FindField() [2/2]

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

Definition at line 1098 of file lib_symbol.cpp.

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

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

References EDA_SHAPE::GetFillMode(), m_drawings, 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 304 of file lib_symbol.cpp.

References GetFieldById(), SCH_FIELD::GetName(), EDA_TEXT::GetText(), IsAlias(), SCH_FIELD::IsMandatory(), m_drawings, m_fpFilters, m_keyWords, m_libId, m_name, m_parent, MANDATORY_FIELDS, SCH_FIELD_T, SCH_ITEM::SetExcludedFromSim(), and EDA_ITEM::SetParent().

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

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 119 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 99 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 107 of file inspectable.h.

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

◆ GetAllLibPins()

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

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

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

Definition at line 842 of file lib_symbol.cpp.

References GetPins().

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

◆ GetAreFontsEmbedded()

bool EMBEDDED_FILES::GetAreFontsEmbedded ( ) const

inlineinherited

Definition at line 225 of file embedded_files.h.

References EMBEDDED_FILES::m_embedFonts.

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR::Format(), FP_CACHE::Save(), PCB_IO_KICAD_SEXPR::SaveBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and PANEL_EMBEDDED_FILES::TransferDataToWindow().

◆ GetBodyBoundingBox()

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	= 0, 1 or 2 If aUnit == 0, unit is not used if aBodyStyle == 0 Convert is non used Fields are not taken in account

Definition at line 957 of file lib_symbol.cpp.

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

◆ GetBodyStyle()

int SCH_ITEM::GetBodyStyle ( ) const

inlineinherited

Definition at line 232 of file sch_item.h.

References SCH_ITEM::m_bodyStyle.

◆ GetBodyStyleDescription()

wxString SCH_ITEM::GetBodyStyleDescription ( int aBodyStyle )

staticinherited

Definition at line 61 of file sch_item.cpp.

References _.

Referenced by CheckDuplicatePins(), CheckLibSymbol(), SCH_PIN::GetMsgPanelInfo(), and SCH_ITEM::getSymbolEditorMsgPanelInfo().

◆ 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 243 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 341 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 71 of file lib_symbol.cpp.

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

Referenced by GetSearchTerms().

◆ GetClass()

virtual wxString LIB_SYMBOL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 126 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 464 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(), and SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires().

◆ GetDatasheetField()

SCH_FIELD & LIB_SYMBOL::GetDatasheetField ( ) const

Return reference to the datasheet field.

Definition at line 1145 of file lib_symbol.cpp.

References DATASHEET_FIELD, and GetFieldById().

Referenced by FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), LIB_SYMBOL(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 458 of file sch_item.cpp.

References EESCHEMA_SETTINGS::APPEARANCE::default_font, SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), and SCH_FIELD::GetRenderCache().

◆ GetDesc()

wxString LIB_SYMBOL::GetDesc ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 140 of file lib_symbol.h.

References GetDescription().

◆ GetDescription()

wxString LIB_SYMBOL::GetDescription ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 158 of file lib_symbol.h.

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

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

◆ GetDescriptionField()

SCH_FIELD & LIB_SYMBOL::GetDescriptionField ( ) const

Return reference to the description field.

Definition at line 1153 of file lib_symbol.cpp.

References DESCRIPTION_FIELD, and GetFieldById().

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

◆ GetDNP()

bool SYMBOL::GetDNP ( ) const

inlineinherited

Set or clear the 'Do Not Populate' flaga.

Definition at line 153 of file symbol.h.

References SYMBOL::m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), KIGFX::SCH_PAINTER::draw(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), SCH_SYMBOL::PrintBackground(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::ToggleAttribute(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

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

References m_drawings.

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CheckLibSymbolGraphics(), EE_SELECTION_TOOL::CollectHits(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), KIGFX::SCH_VIEW::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SYMBOL_EDIT_FRAME::HardRedraw(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_COMMIT::makeImage(), SYMBOL_DIFF_WIDGET::onSlider(), OrientAndMirrorSymbolItems(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SYMBOL::Plot(), SCH_SYMBOL::Print(), EE_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 500 of file lib_symbol.h.

References m_drawings.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 133 of file eda_item.h.

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

◆ 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

◆ 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 191 of file embedded_files.h.

References EMBEDDED_FILES::m_files.

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

◆ GetEmbeddedFileLink()

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

inlineinherited

Returns 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 135 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 1883 of file lib_symbol.cpp.

◆ GetEmbeddedFiles() [2/2]

EMBEDDED_FILES * LIB_SYMBOL::GetEmbeddedFiles ( )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1877 of file lib_symbol.cpp.

Referenced by EmbedFonts(), FIELDS_GRID_TABLE::initGrid(), SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and SCH_PROPERTIES_PANEL::updateFontList().

◆ 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_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 415 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ GetExcludedFromBoard()

bool SYMBOL::GetExcludedFromBoard ( ) const

inlineinherited

◆ GetExcludedFromBOM()

bool SYMBOL::GetExcludedFromBOM ( ) const

inlineinherited

Definition at line 142 of file symbol.h.

References SYMBOL::m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetExcludedFromSim()

bool SYMBOL::GetExcludedFromSim ( ) const

inlineoverridevirtualinherited

Reimplemented from SCH_ITEM.

Definition at line 136 of file symbol.h.

References SYMBOL::m_excludedFromSim.

Referenced by KIGFX::SCH_PAINTER::draw(), FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), SCH_SYMBOL::GetMsgPanelInfo(), SYMBOL_SEARCH_HANDLER::getResultCell(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), ResolveTextVar(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), ERC_TESTER::TestSimModelIssues(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetFieldById()

SCH_FIELD * LIB_SYMBOL::GetFieldById ( int aId ) const

Return pointer to the requested field.

Parameters

aId	- Id of field to return.

Returns: The field if found, otherwise NULL.

Definition at line 1064 of file lib_symbol.cpp.

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

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

◆ GetFieldCount()

size_t LIB_SYMBOL::GetFieldCount ( ) const

inline

Definition at line 394 of file lib_symbol.h.

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

◆ GetFields() [1/2]

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

Return a list of fields within this symbol.

Parameters

aList - List to add fields to

Definition at line 1030 of file lib_symbol.cpp.

References GetFieldById(), SCH_FIELD::IsMandatory(), m_drawings, MANDATORY_FIELDS, and SCH_FIELD_T.

Referenced by SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_IO_EAGLE::loadInstance(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList().

◆ GetFields() [2/2]

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

Definition at line 1047 of file lib_symbol.cpp.

References GetFieldById(), SCH_FIELD::IsMandatory(), m_drawings, MANDATORY_FIELDS, and SCH_FIELD_T.

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 548 of file sch_item.h.

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveSymbol(), and SCH_IO_KICAD_SEXPR::saveText().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), SCH_TABLE::DeleteMarkedCells(), PCB_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), 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_SHAPE, PCB_TRACK, and PCB_ARC.

Definition at line 250 of file eda_item.h.

References EDA_ITEM::GetPosition().

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

◆ 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 507 of file embedded_files.cpp.

References EMBEDDED_FILES::m_fontFiles.

Referenced by FIELDS_GRID_TABLE::initGrid(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SCH_PROPERTIES_PANEL::updateFontList(), and PCB_PROPERTIES_PANEL::updateLists().

◆ GetFontMetrics()

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

inherited

◆ GetFootprint()

wxString LIB_SYMBOL::GetFootprint ( )

inlineoverridevirtual

For items with footprint fields.

Reimplemented from LIB_TREE_ITEM.

Definition at line 184 of file lib_symbol.h.

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

◆ GetFootprintField()

SCH_FIELD & LIB_SYMBOL::GetFootprintField ( ) const

Return reference to the footprint field.

Definition at line 1137 of file lib_symbol.cpp.

References FOOTPRINT_FIELD, and GetFieldById().

Referenced by GetFootprint(), GetSearchTerms(), LIB_SYMBOL(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), and SCH_EASYEDAPRO_PARSER::ParseSchematic().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 161 of file view_item.h.

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

◆ GetFPFilters()

wxArrayString LIB_SYMBOL::GetFPFilters ( ) const

inline

Definition at line 206 of file lib_symbol.h.

References IsAlias(), m_fpFilters, and m_parent.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), netList(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

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

Definition at line 332 of file eda_item.cpp.

References EDA_ITEM::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(), SCH_ITEM::getSymbolEditorMsgPanelInfo(), PROPERTIES_PANEL::rebuildProperties(), and DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow().

◆ GetInheritanceDepth()

unsigned LIB_SYMBOL::GetInheritanceDepth ( ) const

Get the number of parents for this symbol.

Returns: the inhertance depth for this symbol.

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

Definition at line 111 of file eda_item.cpp.

References EDA_ITEM::GetClass().

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

◆ GetKeyWords()

wxString LIB_SYMBOL::GetKeyWords ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 171 of file lib_symbol.h.

References IsAlias(), m_keyWords, and m_parent.

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

◆ GetLastModDate()

timestamp_t LIB_SYMBOL::GetLastModDate ( ) const

inline

Definition at line 202 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 281 of file sch_item.h.

References SCH_ITEM::m_layer.

Referenced by JUNCTION_HELPERS::AnalyzePoint(), SCH_ITEM::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), 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_TEXT::operator==(), SCH_LINE::operator==(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), 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_TEXT::Similarity(), SCH_LINE::Similarity(), SCH_EDIT_FRAME::TrimWire(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLib()

SYMBOL_LIB * LIB_SYMBOL::GetLib ( ) const

inline

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

References m_libId.

◆ GetLibId()

const LIB_ID & LIB_SYMBOL::GetLibId ( ) const

inlineoverridevirtual

Implements SYMBOL.

Definition at line 143 of file lib_symbol.h.

References m_libId.

◆ GetLibNickname()

wxString LIB_SYMBOL::GetLibNickname ( ) const

inlineoverridevirtual

Sets the Description field text value.

Implements LIB_TREE_ITEM.

Definition at line 149 of file lib_symbol.h.

References GetLibraryName().

Referenced by SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary().

◆ GetLibraryName()

const wxString LIB_SYMBOL::GetLibraryName ( ) const

Definition at line 380 of file lib_symbol.cpp.

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

Referenced by GetLibNickname().

◆ GetMaxPinNumber()

int LIB_SYMBOL::GetMaxPinNumber ( ) const

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

Definition at line 1259 of file lib_symbol.cpp.

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

Definition at line 291 of file eda_item.cpp.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

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

inlinevirtualinherited

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

Parameters

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

Reimplemented in SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, 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, SCH_TEXTBOX, GERBER_DRAW_ITEM, DS_DRAW_ITEM_BASE, BOARD, FOOTPRINT, PCB_TUNING_PATTERN, NETINFO_ITEM, PAD, PCB_DIMENSION_BASE, PCB_DIM_ALIGNED, PCB_DIM_LEADER, PCB_GROUP, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TABLECELL, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 203 of file eda_item.h.

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

◆ GetName()

wxString LIB_SYMBOL::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 137 of file lib_symbol.h.

References m_name.

◆ GetNextAvailableFieldId()

int LIB_SYMBOL::GetNextAvailableFieldId ( ) const

Definition at line 1220 of file lib_symbol.cpp.

References GetFieldById(), and MANDATORY_FIELDS.

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

◆ GetOrInitConnection()

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

inherited

Definition at line 326 of file sch_item.cpp.

References SCH_ITEM::Connection(), SCH_ITEM::InitializeConnection(), and SCH_ITEM::IsConnectable().

Referenced by CONNECTION_SUBGRAPH::ExchangeItem().

◆ GetParent() [1/2]

LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( )

inline

Definition at line 106 of file lib_symbol.h.

References m_parent.

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

◆ GetParent() [2/2]

const LIB_SYMBOL_REF & LIB_SYMBOL::GetParent ( ) const

inline

Definition at line 107 of file lib_symbol.h.

References m_parent.

◆ GetParentSymbol() [1/2]

SYMBOL * SCH_ITEM::GetParentSymbol ( )

inherited

Definition at line 184 of file sch_item.cpp.

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

◆ GetParentSymbol() [2/2]

const SYMBOL * SCH_ITEM::GetParentSymbol ( ) const

inherited

Definition at line 166 of file sch_item.cpp.

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

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(), SCH_EDIT_TOOL::EditField(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckNoConnects(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), SCH_PIN::GetDefaultNetName(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_FIELD::GetFullText(), SCH_PIN::GetItemDescription(), SCH_PIN::GetMsgPanelInfo(), PIN_LAYOUT_CACHE::GetPinBoundingBox(), PIN_LAYOUT_CACHE::GetPinNameInfo(), PIN_LAYOUT_CACHE::GetPinNumberInfo(), SCH_PIN::GetPinRoot(), SCH_PIN::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_ITEM::getSymbolEditorMsgPanelInfo(), PIN_LAYOUT_CACHE::getUntransformedAltIconBox(), PIN_LAYOUT_CACHE::getUntransformedPinNameBox(), PIN_LAYOUT_CACHE::getUntransformedPinNumberBox(), DIALOG_FIELD_PROPERTIES::init(), SCH_PIN::IsGlobalPower(), SCH_PIN::MirrorHorizontally(), SCH_PIN::MirrorVertically(), NETLIST_EXPORTER_ALLEGRO::NET_NODE::operator<(), SCH_FIELD::operator==(), orientLabel(), SCH_PIN::Plot(), SCH_PIN::Print(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_PIN::Rotate(), SCH_ITEM_DESC::SCH_ITEM_DESC(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), DIALOG_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ 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_ENTRY_BASE, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_DIRECTIVE_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 292 of file sch_item.h.

Referenced by EE_RTREE::contains(), SCH_ITEM::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	- DeMorgan variant filter. Set to 0 if no specific DeMorgan variant is required.

Returns: The pin object if found. Otherwise NULL.

Definition at line 854 of file lib_symbol.cpp.

References GetPins(), and pin.

Referenced by Compare().

◆ GetPinCount()

int LIB_SYMBOL::GetPinCount ( )

overridevirtual

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

Reimplemented from LIB_TREE_ITEM.

Definition at line 848 of file lib_symbol.cpp.

References GetPins().

◆ GetPinNameOffset()

int SYMBOL::GetPinNameOffset ( ) const

inlineinherited

Definition at line 118 of file symbol.h.

References SYMBOL::m_pinNameOffset.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PIN_LAYOUT_CACHE::GetPinNameInfo(), PIN_LAYOUT_CACHE::GetPinNumberInfo(), PIN_LAYOUT_CACHE::getUntransformedAltIconBox(), SCH_PIN::Plot(), SCH_PIN::Print(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetPins()

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

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

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

Parameters

aUnit	- Unit number of pins to collect. Set to 0 to get pins from any symbol unit.
aBodyStyle	- Symbol alternate body style of pins to collect. Set to 0 to get pins from any DeMorgan variant of symbol.

Definition at line 810 of file lib_symbol.cpp.

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

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

◆ GetPosition()

virtual VECTOR2I EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

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

Definition at line 243 of file eda_item.h.

Referenced by SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), TEARDROP_MANAGER::areItemsInSameZone(), SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::compare(), TEST_BOARD_ITEM_FIXTURE::CompareItems(), TEST_EE_ITEM_FIXTURE::CompareItems(), PCB_GRID_HELPER::computeAnchors(), EE_GRID_HELPER::computeAnchors(), CONVERT_TOOL::CreatePolys(), SCH_EDIT_FRAME::DeleteJunction(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), 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(), EDA_ITEM::GetFocusPosition(), BOARD_ITEM::GetFPRelativePosition(), RC_ITEM::GetJsonViolation(), getMinDist(), SCH_FIELD::GetParentPosition(), EDA_ITEM::GetSortPosition(), PCB_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), DIALOG_MIGRATE_BUSES::onItemSelected(), BOARD::cmp_items::operator()(), PAD::PAD(), SCH_EDITOR_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PCB_CONTROL::placeBoardItems(), POSITION_RELATIVE_TOOL::PositionRelative(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), RC_ITEM::ShowReport(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), DRC_TEST_PROVIDER_MISC::testTextVars(), ERC_TESTER::TestTextVars(), TransformItem(), EDIT_TOOL::updateModificationPoint(), PL_EDIT_TOOL::updateModificationPoint(), DIALOG_CREATE_ARRAY::UpdatePickedItem(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ GetPrefix()

wxString LIB_SYMBOL::GetPrefix ( )

Definition at line 1161 of file lib_symbol.cpp.

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

◆ GetRef()

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

inlineoverridevirtual

Implements SYMBOL.

Definition at line 326 of file lib_symbol.h.

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

◆ GetReferenceField()

SCH_FIELD & LIB_SYMBOL::GetReferenceField ( ) const

Return reference to the reference designator field.

Definition at line 1129 of file lib_symbol.cpp.

References GetFieldById(), and REFERENCE_FIELD.

Referenced by CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), GetRef(), LIB_SYMBOL(), 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().

◆ getRenderSettings()

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

inlineprotectedinherited

Definition at line 670 of file sch_item.h.

References PLOTTER::RenderSettings().

Referenced by 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(), 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 236 of file lib_symbol.cpp.

References m_me, and m_parent.

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

◆ GetRuleAreaCache()

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

inlineinherited

Gets the cache of rule areas enclosing this item.

Definition at line 638 of file sch_item.h.

References SCH_ITEM::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 GetChooserFields(), GetDescription(), GetFootprintField(), GetKeyWords(), GetName(), EDA_TEXT::GetText(), name, and text.

◆ GetShowPinNames()

virtual bool SYMBOL::GetShowPinNames ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 124 of file symbol.h.

References SYMBOL::m_showPinNames.

Referenced by PIN_LAYOUT_CACHE::GetPinNameInfo(), PIN_LAYOUT_CACHE::GetPinNumberInfo(), PIN_LAYOUT_CACHE::getUntransformedPinNumberBox(), SCH_PIN::Plot(), SCH_PIN::Print(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetShowPinNumbers()

virtual bool SYMBOL::GetShowPinNumbers ( ) const

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 130 of file symbol.h.

References SYMBOL::m_showPinNumbers.

Referenced by PIN_LAYOUT_CACHE::GetPinNumberInfo(), SCH_PIN::Plot(), SCH_PIN::Print(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

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

References EDA_ITEM::GetPosition().

◆ GetSourceLibId()

LIB_ID LIB_SYMBOL::GetSourceLibId ( ) const

inline

Definition at line 146 of file lib_symbol.h.

References m_sourceLibId.

Referenced by SYMBOL_EDIT_FRAME::LoadSymbol().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 248 of file sch_item.h.

References SCH_ITEM::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 581 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 141 of file lib_symbol.h.

References GetUnitCount().

◆ getSymbolEditorMsgPanelInfo()

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

protectedinherited

Definition at line 501 of file sch_item.cpp.

References _, SCH_ITEM::GetBodyStyleDescription(), EDA_ITEM::GetFriendlyName(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetUnitDescription(), SCH_ITEM::IsPrivate(), SCH_ITEM::m_bodyStyle, and SCH_ITEM::m_unit.

Referenced by SCH_PIN::GetMsgPanelInfo(), and SCH_SHAPE::GetMsgPanelInfo().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 146 of file eda_item.h.

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

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

◆ GetTemporaryFileName() [1/2]

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

inherited

Definition at line 462 of file embedded_files.cpp.

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

Referenced by GetAssociatedDocument(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), FILENAME_RESOLVER::ResolvePath(), and EMBEDDED_FILES::UpdateFontFiles().

◆ GetTemporaryFileName() [2/2]

wxFileName EMBEDDED_FILES::GetTemporaryFileName ( EMBEDDED_FILE * aFile ) const

inherited

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

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

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

◆ GetUnit()

int SCH_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 229 of file sch_item.h.

References SCH_ITEM::m_unit.

◆ GetUnitBoundingBox()

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

Get the bounding box for the symbol.

Returns: the symbol bounding box ( in user coordinates )

Parameters

aUnit	= unit selection = 0, or 1..n
aBodyStyle	= 0, 1 or 2 If aUnit == 0, unit is not used if aBodyStyle == 0 Convert is non used
aIgnoreHiddenFields	default true, ignores any hidden fields

Definition at line 931 of file lib_symbol.cpp.

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

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

◆ GetUnitCount()

int LIB_SYMBOL::GetUnitCount ( ) const

overridevirtual

Returns: the number of units defined for the symbol.

Implements SYMBOL.

Definition at line 1401 of file lib_symbol.cpp.

References m_parent, and m_unitCount.

Referenced by SCH_SHEET_PATH::AppendMultiUnitSymbol(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), SCH_REFERENCE_LIST::CheckAnnotation(), CheckLibSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), NETLIST_EXPORTER_BASE::findNextSymbol(), GetSubUnitCount(), SCH_REFERENCE::IsMultiUnit(), SCH_IO_EAGLE::loadInstance(), SYMBOL_VIEWER_FRAME::onUpdateUnitChoice(), SYMBOL_EDIT_FRAME::OnUpdateUnitNumber(), SYMBOL_EDIT_FRAME::RebuildSymbolUnitsList(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_EDIT_FRAME::SelectUnit(), SetUnitDisplayName(), PIN_TABLE_DATA_MODEL::SetValue(), ERC_TESTER::TestMissingUnits(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ GetUnitDescription()

wxString SCH_ITEM::GetUnitDescription ( int aUnit )

staticinherited

Definition at line 52 of file sch_item.cpp.

References _, and LetterSubReference().

Referenced by SCH_PIN::GetMsgPanelInfo(), and SCH_ITEM::getSymbolEditorMsgPanelInfo().

◆ GetUnitDisplayName()

wxString LIB_SYMBOL::GetUnitDisplayName ( int aUnit )

overridevirtual

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

Reimplemented from LIB_TREE_ITEM.

Definition at line 260 of file lib_symbol.cpp.

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

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

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

References LIB_SYMBOL_UNIT::m_bodyStyle, m_drawings, LIB_SYMBOL_UNIT::m_items, LIB_SYMBOL_UNIT::m_unit, and SCH_FIELD_T.

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 styple of the item, -1 includes all body styles.

Returns: a list of unit items.

Definition at line 1455 of file lib_symbol.cpp.

References m_drawings, and SCH_FIELD_T.

◆ GetUnitReference()

wxString LIB_SYMBOL::GetUnitReference ( int aUnit )

overridevirtual

Return an identifier for aUnit for symbols with units.

Reimplemented from LIB_TREE_ITEM.

Definition at line 248 of file lib_symbol.cpp.

References LetterSubReference().

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

◆ GetValue()

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

inlineoverridevirtual

Implements SYMBOL.

Definition at line 331 of file lib_symbol.h.

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

◆ GetValueField()

SCH_FIELD & LIB_SYMBOL::GetValueField ( ) const

Return reference to the value field.

Definition at line 1121 of file lib_symbol.cpp.

References GetFieldById(), and VALUE_FIELD.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_SAVE_AS_HANDLER::DoSave(), GetValue(), LIB_SYMBOL(), 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(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ HasAlternateBodyStyle()

bool LIB_SYMBOL::HasAlternateBodyStyle ( ) const

overridevirtual

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

Returns: True if symbol has more than one conversion.

Implements SYMBOL.

Definition at line 1238 of file lib_symbol.cpp.

References m_drawings, and m_parent.

Referenced by CheckDuplicatePins(), CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), SYMBOL_DIFF_WIDGET::DisplayDiff(), SYMBOL_PREVIEW_WIDGET::DisplayPart(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SetHasAlternateBodyStyle(), SYMBOL_VIEWER_FRAME::setupUIConditions(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const

inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 538 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 529 of file sch_item.h.

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

◆ HasFile()

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

inlineinherited

Definition at line 140 of file embedded_files.h.

References EMBEDDED_FILES::m_files, and name.

Referenced by EMBEDDED_FILES::AddFile(), PANEL_EMBEDDED_FILES::onAddEmbeddedFile(), and PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), 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(), SCH_EDIT_TOOL::Rotate(), PCB_TUNING_PATTERN::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), EE_SELECTION_TOOL::selectMultiple(), SCH_COMMIT::Stage(), and PCB_TUNING_PATTERN::ViewDraw().

◆ 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 579 of file sch_item.h.

Referenced by SCH_EDIT_TOOL::Init(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HasUnitDisplayName()

bool LIB_SYMBOL::HasUnitDisplayName ( int aUnit )

overridevirtual

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

Reimplemented from LIB_TREE_ITEM.

Definition at line 254 of file lib_symbol.cpp.

References m_unitDisplayNames.

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

◆ HitTest() [1/2]

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

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

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

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

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

Definition at line 229 of file eda_item.h.

◆ HitTest() [2/2]

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

inlinevirtualinherited

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

Parameters

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

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

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

Definition at line 216 of file eda_item.h.

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

◆ 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 302 of file sch_item.cpp.

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

Referenced by SCH_ITEM::GetOrInitConnection().

◆ IsAlias()

bool LIB_SYMBOL::IsAlias ( ) const

inline

Definition at line 195 of file lib_symbol.h.

References m_parent.

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

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 100 of file view_item.h.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_COMMIT::MakeImage(), BOARD::Move(), DRAWING_TOOL::PlaceImportedGraphics(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), EDIT_TOOL::removeNonRootItems(), BOARD_COMMIT::Revert(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ 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_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 449 of file sch_item.h.

Referenced by SCH_JUNCTION::CanConnect(), SCH_ITEM::Connection(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_EDIT_TOOL::DoDelete(), SCH_SCREEN::GetNeededJunctions(), SCH_ITEM::GetOrInitConnection(), EE_SELECTION::GetTopLeftItem(), SCH_LABEL_BASE::HasConnectivityChanges(), SCH_EDIT_TOOL::Init(), SCH_EDIT_TOOL::Mirror(), EE_GRID_HELPER::nearestAnchor(), SCH_EDITOR_CONTROL::Paste(), SCH_COMMIT::pushSchEdit(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::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 212 of file sch_item.cpp.

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

Referenced by JUNCTION_HELPERS::AnalyzePoint(), 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_LABEL_BASE, SCH_DIRECTIVE_LABEL, SCH_LINE, and SCH_PIN.

Definition at line 442 of file sch_item.h.

◆ IsEmpty()

bool EMBEDDED_FILES::IsEmpty ( ) const

inlineinherited

Definition at line 147 of file embedded_files.h.

References EMBEDDED_FILES::m_files.

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR::Format(), and GetDescription().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 111 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 195 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ 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 274 of file sch_item.h.

Referenced by SCH_ITEM::RenderAsBitmap().

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Definition at line 268 of file sch_item.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( ) const

inlinevirtualinherited

Returns: true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols)

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

Definition at line 246 of file sch_item.h.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMulti()

bool LIB_SYMBOL::IsMulti ( ) 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 554 of file lib_symbol.h.

References m_unitCount.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsNormal()

bool LIB_SYMBOL::IsNormal ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 419 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_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_PIN, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 455 of file sch_item.h.

Referenced by EE_SELECTION_TOOL::autostartEvent().

◆ IsPower()

bool LIB_SYMBOL::IsPower ( ) const

overridevirtual

Implements SYMBOL.

Definition at line 389 of file lib_symbol.cpp.

References ENTRY_POWER, m_options, and m_parent.

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), CheckLibSymbol(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), SCH_IO_DATABASE::EnumerateSymbolLib(), SCH_IO_HTTP_LIB::EnumerateSymbolLib(), FIELDS_GRID_TABLE::GetAttr(), SCH_IO_EAGLE::loadInstance(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), and SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo().

◆ IsPrivate()

bool SCH_ITEM::IsPrivate ( ) const

inlineinherited

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

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 114 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsRoot()

bool LIB_SYMBOL::IsRoot ( ) const

inlineoverridevirtual

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

Reimplemented from LIB_TREE_ITEM.

Definition at line 194 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(), SYMBOL_EDIT_FRAME::IsSymbolAlias(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), SCH_SYMBOL::SetLibSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::Validate().

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 99 of file view_item.h.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::SCH_PAINTER::drawItemBoundingBox(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), SCH_EDIT_FRAME::FlipBodyStyle(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SCH_IO_KICAD_SEXPR::saveTable(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_TEST_SELECTION_TOOL::select(), EE_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectColumns(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::SelectRows(), SCH_COMMIT::Stage(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), SCH_SYMBOL::UpdatePins(), PCB_TUNING_PATTERN::ViewDraw(), PCB_FIELD::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::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 181 of file sch_item.h.

References EDA_ITEM::IsType(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, SCH_ITEM::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(), LABEL_SEARCH_HANDLER::Search(), SCH_MARKER::SerializeToString(), 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 296 of file eda_item.h.

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 316 of file eda_item.h.

References EDA_ITEM::Visit().

◆ LetterSubReference()

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

static

Definition at line 447 of file lib_symbol.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), SCH_FIELD::GetFullText(), SCH_ITEM::GetUnitDescription(), GetUnitReference(), PIN_TABLE_DATA_MODEL::GetValue(), PIN_TABLE_DATA_MODEL::SetValue(), SCH_SYMBOL::SubReference(), and SCHEMATIC_SETTINGS::SubReference().

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

References m_drawings, 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 1316 of file lib_symbol.cpp.

References DefaultTransform, and LocateDrawItem().

◆ LockUnits()

void LIB_SYMBOL::LockUnits ( bool aLockUnits )

inline

Set interchangeable the property for symbol units.

Parameters

aLockUnits when true then units are set as not interchangeable.

Definition at line 258 of file lib_symbol.h.

References m_unitsLocked.

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 377 of file eda_item.h.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 126 of file eda_item.cpp.

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

◆ MirrorHorizontally()

virtual void SCH_ITEM::MirrorHorizontally ( int aCenter )

inlinevirtualinherited

Mirror item horizontally about aCenter.

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

Definition at line 343 of file sch_item.h.

References SCH_ITEM::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 SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_DIRECTIVE_LABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 351 of file sch_item.h.

References SCH_ITEM::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 1231 of file lib_symbol.cpp.

References m_drawings.

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

References EDA_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 404 of file sch_item.cpp.

References SCH_ITEM::compare(), 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 SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_LABEL_BASE, SCH_TEXT, SCH_BITMAP, SCH_JUNCTION, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TABLECELL, and SCH_TEXTBOX.

Definition at line 395 of file sch_item.cpp.

References SCH_ITEM::compare(), SCH_ITEM::EQUALITY, 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 866 of file lib_symbol.cpp.

References GetAllLibPins().

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 648 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, and PLOTTER::SetColor().

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

◆ 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 690 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, PLOTTER::SetColor(), and SCH_FIELD::SetText().

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

◆ Print()

void LIB_SYMBOL::Print	(	const SCH_RENDER_SETTINGS *	aSettings,
		int	aUnit,
		int	aBodyStyle,
		const VECTOR2I &	aOffset,
		bool	aForceNoFill,
		bool	aDimmed
	)

overridevirtual

Print an item.

Parameters

aUnit	- Which unit to print.
aBodyStyle	- Which body style to print.
aOffset	- Relative offset.
aForceNoFill	- Disable printing of fills.
aDimmed	- Reduce brightness of item.

Reimplemented from SCH_ITEM.

Definition at line 567 of file lib_symbol.cpp.

References EDA_SHAPE::GetFillMode(), EDA_TEXT::IsVisible(), m_drawings, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowVisibleFields, SCH_FIELD::Print(), SCH_SHAPE::Print(), SCH_FIELD_T, SCH_PIN_T, and SCH_SHAPE_T.

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

◆ PrintBackground()

void LIB_SYMBOL::PrintBackground	(	const SCH_RENDER_SETTINGS *	aSettings,
		int	aUnit,
		int	aBodyStyle,
		const VECTOR2I &	aOffset,
		bool	aDimmed
	)

overridevirtual

Print just the background fills.

Reimplemented from SCH_ITEM.

Definition at line 614 of file lib_symbol.cpp.

References EDA_SHAPE::GetFillMode(), GetGRForceBlackPenState(), SCH_ITEM::m_bodyStyle, m_drawings, SCH_ITEM::m_unit, SCH_SHAPE::Print(), and SCH_SHAPE_T.

Referenced by SYMBOL_EDIT_FRAME::PrintPage().

◆ RemoveDrawItem()

void LIB_SYMBOL::RemoveDrawItem ( SCH_ITEM * aItem )

Remove draw aItem from list.

Parameters

aItem - Draw item to remove from list.

Definition at line 771 of file lib_symbol.cpp.

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

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

◆ RemoveField()

void LIB_SYMBOL::RemoveField ( SCH_FIELD * aField )

inline

Definition at line 392 of file lib_symbol.h.

References RemoveDrawItem().

◆ RemoveFile()

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

inherited

Removes a file from the collection and frees the memory.

Parameters

aName is the name of the file to remove.

Definition at line 117 of file embedded_files.cpp.

References EMBEDDED_FILES::m_files, and name.

Referenced by PANEL_EMBEDDED_FILES::onDeleteEmbeddedFile(), EMBED_TOOL::RemoveFile(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 489 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, SCH_ITEM::IsHypertext(), and text.

Referenced by 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_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

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

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

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

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

References _, FOOTPRINT_FIELD, SCH_FIELD::GetCanonicalName(), GetDescription(), SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromSim(), SCH_FIELD::GetId(), GetKeyWords(), SCH_FIELD::GetName(), SCH_FIELD::GetShownText(), LIB_ID::GetUniStringLibItemName(), LIB_ID::GetUniStringLibNickname(), m_drawings, m_libId, and SCH_FIELD_T.

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 SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, DELETED_SHEET_ITEM, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and SCH_PIN.

Definition at line 359 of file sch_item.h.

References SCH_ITEM::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 )

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 1187 of file lib_symbol.cpp.

References m_drawings.

Referenced by SCH_COMMIT::pushLibEdit().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches 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 150 of file sch_item.cpp.

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

Referenced by EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_FIELD::DoHypertextAction(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SCH_SHEET::GetContextualTextVars(), SCH_ITEM::GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_SHAPE::GetEffectiveWidth(), SCH_ITEM::GetFontMetrics(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), 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_LABEL_BASE::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_SYMBOL::GetUnitProp(), GetUnplacedUnitsForSymbol(), SCH_SYMBOL::GetValueProp(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_FIELD::OnScintillaCharAdded(), PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_SYMBOL::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_FIELD::Print(), SCH_COMMIT::pushSchEdit(), SCH_LABEL_BASE::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::Revert(), SCH_EDIT_FRAME::SelectUnit(), SCH_MARKER::SerializeToString(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SCH_SYMBOL::SetUnitProp(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_EDITOR_CONTROL::SimTune(), SCH_SYMBOL::SubReference(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_MARKER::ViewGetLayers(), and SCH_ITEM::~SCH_ITEM().

◆ Seed()

static uint32_t EMBEDDED_FILES::Seed ( )

inlinestaticinherited

Definition at line 230 of file embedded_files.h.

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

◆ Serialize()

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

inlinevirtualinherited

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 SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, BOARD_STACKUP, FOOTPRINT, PAD, PADSTACK, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_ARC, and PCB_VIA.

Definition at line 43 of file serializable.h.

Referenced by API_HANDLER_SCH::handleCreateUpdateItemsInternal(), and API_HANDLER_PCB::handleCreateUpdateItemsInternal().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 59 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 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 SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAreFontsEmbedded()

void EMBEDDED_FILES::SetAreFontsEmbedded ( bool aEmbedFonts )

inlineinherited

Definition at line 220 of file embedded_files.h.

References EMBEDDED_FILES::m_embedFonts.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ SetBodyStyle()

virtual void SCH_ITEM::SetBodyStyle ( int aBodyStyle )

inlinevirtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 231 of file sch_item.h.

References SCH_ITEM::m_bodyStyle.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadCircle(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_ITEM_DESC::SCH_ITEM_DESC(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 120 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), EE_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

Updates the connection graph for all connections in this item.

Definition at line 238 of file sch_item.cpp.

References SCH_ITEM::m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 512 of file sch_item.h.

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_LINE::BreakAt(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LINE::MergeOverlap(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_COMMIT::Revert(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetDescription()

void LIB_SYMBOL::SetDescription ( const wxString & aDescription )

inline

Gets the Description field text value *‍/.

Definition at line 152 of file lib_symbol.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_IO_ALTIUM::ParsePowerPort(), and SCH_EASYEDAPRO_PARSER::ParseSymbol().

◆ SetDNP()

void SYMBOL::SetDNP ( bool aDNP )

inlineinherited

Definition at line 154 of file symbol.h.

References SYMBOL::m_DNP.

Referenced by BACK_ANNOTATE::applyChangelist(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromBoard()

void SYMBOL::SetExcludedFromBoard ( bool aExcludeFromBoard )

inlineinherited

Set or clear exclude from board netlist flag.

Definition at line 147 of file symbol.h.

References SYMBOL::m_excludedFromBoard.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromBOM()

void SYMBOL::SetExcludedFromBOM ( bool aExcludeFromBOM )

inlineinherited

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

Definition at line 141 of file symbol.h.

References SYMBOL::m_excludedFromBOM.

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ SetExcludedFromSim()

void SYMBOL::SetExcludedFromSim ( bool aExcludeFromSim )

inlineoverridevirtualinherited

Set or clear the exclude from simulation flag.

Reimplemented from SCH_ITEM.

Definition at line 135 of file symbol.h.

References SYMBOL::m_excludedFromSim.

Referenced by SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_EDIT_TOOL::SetAttribute(), FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

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

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

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

◆ SetFieldsAutoplaced()

void SCH_ITEM::SetFieldsAutoplaced ( )

inlineinherited

Definition at line 550 of file sch_item.h.

References FIELDS_AUTOPLACED_AUTO, and SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_IO_KICAD_SEXPR_PARSER::parseSchText().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 127 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 156 of file view_item.h.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 194 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ SetFPFilters()

void LIB_SYMBOL::SetFPFilters ( const wxArrayString & aFilters )

inline

Definition at line 204 of file lib_symbol.h.

References m_fpFilters.

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

◆ SetHasAlternateBodyStyle()

void LIB_SYMBOL::SetHasAlternateBodyStyle	(	bool	aHasAlternate,
		bool	aDuplicatePins = `true`
	)

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

If the symbol already has an alternate body style set and 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 1410 of file lib_symbol.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::begin(), SCH_ITEM::Duplicate(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::end(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::erase(), HasAlternateBodyStyle(), SCH_ITEM::m_bodyStyle, m_drawings, MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::push_back(), SCH_PIN_T, and MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort().

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

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 160 of file eda_item.h.

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

◆ SetKeyWords()

void LIB_SYMBOL::SetKeyWords ( const wxString & aKeyWords )

inline

Definition at line 169 of file lib_symbol.h.

References m_keyWords.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ 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 541 of file sch_item.h.

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Definition at line 282 of file sch_item.h.

References SCH_ITEM::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 200 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 144 of file lib_symbol.h.

References m_libId.

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

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Definition at line 269 of file sch_item.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 67 of file eda_item.cpp.

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

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

◆ SetName()

void LIB_SYMBOL::SetName ( const wxString & aName )

virtual

Definition at line 288 of file lib_symbol.cpp.

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

Referenced by SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), SYMBOL_SAVE_AS_HANDLER::DoSave(), SYMBOL_EDIT_FRAME::ensureUniqueName(), SYMBOL_EDIT_FRAME::ImportSymbol(), LIB_SYMBOL(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseLibComponent(), SCH_IO_ALTIUM::ParsePowerPort(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties().

◆ SetNormal()

void LIB_SYMBOL::SetNormal ( )

Definition at line 433 of file lib_symbol.cpp.

References ENTRY_NORMAL, m_options, and m_parent.

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

◆ SetParent() [1/2]

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlineprivatevirtual

Reimplemented from EDA_ITEM.

Definition at line 104 of file eda_item.h.

◆ SetParent() [2/2]

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

Definition at line 295 of file lib_symbol.cpp.

References m_parent, and SharedPtr().

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

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

References SYMBOL::m_pinNameOffset.

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

◆ SetPosition()

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

inlinevirtualinherited

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

Definition at line 244 of file eda_item.h.

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

◆ SetPower()

void LIB_SYMBOL::SetPower ( )

Definition at line 405 of file lib_symbol.cpp.

References ENTRY_POWER, m_options, and m_parent.

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

◆ SetPrivate()

void SCH_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 234 of file sch_item.h.

References SCH_ITEM::m_private.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetShowPinNames()

virtual void SYMBOL::SetShowPinNames ( bool aShow )

inlinevirtualinherited

Set or clear the pin name visibility flag.

Reimplemented in SCH_SYMBOL.

Definition at line 123 of file symbol.h.

References SYMBOL::m_showPinNames.

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

◆ SetShowPinNumbers()

virtual void SYMBOL::SetShowPinNumbers ( bool aShow )

inlinevirtualinherited

Set or clear the pin number visibility flag.

Reimplemented in SCH_SYMBOL.

Definition at line 129 of file symbol.h.

References SYMBOL::m_showPinNumbers.

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

◆ SetSourceLibId()

void LIB_SYMBOL::SetSourceLibId ( const LIB_ID & aLibId )

inline

Definition at line 147 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 249 of file sch_item.h.

References SCH_ITEM::m_storedPos.

◆ 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 583 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit )

inlinevirtualinherited

Definition at line 228 of file sch_item.h.

References SCH_ITEM::m_unit.

◆ SetUnitCount()

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

Set the units per symbol count.

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

Parameters

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

Definition at line 1353 of file lib_symbol.cpp.

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

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

◆ SetUnitDisplayName()

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

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

Definition at line 276 of file lib_symbol.cpp.

References GetUnitCount(), and m_unitDisplayNames.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName().

◆ SharedPtr()

LIB_SYMBOL_SPTR LIB_SYMBOL::SharedPtr ( ) const

inline

Definition at line 89 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(), 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 1799 of file lib_symbol.cpp.

References GetAllLibPins(), LIB_SYMBOL_T, 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, Similarity(), and EDA_ITEM::Type().

Referenced by Similarity().

◆ 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 316 of file sch_item.h.

References SCH_ITEM::m_bodyStyle, SCH_ITEM::m_private, and SCH_ITEM::m_unit.

Referenced by SCH_FIELD::Similarity(), SCH_TEXT::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::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 433 of file eda_item.h.

◆ SwapData()

void SCH_ITEM::SwapData ( SCH_ITEM * aItem )

virtualinherited

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_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_DIRECTIVE_LABEL, 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 348 of file sch_item.cpp.

References SCH_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

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

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem )

inherited

Swap the non-temp and non-edit flags.

Definition at line 354 of file sch_item.cpp.

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

Referenced by SCH_BITMAP::SwapData(), SCH_BUS_ENTRY_BASE::SwapData(), SCH_FIELD::SwapData(), SCH_JUNCTION::SwapData(), SCH_LINE::SwapData(), SCH_MARKER::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_SHAPE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), SCH_TABLE::SwapData(), and SCH_TEXT::SwapData().

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

References EDA_ITEM::m_structType.

◆ UnitsLocked()

bool LIB_SYMBOL::UnitsLocked ( ) const

inline

Check whether symbol units are interchangeable.

Returns: False when interchangeable, true otherwise.

Definition at line 264 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_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::SynchronizePins(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ 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_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_LABEL_BASE, SCH_LINE, SCH_SHEET, and SCH_SYMBOL.

Definition at line 435 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ UpdateFieldOrdinals()

int LIB_SYMBOL::UpdateFieldOrdinals ( )

Order optional field indices.

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

Definition at line 1194 of file lib_symbol.cpp.

References SCH_FIELD::GetId(), SCH_FIELD::IsMandatory(), m_drawings, MANDATORY_FIELDS, SCH_FIELD_T, and SCH_FIELD::SetId().

Referenced by SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

◆ 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 neccesary 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 513 of file embedded_files.cpp.

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

Referenced by FIELDS_GRID_TABLE::initGrid(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol(), and SCH_PROPERTIES_PANEL::updateFontList().

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

Definition at line 276 of file eda_item.cpp.

References EDA_ITEM::GetBoundingBox().

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

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, TUNING_STATUS_VIEW_ITEM, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, PCB_TUNING_PATTERN, KIGFX::ORIGIN_VIEWITEM, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::SNAP_INDICATOR, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 119 of file view_item.h.

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

◆ ViewGetLayers()

void SYMBOL::ViewGetLayers	(	int	aLayers[],
		int &	aCount
	)		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 27 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_VALUEPART, LIB_SYMBOL_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

◆ ViewGetLOD()

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

inlinevirtualinherited

Return the level of detail (LOD) of the item.

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

Parameters

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

Returns: the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

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

Definition at line 145 of file view_item.h.

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

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsHiddenOnOverlay(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

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

References m_drawings.

◆ WriteEmbeddedFiles()

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

inherited

Output formatter for the embedded files.

Parameters

aOut	is the output formatter.
aNestLevel	is the current indentation level.
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 149 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, EMBEDDED_FILES::m_files, MIME_BASE64_LENGTH, EMBEDDED_FILES::EMBEDDED_FILE::MODEL, name, EMBEDDED_FILES::EMBEDDED_FILE::name, OUTPUTFORMATTER::Print(), EMBEDDED_FILES::EMBEDDED_FILE::type, and EMBEDDED_FILES::EMBEDDED_FILE::WORKSHEET.

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_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 128 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ m_bodyStyle

int SCH_ITEM::m_bodyStyle

protectedinherited

◆ 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 732 of file sch_item.h.

Referenced by SCH_ITEM::AddConnectionTo(), SCH_ITEM::ClearConnectedItems(), SCH_ITEM::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 735 of file sch_item.h.

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

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty

protectedinherited

Definition at line 737 of file sch_item.h.

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

◆ m_DNP

bool SYMBOL::m_DNP

protectedinherited

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

Definition at line 167 of file symbol.h.

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

◆ m_drawings

LIB_ITEMS_CONTAINER LIB_SYMBOL::m_drawings

private

◆ m_embedFonts

bool EMBEDDED_FILES::m_embedFonts = false

protectedinherited

Definition at line 240 of file embedded_files.h.

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

◆ m_excludedFromBoard

bool SYMBOL::m_excludedFromBoard

protectedinherited

Definition at line 166 of file symbol.h.

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

◆ m_excludedFromBOM

bool SYMBOL::m_excludedFromBOM

protectedinherited

Definition at line 165 of file symbol.h.

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

◆ m_excludedFromSim

bool SYMBOL::m_excludedFromSim

protectedinherited

Definition at line 164 of file symbol.h.

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

◆ m_fieldsAutoplaced

FIELDS_AUTOPLACED SCH_ITEM::m_fieldsAutoplaced

protectedinherited

Definition at line 727 of file sch_item.h.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_SHEET::AutoplaceFields(), SCH_SYMBOL::AutoplaceFields(), SCH_ITEM::ClearFieldsAutoplaced(), SCH_ITEM::GetFieldsAutoplaced(), SCH_ITEM::operator=(), SCH_SHEET::Resize(), SCH_SHEET::Rotate(), SCH_LABEL_BASE::Rotate90(), SCH_ITEM::SCH_ITEM(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), SCH_ITEM::SetFieldsAutoplaced(), SCH_LABEL_BASE::SwapData(), and SCH_SHEET::SwapData().

◆ m_files

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

privateinherited

Definition at line 236 of file embedded_files.h.

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

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 499 of file eda_item.h.

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

◆ m_fontFiles

std::vector<wxString> EMBEDDED_FILES::m_fontFiles

privateinherited

Definition at line 237 of file embedded_files.h.

Referenced by EMBEDDED_FILES::GetFontFiles(), and EMBEDDED_FILES::UpdateFontFiles().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 172 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 501 of file eda_item.h.

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

◆ m_fpFilters

wxArrayString LIB_SYMBOL::m_fpFilters

private

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

Definition at line 657 of file lib_symbol.h.

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

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 170 of file view_item.h.

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 169 of file view_item.h.

◆ m_keyWords

wxString LIB_SYMBOL::m_keyWords

private

Search keywords.

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

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

◆ m_layer

SCH_LAYER_ID SCH_ITEM::m_layer

protectedinherited

Definition at line 723 of file sch_item.h.

Referenced by SCH_ITEM::CanConnect(), SCH_LINE::CanConnect(), SCH_LINE::doIsConnected(), SCH_LINE::GetItemDescription(), SCH_ITEM::GetLayer(), SCH_TEXTBOX::GetLegacyTextMargin(), SCH_LINE::GetMenuImage(), SCH_SHAPE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_LINE::GetPenWidth(), SCH_SYMBOL::Init(), SCH_LINE::IsConnectable(), SCH_ITEM::IsType(), SCH_LINE::IsType(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_ITEM::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_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), SCH_BITMAP::SCH_BITMAP(), SCH_BUS_BUS_ENTRY::SCH_BUS_BUS_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_SHEET::SCH_SHEET(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_ITEM::SetLayer(), SCH_FIELD::SwapData(), SCH_LINE::SwapData(), SCH_SHAPE::SwapData(), SCH_TEXT::SwapData(), SCH_TEXTBOX::SwapData(), 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 642 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 654 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 640 of file lib_symbol.h.

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

◆ m_name

wxString LIB_SYMBOL::m_name

private

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

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

◆ m_parent

LIB_SYMBOL_REF LIB_SYMBOL::m_parent

private

Use for inherited symbols.

Definition at line 641 of file lib_symbol.h.

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

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

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

◆ m_private

bool SCH_ITEM::m_private

protectedinherited

Definition at line 726 of file sch_item.h.

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

◆ 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 740 of file sch_item.h.

Referenced by SCH_ITEM::AddRuleAreaToCache(), SCH_ITEM::ClearRuleAreasCache(), SCH_SYMBOL::GetComponentClassNames(), and SCH_ITEM::GetRuleAreaCache().

◆ m_showPinNames

bool SYMBOL::m_showPinNames

protectedinherited

Definition at line 161 of file symbol.h.

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

◆ m_showPinNumbers

bool SYMBOL::m_showPinNumbers

protectedinherited

Definition at line 162 of file symbol.h.

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

◆ m_sourceLibId

LIB_ID LIB_SYMBOL::m_sourceLibId

private

For database library symbols; the original symbol.

Definition at line 643 of file lib_symbol.h.

Referenced by GetSourceLibId(), and SetSourceLibId().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos

protectedinherited

Definition at line 728 of file sch_item.h.

Referenced by SCH_ITEM::GetStoredPos(), and SCH_ITEM::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 496 of file eda_item.h.

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

◆ m_unit

◆ m_unitCount

int LIB_SYMBOL::m_unitCount

private

Number of units (parts) per package.

Definition at line 646 of file lib_symbol.h.

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

◆ m_unitDisplayNames

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

private

Definition at line 660 of file lib_symbol.h.

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

◆ m_unitsLocked

bool LIB_SYMBOL::m_unitsLocked

private

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

Definition at line 647 of file lib_symbol.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 489 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 171 of file view_item.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

◆ AutoAutoplaceFields()

◆ AutoplaceFields()

◆ BeginEdit()

◆ CalcEdit()

◆ CanConnect()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCaches()

◆ ClearConnectedItems()

◆ ClearEditFlags()

◆ ClearEmbeddedFiles()

◆ ClearEmbeddedFonts()

◆ ClearFieldsAutoplaced()

◆ ClearFlags()

◆ ClearRuleAreasCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ compare()

◆ CompressAndEncode()

◆ ConnectedItems()

◆ Connection()

◆ ConnectionPropagatesTo()

◆ ContinueEdit()

◆ CopyUnitDisplayNames()

◆ DecompressAndDecode()

◆ deleteAllFields()

◆ Deserialize()

◆ DoHypertextAction()

◆ doIsConnected()

◆ Duplicate() [1/2]

◆ Duplicate() [2/2]

◆ EmbeddedFileMap()

◆ EmbedFonts()

◆ EndEdit()

◆ FindField() [1/2]

◆ FindField() [2/2]

◆ FixupDrawItems()

◆ Flatten()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllLibPins()

◆ GetAreFontsEmbedded()

◆ GetBodyBoundingBox()

◆ GetBodyStyle()

◆ GetBodyStyleDescription()

◆ GetBoundingBox()

◆ GetCachedDriverName()

◆ GetChooserFields()

◆ GetClass()

◆ GetConnectionPoints()

◆ GetDatasheetField()

◆ GetDefaultFont()

◆ GetDesc()