#include <lib_pin.h>

Inheritance diagram for LIB_PIN:

Classes
struct	ALT

struct	EXTENTS_CACHE

Public Types
enum	LIB_CONVERT : int { BASE = 1 , DEMORGAN = 2 }

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

Public Member Functions
	~LIB_PIN ()

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

wxString	GetTypeName () const override
	Provide a user-consumable name of the object type. More...

int	GetOrientation () const

void	SetOrientation (int aOrientation)

GRAPHIC_PINSHAPE	GetShape () const

void	SetShape (GRAPHIC_PINSHAPE aShape)

int	GetLength () const

void	SetLength (int aLength)

void	ChangeLength (int aLength)
	Change the length of a pin and adjust its position based on orientation. More...

ELECTRICAL_PINTYPE	GetType () const

void	SetType (ELECTRICAL_PINTYPE aType)

wxString const	GetCanonicalElectricalTypeName () const

wxString const	GetElectricalTypeName () const

bool	IsVisible () const

void	SetVisible (bool aVisible)

const wxString &	GetName () const

wxString	GetShownName () const

void	SetName (const wxString &aName)

const wxString &	GetNumber () const

wxString	GetShownNumber () const

void	SetNumber (const wxString &aNumber)

int	GetNameTextSize () const

void	SetNameTextSize (int aSize)

int	GetNumberTextSize () const

void	SetNumberTextSize (int aSize)

std::map< wxString, ALT > &	GetAlternates ()

ALT	GetAlt (const wxString &aAlt)

void	print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed) override
	Print a pin, with or without the pin texts. More...

int	PinDrawOrient (const TRANSFORM &aTransform) const
	Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation and the matrix transform (rot, mirror) aTransform. More...

	LIB_PIN (LIB_SYMBOL *aParent)

	LIB_PIN (LIB_SYMBOL *aParent, const wxString &aName, const wxString &aNumber, int aOrientation, ELECTRICAL_PINTYPE aPinType, int aLength, int aNameTextSize, int aNumTextSize, int aConvert, const VECTOR2I &aPos, int aUnit)

const wxString &	GetOperatingPoint () const

void	SetOperatingPoint (const wxString &aText)

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

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

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Display basic info (type, part and convert) about the current item in message panel. More...

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

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

const BOX2I	GetBoundingBox () const override

const BOX2I	GetBoundingBox (bool aIncludeInvisiblePins, bool aIncludeNameAndNumber, bool aIncludeElectricalType) const

bool	IsGlobalPower () const
	Return whether this pin forms a global power connection: i.e., is part of a power symbol and of type POWER_IN, or is a legacy invisible global power pin on a symbol. More...

int	GetPenWidth () const override

void	PlotPinTexts (PLOTTER *aPlotter, const VECTOR2I &aPinPos, int aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed) const
	Plot the pin number and pin text info, given the pin line coordinates. More...

void	PlotSymbol (PLOTTER *aPlotter, const VECTOR2I &aPosition, int aOrientation, bool aDimmed) const

void	Offset (const VECTOR2I &aOffset) override
	Set the drawing object by aOffset from the current position. More...

void	MoveTo (const VECTOR2I &aNewPosition) override
	Move a draw object to aPosition. More...

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPinRoot () const

void	MirrorHorizontal (const VECTOR2I &aCenter) override
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...

void	MirrorVertical (const VECTOR2I &aCenter) override
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...

void	Rotate (const VECTOR2I &aCenter, bool aRotateCCW=true) override
	Rotate the object about aCenter point. More...

void	Plot (PLOTTER *aPlotter, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed) const override
	Plot the draw item using the plot object. More...

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

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

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

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

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

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

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

virtual void	Print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed)
	Draw an item. More...

const wxString &	GetDefaultFont () const

virtual int	GetEffectivePenWidth (const RENDER_SETTINGS *aSettings) const

LIB_SYMBOL *	GetParent () const

bool	operator== (const LIB_ITEM &aOther) const
	Test LIB_ITEM objects for equivalence. More...

bool	operator== (const LIB_ITEM *aOther) const

bool	operator< (const LIB_ITEM &aOther) const
	Test if another draw item is less than this draw object. More...

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

void	SetUnit (int aUnit)

int	GetUnit () const

void	SetConvert (int aConvert)

int	GetConvert () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

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

virtual void	SetParent (EDA_ITEM *aParent)

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

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

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

bool	IsForceVisible () const

virtual wxString	GetFriendlyName () const

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

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

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

static const wxString	GetCanonicalElectricalTypeName (ELECTRICAL_PINTYPE aType)
	Return a string giving the electrical type of a pin. More...

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

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

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

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

Public Attributes
const KIID	m_Uuid

Protected Member Functions
void	validateExtentsCache (KIFONT::FONT aFont, int aSize, const wxString &aText, EXTENTS_CACHE aCache) const

void	printPinSymbol (const RENDER_SETTINGS *aSettings, const VECTOR2I &aPos, int aOrientation, bool aDimmed)
	Print the pin symbol without text. More...

void	printPinTexts (const RENDER_SETTINGS *aSettings, VECTOR2I &aPinPos, int aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName, bool aDimmed)
	Put the pin number and pin text info, given the pin line coordinates. More...

void	printPinElectricalTypeName (const RENDER_SETTINGS *aSettings, VECTOR2I &aPosition, int aOrientation, bool aDimmed)
	Draw the electrical type text of the pin (only for the footprint editor) More...

bool	operator== (const LIB_PIN &aRhs) const

bool	operator< (const LIB_PIN &aRhs) const

bool	operator> (const LIB_PIN &aRhs) const

std::ostream &	operator<< (std::ostream &aStream)

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

Protected Attributes
VECTOR2I	m_position

int	m_length

int	m_orientation

GRAPHIC_PINSHAPE	m_shape

ELECTRICAL_PINTYPE	m_type

int	m_attributes

