#include <lib_pin.h>

Inheritance diagram for LIB_PIN:

Classes
struct	ALT

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)

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	IsPowerConnection () const
	Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN. 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	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. 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 ()
	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	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (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	ClearViewPrivData ()

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

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_FLAGS	m_status

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

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.

 {
 UNIT = 0x01,
 EQUALITY = 0x02,
 ERC = 0x04
 };

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 70 of file lib_item.h.

70: int { BASE = 1, DEMORGAN = 2 };

LIB_ITEM::BASE

@ BASE

Definition: lib_item.h:70

LIB_ITEM::DEMORGAN

@ DEMORGAN

Definition: lib_item.h:70

Constructor & Destructor Documentation

◆ ~LIB_PIN()

LIB_PIN::~LIB_PIN ( )

inline

Definition at line 62 of file lib_pin.h.

62{ }

◆ LIB_PIN() [1/2]

LIB_PIN::LIB_PIN ( LIB_SYMBOL * aParent )

Definition at line 97 of file lib_pin.cpp.

 :
 LIB_ITEM( LIB_PIN_T, aParent ),
 m_orientation( PIN_RIGHT ),
 m_shape( GRAPHIC_PINSHAPE::LINE ),
 m_type( ELECTRICAL_PINTYPE::PT_UNSPECIFIED ),
 m_attributes( 0 )
{
 // Use the application settings for pin sizes if exists.
 // pgm can be nullptr when running a shared lib from a script, not from a kicad appl
 PGM_BASE* pgm = PgmOrNull();
 
 if( pgm )
 {
 auto* settings = pgm->GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>();
 m_length = schIUScale.MilsToIU( settings->m_Defaults.pin_length );
 m_numTextSize = schIUScale.MilsToIU( settings->m_Defaults.pin_num_size );
 m_nameTextSize = schIUScale.MilsToIU( settings->m_Defaults.pin_name_size );
 }
 else // Use hardcoded eeschema defaults: symbol_editor settings are not existing.
 {
 m_length = schIUScale.MilsToIU( DEFAULT_PIN_LENGTH );
 m_numTextSize = schIUScale.MilsToIU( DEFAULT_PINNUM_SIZE );
 m_nameTextSize = schIUScale.MilsToIU( DEFAULT_PINNAME_SIZE );
 }
}

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

Referenced by Clone().

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

 :
 LIB_ITEM( LIB_PIN_T, aParent ),
 m_position( aPos ),
 m_length( aLength ),
 m_orientation( aOrientation ),
 m_shape( GRAPHIC_PINSHAPE::LINE ),
 m_type( aPinType ),
 m_attributes( 0 ),
 m_numTextSize( aNumTextSize ),
 m_nameTextSize( aNameTextSize )
{
 SetName( aName );
 SetNumber( aNumber );
 SetUnit( aUnit );
 SetConvert( aConvert );
}

References LINE, 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 104 of file lib_item.h.

104{}

◆ 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 1379 of file lib_pin.cpp.

{
 if( IsMoving() )
 MoveTo( aPosition );
}

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 1026 of file lib_pin.cpp.

{
 int lengthChange = m_length - aLength;
 int offsetX = 0;
 int offsetY = 0;
 
 switch( m_orientation )
 {
 case PIN_RIGHT:
 offsetX = lengthChange;
 break;
 case PIN_LEFT:
 offsetX = -1 * lengthChange;
 break;
 case PIN_UP:
 offsetY = lengthChange;
 break;
 case PIN_DOWN:
 offsetY = -1 * lengthChange;
 break;
 }
 
 wxPoint offset = wxPoint( offsetX, offsetY );
 Offset( offset );
 
 m_length = aLength;
}

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

Referenced by DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), 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 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:500

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), 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(), 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(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), 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 155 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ 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 943 of file lib_pin.cpp.

{
 return new LIB_PIN( *this );
}

References LIB_PIN().

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 949 of file lib_pin.cpp.