wxString	m_name

wxString	m_number

int	m_numTextSize

int	m_nameTextSize

std::map< wxString, ALT >	m_alternates

wxString	m_operatingPoint

EXTENTS_CACHE	m_numExtentsCache

EXTENTS_CACHE	m_nameExtentsCache

int	m_unit
	Unit identification for multiple parts per package. More...

int	m_convert
	Shape identification for alternate body styles. More...

bool	m_private
	Private items are shown only in the Symbol Editor. More...

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
int	compare (const LIB_ITEM &aOther, int aCompareFlags=0) const override
	Provide the draw object specific comparison called by the == and < operators. More...

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

VIEW_ITEM_DATA *	m_viewPrivData

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

Detailed Description

Definition at line 52 of file lib_pin.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, conversion and pin number constraints. It is used for LIB_ITEM object unit comparisons.
EQUALITY This flag relaxes ordering contstraints 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.

Enumerator
UNIT
EQUALITY
ERC

Definition at line 82 of file lib_item.h.

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 70 of file lib_item.h.

Constructor & Destructor Documentation

◆ ~LIB_PIN()

LIB_PIN::~LIB_PIN ( )

inline

Definition at line 62 of file lib_pin.h.

◆ LIB_PIN() [1/2]

LIB_PIN::LIB_PIN ( LIB_SYMBOL * aParent )

Definition at line 97 of file lib_pin.cpp.

References DEFAULT_PIN_LENGTH, DEFAULT_PINNAME_SIZE, DEFAULT_PINNUM_SIZE, SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), m_length, m_nameTextSize, m_numTextSize, EDA_IU_SCALE::MilsToIU(), PgmOrNull(), and schIUScale.

◆ LIB_PIN() [2/2]

LIB_PIN::LIB_PIN	(	LIB_SYMBOL *	aParent,
		const wxString &	aName,
		const wxString &	aNumber,
		int	aOrientation,
		ELECTRICAL_PINTYPE	aPinType,
		int	aLength,
		int	aNameTextSize,
		int	aNumTextSize,
		int	aConvert,
		const VECTOR2I &	aPos,
		int	aUnit
	)

Definition at line 124 of file lib_pin.cpp.

References LIB_ITEM::SetConvert(), SetName(), SetNumber(), and LIB_ITEM::SetUnit().

Member Function Documentation

◆ BeginEdit()

virtual void LIB_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 LIB_FIELD, LIB_SHAPE, and LIB_TEXT.

Definition at line 124 of file lib_item.h.

◆ CalcEdit()

void LIB_PIN::CalcEdit ( const VECTOR2I & aPosition )

overridevirtual

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

Definition at line 1459 of file lib_pin.cpp.

References EDA_ITEM::IsMoving(), and MoveTo().

◆ ChangeLength()

void LIB_PIN::ChangeLength ( int aLength )

Change the length of a pin and adjust its position based on orientation.

Parameters

aLength New length of pin

Definition at line 1049 of file lib_pin.cpp.

References m_length, m_orientation, Offset(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, and PIN_UP.

Referenced by DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ ClassOf()

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

inlinestatic

Definition at line 69 of file lib_pin.h.

References LIB_PIN_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 142 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToCommitAndScreen(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 125 of file eda_item.h.

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References CANDIDATE, EDA_ITEM::ClearFlags(), IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ Clone()

EDA_ITEM * LIB_PIN::Clone ( ) const

overridevirtual

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

Definition at line 966 of file lib_pin.cpp.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), and SYMBOL_EDITOR_PIN_TOOL::RepeatPin().

◆ compare()

int LIB_PIN::compare	(	const LIB_ITEM &	aOther,
		int	aCompareFlags = `0`
	)		const

overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

Symbol alternate part (DeMorgan) number.
Symbol part number.
KICAD_T enum value.
Result of derived classes comparison.

Note: Make sure you call down to LIB_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.

Parameters

aOther	A reference to the other LIB_ITEM to compare the arc against.
aCompareFlags	The flags used to perform the comparison.

Returns: An integer value less than 0 if the object is less than aOther object, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The pin specific sort order is as follows:

Pin number.
Pin name, case insensitive compare.
Pin horizontal (X) position.
Pin vertical (Y) position.

Reimplemented from LIB_ITEM.

Definition at line 972 of file lib_pin.cpp.

References LIB_ITEM::compare(), LIB_PIN_T, m_alternates, m_attributes, m_length, LIB_PIN::ALT::m_Name, m_name, m_nameTextSize, m_number, m_numTextSize, m_orientation, m_position, LIB_PIN::ALT::m_Shape, m_shape, LIB_PIN::ALT::m_Type, m_type, EDA_ITEM::Type(), LIB_ITEM::UNIT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by operator<(), operator==(), and operator>().

◆ ContinueEdit()

virtual bool LIB_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 LIB_SHAPE.

Definition at line 136 of file lib_item.h.

◆ EndEdit()

virtual void LIB_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 LIB_SHAPE.

Definition at line 143 of file lib_item.h.

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

◆ GetAlt()

ALT LIB_PIN::GetAlt ( const wxString & aAlt )

inline

Definition at line 155 of file lib_pin.h.

References m_alternates.

Referenced by SCH_PIN::GetShape(), and SCH_PIN::GetType().

◆ GetAlternates()

std::map< wxString, ALT > & LIB_PIN::GetAlternates ( )

inline

Definition at line 153 of file lib_pin.h.

References m_alternates.

Referenced by SCH_PIN_TABLE_DATA_MODEL::BuildAttrs(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SCH_SEXPR_PLUGIN_CACHE::savePin(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetBoundingBox() [1/2]

const BOX2I LIB_PIN::GetBoundingBox ( ) const

inlineoverridevirtual

Returns: the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 204 of file lib_pin.h.

References GetBoundingBox().

Referenced by GetBoundingBox(), SCH_PIN::GetBoundingBox(), HitTest(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), and ViewBBox().

◆ GetBoundingBox() [2/2]

const BOX2I LIB_PIN::GetBoundingBox	(	bool	aIncludeInvisiblePins,
		bool	aIncludeNameAndNumber,
		bool	aIncludeElectricalType
	)		const

Parameters

aIncludeInvisibles - if false, do not include labels for invisible pins in the calculation.

Definition at line 1235 of file lib_pin.cpp.

References ANGLE_90, EESCHEMA_SETTINGS::APPEARANCE::default_font, DefaultTransform, externalPinDecoSize(), GetElectricalTypeName(), KIFONT::FONT::GetFont(), LIB_ITEM::GetParent(), GetPenWidth(), LIB_SYMBOL::GetPinNameOffset(), GetShownName(), GetShownNumber(), BOX2< Vec >::Inflate(), IsVisible(), KiROUND(), EESCHEMA_SETTINGS::m_Appearance, LIB_PIN::EXTENTS_CACHE::m_Extents, m_length, m_nameExtentsCache, m_nameTextSize, m_numExtentsCache, m_numTextSize, m_position, m_shape, EDA_IU_SCALE::MilsToIU(), EDA_IU_SCALE::mmToIU(), BOX2< Vec >::Normalize(), Pgm(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PinDrawOrient(), BOX2< Vec >::RevertYAxis(), RotatePoint(), schIUScale, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), TARGET_PIN_RADIUS, validateExtentsCache(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetCanonicalElectricalTypeName() [1/2]

wxString const LIB_PIN::GetCanonicalElectricalTypeName ( ) const

inline

Definition at line 98 of file lib_pin.h.

References GetCanonicalElectricalTypeName(), and m_type.

Referenced by GetCanonicalElectricalTypeName(), and SCH_PIN::GetCanonicalElectricalTypeName().

◆ GetCanonicalElectricalTypeName() [2/2]

const wxString LIB_PIN::GetCanonicalElectricalTypeName ( ELECTRICAL_PINTYPE aType )

static

Return a string giving the electrical type of a pin.

Can be used when a known, not translated name is needed (for instance in net lists)

Parameters

aType is the electrical type (see enum ELECTRICAL_PINTYPE )

Returns: The electrical name for a pin type (see enun MsgPinElectricType for names).

Definition at line 43 of file lib_pin.cpp.

◆ GetClass()

wxString LIB_PIN::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 64 of file lib_pin.h.

◆ GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 296 of file lib_item.h.

References LIB_ITEM::m_convert.

Referenced by LIB_SYMBOL::Compare(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetDefaultFont()

const wxString & LIB_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 132 of file lib_item.cpp.

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), and LIB_TEXTBOX::GetShownText().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

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

◆ GetEffectivePenWidth()

virtual int LIB_ITEM::GetEffectivePenWidth ( const RENDER_SETTINGS * aSettings ) const

inlinevirtualinherited

Definition at line 175 of file lib_item.h.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), and LIB_ITEM::GetPenWidth().

Referenced by LIB_FIELD::Plot(), LIB_SHAPE::Plot(), LIB_TEXTBOX::Plot(), PlotSymbol(), LIB_FIELD::print(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), and printPinSymbol().

◆ GetElectricalTypeName()

wxString const LIB_PIN::GetElectricalTypeName ( ) const

inline

Definition at line 103 of file lib_pin.h.

References ElectricalPinTypeGetText(), and m_type.

Referenced by KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), GetItemDescription(), and printPinElectricalTypeName().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 239 of file eda_item.h.

References EDA_ITEM::GetPosition().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetItemDescription()

wxString LIB_PIN::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

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

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1381 of file lib_pin.cpp.

References _, GetElectricalTypeName(), GetShownName(), GetShownNumber(), IsVisible(), m_shape, PinShapeGetText(), and UnescapeString().

Referenced by SCH_PIN::GetItemDescription().

◆ GetLength()

int LIB_PIN::GetLength ( ) const

inline

Definition at line 85 of file lib_pin.h.

References m_length.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetLength(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetMenuImage()

BITMAPS LIB_PIN::GetMenuImage ( ) const

overridevirtual

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

Definition at line 1375 of file lib_pin.cpp.

References ElectricalPinTypeGetBitmap(), and m_type.

◆ GetMsgPanelInfo()

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

overridevirtual

Display basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters

aList is the list to populate.

Reimplemented from LIB_ITEM.

Definition at line 1164 of file lib_pin.cpp.

References _, ElectricalPinTypeGetText(), EDA_ITEM::GetFlags(), LIB_ITEM::GetMsgPanelInfo(), GetPosition(), GetShownName(), GetShownNumber(), IsVisible(), m_length, m_orientation, m_shape, m_type, UNITS_PROVIDER::MessageTextFromValue(), PinOrientationIndex(), PinOrientationName(), PinShapeGetText(), UnescapeString(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties().

◆ GetName()

const wxString & LIB_PIN::GetName ( ) const

inline

Definition at line 117 of file lib_pin.h.

References m_name.

Referenced by SCH_PIN_TABLE_DATA_MODEL::BuildAttrs(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetDefaultNetName(), SCH_PIN::GetName(), SCH_PIN::GetShownName(), SCH_PIN_TABLE_DATA_MODEL::GetValue(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetNameTextSize()

int LIB_PIN::GetNameTextSize ( ) const

inline

Definition at line 139 of file lib_pin.h.

References m_nameTextSize.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), KIGFX::SCH_PAINTER::internalPinDecoSize(), internalPinDecoSize(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetNumber()

const wxString & LIB_PIN::GetNumber ( ) const

inline

Definition at line 128 of file lib_pin.h.

References m_number.

Referenced by LIB_SYMBOL::Compare(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_PIN::GetDefaultNetName(), SYMBOL_EDITOR_EDIT_TOOL::handlePinDuplication(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_PIN::SCH_PIN(), sort_by_pin_number(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetNumberTextSize()

int LIB_PIN::GetNumberTextSize ( ) const

inline

Definition at line 146 of file lib_pin.h.

References m_numTextSize.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), KIGFX::SCH_PAINTER::externalPinDecoSize(), externalPinDecoSize(), KIGFX::SCH_PAINTER::internalPinDecoSize(), internalPinDecoSize(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetOperatingPoint()

const wxString & LIB_PIN::GetOperatingPoint ( ) const

inline

Definition at line 186 of file lib_pin.h.

References m_operatingPoint.

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

◆ GetOrientation()

int LIB_PIN::GetOrientation ( ) const

inline

Definition at line 79 of file lib_pin.h.

References m_orientation.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetOrientation(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), orientLabel(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetParent()

LIB_SYMBOL * LIB_ITEM::GetParent ( ) const

inlineinherited

Definition at line 188 of file lib_item.h.

References EDA_ITEM::m_parent.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), GetBoundingBox(), LIB_FIELD::GetFullText(), IsGlobalPower(), Plot(), print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetPenWidth()

int LIB_PIN::GetPenWidth ( ) const

overridevirtual

Implements LIB_ITEM.

Definition at line 169 of file lib_pin.cpp.

Referenced by GetBoundingBox(), PlotPinTexts(), and printPinTexts().

◆ GetPinRoot()

VECTOR2I LIB_PIN::GetPinRoot ( ) const

Definition at line 184 of file lib_pin.cpp.

References m_length, m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetPosition()

VECTOR2I LIB_PIN::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 243 of file lib_pin.h.

References m_position.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), GetMsgPanelInfo(), SCH_SYMBOL::GetPinPhysicalPosition(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_PIN::SCH_PIN(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetShape()

GRAPHIC_PINSHAPE LIB_PIN::GetShape ( ) const

inline

Definition at line 82 of file lib_pin.h.

References m_shape.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetShape(), DIALOG_PIN_PROPERTIES::OnAddAlternate(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetShownName()

wxString LIB_PIN::GetShownName ( ) const

Definition at line 175 of file lib_pin.cpp.

References m_name.

Referenced by KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), SCH_PIN::GetDefaultNetName(), GetItemDescription(), GetMsgPanelInfo(), PlotPinTexts(), and printPinTexts().

◆ GetShownNumber()

wxString LIB_PIN::GetShownNumber ( ) const

inline

Definition at line 129 of file lib_pin.h.

References m_number.

Referenced by KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), SCH_PIN::GetDefaultNetName(), GetItemDescription(), GetMsgPanelInfo(), PlotPinTexts(), printPinTexts(), and sortPinsByNumber().

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

References EDA_ITEM::GetPosition().

◆ GetType()

ELECTRICAL_PINTYPE LIB_PIN::GetType ( ) const

inline

Definition at line 95 of file lib_pin.h.

References m_type.

Referenced by SCH_PIN::ConnectionPropagatesTo(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetType(), IsGlobalPower(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_PIN_PROPERTIES::OnAddAlternate(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

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

◆ GetTypeName()

wxString LIB_PIN::GetTypeName ( ) const

inlineoverridevirtual

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 74 of file lib_pin.h.

References _.

◆ GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 293 of file lib_item.h.

References LIB_ITEM::m_unit.

Referenced by LIB_SYMBOL::Compare(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), SCH_SYMBOL::GetEndPoints(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), PIN_TABLE_DATA_MODEL::SetValue(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ HitTest() [1/2]

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

overridevirtual

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

Definition at line 152 of file lib_pin.cpp.

References BOX2< Vec >::Contains(), GetBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), EDA_ITEM::m_flags, SHOW_ELEC_TYPE, SKIP_STRUCT, and STRUCT_DELETED.

◆ HitTest() [2/2]

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

overridevirtual

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

Definition at line 144 of file lib_pin.cpp.

References BOX2< Vec >::Contains(), GetBoundingBox(), BOX2< Vec >::Inflate(), EDA_ITEM::m_flags, and SHOW_ELEC_TYPE.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ IsGlobalPower()

bool LIB_PIN::IsGlobalPower ( ) const

inline

Return whether this pin forms a global power connection: i.e., is part of a power symbol and of type POWER_IN, or is a legacy invisible global power pin on a symbol.

Definition at line 218 of file lib_pin.h.

References LIB_ITEM::GetParent(), GetType(), LIB_SYMBOL::IsPower(), and IsVisible().

Referenced by SCH_PIN::IsGlobalPower().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToCommitAndScreen(), SCH_EDIT_TOOL::AutoplaceFields(), CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToCommitAndScreen(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::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 DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ IsPrivate()

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

Definition at line 403 of file eda_item.h.

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

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

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

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

Definition at line 165 of file eda_item.h.

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsVisible()

bool LIB_PIN::IsVisible ( ) const

inline

Definition at line 108 of file lib_pin.h.

References m_attributes, and PIN_INVISIBLE.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), GetBoundingBox(), GetItemDescription(), GetMsgPanelInfo(), IsGlobalPower(), SCH_PIN::IsVisible(), Plot(), print(), printPinElectricalTypeName(), printPinSymbol(), printPinTexts(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

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

References EDA_ITEM::Visit().

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 365 of file eda_item.h.

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), 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 116 of file eda_item.cpp.

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

◆ MirrorHorizontal()

void LIB_PIN::MirrorHorizontal ( const VECTOR2I & aCenter )

overridevirtual

Mirror the draw object along the horizontal (X) axis about aCenter point.

Parameters

aCenter Point to mirror around.

Implements LIB_ITEM.

Definition at line 1093 of file lib_pin.cpp.

References m_orientation, m_position, PIN_LEFT, PIN_RIGHT, and VECTOR2< T >::x.

◆ MirrorVertical()

void LIB_PIN::MirrorVertical ( const VECTOR2I & aCenter )

overridevirtual

Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.

Parameters

aCenter Point to mirror around.

Implements LIB_ITEM.

Definition at line 1106 of file lib_pin.cpp.

References m_orientation, m_position, PIN_DOWN, PIN_UP, and VECTOR2< T >::y.

◆ MoveTo()

void LIB_PIN::MoveTo ( const VECTOR2I & aPosition )

overridevirtual

Move a draw object to aPosition.

Parameters

aPosition Position to move draw item to.

Implements LIB_ITEM.

Definition at line 1083 of file lib_pin.cpp.

References m_position, and EDA_ITEM::SetModified().

Referenced by CalcEdit().

◆ Offset()

void LIB_PIN::Offset ( const VECTOR2I & aOffset )

overridevirtual

Set the drawing object by aOffset from the current position.

Parameters

aOffset Coordinates to offset the item position.

Implements LIB_ITEM.

Definition at line 1077 of file lib_pin.cpp.

References m_position.

Referenced by ChangeLength().

◆ operator<() [1/3]

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

References EDA_ITEM::GetClass().

◆ operator<() [2/3]

bool LIB_ITEM::operator< ( const LIB_ITEM & aOther ) const

inherited

Test if another draw item is less than this draw object.

Parameters

aOther - Draw item to compare against.

Returns: - True if object is less than this object.

Definition at line 106 of file lib_item.cpp.

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

◆ operator<() [3/3]

bool LIB_PIN::operator< ( const LIB_PIN & aRhs ) const

inlineprotected

Definition at line 309 of file lib_pin.h.

References compare(), and LIB_ITEM::EQUALITY.

◆ operator<<()

std::ostream & LIB_PIN::operator<< ( std::ostream & aStream )

protected

Definition at line 1429 of file lib_pin.cpp.

References ElectricalPinTypeGetText(), m_length, m_name, m_nameTextSize, m_number, m_numTextSize, m_orientation, m_position, m_shape, m_type, PinOrientationName(), and PinShapeGetText().

◆ operator==() [1/3]

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

inherited

Test LIB_ITEM objects for equivalence.

Parameters

aOther Object to test against.

Returns: True if object is identical to this object.

Definition at line 97 of file lib_item.cpp.

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

◆ operator==() [2/3]

bool LIB_ITEM::operator== ( const LIB_ITEM * aOther ) const

inlineinherited

Definition at line 227 of file lib_item.h.

◆ operator==() [3/3]

bool LIB_PIN::operator== ( const LIB_PIN & aRhs ) const

inlineprotected

Definition at line 308 of file lib_pin.h.

References compare(), and LIB_ITEM::EQUALITY.

◆ operator>()

bool LIB_PIN::operator> ( const LIB_PIN & aRhs ) const

inlineprotected

Definition at line 310 of file lib_pin.h.

References compare(), and LIB_ITEM::EQUALITY.

◆ PinDrawOrient()

int LIB_PIN::PinDrawOrient ( const TRANSFORM & aTransform ) const

Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT), according to its orientation and the matrix transform (rot, mirror) aTransform.

Parameters

aTransform Transform matrix

Definition at line 932 of file lib_pin.cpp.

References m_orientation, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, TRANSFORM::TransformCoordinate(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoundingBox(), AUTOPLACER::getPinSide(), Plot(), and print().

◆ Plot()

void LIB_PIN::Plot	(	PLOTTER *	aPlotter,
		bool	aBackground,
		const VECTOR2I &	aOffset,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)		const

overridevirtual

Plot the draw item using the plot object.

Parameters

aPlotter	The plot object to plot to.
aBackground	a poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.
aOffset	Plot offset position.
aFill	Flag to indicate whether or not the object is filled.
aTransform	The plot transform.
aDimmed	if true, reduce color to background

Implements LIB_ITEM.

Definition at line 1148 of file lib_pin.cpp.

References LIB_ITEM::GetParent(), IsVisible(), m_position, PinDrawOrient(), PlotPinTexts(), PlotSymbol(), and TRANSFORM::TransformCoordinate().

Referenced by SCH_SYMBOL::PlotPins().

◆ PlotPinTexts()

void LIB_PIN::PlotPinTexts	(	PLOTTER *	aPlotter,
		const VECTOR2I &	aPinPos,
		int	aPinOrient,
		int	aTextInside,
		bool	aDrawPinNum,
		bool	aDrawPinName,
		bool	aDimmed
	)		const

Plot the pin number and pin text info, given the pin line coordinates.

Same as DrawPinTexts((), but output is the plotter The line must be vertical or horizontal. If TextInside then the text is been put inside (moving from x1, y1 in the opposite direction to x2,y2), otherwise all is drawn outside.

Definition at line 758 of file lib_pin.cpp.

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, Clamp_Text_PenSize(), color, KIGFX::COLOR4D::Desaturate(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIFONT::FONT::GetFont(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), GetShownName(), GetShownNumber(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, LAYER_PINNAM, LAYER_PINNUM, TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Halign, m_length, TEXT_ATTRIBUTES::m_Multiline, m_nameTextSize, m_numTextSize, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, TEXT_ATTRIBUTES::m_Valign, EDA_IU_SCALE::MilsToIU(), KIGFX::COLOR4D::Mix(), name, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PLOTTER::PlotText(), PLOTTER::RenderSettings(), schIUScale, text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Plot().

◆ PlotSymbol()

void LIB_PIN::PlotSymbol	(	PLOTTER *	aPlotter,
		const VECTOR2I &	aPosition,
		int	aOrientation,
		bool	aDimmed
	)		const

◆ Print()

void LIB_ITEM::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		void *	aData,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)

virtualinherited

Draw an item.

Parameters

aDC	Device Context (can be null)
aOffset	Offset to draw
aData	Value or pointer used to pass others parameters, depending on body items. Used for some items to force to force no fill mode ( has meaning only for items what can be filled ). used in printing or moving objects mode or to pass reference to the lib symbol for pins.
aTransform	Transform Matrix (rotation, mirror ..)
aDimmed	Dim the color on the printout

Definition at line 140 of file lib_item.cpp.

References LIB_ITEM::print().

Referenced by DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), LIB_SYMBOL::Print(), and LIB_SYMBOL::PrintBackground().

◆ print()

void LIB_PIN::print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		void *	aData,
		const TRANSFORM &	aTransform,
		bool	aDimmed
	)

overridevirtual

Print a pin, with or without the pin texts.

Parameters

aOffset	Offset to draw
aData	= used here as a boolean indicating whether or not to draw the pin electrical types
aTransform	Transform Matrix (rotation, mirror ..)

Implements LIB_ITEM.

Definition at line 197 of file lib_pin.cpp.

References color, LIB_SYMBOL_OPTIONS::draw_hidden_fields, LIB_SYMBOL_OPTIONS::force_draw_pin_text, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), LIB_ITEM::GetParent(), LIB_SYMBOL::GetPinNameOffset(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRCircle(), IsVisible(), LAYER_HIDDEN, LAYER_PIN, m_position, m_type, PinDrawOrient(), printPinElectricalTypeName(), printPinSymbol(), printPinTexts(), LIB_SYMBOL_OPTIONS::show_connect_point, LIB_SYMBOL_OPTIONS::show_elec_type, LIB_SYMBOL::ShowPinNames(), LIB_SYMBOL::ShowPinNumbers(), TARGET_PIN_RADIUS, and TRANSFORM::TransformCoordinate().

◆ printPinElectricalTypeName()

void LIB_PIN::printPinElectricalTypeName	(	const RENDER_SETTINGS *	aSettings,
		VECTOR2I &	aPosition,
		int	aOrientation,
		bool	aDimmed
	)

protected

Draw the electrical type text of the pin (only for the footprint editor)

Definition at line 548 of file lib_pin.cpp.

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, color, ETXT_MAX_SIZE, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), GetElectricalTypeName(), KIFONT::FONT::GetFont(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_CENTER, GRPrintText(), IsVisible(), LAYER_HIDDEN, LAYER_PRIVATE_NOTES, m_nameTextSize, EDA_IU_SCALE::mmToIU(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by print().

◆ printPinSymbol()

void LIB_PIN::printPinSymbol	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aPos,
		int	aOrientation,
		bool	aDimmed
	)

protected

Print the pin symbol without text.

If aColor != 0, draw with aColor, else with the normal pin color.

Definition at line 251 of file lib_pin.cpp.

References color, externalPinDecoSize(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), LIB_ITEM::GetEffectivePenWidth(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRCircle(), GRLine(), GRLineTo(), GRMoveTo(), internalPinDecoSize(), IsVisible(), LAYER_HIDDEN, LAYER_PIN, m_length, m_shape, m_type, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, TARGET_PIN_RADIUS, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by print().

◆ printPinTexts()

void LIB_PIN::printPinTexts	(	const RENDER_SETTINGS *	aSettings,
		VECTOR2I &	aPinPos,
		int	aPinOrient,
		int	aTextInside,
		bool	aDrawPinNum,
		bool	aDrawPinName,
		bool	aDimmed
	)

protected

Put the pin number and pin text info, given the pin line coordinates.

The line must be vertical or horizontal. If aDrawPinName == false the pin name is not printed. If aDrawPinNum = false the pin number is not printed. If aTextInside then the text is been put inside,otherwise all is drawn outside. Pin Name: substring between '~' is negated

Definition at line 375 of file lib_pin.cpp.

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, Clamp_Text_PenSize(), KIGFX::COLOR4D::Desaturate(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIFONT::FONT::GetFont(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetShownName(), GetShownNumber(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, GRPrintText(), IsVisible(), LAYER_HIDDEN, LAYER_PINNAM, LAYER_PINNUM, m_length, m_nameTextSize, m_numTextSize, EDA_IU_SCALE::MilsToIU(), KIGFX::COLOR4D::Mix(), name, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by print().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 147 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

This function must be overridden for items that support text replace.

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

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

References EDA_SEARCH_DATA::findString, 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().

◆ Rotate()

void LIB_PIN::Rotate	(	const VECTOR2I &	aCenter,
		bool	aRotateCCW = `true`
	)

overridevirtual

Rotate the object about aCenter point.

Parameters

aCenter	Point to rotate around.
aRotateCCW	True to rotate counter clockwise. False to rotate clockwise.

Implements LIB_ITEM.

Definition at line 1119 of file lib_pin.cpp.

References ANGLE_90, m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, and RotatePoint().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConvert()

void LIB_ITEM::SetConvert ( int aConvert )

inlineinherited

Definition at line 295 of file lib_item.h.

References LIB_ITEM::m_convert.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), LIB_PIN(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 123 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 145 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

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

References EDA_ITEM::m_forceVisible.

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

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 149 of file eda_item.h.

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

◆ SetLength()

void LIB_PIN::SetLength ( int aLength )

inline

Definition at line 86 of file lib_pin.h.

References m_length.

Referenced by LTSPICE_SCH_PARSER::CreatePin(), and DIALOG_PIN_PROPERTIES::OnPropertiesChange().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

◆ SetName()

void LIB_PIN::SetName ( const wxString & aName )

inline

Definition at line 119 of file lib_pin.h.

References LIB_PIN::EXTENTS_CACHE::m_Extents, m_name, and m_nameExtentsCache.

Referenced by LTSPICE_SCH_PARSER::CreatePin(), KIGFX::SCH_PAINTER::draw(), LIB_PIN(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), SCH_SYMBOL::Print(), PIN_TABLE_DATA_MODEL::SetValue(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetNameTextSize()

void LIB_PIN::SetNameTextSize ( int aSize )

inline

Definition at line 140 of file lib_pin.h.

References LIB_PIN::EXTENTS_CACHE::m_Extents, m_nameExtentsCache, and m_nameTextSize.

Referenced by DIALOG_PIN_PROPERTIES::OnPropertiesChange(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetNumber()

void LIB_PIN::SetNumber ( const wxString & aNumber )

inline

Definition at line 130 of file lib_pin.h.

References LIB_PIN::EXTENTS_CACHE::m_Extents, m_number, and m_numExtentsCache.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), LTSPICE_SCH_PARSER::CreatePin(), SYMBOL_EDITOR_EDIT_TOOL::handlePinDuplication(), LIB_PIN(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EAGLE_PLUGIN::loadSymbol(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SIM_LIBRARY_KIBIS::ReadFile(), PIN_TABLE_DATA_MODEL::SetValue(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetNumberTextSize()

void LIB_PIN::SetNumberTextSize ( int aSize )

inline

Definition at line 147 of file lib_pin.h.

References LIB_PIN::EXTENTS_CACHE::m_Extents, m_numExtentsCache, and m_numTextSize.

Referenced by DIALOG_PIN_PROPERTIES::OnPropertiesChange(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetOperatingPoint()

void LIB_PIN::SetOperatingPoint ( const wxString & aText )

inline

Definition at line 187 of file lib_pin.h.

References m_operatingPoint.

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

◆ SetOrientation()

void LIB_PIN::SetOrientation ( int aOrientation )

inline

Definition at line 80 of file lib_pin.h.

References m_orientation.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 100 of file eda_item.h.

References EDA_ITEM::m_parent.

◆ SetPosition()

void LIB_PIN::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from LIB_ITEM.

Definition at line 244 of file lib_pin.h.

References m_position.

Referenced by LTSPICE_SCH_PARSER::CreatePin(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), PIN_TABLE_DATA_MODEL::SetValue(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetPrivate()

void LIB_ITEM::SetPrivate ( bool aPrivate )

inlineinherited

Definition at line 298 of file lib_item.h.

References LIB_ITEM::m_private.

Referenced by DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetShape()

void LIB_PIN::SetShape ( GRAPHIC_PINSHAPE aShape )

inline

Definition at line 83 of file lib_pin.h.

References m_shape.

Referenced by LTSPICE_SCH_PARSER::CreatePin(), KIGFX::SCH_PAINTER::draw(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), SCH_SYMBOL::Print(), PIN_TABLE_DATA_MODEL::SetValue(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetType()

void LIB_PIN::SetType ( ELECTRICAL_PINTYPE aType )

inline

Definition at line 96 of file lib_pin.h.

References m_type.

Referenced by LTSPICE_SCH_PARSER::CreatePin(), KIGFX::SCH_PAINTER::draw(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), SCH_SYMBOL::Print(), PIN_TABLE_DATA_MODEL::SetValue(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetUnit()

void LIB_ITEM::SetUnit ( int aUnit )

inlineinherited

Definition at line 292 of file lib_item.h.

References LIB_ITEM::m_unit.

◆ SetVisible()

void LIB_PIN::SetVisible ( bool aVisible )

inline

Definition at line 109 of file lib_pin.h.

References m_attributes, and PIN_INVISIBLE.

Referenced by DIALOG_PIN_PROPERTIES::OnPropertiesChange(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 97 of file eda_item.h.

References EDA_ITEM::m_structType.

◆ validateExtentsCache()

void LIB_PIN::validateExtentsCache	(	KIFONT::FONT *	aFont,
		int	aSize,
		const wxString &	aText,
		EXTENTS_CACHE *	aCache
	)		const

protected

Definition at line 1211 of file lib_pin.cpp.

References GetPenSizeForNormal(), LIB_PIN::EXTENTS_CACHE::m_Extents, LIB_PIN::EXTENTS_CACHE::m_Font, LIB_PIN::EXTENTS_CACHE::m_FontSize, KIFONT::FONT::StringBoundaryLimits(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoundingBox().

◆ ViewBBox()

const BOX2I LIB_PIN::ViewBBox ( ) const

overridevirtual

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

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1193 of file lib_pin.cpp.

References GetBoundingBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 108 of file view_item.h.

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

◆ ViewGetLayers()

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

overridevirtual

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

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

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Reimplemented from LIB_ITEM.

Definition at line 1199 of file lib_pin.cpp.

References LAYER_DANGLING, LAYER_DEVICE, LAYER_OP_CURRENTS, and LAYER_SELECTION_SHADOWS.

◆ ViewGetLOD()

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 134 of file view_item.h.

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

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

virtualinherited

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 in PCB_GROUP, LIB_SYMBOL, SCH_SHEET, SCH_SYMBOL, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, FOOTPRINT, PCB_TRACK, SCH_LABEL_BASE, and BOARD.

Definition at line 90 of file eda_item.cpp.

References EDA_ITEM::GetClass(), and EDA_ITEM::IsType().

Referenced by PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), EDA_ITEM::IterateForward(), FOOTPRINT_PREVIEW_PANEL::renderFootprint(), and BOARD::UpdateUserUnits().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 124 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ m_alternates

std::map<wxString, ALT> LIB_PIN::m_alternates

protected

Definition at line 337 of file lib_pin.h.

Referenced by compare(), GetAlt(), and GetAlternates().

◆ m_attributes

int LIB_PIN::m_attributes

protected

Definition at line 331 of file lib_pin.h.

Referenced by compare(), IsVisible(), and SetVisible().

◆ m_convert

int LIB_ITEM::m_convert

protectedinherited

Shape identification for alternate body styles.

Set 0 if the item is common to all body styles. This is typially used for representing DeMorgan variants in KiCad.

Definition at line 358 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::compare(), LIB_ITEM::GetConvert(), LIB_ITEM::GetMsgPanelInfo(), LIB_SYMBOL::PlotLibFields(), LIB_SYMBOL::PrintBackground(), LIB_SYMBOL::SetConversion(), and LIB_ITEM::SetConvert().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), 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=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::swapData(), PCB_BITMAP::swapData(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 159 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 479 of file eda_item.h.

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

◆ m_length

int LIB_PIN::m_length

protected

Definition at line 327 of file lib_pin.h.

Referenced by ChangeLength(), compare(), GetBoundingBox(), GetLength(), GetMsgPanelInfo(), GetPinRoot(), LIB_PIN(), operator<<(), PlotPinTexts(), PlotSymbol(), printPinSymbol(), printPinTexts(), and SetLength().

◆ m_name

wxString LIB_PIN::m_name

protected

Definition at line 332 of file lib_pin.h.

Referenced by compare(), GetName(), GetShownName(), operator<<(), and SetName().

◆ m_nameExtentsCache

EXTENTS_CACHE LIB_PIN::m_nameExtentsCache

mutableprotected

Definition at line 344 of file lib_pin.h.

Referenced by GetBoundingBox(), SetName(), and SetNameTextSize().

◆ m_nameTextSize

int LIB_PIN::m_nameTextSize

protected

Definition at line 335 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetNameTextSize(), LIB_PIN(), operator<<(), PlotPinTexts(), printPinElectricalTypeName(), printPinTexts(), and SetNameTextSize().

◆ m_number

wxString LIB_PIN::m_number

protected

Definition at line 333 of file lib_pin.h.

Referenced by compare(), GetNumber(), GetShownNumber(), operator<<(), and SetNumber().

◆ m_numExtentsCache

EXTENTS_CACHE LIB_PIN::m_numExtentsCache

mutableprotected

Definition at line 343 of file lib_pin.h.

Referenced by GetBoundingBox(), SetNumber(), and SetNumberTextSize().

◆ m_numTextSize

int LIB_PIN::m_numTextSize

protected

Definition at line 334 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetNumberTextSize(), LIB_PIN(), operator<<(), PlotPinTexts(), printPinTexts(), and SetNumberTextSize().

◆ m_operatingPoint

wxString LIB_PIN::m_operatingPoint

protected

Definition at line 339 of file lib_pin.h.

Referenced by GetOperatingPoint(), and SetOperatingPoint().

◆ m_orientation

int LIB_PIN::m_orientation

protected

Definition at line 328 of file lib_pin.h.

Referenced by ChangeLength(), compare(), GetMsgPanelInfo(), GetOrientation(), GetPinRoot(), MirrorHorizontal(), MirrorVertical(), operator<<(), PinDrawOrient(), Rotate(), and SetOrientation().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 478 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SYMBOL::SCH_SYMBOL(), SCH_FIELD::SetId(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PCB_SHAPE::swapData(), and PCB_BITMAP::swapData().

◆ m_position

VECTOR2I LIB_PIN::m_position

protected

Definition at line 326 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetPinRoot(), GetPosition(), MirrorHorizontal(), MirrorVertical(), MoveTo(), Offset(), operator<<(), Plot(), print(), Rotate(), and SetPosition().

◆ m_private

bool LIB_ITEM::m_private

protectedinherited

Private items are shown only in the Symbol Editor.

Definition at line 363 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::IsPrivate(), and LIB_ITEM::SetPrivate().

◆ m_shape

GRAPHIC_PINSHAPE LIB_PIN::m_shape

protected

Definition at line 329 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetItemDescription(), GetMsgPanelInfo(), GetShape(), operator<<(), PlotSymbol(), printPinSymbol(), and SetShape().

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

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

◆ m_type

ELECTRICAL_PINTYPE LIB_PIN::m_type

protected

Definition at line 330 of file lib_pin.h.

Referenced by compare(), GetCanonicalElectricalTypeName(), GetElectricalTypeName(), GetMenuImage(), GetMsgPanelInfo(), GetType(), operator<<(), PlotSymbol(), print(), printPinSymbol(), and SetType().

◆ m_unit

int LIB_ITEM::m_unit

protectedinherited

Unit identification for multiple parts per package.

Set to 0 if the item is common to all units.

Definition at line 352 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), LIB_ITEM::compare(), LIB_ITEM::GetMsgPanelInfo(), LIB_ITEM::GetUnit(), LIB_SYMBOL::PlotLibFields(), LIB_SYMBOL::PrintBackground(), LIB_ITEM::SetUnit(), and LIB_SYMBOL::SetUnitCount().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 475 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 158 of file view_item.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ LIB_CONVERT

Constructor & Destructor Documentation

◆ ~LIB_PIN()

◆ LIB_PIN() [1/2]

◆ LIB_PIN() [2/2]

Member Function Documentation

◆ BeginEdit()

◆ CalcEdit()

◆ ChangeLength()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ compare()

◆ ContinueEdit()

◆ EndEdit()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAlt()

◆ GetAlternates()

◆ GetBoundingBox() [1/2]

◆ GetBoundingBox() [2/2]

◆ GetCanonicalElectricalTypeName() [1/2]

◆ GetCanonicalElectricalTypeName() [2/2]

◆ GetClass()

◆ GetConvert()

◆ GetDefaultFont()

◆ GetEditFlags()

◆ GetEffectivePenWidth()

◆ GetElectricalTypeName()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetForcedTransparency()

◆ GetFriendlyName()

◆ GetItemDescription()

◆ GetLength()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetNameTextSize()

◆ GetNumber()

◆ GetNumberTextSize()

◆ GetOperatingPoint()

◆ GetOrientation()

◆ GetParent()

◆ GetPenWidth()

◆ GetPinRoot()

◆ GetPosition()

◆ GetShape()

◆ GetShownName()

◆ GetShownNumber()

◆ GetSortPosition()

◆ GetType()

◆ GetTypeDesc()

◆ GetTypeName()

◆ GetUnit()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsEntered()

◆ IsForceVisible()

◆ IsGlobalPower()

◆ IsModified()