{
 wxASSERT( aOther.Type() == LIB_PIN_T );
 
 int retv = LIB_ITEM::compare( aOther, aCompareFlags );
 
 if( retv )
 return retv;
 
 const LIB_PIN* tmp = (LIB_PIN*) &aOther;
 
 // When comparing units, we do not compare the part numbers. If everything else is
 // identical, then we can just renumber the parts for the inherited symbol.
 if( !( aCompareFlags & COMPARE_FLAGS::UNIT ) && m_number != tmp->m_number )
 return m_number.Cmp( tmp->m_number );
 
 int result = m_name.Cmp( tmp->m_name );
 
 if( result )
 return result;
 
 if( m_position.x != tmp->m_position.x )
 return m_position.x - tmp->m_position.x;
 
 if( m_position.y != tmp->m_position.y )
 return m_position.y - tmp->m_position.y;
 
 if( m_length != tmp->m_length )
 return m_length - tmp->m_length;
 
 if( m_orientation != tmp->m_orientation )
 return m_orientation - tmp->m_orientation;
 
 if( m_shape != tmp->m_shape )
 return static_cast<int>( m_shape ) - static_cast<int>( tmp->m_shape );
 
 if( m_type != tmp->m_type )
 return static_cast<int>( m_type ) - static_cast<int>( tmp->m_type );
 
 if( m_attributes != tmp->m_attributes )
 return m_attributes - tmp->m_attributes;
 
 if( m_numTextSize != tmp->m_numTextSize )
 return m_numTextSize - tmp->m_numTextSize;
 
 if( m_nameTextSize != tmp->m_nameTextSize )
 return m_nameTextSize - tmp->m_nameTextSize;
 
 if( m_alternates.size() != tmp->m_alternates.size() )
 return m_alternates.size() - tmp->m_alternates.size();
 
 auto lhsItem = m_alternates.begin();
 auto rhsItem = tmp->m_alternates.begin();
 
 while( lhsItem != m_alternates.end() )
 {
 const ALT& lhsAlt = lhsItem->second;
 const ALT& rhsAlt = rhsItem->second;
 
 retv = lhsAlt.m_Name.Cmp( rhsAlt.m_Name );
 
 if( retv )
 return retv;
 
 if( lhsAlt.m_Type != rhsAlt.m_Type )
 return static_cast<int>( lhsAlt.m_Type ) - static_cast<int>( rhsAlt.m_Type );
 
 if( lhsAlt.m_Shape != rhsAlt.m_Shape )
 return static_cast<int>( lhsAlt.m_Shape ) - static_cast<int>( rhsAlt.m_Shape );
 
 ++lhsItem;
 ++rhsItem;
 }
 
 return 0;
}

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(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ 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 116 of file lib_item.h.

116{ return false; }

◆ EndEdit()

virtual void LIB_ITEM::EndEdit ( )

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 123 of file lib_item.h.

123{}

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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 140 of file lib_pin.h.

140{ return m_alternates[ aAlt ]; }

References m_alternates.

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

◆ GetAlternates()

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

inline

Definition at line 138 of file lib_pin.h.

138{ return m_alternates; }

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 184 of file lib_pin.h.

184{ return GetBoundingBox( false, true, false ); }

LIB_PIN::GetBoundingBox

const BOX2I GetBoundingBox() const override

Definition: lib_pin.h:184

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 1183 of file lib_pin.cpp.

{
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 KIFONT::FONT* font = KIFONT::FONT::GetFont( cfg->m_Appearance.default_font );
 
 BOX2I bbox;
 VECTOR2I begin;
 VECTOR2I end;
 int nameTextOffset = 0;
 int nameTextLength = 0;
 int nameTextHeight = 0;
 int numberTextLength = 0;
 int numberTextHeight = 0;
 int typeTextLength = 0;
 wxString name = GetShownName();
 wxString number = GetShownNumber();
 bool includeName = aIncludeNameAndNumber && !name.IsEmpty();
 bool includeNumber = aIncludeNameAndNumber && !number.IsEmpty();
 bool includeType = aIncludeElectricalType;
 int minsizeV = TARGET_PIN_RADIUS;
 int penWidth = GetPenWidth();
 
 if( !aIncludeInvisiblePins && !IsVisible() )
 {
 includeName = false;
 includeType = false;
 }
 
 if( GetParent() )
 {
 if( GetParent()->ShowPinNames() )
 nameTextOffset = GetParent()->GetPinNameOffset();
 else
 includeName = false;
 
 if( !GetParent()->ShowPinNumbers() )
 includeNumber = false;
 }
 
 if( includeNumber )
 {
 VECTOR2D fontSize( m_numTextSize, m_numTextSize );
 VECTOR2I numSize = font->StringBoundaryLimits( number, fontSize, penWidth, false, false );
 
 numberTextLength = numSize.x;
 numberTextHeight = numSize.y;
 }
 
 if( includeName )
 {
 VECTOR2D fontSize( m_nameTextSize, m_nameTextSize );
 VECTOR2I nameSize = font->StringBoundaryLimits( name, fontSize, penWidth, false, false );
 
 nameTextLength = nameSize.x + nameTextOffset;
 nameTextHeight = nameSize.y + schIUScale.MilsToIU( PIN_TEXT_MARGIN );
 }
 
 if( includeType )
 {
 double fontSize = std::max( m_nameTextSize * 3 / 4, schIUScale.mmToIU( 0.7 ) );
 VECTOR2I typeTextSize = font->StringBoundaryLimits( GetElectricalTypeName(),
 VECTOR2D( fontSize, fontSize ),
 fontSize / 8.0, false, false );
 
 typeTextLength = typeTextSize.x + schIUScale.MilsToIU( PIN_TEXT_MARGIN ) + TARGET_PIN_RADIUS;
 minsizeV = std::max( minsizeV, typeTextSize.y / 2 );
 }
 
 // First, calculate boundary box corners position
 if( m_shape == GRAPHIC_PINSHAPE::INVERTED || m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK )
 minsizeV = std::max( TARGET_PIN_RADIUS, externalPinDecoSize( nullptr, *this ) );
 
 // calculate top left corner position
 // for the default pin orientation (PIN_RIGHT)
 begin.y = std::max( minsizeV, numberTextHeight + schIUScale.MilsToIU( PIN_TEXT_MARGIN ) );
 begin.x = std::min( -typeTextLength, m_length - ( numberTextLength / 2) );
 
 // calculate bottom right corner position and adjust top left corner position
 if( nameTextOffset ) // for values > 0, pin name is inside the body
 {
 end.x = m_length + nameTextLength;
 end.y = std::min( -minsizeV, -nameTextHeight / 2 );
 }
 else // if value == 0:
 // pin name is outside the body, and above the pin line
 // pin num is below the pin line
 {
 end.x = std::max( m_length, nameTextLength );
 end.y = -begin.y;
 begin.y = std::max( minsizeV, nameTextHeight );
 }
 
 // Now, calculate boundary box corners position for the actual pin orientation
 int orient = PinDrawOrient( DefaultTransform );
 
 /* Calculate the pin position */
 switch( orient )
 {
 case PIN_UP:
 // Pin is rotated and texts positions are mirrored
 RotatePoint( begin, VECTOR2I( 0, 0 ), -ANGLE_90 );
 RotatePoint( end, VECTOR2I( 0, 0 ), -ANGLE_90 );
 break;
 
 case PIN_DOWN:
 RotatePoint( begin, VECTOR2I( 0, 0 ), ANGLE_90 );
 RotatePoint( end, VECTOR2I( 0, 0 ), ANGLE_90 );
 begin.x = -begin.x;
 end.x = -end.x;
 break;
 
 case PIN_LEFT:
 begin.x = -begin.x;
 end.x = -end.x;
 break;
 
 case PIN_RIGHT:
 break;
 }
 
 begin += m_position;
 end += m_position;
 
 bbox.SetOrigin( begin );
 bbox.SetEnd( end );
 bbox.Normalize();
 bbox.Inflate( ( GetPenWidth() / 2 ) + 1 );
 
 // Draw Y axis is reversed in schematic:
 bbox.RevertYAxis();
 
 return bbox;
}

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(), INVERTED, INVERTED_CLOCK, IsVisible(), EESCHEMA_SETTINGS::m_Appearance, m_length, m_nameTextSize, m_numTextSize, m_position, m_shape, EDA_IU_SCALE::MilsToIU(), EDA_IU_SCALE::mmToIU(), name, 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, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetCanonicalElectricalTypeName() [1/2]

wxString const LIB_PIN::GetCanonicalElectricalTypeName ( ) const

inline

Definition at line 93 of file lib_pin.h.

 {
 return GetCanonicalElectricalTypeName( m_type );
 }

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.

{
 // These strings are the canonical name of the electrictal type
 // Not translated, no space in name, only ASCII chars.
 // to use when the string name must be known and well defined
 // must have same order than enum ELECTRICAL_PINTYPE (see lib_pin.h)
 static const wxChar* msgPinElectricType[] =
 {
 wxT( "input" ),
 wxT( "output" ),
 wxT( "bidirectional" ),
 wxT( "tri_state" ),
 wxT( "passive" ),
 wxT( "free" ),
 wxT( "unspecified" ),
 wxT( "power_in" ),
 wxT( "power_out" ),
 wxT( "open_collector" ),
 wxT( "open_emitter" ),
 wxT( "no_connect" )
 };
 
 return msgPinElectricType[static_cast<int>( aType )];
}

◆ GetClass()

wxString LIB_PIN::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 64 of file lib_pin.h.

 {
 return wxT( "LIB_PIN" );
 }

◆ GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 276 of file lib_item.h.

276{ return m_convert; }

LIB_ITEM::m_convert

int m_convert

Shape identification for alternate body styles.

Definition: lib_item.h:333

References LIB_ITEM::m_convert.

Referenced by 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 128 of file lib_item.cpp.

{
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 
 return cfg->m_Appearance.default_font;
}

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

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_CHANGED | IS_WIRE_IMAGE | STRUCT_DELETED );
 
 return m_flags & mask;
 }

References IS_CHANGED, IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectivePenWidth()

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

inlinevirtualinherited

Definition at line 155 of file lib_item.h.

 {
 // For historical reasons, a stored value of 0 means "default width" and negative
 // numbers meant "don't stroke".
 
 if( GetPenWidth() < 0 )
 return 0;
 else if( GetPenWidth() == 0 )
 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }

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 98 of file lib_pin.h.

 {
 return ElectricalPinTypeGetText( m_type );
 }

References ElectricalPinTypeGetText(), and m_type.

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), 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 258 of file eda_item.h.

258{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::update().

◆ GetLength()

int LIB_PIN::GetLength ( ) const

inline

Definition at line 80 of file lib_pin.h.

80{ return m_length; }

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 1319 of file lib_pin.cpp.

{
 return ElectricalPinTypeGetBitmap( m_type );
}

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 1141 of file lib_pin.cpp.

{
 LIB_ITEM::GetMsgPanelInfo( aFrame, aList );
 
 aList.emplace_back( _( "Name" ), UnescapeString( GetShownName() ) );
 aList.emplace_back( _( "Number" ), GetShownNumber() );
 aList.emplace_back( _( "Type" ), ElectricalPinTypeGetText( m_type ) );
 aList.emplace_back( _( "Style" ), PinShapeGetText( m_shape ) );
 
 aList.emplace_back( _( "Style" ), IsVisible() ? _( "Yes" ) : _( "No" ) );
 
 // Display pin length
 aList.emplace_back( _( "Length" ), aFrame->MessageTextFromValue( m_length, true ) );
 
 int i = PinOrientationIndex( m_orientation );
 aList.emplace_back( _( "Orientation" ), PinOrientationName( (unsigned) i ) );
 
 VECTOR2I pinpos = GetPosition();
 pinpos.y = -pinpos.y; // Display coords are top to bottom; lib item coords are bottom to top
 
 aList.emplace_back( _( "Pos X" ), aFrame->MessageTextFromValue( pinpos.x, true ) );
 aList.emplace_back( _( "Pos Y" ), aFrame->MessageTextFromValue( pinpos.y, true ) );
}

References _, ElectricalPinTypeGetText(), 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 ( void ) const

inline

Definition at line 112 of file lib_pin.h.

112{ return m_name; }

References m_name.

Referenced by SCH_PIN_TABLE_DATA_MODEL::BuildAttrs(), 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 132 of file lib_pin.h.

132{ return m_nameTextSize; }

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 122 of file lib_pin.h.

122{ return m_number; }

References m_number.

Referenced by 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 135 of file lib_pin.h.

135{ return m_numTextSize; }

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

◆ GetOrientation()

int LIB_PIN::GetOrientation ( ) const

inline

Definition at line 74 of file lib_pin.h.

74{ return m_orientation; }

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

inlineinherited

Definition at line 168 of file lib_item.h.

 {
 return (LIB_SYMBOL*) m_parent;
 }

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(), IsPowerConnection(), Plot(), print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_FIELD_PROPERTIES::UpdateField().

◆ GetPenWidth()

int LIB_PIN::GetPenWidth ( ) const

overridevirtual

Implements LIB_ITEM.

Definition at line 169 of file lib_pin.cpp.

{
 return 0;
}

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

◆ GetPinRoot()

VECTOR2I LIB_PIN::GetPinRoot ( ) const

Definition at line 184 of file lib_pin.cpp.

{
 switch( m_orientation )
 {
 default:
 case PIN_RIGHT: return VECTOR2I( m_position.x + m_length, -( m_position.y ) );
 case PIN_LEFT: return VECTOR2I( m_position.x - m_length, -( m_position.y ) );
 case PIN_UP: return VECTOR2I( m_position.x, -( m_position.y + m_length ) );
 case PIN_DOWN: return VECTOR2I( m_position.x, -( m_position.y - m_length ) );
 }
}

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 222 of file lib_pin.h.

222{ return m_position; }

References m_position.

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

◆ GetSelectMenuText()

wxString LIB_PIN::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1325 of file lib_pin.cpp.

{
 if( IsVisible() )
 {
 if( !m_name.IsEmpty() )
 {
 return wxString::Format( _( "Pin %s [%s, %s, %s]" ),
 GetShownNumber(),
 UnescapeString( GetShownName() ),
 GetElectricalTypeName(),
 PinShapeGetText( m_shape ) );
 }
 else
 {
 return wxString::Format( _( "Pin %s [%s, %s]" ),
 GetShownNumber(),
 GetElectricalTypeName(),
 PinShapeGetText( m_shape ) );
 }
 }
 else
 {
 if( !m_name.IsEmpty() )
 {
 return wxString::Format( _( "Hidden pin %s [%s, %s, %s]" ),
 GetShownNumber(),
 UnescapeString( GetShownName() ),
 GetElectricalTypeName(),
 PinShapeGetText( m_shape ) );
 }
 else
 {
 return wxString::Format( _( "Hidden pin %s [%s, %s]" ),
 GetShownNumber(),
 GetElectricalTypeName(),
 PinShapeGetText( m_shape ) );
 }
 }
}

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

Referenced by SCH_PIN::GetSelectMenuText().

◆ GetShape()

GRAPHIC_PINSHAPE LIB_PIN::GetShape ( ) const

inline

Definition at line 77 of file lib_pin.h.

77{ return m_shape; }

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.

{
 if( m_name == wxS( "~" ) )
 return wxEmptyString;
 else
 return m_name;
}

References m_name.

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

◆ GetShownNumber()

wxString LIB_PIN::GetShownNumber ( ) const

inline

Definition at line 123 of file lib_pin.h.

123{ return m_number; }

References m_number.

Referenced by KIGFX::SCH_PAINTER::draw(), GetBoundingBox(), SCH_PIN::GetDefaultNetName(), GetMsgPanelInfo(), GetSelectMenuText(), 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 267 of file eda_item.h.

267{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetType()

ELECTRICAL_PINTYPE LIB_PIN::GetType ( ) const

inline

Definition at line 90 of file lib_pin.h.

90{ return m_type; }

References m_type.

Referenced by SCH_PIN::ConnectionPropagatesTo(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetType(), IsPowerConnection(), 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.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

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 69 of file lib_pin.h.

 {
 return _( "Pin" );
 }

References _.

◆ GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 273 of file lib_item.h.

273{ return m_unit; }

LIB_ITEM::m_unit

int m_unit

Unit identification for multiple parts per package.

Definition: lib_item.h:327

References LIB_ITEM::m_unit.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), 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

Definition at line 145 of file eda_item.h.

145{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

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

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;
 
 BOX2I sel = aRect;
 
 if ( aAccuracy )
 sel.Inflate( aAccuracy );
 
 if( aContained )
 return sel.Contains( GetBoundingBox( false, false, false ) );
 
 return sel.Intersects( GetBoundingBox( false, true, m_flags & SHOW_ELEC_TYPE ) );
}

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.

{
 BOX2I rect = GetBoundingBox( false, true, m_flags & SHOW_ELEC_TYPE );
 
 return rect.Inflate( aAccuracy ).Contains( aPosition );
}

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

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:499

References EDA_ITEM::m_forceVisible.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

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.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), 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.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), 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(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsPowerConnection()

bool LIB_PIN::IsPowerConnection ( ) const

inline

Return whether this pin forms an implicit power connection: i.e., is hidden and of type POWER_IN.

Definition at line 197 of file lib_pin.h.

 {
 return GetType() == ELECTRICAL_PINTYPE::PT_POWER_IN
 && ( !IsVisible() || (LIB_SYMBOL*) GetParent()->IsPower() );
 }

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

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_PIN::GetDefaultNetName(), and SCH_PIN::IsPowerConnection().

◆ IsPrivate()

bool LIB_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 279 of file lib_item.h.

279{ return m_private; }

LIB_ITEM::m_private

bool m_private

Private items are shown only in the Symbol Editor.

Definition: lib_item.h:338

References LIB_ITEM::m_private.

Referenced by LIB_ITEM::compare(), KIGFX::SCH_PAINTER::draw(), LIB_ITEM::GetMsgPanelInfo(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), LIB_SHAPE::ViewGetLayers(), LIB_TEXT::ViewGetLayers(), and LIB_TEXTBOX::ViewGetLayers().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns: True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 422 of file eda_item.h.

422{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

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

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

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, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 183 of file eda_item.h.

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

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(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::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_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IsVisible()

bool LIB_PIN::IsVisible ( ) const

inline

Definition at line 103 of file lib_pin.h.

103{ return ( m_attributes & PIN_INVISIBLE ) == 0; }

PIN_INVISIBLE

#define PIN_INVISIBLE

Definition: lib_pin.h:38

References m_attributes, and PIN_INVISIBLE.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

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

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and 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 324 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and 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, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 384 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_EDITOR_CONTROL::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(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_EDITOR_CONTROL::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 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
  if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

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

◆ 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 1070 of file lib_pin.cpp.

{
 m_position.x -= aCenter.x;
 m_position.x *= -1;
 m_position.x += aCenter.x;
 
 if( m_orientation == PIN_RIGHT )
 m_orientation = PIN_LEFT;
 else if( m_orientation == PIN_LEFT )
 m_orientation = PIN_RIGHT;
}

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 1083 of file lib_pin.cpp.

{
 m_position.y -= aCenter.y;
 m_position.y *= -1;
 m_position.y += aCenter.y;
 
 if( m_orientation == PIN_UP )
 m_orientation = PIN_DOWN;
 else if( m_orientation == PIN_DOWN )
 m_orientation = PIN_UP;
}

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 1060 of file lib_pin.cpp.

{
 if( m_position != aNewPosition )
 {
 m_position = aNewPosition;
 SetModified();
 }
}

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 1054 of file lib_pin.cpp.

{
 m_position += aOffset;
}

References m_position.

Referenced by ChangeLength().

◆ operator<() [1/2]

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 231 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );
 
 return false;
}

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

◆ operator<() [2/2]

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 102 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return Type() < aOther.Type();
 
 return ( compare( aOther ) < 0 );
}

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

◆ operator==() [1/2]

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 93 of file lib_item.cpp.

{
 if( Type() != aOther.Type() )
 return false;
 
 return compare( aOther, LIB_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
}

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

◆ operator==() [2/2]

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

inlineinherited

Definition at line 207 of file lib_item.h.

 {
 return *this == *aOther;
 }

◆ 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 909 of file lib_pin.cpp.

{
 int orient;
 VECTOR2I end; // position of pin end starting at 0,0 according to its orientation, length = 1
 
 switch( m_orientation )
 {
 case PIN_UP: end.y = 1; break;
 case PIN_DOWN: end.y = -1; break;
 case PIN_LEFT: end.x = -1; break;
 case PIN_RIGHT: end.x = 1; break;
 }
 
 // = pos of end point, according to the symbol orientation.
 end = aTransform.TransformCoordinate( end );
 orient = PIN_UP;
 
 if( end.x == 0 )
 {
 if( end.y > 0 )
 orient = PIN_DOWN;
 }
 else
 {
 orient = PIN_RIGHT;
 
 if( end.x < 0 )
 orient = PIN_LEFT;
 }
 
 return orient;
}

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 1125 of file lib_pin.cpp.

{
 if( !IsVisible() || aBackground )
 return;
 
 int orient = PinDrawOrient( aTransform );
 VECTOR2I pos = aTransform.TransformCoordinate( m_position ) + aOffset;
 
 PlotSymbol( aPlotter, pos, orient, aDimmed );
 PlotPinTexts( aPlotter, pos, orient, GetParent()->GetPinNameOffset(),
 GetParent()->ShowPinNumbers(), GetParent()->ShowPinNames(),
 aDimmed );
}

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 744 of file lib_pin.cpp.

{
 RENDER_SETTINGS* settings = aPlotter->RenderSettings();
 KIFONT::FONT* font = KIFONT::FONT::GetFont( settings->GetDefaultFont(), false, false );
 wxString name = GetShownName();
 wxString number = GetShownNumber();
 
 if( name.IsEmpty() || m_nameTextSize == 0 )
 aDrawPinName = false;
 
 if( number.IsEmpty() || m_numTextSize == 0 )
 aDrawPinNum = false;
 
 if( !aDrawPinNum && !aDrawPinName )
 return;
 
 int x, y;
 int namePenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_nameTextSize, true ),
 settings->GetDefaultPenWidth() );
 int numPenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_numTextSize, true ),
 settings->GetDefaultPenWidth() );
 int name_offset = schIUScale.MilsToIU( PIN_TEXT_MARGIN ) + namePenWidth;
 int num_offset = schIUScale.MilsToIU( PIN_TEXT_MARGIN ) + numPenWidth;
 
 /* Get the num and name colors */
 COLOR4D nameColor = settings->GetLayerColor( LAYER_PINNAM );
 COLOR4D numColor = settings->GetLayerColor( LAYER_PINNUM );
 COLOR4D bg = settings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
 bg = COLOR4D::WHITE;
 
 if( aDimmed )
 {
 nameColor = nameColor.Mix( bg, 0.5f );
 numColor = numColor.Mix( bg, 0.5f );
 }
 
 int x1 = aPinPos.x;
 int y1 = aPinPos.y;
 
 switch( aPinOrient )
 {
 case PIN_UP: y1 -= m_length; break;
 case PIN_DOWN: y1 += m_length; break;
 case PIN_LEFT: x1 -= m_length; break;
 case PIN_RIGHT: x1 += m_length; break;
 }
 
 auto plotText =
 [&]( int px, int py, const COLOR4D& color, const wxString& text, const EDA_ANGLE& angle,
 int size, GR_TEXT_H_ALIGN_T hJustify, GR_TEXT_V_ALIGN_T vJustify, int penWidth )
 
 {
 aPlotter->Text( VECTOR2I( px, py ), color, text, angle, VECTOR2I( size, size ),
 hJustify, vJustify, penWidth, false, false, false, font );
 };
 
 /* Draw the text inside, but the pin numbers outside. */
 if( aTextInside )
 {
 if( ( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) ) /* Its an horizontal line. */
 {
 if( aDrawPinName )
 {
 GR_TEXT_H_ALIGN_T hjustify;
 if( aPinOrient == PIN_RIGHT )
 {
 x = x1 + aTextInside;
 hjustify = GR_TEXT_H_ALIGN_LEFT;
 }
 else // orient == PIN_LEFT
 {
 x = x1 - aTextInside;
 hjustify = GR_TEXT_H_ALIGN_RIGHT;
 }
 
 plotText( x, y1, nameColor, name, ANGLE_HORIZONTAL, m_nameTextSize, hjustify,
 GR_TEXT_V_ALIGN_CENTER, namePenWidth );
 }
 
 if( aDrawPinNum )
 {
 plotText( ( x1 + aPinPos.x) / 2, y1 - num_offset, numColor, number,
 ANGLE_HORIZONTAL, m_numTextSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth );
 }
 }
 else /* Its a vertical line. */
 {
 if( aPinOrient == PIN_DOWN )
 {
 y = y1 + aTextInside;
 
 if( aDrawPinName )
 {
 plotText( x1, y, nameColor, name, ANGLE_VERTICAL, m_nameTextSize,
 GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_CENTER, namePenWidth );
 }
 
 if( aDrawPinNum )
 {
 plotText( x1 - num_offset, ( y1 + aPinPos.y) / 2, numColor, number,
 ANGLE_VERTICAL, m_numTextSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth );
 }
 }
 else /* PIN_UP */
 {
 y = y1 - aTextInside;
 
 if( aDrawPinName )
 {
 plotText( x1, y, nameColor, name, ANGLE_VERTICAL, m_nameTextSize,
 GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, namePenWidth );
 }
 
 if( aDrawPinNum )
 {
 plotText( x1 - num_offset, ( y1 + aPinPos.y) / 2, numColor, number,
 ANGLE_VERTICAL, m_numTextSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth );
 }
 }
 }
 }
 else /* Draw num & text pin outside */
 {
 if(( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) )
 {
 /* Its an horizontal line. */
 if( aDrawPinName )
 {
 x = ( x1 + aPinPos.x) / 2;
 plotText( x, y1 - name_offset, nameColor, name, ANGLE_HORIZONTAL, m_nameTextSize,
 GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_BOTTOM, namePenWidth );
 }
 
 if( aDrawPinNum )
 {
 x = ( x1 + aPinPos.x ) / 2;
 plotText( x, y1 + num_offset, numColor, number, ANGLE_HORIZONTAL, m_numTextSize,
 GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, numPenWidth );
 }
 }
 else /* Its a vertical line. */
 {
 if( aDrawPinName )
 {
 y = ( y1 + aPinPos.y ) / 2;
 plotText( x1 - name_offset, y, nameColor, name, ANGLE_VERTICAL, m_nameTextSize,
 GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_BOTTOM, namePenWidth );
 }
 
 if( aDrawPinNum )
 {
 plotText( x1 + num_offset, ( y1 + aPinPos.y ) / 2, numColor, number, ANGLE_VERTICAL,
 m_numTextSize, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, numPenWidth );
 }
 }
 }
}

References PNS::angle(), ANGLE_HORIZONTAL, ANGLE_VERTICAL, Clamp_Text_PenSize(), color, 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, 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, PLOTTER::RenderSettings(), schIUScale, text, PLOTTER::Text(), WHITE, 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

Definition at line 604 of file lib_pin.cpp.

{
 int MapX1, MapY1, x1, y1;
 COLOR4D color = aPlotter->RenderSettings()->GetLayerColor( LAYER_PIN );
 COLOR4D bg = aPlotter->RenderSettings()->GetBackgroundColor();
 int penWidth = GetEffectivePenWidth( aPlotter->RenderSettings() );
 
 if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
 bg = COLOR4D::WHITE;
 
 if( aDimmed )
 color = color.Mix( bg, 0.5f );
 
 aPlotter->SetColor( color );
 aPlotter->SetCurrentLineWidth( penWidth );
 
 MapX1 = MapY1 = 0;
 x1 = aPosition.x; y1 = aPosition.y;
 
 switch( aOrientation )
 {
 case PIN_UP: y1 = aPosition.y - m_length; MapY1 = 1; break;
 case PIN_DOWN: y1 = aPosition.y + m_length; MapY1 = -1; break;
 case PIN_LEFT: x1 = aPosition.x - m_length; MapX1 = 1; break;
 case PIN_RIGHT: x1 = aPosition.x + m_length; MapX1 = -1; break;
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::INVERTED || m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK )
 {
 const int radius = externalPinDecoSize( aPlotter->RenderSettings(), *this );
 aPlotter->Circle( VECTOR2I( MapX1 * radius + x1, MapY1 * radius + y1 ), radius * 2,
 FILL_T::NO_FILL, penWidth );
 
 aPlotter->MoveTo( VECTOR2I( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 ) );
 aPlotter->FinishTo( aPosition );
 }
 else if( m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK )
 {
 const int deco_size = internalPinDecoSize( aPlotter->RenderSettings(), *this );
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 aPlotter->MoveTo( VECTOR2I( x1, y1 + deco_size ) );
 aPlotter->LineTo( VECTOR2I( x1 + MapX1 * deco_size * 2, y1 ) );
 aPlotter->FinishTo( VECTOR2I( x1, y1 - deco_size ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( VECTOR2I( x1 + deco_size, y1 ) );
 aPlotter->LineTo( VECTOR2I( x1, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( VECTOR2I( x1 - deco_size, y1 ) );
 }
 
 aPlotter->MoveTo( VECTOR2I( MapX1 * deco_size * 2 + x1, MapY1 * deco_size * 2 + y1 ) );
 aPlotter->FinishTo( aPosition );
 }
 else
 {
 aPlotter->MoveTo( VECTOR2I( x1, y1 ) );
 aPlotter->FinishTo( aPosition );
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::CLOCK
 || m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK
 || m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
 {
 const int deco_size = internalPinDecoSize( aPlotter->RenderSettings(), *this );
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 aPlotter->MoveTo( VECTOR2I( x1, y1 + deco_size ) );
 aPlotter->LineTo( VECTOR2I( x1 - MapX1 * deco_size * 2, y1 ) );
 aPlotter->FinishTo( VECTOR2I( x1, y1 - deco_size ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( VECTOR2I( x1 + deco_size, y1 ) );
 aPlotter->LineTo( VECTOR2I( x1, y1 - MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( VECTOR2I( x1 - deco_size, y1 ) );
 }
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::INPUT_LOW
 || m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW ) /* IEEE symbol "Active Low Input" */
 {
 const int deco_size = externalPinDecoSize( aPlotter->RenderSettings(), *this );
 
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 aPlotter->MoveTo( VECTOR2I( x1 + MapX1 * deco_size * 2, y1 ) );
 aPlotter->LineTo( VECTOR2I( x1 + MapX1 * deco_size * 2, y1 - deco_size * 2 ) );
 aPlotter->FinishTo( VECTOR2I( x1, y1 ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( VECTOR2I( x1, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->LineTo( VECTOR2I( x1 - deco_size * 2, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( VECTOR2I( x1, y1 ) );
 }
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW ) /* IEEE symbol "Active Low Output" */
 {
 const int symbol_size = externalPinDecoSize( aPlotter->RenderSettings(), *this );
 
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 aPlotter->MoveTo( VECTOR2I( x1, y1 - symbol_size * 2 ) );
 aPlotter->FinishTo( VECTOR2I( x1 + MapX1 * symbol_size * 2, y1 ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( VECTOR2I( x1 - symbol_size * 2, y1 ) );
 aPlotter->FinishTo( VECTOR2I( x1, y1 + MapY1 * symbol_size * 2 ) );
 }
 }
 else if( m_shape == GRAPHIC_PINSHAPE::NONLOGIC ) /* NonLogic pin symbol */
 {
 const int deco_size = externalPinDecoSize( aPlotter->RenderSettings(), *this );
 aPlotter->MoveTo( VECTOR2I( x1 - ( MapX1 + MapY1 ) * deco_size,
 y1 - ( MapY1 - MapX1 ) * deco_size ) );
 aPlotter->FinishTo( VECTOR2I( x1 + ( MapX1 + MapY1 ) * deco_size,
 y1 + ( MapY1 - MapX1 ) * deco_size ) );
 aPlotter->MoveTo( VECTOR2I( x1 - ( MapX1 - MapY1 ) * deco_size,
 y1 - ( MapY1 + MapX1 ) * deco_size ) );
 aPlotter->FinishTo( VECTOR2I( x1 + ( MapX1 - MapY1 ) * deco_size,
 y1 + ( MapY1 + MapX1 ) * deco_size ) );
 }
 
 if( m_type == ELECTRICAL_PINTYPE::PT_NC ) // Draw a N.C. symbol
 {
 const int deco_size = TARGET_PIN_RADIUS;
 const int ex1 = aPosition.x;
 const int ey1 = aPosition.y;
 aPlotter->MoveTo( VECTOR2I( ex1 - deco_size, ey1 - deco_size ) );
 aPlotter->FinishTo( VECTOR2I( ex1 + deco_size, ey1 + deco_size ) );
 aPlotter->MoveTo( VECTOR2I( ex1 + deco_size, ey1 - deco_size ) );
 aPlotter->FinishTo( VECTOR2I( ex1 - deco_size, ey1 + deco_size ) );
 }
}

References PLOTTER::Circle(), CLOCK, CLOCK_LOW, color, externalPinDecoSize(), FALLING_EDGE_CLOCK, PLOTTER::FinishTo(), KIGFX::RENDER_SETTINGS::GetBackgroundColor(), PLOTTER::GetColorMode(), LIB_ITEM::GetEffectivePenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), INPUT_LOW, internalPinDecoSize(), INVERTED, INVERTED_CLOCK, LAYER_PIN, PLOTTER::LineTo(), m_length, m_shape, m_type, PLOTTER::MoveTo(), NO_FILL, NONLOGIC, OUTPUT_LOW, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, PT_NC, PLOTTER::RenderSettings(), PLOTTER::SetColor(), PLOTTER::SetCurrentLineWidth(), TARGET_PIN_RADIUS, WHITE, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Plot().

◆ 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 136 of file lib_item.cpp.

{
 print( aSettings, aOffset, aData, aTransform, aDimmed );
}

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.

{
 LIB_SYMBOL_OPTIONS* opts = (LIB_SYMBOL_OPTIONS*) aData;
 bool drawHiddenFields = opts ? opts->draw_hidden_fields : false;
 bool showPinType = opts ? opts->show_elec_type : false;
 bool show_connect_point = opts ? opts->show_connect_point : false;
 
 LIB_SYMBOL* part = GetParent();
 
 wxCHECK( part && opts, /* void */ );
 
 /* Calculate pin orient taking in account the symbol orientation. */
 int orient = PinDrawOrient( aTransform );
 
 /* Calculate the pin position */
 VECTOR2I pos1 = aTransform.TransformCoordinate( m_position ) + aOffset;
 
 if( IsVisible() || drawHiddenFields )
 {
 printPinSymbol( aSettings, pos1, orient, aDimmed );
 
 printPinTexts( aSettings, pos1, orient, part->GetPinNameOffset(),
 opts->force_draw_pin_text || part->ShowPinNumbers(),
 opts->force_draw_pin_text || part->ShowPinNames(),
 aDimmed );
 
 if( showPinType )
 printPinElectricalTypeName( aSettings, pos1, orient, aDimmed );
 
 if( show_connect_point
 && m_type != ELECTRICAL_PINTYPE::PT_NC
 && m_type != ELECTRICAL_PINTYPE::PT_NIC )
 {
 wxDC* DC = aSettings->GetPrintDC();
 COLOR4D color = aSettings->GetLayerColor( IsVisible() ? LAYER_PIN : LAYER_HIDDEN );
 
 COLOR4D bg = aSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
 bg = COLOR4D::WHITE;
 
 if( aDimmed )
 color = color.Mix( bg, 0.5f );
 
 GRCircle( DC, pos1, TARGET_PIN_RADIUS, 0, color );
 }
 }
}

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(), PT_NC, PT_NIC, LIB_SYMBOL_OPTIONS::show_connect_point, LIB_SYMBOL_OPTIONS::show_elec_type, LIB_SYMBOL::ShowPinNames(), LIB_SYMBOL::ShowPinNumbers(), TARGET_PIN_RADIUS, TRANSFORM::TransformCoordinate(), and WHITE.

◆ 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 540 of file lib_pin.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 wxString typeName = GetElectricalTypeName();
 
 // Use a reasonable (small) size to draw the text
 int textSize = ( m_nameTextSize * 3 ) / 4;
 
 #define ETXT_MAX_SIZE schIUScale.mmToIU( 0.7 )
 
 if( textSize > ETXT_MAX_SIZE )
 textSize = ETXT_MAX_SIZE;
 
 // Use a reasonable pen size to draw the text
 int pensize = textSize/6;
 
 // Get a suitable color
 COLOR4D color = aSettings->GetLayerColor( IsVisible() ? LAYER_PRIVATE_NOTES : LAYER_HIDDEN );
 COLOR4D bg = aSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
 bg = COLOR4D::WHITE;
 
 if( !IsVisible() )
 bg = aSettings->GetLayerColor( LAYER_HIDDEN );
 
 if( aDimmed )
 color = color.Mix( bg, 0.5f );
 
 VECTOR2I txtpos = aPosition;
 int offset = schIUScale.mmToIU( 0.4 );
 GR_TEXT_H_ALIGN_T hjustify = GR_TEXT_H_ALIGN_LEFT;
 EDA_ANGLE orient = ANGLE_HORIZONTAL;
 KIFONT::FONT* font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), false, false );
 
 switch( aOrientation )
 {
 case PIN_UP:
 txtpos.y += offset;
 orient = ANGLE_VERTICAL;
 hjustify = GR_TEXT_H_ALIGN_RIGHT;
 break;
 
 case PIN_DOWN:
 txtpos.y -= offset;
 orient = ANGLE_VERTICAL;
 break;
 
 case PIN_LEFT:
 txtpos.x += offset;
 break;
 
 case PIN_RIGHT:
 txtpos.x -= offset;
 hjustify = GR_TEXT_H_ALIGN_RIGHT;
 break;
 }
 
 GRPrintText( DC, txtpos, color, typeName, orient, wxSize( textSize, textSize ), hjustify,
 GR_TEXT_V_ALIGN_CENTER, pensize, false, false, font );
}

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, WHITE, 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 248 of file lib_pin.cpp.

{
 wxDC* DC = aSettings->GetPrintDC();
 int MapX1, MapY1, x1, y1;
 int width = GetEffectivePenWidth( aSettings );
 int posX = aPos.x, posY = aPos.y, len = m_length;
 COLOR4D color = aSettings->GetLayerColor( IsVisible() ? LAYER_PIN : LAYER_HIDDEN );
 COLOR4D bg = aSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
 bg = COLOR4D::WHITE;
 
 if( !IsVisible() )
 bg = aSettings->GetLayerColor( LAYER_HIDDEN );
 
 if( aDimmed )
 color = color.Mix( bg, 0.5f );
 
 MapX1 = MapY1 = 0;
 x1 = posX;
 y1 = posY;
 
 switch( aOrient )
 {
 case PIN_UP: y1 = posY - len; MapY1 = 1; break;
 case PIN_DOWN: y1 = posY + len; MapY1 = -1; break;
 case PIN_LEFT: x1 = posX - len; MapX1 = 1; break;
 case PIN_RIGHT: x1 = posX + len; MapX1 = -1; break;
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::INVERTED || m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK )
 {
 const int radius = externalPinDecoSize( aSettings, *this );
 GRCircle( DC, VECTOR2I( MapX1 * radius + x1, MapY1 * radius + y1 ), radius, width, color );
 
 GRMoveTo( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 );
 GRLineTo( DC, posX, posY, width, color );
 }
 else
 {
 GRMoveTo( x1, y1 );
 GRLineTo( DC, posX, posY, width, color );
 }
 
 // Draw the clock shape (>)inside the symbol
 if( m_shape == GRAPHIC_PINSHAPE::CLOCK
 || m_shape == GRAPHIC_PINSHAPE::INVERTED_CLOCK
 || m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK
 || m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
 {
 const int clock_size = internalPinDecoSize( aSettings, *this );
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 GRMoveTo( x1, y1 + clock_size );
 GRLineTo( DC, x1 - MapX1 * clock_size * 2, y1, width, color );
 GRLineTo( DC, x1, y1 - clock_size, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1 + clock_size, y1 );
 GRLineTo( DC, x1, y1 - MapY1 * clock_size * 2, width, color );
 GRLineTo( DC, x1 - clock_size, y1, width, color );
 }
 }
 
 // Draw the active low (or H to L active transition)
 if( m_shape == GRAPHIC_PINSHAPE::INPUT_LOW
 || m_shape == GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK
 || m_shape == GRAPHIC_PINSHAPE::CLOCK_LOW )
 {
 const int deco_size = externalPinDecoSize( aSettings, *this );
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 GRMoveTo( x1 + MapX1 * deco_size * 2, y1 );
 GRLineTo( DC, x1 + MapX1 * deco_size * 2, y1 - deco_size * 2, width, color );
 GRLineTo( DC, x1, y1, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1, y1 + MapY1 * deco_size * 2 );
 GRLineTo( DC, x1 - deco_size * 2, y1 + MapY1 * deco_size * 2, width, color );
 GRLineTo( DC, x1, y1, width, color );
 }
 }
 
 if( m_shape == GRAPHIC_PINSHAPE::OUTPUT_LOW ) /* IEEE symbol "Active Low Output" */
 {
 const int deco_size = externalPinDecoSize( aSettings, *this );
 if( MapY1 == 0 ) /* MapX1 = +- 1 */
 {
 GRMoveTo( x1, y1 - deco_size * 2 );
 GRLineTo( DC, x1 + MapX1 * deco_size * 2, y1, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1 - deco_size * 2, y1 );
 GRLineTo( DC, x1, y1 + MapY1 * deco_size * 2, width, color );
 }
 }
 else if( m_shape == GRAPHIC_PINSHAPE::NONLOGIC ) /* NonLogic pin symbol */
 {
 const int deco_size = externalPinDecoSize( aSettings, *this );
 GRMoveTo( x1 - (MapX1 + MapY1) * deco_size, y1 - (MapY1 - MapX1) * deco_size );
 GRLineTo( DC, x1 + (MapX1 + MapY1) * deco_size, y1 + ( MapY1 - MapX1 ) * deco_size, width,
 color );
 GRMoveTo( x1 - (MapX1 - MapY1) * deco_size, y1 - (MapY1 + MapX1) * deco_size );
 GRLineTo( DC, x1 + (MapX1 - MapY1) * deco_size, y1 + ( MapY1 + MapX1 ) * deco_size, width,
 color );
 }
 
 if( m_type == ELECTRICAL_PINTYPE::PT_NC ) // Draw a N.C. symbol
 {
 const int deco_size = TARGET_PIN_RADIUS;
 GRLine( DC, posX - deco_size, posY - deco_size, posX + deco_size, posY + deco_size, width,
 color );
 GRLine( DC, posX + deco_size, posY - deco_size, posX - deco_size, posY + deco_size, width,
 color );
 }
}

References CLOCK, CLOCK_LOW, color, externalPinDecoSize(), FALLING_EDGE_CLOCK, KIGFX::RENDER_SETTINGS::GetBackgroundColor(), LIB_ITEM::GetEffectivePenWidth(), GetGRForceBlackPenState(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GRCircle(), GRLine(), GRLineTo(), GRMoveTo(), INPUT_LOW, internalPinDecoSize(), INVERTED, INVERTED_CLOCK, IsVisible(), LAYER_HIDDEN, LAYER_PIN, m_length, m_shape, m_type, NONLOGIC, OUTPUT_LOW, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, PT_NC, TARGET_PIN_RADIUS, WHITE, 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 369 of file lib_pin.cpp.

{
 if( !aDrawPinName && !aDrawPinNum )
 return;
 
 int x, y;
 wxDC* DC = aSettings->GetPrintDC();
 KIFONT::FONT* font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), false, false );
 
 wxSize pinNameSize( m_nameTextSize, m_nameTextSize );
 wxSize pinNumSize( m_numTextSize, m_numTextSize );
 
 int namePenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_nameTextSize, true ),
 aSettings->GetDefaultPenWidth() );
 int numPenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_numTextSize, true ),
 aSettings->GetDefaultPenWidth() );
 
 int name_offset = schIUScale.MilsToIU( PIN_TEXT_MARGIN ) + namePenWidth;
 int num_offset = schIUScale.MilsToIU( PIN_TEXT_MARGIN ) + numPenWidth;
 
 /* Get the num and name colors */
 COLOR4D nameColor = aSettings->GetLayerColor( IsVisible() ? LAYER_PINNAM : LAYER_HIDDEN );
 COLOR4D numColor = aSettings->GetLayerColor( IsVisible() ? LAYER_PINNUM : LAYER_HIDDEN );
 COLOR4D bg = aSettings->GetBackgroundColor();
 
 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
 bg = COLOR4D::WHITE;
 
 if( !IsVisible() )
 bg = aSettings->GetLayerColor( LAYER_HIDDEN );
 
 if( aDimmed )
 {
 nameColor = nameColor.Mix( bg, 0.5f );
 numColor = numColor.Mix( bg, 0.5f );
 }
 
 int x1 = aPinPos.x;
 int y1 = aPinPos.y;
 
 switch( aPinOrient )
 {
 case PIN_UP: y1 -= m_length; break;
 case PIN_DOWN: y1 += m_length; break;
 case PIN_LEFT: x1 -= m_length; break;
 case PIN_RIGHT: x1 += m_length; break;
 }
 
 wxString name = GetShownName();
 wxString number = GetShownNumber();
 
 if( name.IsEmpty() || m_nameTextSize == 0 )
 aDrawPinName = false;
 
 if( number.IsEmpty() || m_numTextSize == 0 )
 aDrawPinNum = false;
 
 if( aTextInside ) // Draw the text inside, but the pin numbers outside.
 {
 if(( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) )
 {
 // It is an horizontal line
 if( aDrawPinName )
 {
 if( aPinOrient == PIN_RIGHT )
 {
 x = x1 + aTextInside;
 GRPrintText( DC, VECTOR2I( x, y1 ), nameColor, name, ANGLE_HORIZONTAL,
 pinNameSize, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER,
 namePenWidth, false, false, font );
 }
 else // Orient == PIN_LEFT
 {
 x = x1 - aTextInside;
 GRPrintText( DC, VECTOR2I( x, y1 ), nameColor, name, ANGLE_HORIZONTAL,
 pinNameSize, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_CENTER,
 namePenWidth, false, false, font );
 }
 }
 
 if( aDrawPinNum )
 {
 GRPrintText( DC, VECTOR2I(( x1 + aPinPos.x) / 2, y1 - num_offset ), numColor,
 number, ANGLE_HORIZONTAL, pinNumSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth, false, false, font );
 }
 }
 else /* Its a vertical line. */
 {
 // Text is drawn from bottom to top (i.e. to negative value for Y axis)
 if( aPinOrient == PIN_DOWN )
 {
 y = y1 + aTextInside;
 
 if( aDrawPinName )
 {
 GRPrintText( DC, VECTOR2I( x1, y ), nameColor, name, ANGLE_VERTICAL,
 pinNameSize, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_CENTER,
 namePenWidth, false, false, font );
 }
 
  if( aDrawPinNum )
 {
 GRPrintText( DC, VECTOR2I( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), numColor,
 number, ANGLE_VERTICAL, pinNumSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth, false, false, font );
 }
 }
 else /* PIN_UP */
 {
 y = y1 - aTextInside;
 
 if( aDrawPinName )
 {
 GRPrintText( DC, VECTOR2I( x1, y ), nameColor, name, ANGLE_VERTICAL,
 pinNameSize, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER,
 namePenWidth, false, false, font );
 }
 
 if( aDrawPinNum )
 {
 GRPrintText( DC, VECTOR2I( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), numColor,
 number, ANGLE_VERTICAL, pinNumSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_BOTTOM, numPenWidth, false, false, font );
 }
 }
 }
 }
 else /**** Draw num & text pin outside ****/
 {
 if( ( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) )
 {
 /* Its an horizontal line. */
 if( aDrawPinName )
 {
 x = ( x1 + aPinPos.x) / 2;
 GRPrintText( DC, VECTOR2I( x, y1 - name_offset ), nameColor, name, ANGLE_HORIZONTAL,
 pinNameSize, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_BOTTOM,
 namePenWidth, false, false, font );
 }
 if( aDrawPinNum )
 {
 x = ( x1 + aPinPos.x) / 2;
 GRPrintText( DC, VECTOR2I( x, y1 + num_offset ), numColor, number, ANGLE_HORIZONTAL,
 pinNumSize, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP,
 numPenWidth, false, false, font );
 }
 }
 else /* Its a vertical line. */
 {
 if( aDrawPinName )
 {
 y = ( y1 + aPinPos.y) / 2;
 GRPrintText( DC, VECTOR2I( x1 - name_offset, y ), nameColor, name, ANGLE_VERTICAL,
 pinNameSize, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_BOTTOM,
 namePenWidth, false, false, font );
 }
 
 if( aDrawPinNum )
 {
 GRPrintText( DC, VECTOR2I( x1 + num_offset, ( y1 + aPinPos.y) / 2 ), numColor,
 number, ANGLE_VERTICAL, pinNumSize, GR_TEXT_H_ALIGN_CENTER,
 GR_TEXT_V_ALIGN_TOP, numPenWidth, false, false, font );
 }
 }
 }
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, Clamp_Text_PenSize(), 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, WHITE, 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 165 of file eda_item.h.

165{ return false; }

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

 {
 return false;
 }

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

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

Referenced by EDA_TEXT::Replace(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), and SCH_EDITOR_CONTROL::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 1096 of file lib_pin.cpp.

{
 EDA_ANGLE rot_angle = aRotateCCW ? -ANGLE_90 : ANGLE_90;
 
 RotatePoint( m_position, aCenter, rot_angle );
 
 if( aRotateCCW )
 {
 switch( m_orientation )
 {
 case PIN_RIGHT: m_orientation = PIN_UP; break;
 case PIN_UP: m_orientation = PIN_LEFT; break;
 case PIN_LEFT: m_orientation = PIN_DOWN; break;
 case PIN_DOWN: m_orientation = PIN_RIGHT; break;
 }
 }
 else
 {
 switch( m_orientation )
 {
 case PIN_RIGHT: m_orientation = PIN_DOWN; break;
 case PIN_UP: m_orientation = PIN_RIGHT; break;
 case PIN_LEFT: m_orientation = PIN_UP; break;
 case PIN_DOWN: m_orientation = PIN_LEFT; break;
 }
 }
}

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.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

119{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:142

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConvert()

void LIB_ITEM::SetConvert ( int aConvert )

inlineinherited

Definition at line 275 of file lib_item.h.

275{ m_convert = aConvert; }

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

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

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

◆ SetLength()

void LIB_PIN::SetLength ( int aLength )

inline

Definition at line 81 of file lib_pin.h.

81{ m_length = aLength; }

References m_length.

Referenced by DIALOG_PIN_PROPERTIES::OnPropertiesChange().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );
 
 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), PCB_PARSER::parseZONE(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetName()

void LIB_PIN::SetName ( const wxString & aName )

inline

Definition at line 114 of file lib_pin.h.

 {
 m_name = aName;
 
 // pin name string does not support spaces
 m_name.Replace( wxT( " " ), wxT( "_" ) );
 }

References m_name.

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), 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 133 of file lib_pin.h.

133{ m_nameTextSize = aSize; }

References 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 124 of file lib_pin.h.

 {
 m_number = aNumber;
 
 // pin number string does not support spaces
 m_number.Replace( wxT( " " ), wxT( "_" ) );
 }

References m_number.

Referenced by BOOST_AUTO_TEST_CASE(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_EDIT_TOOL::handlePinDuplication(), LIB_PIN(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EAGLE_PLUGIN::loadSymbol(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), 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 136 of file lib_pin.h.

136{ m_numTextSize = aSize; }

References m_numTextSize.

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

◆ SetOrientation()

void LIB_PIN::SetOrientation ( int aOrientation )

inline

Definition at line 75 of file lib_pin.h.

75{ m_orientation = aOrientation; }

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, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetPosition()

void LIB_PIN::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from LIB_ITEM.

Definition at line 223 of file lib_pin.h.

223{ m_position = aPos; }

References m_position.

Referenced by 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 278 of file lib_item.h.

278{ m_private = aPrivate; }

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

118{ SetFlags( SELECTED ); }

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(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetShape()

void LIB_PIN::SetShape ( GRAPHIC_PINSHAPE aShape )

inline

Definition at line 78 of file lib_pin.h.

78{ m_shape = aShape; }

References m_shape.

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

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 131 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetType()

void LIB_PIN::SetType ( ELECTRICAL_PINTYPE aType )

inline

Definition at line 91 of file lib_pin.h.

91{ m_type = aType; }

References m_type.

Referenced by KIGFX::SCH_PAINTER::draw(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), 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 272 of file lib_item.h.

272{ m_unit = aUnit; }

References LIB_ITEM::m_unit.

◆ SetVisible()

void LIB_PIN::SetVisible ( bool aVisible )

inline

Definition at line 104 of file lib_pin.h.

 {
 if( aVisible )
 m_attributes &= ~PIN_INVISIBLE;
 else
 m_attributes |= PIN_INVISIBLE;
 }

References m_attributes, and PIN_INVISIBLE.

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

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

117{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

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

440{ return *aLeft < *aRight; }

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

97{ return m_structType; }

References EDA_ITEM::m_structType.

◆ 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 1166 of file lib_pin.cpp.

{
 return GetBoundingBox( false, true, true );
}

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 106 of file view_item.h.

107 {}

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 1172 of file lib_pin.cpp.

{
 aCount = 3;
 aLayers[0] = LAYER_DANGLING; // We don't really show dangling vs non-dangling (since there
 // are no connections in the symbol editor), but it's still
 // a good visual indication of which end of the pin is which.
 aLayers[1] = LAYER_DEVICE;
 aLayers[2] = LAYER_SELECTION_SHADOWS;
}

References LAYER_DANGLING, LAYER_DEVICE, 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 GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 132 of file view_item.h.

 {
 // By default always show the item
 return 0.0;
 }

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

{
#if 0 && defined(DEBUG)
 std::cout << GetClass().mb_str() << ' ';
#endif
 
 if( IsType( aScanTypes ) )
 {
 if( INSPECT_RESULT::QUIT == inspector( this, testData ) )
 return INSPECT_RESULT::QUIT;
 }
 
 return INSPECT_RESULT::CONTINUE;
}

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

Referenced by PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), and EDA_ITEM::IterateForward().

Member Data Documentation

◆ m_alternates

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

protected

Definition at line 301 of file lib_pin.h.

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

◆ m_attributes

int LIB_PIN::m_attributes

protected

Definition at line 295 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 333 of file lib_item.h.

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

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 500 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::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), EDA_ITEM::IsWireImage(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::swapData().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 499 of file eda_item.h.

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

◆ m_length

int LIB_PIN::m_length

protected

Definition at line 291 of file lib_pin.h.

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

◆ m_name

wxString LIB_PIN::m_name

protected

Definition at line 296 of file lib_pin.h.

Referenced by compare(), GetName(), GetSelectMenuText(), GetShownName(), and SetName().

◆ m_nameTextSize

int LIB_PIN::m_nameTextSize

protected

Definition at line 299 of file lib_pin.h.

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

◆ m_number

wxString LIB_PIN::m_number

protected

Definition at line 297 of file lib_pin.h.

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

◆ m_numTextSize

int LIB_PIN::m_numTextSize

protected

Definition at line 298 of file lib_pin.h.

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

◆ m_orientation

int LIB_PIN::m_orientation

protected

Definition at line 292 of file lib_pin.h.

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

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 498 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), 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(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), and PCB_SHAPE::swapData().

◆ m_position

VECTOR2I LIB_PIN::m_position

protected

Definition at line 290 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetPinRoot(), GetPosition(), MirrorHorizontal(), MirrorVertical(), MoveTo(), Offset(), 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 338 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 293 of file lib_pin.h.

Referenced by compare(), GetBoundingBox(), GetMsgPanelInfo(), GetSelectMenuText(), GetShape(), PlotSymbol(), printPinSymbol(), and SetShape().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 497 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::swapData().

◆ 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 507 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 294 of file lib_pin.h.

Referenced by compare(), GetCanonicalElectricalTypeName(), GetElectricalTypeName(), GetMenuImage(), GetMsgPanelInfo(), GetType(), 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 327 of file lib_item.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 494 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW_ITEM::ClearViewPrivData(), 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()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

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

◆ GetFriendlyName()

◆ GetLength()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetName()

◆ GetNameTextSize()

◆ GetNumber()

◆ GetNumberTextSize()

◆ GetOrientation()

◆ GetParent()

◆ GetPenWidth()

◆ GetPinRoot()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetShape()

◆ GetShownName()

◆ GetShownNumber()

◆ GetSortPosition()

◆ GetState()

◆ GetStatus()

◆ GetType()

◆ GetTypeDesc()

◆ GetTypeName()

◆ GetUnit()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsDragging()

◆ IsEntered()

◆ IsForceVisible()

◆ IsModified()