LIB_PIN Class Reference

#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)
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 wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) 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 wxPoint &aPos, int aUnit)
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...
bool	HitTest (const EDA_RECT &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...
void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...
const EDA_RECT	GetBoundingBox () const override
const EDA_RECT	GetBoundingBox (bool aIncludeInvisibles, bool aPinOnly=false) 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 wxPoint &aPinPos, int aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName) const
	Plot the pin number and pin text info, given the pin line coordinates. More...
void	PlotSymbol (PLOTTER *aPlotter, const wxPoint &aPosition, int aOrientation) const
void	Offset (const wxPoint &aOffset) override
	Set the drawing object by aOffset from the current position. More...
void	MoveTo (const wxPoint &aNewPosition) override
	Move a draw object to aPosition. More...
wxPoint	GetPosition () const override
void	SetPosition (const wxPoint &aPos) override
wxPoint	GetPinRoot () const
void	MirrorHorizontal (const wxPoint &aCenter) override
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...
void	MirrorVertical (const wxPoint &aCenter) override
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...
void	Rotate (const wxPoint &aCenter, bool aRotateCCW=true) override
	Rotate the object about aCenter point. More...
void	Plot (PLOTTER *aPlotter, const wxPoint &aPffset, bool aFill, const TRANSFORM &aTransform) 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 (EDA_UNITS aUnits) 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 wxPoint &aPosition) override
	Calculate the attributes of an item at aPosition when it is being edited. More...
virtual void	BeginEdit (const wxPoint &aPosition)
	Begin drawing a symbol library draw item at aPosition. More...
virtual bool	ContinueEdit (const wxPoint &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 wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
	Draw an item. More...
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
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
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	IsType (const 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 const wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const wxFindReplaceData &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 const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...
virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...
virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...
VIEW_ITEM_DATA *	viewPrivData () const
void	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)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

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 SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &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 wxPoint &aPos, int aOrientation)
	Print the pin symbol without text. More...
void	printPinTexts (const RENDER_SETTINGS *aSettings, wxPoint &aPinPos, int aPinOrient, int aTextInside, bool aDrawPinNum, bool aDrawPinName)
	Put the pin number and pin text info, given the pin line coordinates. More...
void	printPinElectricalTypeName (const RENDER_SETTINGS *aSettings, wxPoint &aPosition, int aOrientation)
	Draw the electrical type text of the pin (only for the footprint editor) More...
bool	Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

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

Detailed Description

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

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

LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 71 of file lib_item.h.

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

Constructor & Destructor Documentation

~LIB_PIN()

LIB_PIN::~LIB_PIN ( )

inline

Definition at line 63 of file lib_pin.h.

{ }

LIB_PIN() [1/2]

LIB_PIN::LIB_PIN

(

LIB_SYMBOL *

aParent

)

Definition at line 94 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 = Mils2iu( settings->m_Defaults.pin_length );
 m_numTextSize = Mils2iu( settings->m_Defaults.pin_num_size );
 m_nameTextSize = Mils2iu( settings->m_Defaults.pin_name_size );
 }
 else // Use hardcoded eeschema defaults: symbol_editor settings are not existing.
 {
 m_length = Mils2iu( DEFAULT_PIN_LENGTH );
 m_numTextSize = Mils2iu( DEFAULT_PINNUM_SIZE );
 m_nameTextSize = Mils2iu( 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, PgmOrNull(), and PT_UNSPECIFIED.

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 wxPoint &	aPos,
		int	aUnit
	)

Definition at line 121 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 wxPoint &  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_TEXT, and LIB_SHAPE.

Definition at line 105 of file lib_item.h.

{}

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

CalcEdit()

void LIB_PIN::CalcEdit ( const wxPoint &  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 1232 of file lib_pin.cpp.

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

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

ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 171 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by FOOTPRINT::Add(), BOARD::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), 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 153 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), 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(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 131 of file eda_item.h.

{ ClearFlags( SELECTED ); }

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< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
 DO_NOT_DRAW );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by 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 867 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 873 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.CmpNoCase( 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, and EDA_ITEM::Type().

ContinueEdit()

virtual bool LIB_ITEM::ContinueEdit ( const wxPoint &  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 117 of file lib_item.h.

{ return false; }

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

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

{}

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, 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(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 return object ? aProperty->get<T>( object ) : T();
 }

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

Get() [3/3]

template<typename T >

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

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 );
 boost::optional<T> ret = T();

 if( prop )
 {
 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().

GetAlt()

ALT LIB_PIN::GetAlt ( const wxString &  aAlt )

inline

Definition at line 134 of file lib_pin.h.

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

{ 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 EDA_RECT LIB_PIN::GetBoundingBox ( ) const

inlineoverridevirtual

Returns

the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 176 of file lib_pin.h.

{ return GetBoundingBox( false ); }

References GetBoundingBox().

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

GetBoundingBox() [2/2]

const EDA_RECT LIB_PIN::GetBoundingBox	(	bool	aIncludeInvisibles,
		bool	aPinOnly = false
	)		const

Parameters

aIncludeInvisibles

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

Definition at line 1075 of file lib_pin.cpp.

{
 EDA_RECT bbox;
 wxPoint begin;
 wxPoint end;
 int nameTextOffset = 0;
 wxString name = GetShownName();
 wxString number = GetShownNumber();
 bool showName = !name.IsEmpty();
 bool showNum = !number.IsEmpty();
 int minsizeV = TARGET_PIN_RADIUS;

 if( !aIncludeInvisibles && !IsVisible() )
 showName = false;

 if( GetParent() )
 {
 if( GetParent()->ShowPinNames() )
 nameTextOffset = GetParent()->GetPinNameOffset();
 else
 showName = false;

 if( !GetParent()->ShowPinNumbers() )
 showNum = false;
 }

 if( aPinOnly )
 {
 showName = false;
 showNum = false;
 }

 // First, calculate boundary box corners position
 int numberTextLength = showNum ? m_numTextSize * number.Len() : 0;

 // Actual text height is bigger than text size
 int numberTextHeight = showNum ? KiROUND( m_numTextSize * 1.1 ) : 0;

 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 + Mils2iu( PIN_TEXT_MARGIN ) );
 begin.x = std::min( 0, m_length - (numberTextLength / 2) );

 // calculate bottom right corner position and adjust top left corner position
 int nameTextLength = 0;
 int nameTextHeight = 0;

 if( showName )
 {
 int length = name.Len();

 // TODO: exclude markup characters!
 nameTextLength = ( m_nameTextSize * length ) + nameTextOffset;

 // Actual text height are bigger than text size
 nameTextHeight = KiROUND( m_nameTextSize * 1.1 ) + Mils2iu( PIN_TEXT_MARGIN );
 }

 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, wxPoint( 0, 0 ), -900 );
 RotatePoint( &end, wxPoint( 0, 0 ), -900 );
 break;

 case PIN_DOWN:
 RotatePoint( &begin, wxPoint( 0, 0 ), 900 );
 RotatePoint( &end, wxPoint( 0, 0 ), 900 );
 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 DefaultTransform, externalPinDecoSize(), LIB_ITEM::GetParent(), GetPenWidth(), LIB_SYMBOL::GetPinNameOffset(), GetShownName(), GetShownNumber(), EDA_RECT::Inflate(), INVERTED, INVERTED_CLOCK, IsVisible(), KiROUND(), m_length, m_nameTextSize, m_numTextSize, m_position, m_shape, name, EDA_RECT::Normalize(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PinDrawOrient(), EDA_RECT::RevertYAxis(), RotatePoint(), EDA_RECT::SetEnd(), EDA_RECT::SetOrigin(), and TARGET_PIN_RADIUS.

GetCanonicalElectricalTypeName() [1/2]

wxString const LIB_PIN::GetCanonicalElectricalTypeName ( ) const

inline

Definition at line 87 of file lib_pin.h.

 {
 return GetCanonicalElectricalTypeName( m_type );
 }

References m_type.

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

 {
 return wxT( "LIB_PIN" );
 }

GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 269 of file lib_item.h.

{ return m_convert; }

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_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_WIRE_IMAGE | STRUCT_DELETED );

 return m_flags & mask;
 }

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

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetEffectivePenWidth()

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

inlinevirtualinherited

Reimplemented in LIB_SHAPE.

Definition at line 153 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 aSettings->GetDefaultPenWidth();
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }

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

Referenced by KIGFX::SCH_PAINTER::getLineWidth(), LIB_FIELD::Plot(), PlotSymbol(), LIB_FIELD::print(), and printPinSymbol().

GetElectricalTypeName()

wxString const LIB_PIN::GetElectricalTypeName ( ) const

inline

Definition at line 92 of file lib_pin.h.

 {
 return ElectricalPinTypeGetText( m_type );
 }

References ElectricalPinTypeGetText(), and m_type.

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

GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), 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 wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

GetLength()

int LIB_PIN::GetLength ( ) const

inline

Definition at line 81 of file lib_pin.h.

{ 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_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_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 1193 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 1037 of file lib_pin.cpp.

{
 EDA_UNITS units = aFrame->GetUserUnits();

 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" ), MessageTextFromValue( units, m_length, true ) );

 int i = PinOrientationIndex( m_orientation );
 aList.emplace_back( _( "Orientation" ), PinOrientationName( (unsigned) i ) );

 wxPoint pinpos = GetPosition();
 pinpos.y = -pinpos.y; // Display coords are top to bottom; lib item coords are bottom to top

 aList.emplace_back( _( "Pos X" ), MessageTextFromValue( units, pinpos.x, true ) );
 aList.emplace_back( _( "Pos Y" ), MessageTextFromValue( units, pinpos.y, true ) );
}

References _, ElectricalPinTypeGetText(), LIB_ITEM::GetMsgPanelInfo(), GetPosition(), GetShownName(), GetShownNumber(), EDA_BASE_FRAME::GetUserUnits(), IsVisible(), m_length, m_orientation, m_shape, m_type, MessageTextFromValue(), PinOrientationIndex(), PinOrientationName(), PinShapeGetText(), and UnescapeString().

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties().

GetName()

const wxString& LIB_PIN::GetName ( void  ) const

inline

Definition at line 106 of file lib_pin.h.

{ 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_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetNameTextSize()

int LIB_PIN::GetNameTextSize ( ) const

inline

Definition at line 126 of file lib_pin.h.

{ return m_nameTextSize; }

References m_nameTextSize.

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

GetNumber()

const wxString& LIB_PIN::GetNumber ( ) const

inline

Definition at line 116 of file lib_pin.h.

{ return m_number; }

References m_number.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_PIN::GetDefaultNetName(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_PIN::SCH_PIN(), sort_by_pin_number(), PIN_TABLE_DATA_MODEL::SortPins(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetNumberTextSize()

int LIB_PIN::GetNumberTextSize ( ) const

inline

Definition at line 129 of file lib_pin.h.

{ return m_numTextSize; }

References m_numTextSize.

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

GetOrientation()

int LIB_PIN::GetOrientation ( ) const

inline

Definition at line 75 of file lib_pin.h.

{ 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_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetParent()

LIB_SYMBOL* LIB_ITEM::GetParent ( void  ) const

inlineinherited

Definition at line 164 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(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), 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 166 of file lib_pin.cpp.

{
 return 0;
}

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

GetPinRoot()

wxPoint LIB_PIN::GetPinRoot

(

)

const

Definition at line 181 of file lib_pin.cpp.

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

References m_length, m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, and PIN_UP.

GetPosition()

wxPoint LIB_PIN::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 212 of file lib_pin.h.

{ 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(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_PIN::SCH_PIN(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetSelectMenuText()

wxString LIB_PIN::GetSelectMenuText ( EDA_UNITS  aUnits ) 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 1199 of file lib_pin.cpp.

{
 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 ) );
 }
}

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

Referenced by SCH_PIN::GetSelectMenuText().

GetShape()

GRAPHIC_PINSHAPE LIB_PIN::GetShape ( ) const

inline

Definition at line 78 of file lib_pin.h.

{ 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_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

GetShownName()

wxString LIB_PIN::GetShownName

(

)

const

Definition at line 172 of file lib_pin.cpp.

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

References m_name.

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

GetShownNumber()

wxString LIB_PIN::GetShownNumber ( ) const

inline

Definition at line 117 of file lib_pin.h.

{ return m_number; }

References m_number.

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

GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS  type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetType()

ELECTRICAL_PINTYPE LIB_PIN::GetType ( ) const

inline

Definition at line 84 of file lib_pin.h.

{ 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_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

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

 {
 return _( "Pin" );
 }

References _.

GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 266 of file lib_item.h.

{ return m_unit; }

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(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), 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(), sort_by_pin_number(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS  aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

HitTest() [1/2]

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

overridevirtual

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

Parameters

aPosition	A reference to a wxPoint 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 141 of file lib_pin.cpp.

{
 EDA_RECT rect = GetBoundingBox();

 return rect.Inflate( aAccuracy ).Contains( aPosition );
}

References EDA_RECT::Contains(), GetBoundingBox(), and EDA_RECT::Inflate().

HitTest() [2/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a EDA_RECT 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 149 of file lib_pin.cpp.

{
 if( m_flags & (STRUCT_DELETED | SKIP_STRUCT ) )
 return false;

 EDA_RECT sel = aRect;

 if ( aAccuracy )
 sel.Inflate( aAccuracy );

 if( aContained )
 return sel.Contains( GetBoundingBox( false, true ) );

 return sel.Intersects( GetBoundingBox( false, true ) );
}

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

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

{ return m_flags & ENTERED; }

References ENTERED, and EDA_ITEM::m_flags.

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

IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 205 of file eda_item.h.

{ return m_forceVisible; }

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

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

{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_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 188 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().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

Returns

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

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

Definition at line 402 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsType()

virtual bool EDA_ITEM::IsType ( const 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 PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 182 of file eda_item.h.

 {
 if( aScanTypes[0] == SCH_LOCATE_ANY_T )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( m_structType == *p )
 return true;
 }

 return false;
 }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsVisible()

bool LIB_PIN::IsVisible ( ) const

inline

Definition at line 97 of file lib_pin.h.

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

References m_attributes, and PIN_INVISIBLE.

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

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 294 of file eda_item.h.

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

 return SEARCH_RESULT::CONTINUE;
 }

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

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 313 of file eda_item.h.

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

 return SEARCH_RESULT::CONTINUE;
 }

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

Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  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_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), SCH_MARKER::Matches(), PCB_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText, const wxFindReplaceData &  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 118 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();

 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
 return false;

 if( !( flags & wxFR_MATCHCASE ) )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }

 if( flags & wxFR_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( flags & FR_MATCH_WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, EDA_ITEM::IsReplaceable(), next(), and text.

MirrorHorizontal()

void LIB_PIN::MirrorHorizontal ( const wxPoint &  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 967 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, and PIN_RIGHT.

MirrorVertical()

void LIB_PIN::MirrorVertical ( const wxPoint &  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 980 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, and PIN_UP.

MoveTo()

void LIB_PIN::MoveTo ( const wxPoint &  aPosition )

overridevirtual

Move a draw object to aPosition.

Parameters

aPosition

Position to move draw item to.

Implements LIB_ITEM.

Definition at line 957 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 wxPoint &  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 951 of file lib_pin.cpp.

{
 m_position += aOffset;
}

References m_position.

operator<() [1/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 92 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<() [2/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 234 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==() [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 83 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 203 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 833 of file lib_pin.cpp.

{
 int orient;
 wxPoint 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, and TRANSFORM::TransformCoordinate().

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

Plot()

void LIB_PIN::Plot ( PLOTTER *  aPlotter, const wxPoint &  aOffset, bool  aFill, const TRANSFORM &  aTransform  ) const

overridevirtual

Plot the draw item using the plot object.

Parameters

aPlotter	The plot object to plot to.
aOffset	Plot offset position.
aFill	Flag to indicate whether or not the object is filled.
aTransform	The plot transform.

Implements LIB_ITEM.

Definition at line 1022 of file lib_pin.cpp.

{
 if( !IsVisible() )
 return;

 int orient = PinDrawOrient( aTransform );
 wxPoint pos = aTransform.TransformCoordinate( m_position ) + aPffset;

 PlotSymbol( aPlotter, pos, orient );
 PlotPinTexts( aPlotter, pos, orient, GetParent()->GetPinNameOffset(),
 GetParent()->ShowPinNumbers(), GetParent()->ShowPinNames() );
}

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

PlotPinTexts()

void LIB_PIN::PlotPinTexts	(	PLOTTER *	aPlotter,
		const wxPoint &	aPinPos,
		int	aPinOrient,
		int	aTextInside,
		bool	aDrawPinNum,
		bool	aDrawPinName
	)		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 681 of file lib_pin.cpp.

{
 wxString name = GetShownName();
 wxString number = GetShownNumber();

 if( name.IsEmpty() )
 aDrawPinName = false;

 if( number.IsEmpty() )
 aDrawPinNum = false;

 if( !aDrawPinNum && !aDrawPinName )
 return;

 int x, y;
 wxSize pinNameSize = wxSize( m_nameTextSize, m_nameTextSize );
 wxSize pinNumSize = wxSize( m_numTextSize, m_numTextSize );

 int namePenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_nameTextSize, false ),
 aPlotter->RenderSettings()->GetDefaultPenWidth() );
 int numPenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_numTextSize, false ),
 aPlotter->RenderSettings()->GetDefaultPenWidth() );

 int name_offset = Mils2iu( PIN_TEXT_MARGIN ) + namePenWidth;
 int num_offset = Mils2iu( PIN_TEXT_MARGIN ) + numPenWidth;

 /* Get the num and name colors */
 COLOR4D nameColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_PINNAM );
 COLOR4D numColor = aPlotter->RenderSettings()->GetLayerColor( LAYER_PINNUM );

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

 /* Draw the text inside, but the pin numbers outside. */
 if( aTextInside )
 {
 if( ( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) ) /* Its an horizontal line. */
 {
 if( aDrawPinName )
 {
 EDA_TEXT_HJUSTIFY_T hjustify;
 if( aPinOrient == PIN_RIGHT )
 {
 x = x1 + aTextInside;
 hjustify = GR_TEXT_HJUSTIFY_LEFT;
 }
 else // orient == PIN_LEFT
 {
 x = x1 - aTextInside;
 hjustify = GR_TEXT_HJUSTIFY_RIGHT;
 }

 aPlotter->Text( wxPoint( x, y1 ), nameColor, name, TEXT_ANGLE_HORIZ, pinNameSize,
 hjustify, GR_TEXT_VJUSTIFY_CENTER, namePenWidth,
 false, false );
 }
 if( aDrawPinNum )
 {
 aPlotter->Text( wxPoint( ( x1 + aPinPos.x) / 2, y1 - num_offset ), numColor,
 number, TEXT_ANGLE_HORIZ, pinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 else /* Its a vertical line. */
 {
 if( aPinOrient == PIN_DOWN )
 {
 y = y1 + aTextInside;

 if( aDrawPinName )
 aPlotter->Text( wxPoint( x1, y ), nameColor, name, TEXT_ANGLE_VERT,
 pinNameSize, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER,
 namePenWidth, false, false );

 if( aDrawPinNum )
 {
 aPlotter->Text( wxPoint( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), numColor,
 number, TEXT_ANGLE_VERT, pinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 else /* PIN_UP */
 {
 y = y1 - aTextInside;

 if( aDrawPinName )
 {
 aPlotter->Text( wxPoint( x1, y ), nameColor, name, TEXT_ANGLE_VERT,
 pinNameSize, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER,
 namePenWidth, false, false );
 }

 if( aDrawPinNum )
 {
 aPlotter->Text( wxPoint( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), numColor,
 number, TEXT_ANGLE_VERT, pinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 }
 }
 else /* Draw num & text pin outside */
 {
 if(( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) )
 {
 /* Its an horizontal line. */
 if( aDrawPinName )
 {
 x = ( x1 + aPinPos.x) / 2;
 aPlotter->Text( wxPoint( x, y1 - name_offset ), nameColor, name,
 TEXT_ANGLE_HORIZ, pinNameSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, namePenWidth, false, false );
 }

 if( aDrawPinNum )
 {
 x = ( x1 + aPinPos.x ) / 2;
 aPlotter->Text( wxPoint( x, y1 + num_offset ), numColor, number,
 TEXT_ANGLE_HORIZ, pinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_TOP, numPenWidth, false, false );
 }
 }
 else /* Its a vertical line. */
 {
 if( aDrawPinName )
 {
 y = ( y1 + aPinPos.y ) / 2;
 aPlotter->Text( wxPoint( x1 - name_offset, y ), nameColor, name,
 TEXT_ANGLE_VERT, pinNameSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, namePenWidth, false, false );
 }

 if( aDrawPinNum )
 {
 aPlotter->Text( wxPoint( x1 + num_offset, ( y1 + aPinPos.y ) / 2 ), numColor,
 number, TEXT_ANGLE_VERT, pinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_TOP, numPenWidth, false, false );
 }
 }
 }
}

References Clamp_Text_PenSize(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), GetShownName(), GetShownNumber(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, LAYER_PINNAM, LAYER_PINNUM, m_length, m_nameTextSize, m_numTextSize, name, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, PLOTTER::RenderSettings(), PLOTTER::Text(), TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by Plot().

PlotSymbol()

void LIB_PIN::PlotSymbol	(	PLOTTER *	aPlotter,
		const wxPoint &	aPosition,
		int	aOrientation
	)		const

Definition at line 552 of file lib_pin.cpp.

{
 int MapX1, MapY1, x1, y1;
 COLOR4D color = aPlotter->RenderSettings()->GetLayerColor( LAYER_PIN );
 int penWidth = GetEffectivePenWidth( aPlotter->RenderSettings() );

 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( wxPoint( MapX1 * radius + x1, MapY1 * radius + y1 ), radius * 2,
 FILL_T::NO_FILL, penWidth );

 aPlotter->MoveTo( wxPoint( 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( wxPoint( x1, y1 + deco_size ) );
 aPlotter->LineTo( wxPoint( x1 + MapX1 * deco_size * 2, y1 ) );
 aPlotter->FinishTo( wxPoint( x1, y1 - deco_size ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( wxPoint( x1 + deco_size, y1 ) );
 aPlotter->LineTo( wxPoint( x1, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( wxPoint( x1 - deco_size, y1 ) );
 }

 aPlotter->MoveTo( wxPoint( MapX1 * deco_size * 2 + x1, MapY1 * deco_size * 2 + y1 ) );
 aPlotter->FinishTo( aPosition );
 }
 else
 {
 aPlotter->MoveTo( wxPoint( 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( wxPoint( x1, y1 + deco_size ) );
 aPlotter->LineTo( wxPoint( x1 - MapX1 * deco_size * 2, y1 ) );
 aPlotter->FinishTo( wxPoint( x1, y1 - deco_size ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( wxPoint( x1 + deco_size, y1 ) );
 aPlotter->LineTo( wxPoint( x1, y1 - MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( wxPoint( 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( wxPoint( x1 + MapX1 * deco_size * 2, y1 ) );
 aPlotter->LineTo( wxPoint( x1 + MapX1 * deco_size * 2, y1 - deco_size * 2 ) );
 aPlotter->FinishTo( wxPoint( x1, y1 ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( wxPoint( x1, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->LineTo( wxPoint( x1 - deco_size * 2, y1 + MapY1 * deco_size * 2 ) );
 aPlotter->FinishTo( wxPoint( 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( wxPoint( x1, y1 - symbol_size * 2 ) );
 aPlotter->FinishTo( wxPoint( x1 + MapX1 * symbol_size * 2, y1 ) );
 }
 else /* MapX1 = 0 */
 {
 aPlotter->MoveTo( wxPoint( x1 - symbol_size * 2, y1 ) );
 aPlotter->FinishTo( wxPoint( 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( wxPoint( x1 - (MapX1 + MapY1) * deco_size, y1 - (MapY1 - MapX1) * deco_size ) );
 aPlotter->FinishTo( wxPoint( x1 + (MapX1 + MapY1) * deco_size, y1 + (MapY1 - MapX1) * deco_size ) );
 aPlotter->MoveTo( wxPoint( x1 - (MapX1 - MapY1) * deco_size, y1 - (MapY1 + MapX1) * deco_size ) );
 aPlotter->FinishTo( wxPoint( 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( wxPoint( ex1 - deco_size, ey1 - deco_size ) );
 aPlotter->FinishTo( wxPoint( ex1 + deco_size, ey1 + deco_size ) );
 aPlotter->MoveTo( wxPoint( ex1 + deco_size, ey1 - deco_size ) );
 aPlotter->FinishTo( wxPoint( ex1 - deco_size, ey1 + deco_size ) );
 }
}

References PLOTTER::Circle(), CLOCK, CLOCK_LOW, color, externalPinDecoSize(), FALLING_EDGE_CLOCK, PLOTTER::FinishTo(), 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(), and TARGET_PIN_RADIUS.

Referenced by Plot().

print()

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

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

 /* Calculate pin orient taking in account the symbol orientation. */
 int orient = PinDrawOrient( aTransform );

 /* Calculate the pin position */
 wxPoint pos1 = aTransform.TransformCoordinate( m_position ) + aOffset;

 if( IsVisible() || drawHiddenFields )
 {
 printPinSymbol( aSettings, pos1, orient );

 printPinTexts( aSettings, pos1, orient, part->GetPinNameOffset(), part->ShowPinNumbers(),
 part->ShowPinNames() );

 if( showPinType )
 printPinElectricalTypeName( aSettings, pos1, orient );

 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 );
 GRCircle( nullptr, DC, pos1.x, pos1.y, TARGET_PIN_RADIUS, 0, color );
 }
 }
}

References color, LIB_SYMBOL_OPTIONS::draw_hidden_fields, 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, and TRANSFORM::TransformCoordinate().

Print()

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

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

Definition at line 118 of file lib_item.cpp.

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

References LIB_ITEM::print().

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

printPinElectricalTypeName()

void LIB_PIN::printPinElectricalTypeName ( const RENDER_SETTINGS *  aSettings, wxPoint &  aPosition, int  aOrientation  )

protected

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

Definition at line 499 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 Millimeter2iu( 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_NOTES : LAYER_HIDDEN );

 wxPoint txtpos = aPosition;
 int offset = Millimeter2iu( 0.4 );
 EDA_TEXT_HJUSTIFY_T hjustify = GR_TEXT_HJUSTIFY_LEFT;
 int orient = TEXT_ANGLE_HORIZ;

 switch( aOrientation )
 {
 case PIN_UP:
 txtpos.y += offset;
 orient = TEXT_ANGLE_VERT;
 hjustify = GR_TEXT_HJUSTIFY_RIGHT;
 break;

 case PIN_DOWN:
 txtpos.y -= offset;
 orient = TEXT_ANGLE_VERT;
 break;

 case PIN_LEFT:
 txtpos.x += offset;
 break;

 case PIN_RIGHT:
 txtpos.x -= offset;
 hjustify = GR_TEXT_HJUSTIFY_RIGHT;
 break;
 }

 GRText( DC, txtpos, color, typeName, orient, wxSize( textSize, textSize ), hjustify,
 GR_TEXT_VJUSTIFY_CENTER, pensize, false, false, nullptr );
}

References color, ETXT_MAX_SIZE, GetElectricalTypeName(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, GRText(), IsVisible(), LAYER_HIDDEN, LAYER_NOTES, m_nameTextSize, Millimeter2iu(), PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by print().

printPinSymbol()

void LIB_PIN::printPinSymbol ( const RENDER_SETTINGS *  aSettings, const wxPoint &  aPos, int  aOrientation  )

protected

Print the pin symbol without text.

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

Definition at line 232 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 );

 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( nullptr, DC, MapX1 * radius + x1, MapY1 * radius + y1, radius, width, color );

 GRMoveTo( MapX1 * radius * 2 + x1, MapY1 * radius * 2 + y1 );
 GRLineTo( nullptr, DC, posX, posY, width, color );
 }
 else
 {
 GRMoveTo( x1, y1 );
 GRLineTo( nullptr, 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( nullptr, DC, x1 - MapX1 * clock_size * 2, y1, width, color );
 GRLineTo( nullptr, DC, x1, y1 - clock_size, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1 + clock_size, y1 );
 GRLineTo( nullptr, DC, x1, y1 - MapY1 * clock_size * 2, width, color );
 GRLineTo( nullptr, 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( nullptr, DC, x1 + MapX1 * deco_size * 2, y1 - deco_size * 2, width, color );
 GRLineTo( nullptr, DC, x1, y1, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1, y1 + MapY1 * deco_size * 2 );
 GRLineTo( nullptr, DC, x1 - deco_size * 2, y1 + MapY1 * deco_size * 2, width, color );
 GRLineTo( nullptr, 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( nullptr, DC, x1 + MapX1 * deco_size * 2, y1, width, color );
 }
 else /* MapX1 = 0 */
 {
 GRMoveTo( x1 - deco_size * 2, y1 );
 GRLineTo( nullptr, 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( nullptr, 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( nullptr, 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( nullptr, DC, posX - deco_size, posY - deco_size, posX + deco_size,
 posY + deco_size, width, color );
 GRLine( nullptr, DC, posX + deco_size, posY - deco_size, posX - deco_size,
 posY + deco_size, width, color );
 }
}

References CLOCK, CLOCK_LOW, color, externalPinDecoSize(), FALLING_EDGE_CLOCK, LIB_ITEM::GetEffectivePenWidth(), 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, and TARGET_PIN_RADIUS.

Referenced by print().

printPinTexts()

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

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

{
 if( !aDrawPinName && !aDrawPinNum )
 return;

 int x, y;
 wxDC* DC = aSettings->GetPrintDC();
 wxSize PinNameSize( m_nameTextSize, m_nameTextSize );
 wxSize PinNumSize( m_numTextSize, m_numTextSize );

 int namePenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_nameTextSize, false ),
 aSettings->GetDefaultPenWidth() );
 int numPenWidth = std::max( Clamp_Text_PenSize( GetPenWidth(), m_numTextSize, false ),
 aSettings->GetDefaultPenWidth() );

 int name_offset = Mils2iu( PIN_TEXT_MARGIN ) + namePenWidth;
 int num_offset = Mils2iu( 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 );

 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() )
 aDrawPinName = false;

 if( number.IsEmpty() )
 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;
 GRText( DC, wxPoint( x, y1 ), NameColor, name, TEXT_ANGLE_HORIZ, PinNameSize,
 GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, namePenWidth, false,
 false );
 }
 else // Orient == PIN_LEFT
 {
 x = x1 - aTextInside;
 GRText( DC, wxPoint( x, y1 ), NameColor, name, TEXT_ANGLE_HORIZ, PinNameSize,
 GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, namePenWidth, false,
 false );
 }
 }

 if( aDrawPinNum )
 {
 GRText( DC, wxPoint(( x1 + aPinPos.x) / 2, y1 - num_offset ), NumColor, number,
 TEXT_ANGLE_HORIZ, PinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 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 )
 {
 GRText( DC, wxPoint( x1, y ), NameColor, name, TEXT_ANGLE_VERT, PinNameSize,
 GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_CENTER, namePenWidth, false,
 false );
 }

 if( aDrawPinNum )
 {
 GRText( DC, wxPoint( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), NumColor,
 number, TEXT_ANGLE_VERT, PinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 else /* PIN_UP */
 {
 y = y1 - aTextInside;

 if( aDrawPinName )
 {
 GRText( DC, wxPoint( x1, y ), NameColor, name, TEXT_ANGLE_VERT, PinNameSize,
 GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, namePenWidth, false,
 false );
 }

 if( aDrawPinNum )
 {
 GRText( DC, wxPoint( x1 - num_offset, ( y1 + aPinPos.y) / 2 ), NumColor,
 number, TEXT_ANGLE_VERT, PinNumSize, GR_TEXT_HJUSTIFY_CENTER,
 GR_TEXT_VJUSTIFY_BOTTOM, numPenWidth, false, false );
 }
 }
 }
 }
 else /**** Draw num & text pin outside ****/
 {
 if(( aPinOrient == PIN_LEFT) || ( aPinOrient == PIN_RIGHT) )
 {
 /* Its an horizontal line. */
 if( aDrawPinName )
 {
 x = ( x1 + aPinPos.x) / 2;
 GRText( DC, wxPoint( x, y1 - name_offset ), NameColor, name, TEXT_ANGLE_HORIZ,
 PinNameSize, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_BOTTOM,
 namePenWidth, false, false );
 }
 if( aDrawPinNum )
 {
 x = ( x1 + aPinPos.x) / 2;
 GRText( DC, wxPoint( x, y1 + num_offset ), NumColor, number, TEXT_ANGLE_HORIZ,
 PinNumSize, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, numPenWidth,
 false, false );
 }
 }
 else /* Its a vertical line. */
 {
 if( aDrawPinName )
 {
 y = ( y1 + aPinPos.y) / 2;
 GRText( DC, wxPoint( x1 - name_offset, y ), NameColor, name, TEXT_ANGLE_VERT,
 PinNameSize, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_BOTTOM,
 namePenWidth, false, false );
 }

 if( aDrawPinNum )
 {
 GRText( DC, wxPoint( x1 + num_offset, ( y1 + aPinPos.y) / 2 ), NumColor, number,
 TEXT_ANGLE_VERT, PinNumSize, GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP,
 numPenWidth, false, false );
 }
 }
 }
}

References Clamp_Text_PenSize(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPenWidth(), KIGFX::RENDER_SETTINGS::GetPrintDC(), GetShownName(), GetShownNumber(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, GRText(), IsVisible(), LAYER_HIDDEN, LAYER_PINNAM, LAYER_PINNUM, m_length, m_nameTextSize, m_numTextSize, name, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_TEXT_MARGIN, PIN_UP, TEXT_ANGLE_HORIZ, and TEXT_ANGLE_VERT.

Referenced by print().

Replace() [1/2]

bool EDA_ITEM::Replace ( const wxFindReplaceData &  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 170 of file eda_item.cpp.

{
 wxString text = aText;
 int flags = aSearchData.GetFlags();
 wxString searchText = aSearchData.GetFindString();
 wxString result;
 bool replaced = false;

 if( flags & wxFR_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( flags & wxFR_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.GetReplaceString();
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }

 aText = result;
 return replaced;
}

References next(), and text.

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

Replace() [2/2]

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

inlinevirtualinherited

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

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

Parameters

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

Returns

True if the item text was modified, otherwise false.

Reimplemented in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 391 of file eda_item.h.

 {
 return false;
 }

Rotate()

void LIB_PIN::Rotate ( const wxPoint &  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 993 of file lib_pin.cpp.

{
 int rot_angle = aRotateCCW ? -900 : 900;

 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 m_orientation, m_position, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, and RotatePoint().

Set() [1/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, 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().

Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 void* object = propMgr.TypeCast( this, thisType, 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]

template<typename T >

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

inlineinherited

Definition at line 68 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().

SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 129 of file eda_item.h.

{ SetFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

SetConvert()

void LIB_ITEM::SetConvert ( int  aConvert )

inlineinherited

Definition at line 268 of file lib_item.h.

{ m_convert = aConvert; }

References LIB_ITEM::m_convert.

Referenced by 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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS  aMask )

inlineinherited

Definition at line 152 of file eda_item.h.

{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_MOVE_TOOL::AlignElements(), PCB_CONTROL::AppendBoard(), FOOTPRINT::BuildPolyCourtyards(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupShapes(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), EE_SELECTION_TOOL::Main(), TRACKS_CLEANER::mergeCollinearSegments(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::moveItem(), EE_SELECTION_TOOL::narrowSelection(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseBus(), SCH_ALTIUM_PLUGIN::ParseBusEntry(), SCH_ALTIUM_PLUGIN::ParseJunction(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParseNoERC(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_ALTIUM_PLUGIN::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceText(), SCH_SYMBOL::Plot(), BACK_ANNOTATE::processNetNameChange(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetBrightened(), EDA_ITEM::SetModified(), EDA_ITEM::SetSelected(), EDA_ITEM::SetWireImage(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

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

{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

SetLength()

void LIB_PIN::SetLength ( int  aLength )

inline

Definition at line 82 of file lib_pin.h.

{ m_length = aLength; }

References m_length.

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

SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 65 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(), 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 108 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(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetNameTextSize()

void LIB_PIN::SetNameTextSize ( int  aSize )

inline

Definition at line 127 of file lib_pin.h.

{ 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 118 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 SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), LIB_PIN(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), SCH_EAGLE_PLUGIN::loadSymbol(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetNumberTextSize()

void LIB_PIN::SetNumberTextSize ( int  aSize )

inline

Definition at line 130 of file lib_pin.h.

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

{ m_orientation = aOrientation; }

References m_orientation.

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

SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM *  aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 115 of file eda_item.h.

{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), FOOTPRINT::operator=(), LIB_SYMBOL::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

SetPosition()

void LIB_PIN::SetPosition ( const wxPoint &  aPos )

inlineoverridevirtual

Reimplemented from LIB_ITEM.

Definition at line 213 of file lib_pin.h.

{ m_position = aPos; }

References m_position.

Referenced by DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 128 of file eda_item.h.

{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

SetShape()

void LIB_PIN::SetShape ( GRAPHIC_PINSHAPE  aShape )

inline

Definition at line 79 of file lib_pin.h.

{ 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(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetState()

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

inlineinherited

Definition at line 141 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(), TRACKS_CLEANER::mergeCollinearSegments(), and BOARD_ITEM::SetLocked().

SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS  aStatus )

inlineinherited

Definition at line 150 of file eda_item.h.

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

{ 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(), TEST_SCH_PIN_FIXTURE::TEST_SCH_PIN_FIXTURE(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetUnit()

void LIB_ITEM::SetUnit ( int  aUnit )

inlineinherited

Definition at line 265 of file lib_item.h.

{ m_unit = aUnit; }

References LIB_ITEM::m_unit.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), 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(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SCH_EAGLE_PLUGIN::loadSymbolCircle(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), SCH_EAGLE_PLUGIN::loadSymbolWire(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

SetVisible()

void LIB_PIN::SetVisible ( bool  aVisible )

inline

Definition at line 98 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 127 of file eda_item.h.

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

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

{ return m_structType; }

References EDA_ITEM::m_structType.

Referenced by KIGFX::PCB_VIEW::Add(), FOOTPRINT::Add(), CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_CLUSTER::Add(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), SCH_MOVE_TOOL::AlignElements(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CN_ITEM::AnchorCount(), SCH_SCREEN::Append(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), PNS::TOPOLOGY::AssembleTuningPath(), CONNECTION_GRAPH::buildConnectionGraph(), DIALOG_NET_INSPECTOR::buildNewItem(), SCH_SCREENS::buildScreenList(), calcIsInsideArea(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), PCB_POINT_EDITOR::canAddCorner(), SCH_NO_CONNECT::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SYMBOL::CanConnect(), CN_VISITOR::checkZoneItemConnection(), SCH_MARKER::ClassOf(), SCH_JUNCTION::ClassOf(), PCB_TEXT::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), PCB_MARKER::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FP_SHAPE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TARGET::ClassOf(), SCH_LINE::ClassOf(), PCB_GROUP::ClassOf(), SCH_FIELD::ClassOf(), FP_TEXT::ClassOf(), SCH_SHEET::ClassOf(), NETINFO_ITEM::ClassOf(), ZONE::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_BITMAP::ClassOf(), PCB_TRACK::ClassOf(), PAD::ClassOf(), SCH_SYMBOL::ClassOf(), FOOTPRINT::ClassOf(), SCH_SCREEN::ClassOf(), SCH_TEXT::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), BOARD::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), PCB_ARC::ClassOf(), SCH_LABEL::ClassOf(), PCB_VIA::ClassOf(), SCH_GLOBALLABEL::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), SCH_HIERLABEL::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_CENTER::ClassOf(), TRACKS_CLEANER::cleanup(), CONNECTION_GRAPH::collectAllDriverValues(), LIB_TEXT::compare(), LIB_FIELD::compare(), compare(), LIB_ITEM::compare(), LIB_SYMBOL::Compare(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), ZONE_CREATE_HELPER::createNewZone(), CONVERT_TOOL::CreatePolys(), BOARD_ADAPTER::createTrack(), DRC_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), SCH_EDITOR_CONTROL::doCopy(), SCH_EDIT_TOOL::DoDelete(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::Draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), NETLIST_EXPORTER_BASE::findNextSymbol(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_BASE_FRAME::FocusOnItems(), EDIT_TOOL::FootprintFilter(), SCH_SEXPR_PLUGIN::Format(), SCH_LEGACY_PLUGIN::Format(), PCB_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), FP_TEXT::FP_TEXT(), PCB_POINT_EDITOR::get45DegConstrainer(), CN_ITEM::GetAnchor(), BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_TEXT::GetConnectionPoints(), SCH_TEXT::GetContextualTextVars(), FOOTPRINT::GetCoverageArea(), CONNECTION_GRAPH::getDefaultConnection(), SCH_FIELD::GetDrawRotation(), getDrilledHoleShape(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_TEXT::GetEndPoints(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_FIELD::GetMenuImage(), getMinDist(), PCB_TRACK::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetName(), CONNECTIVITY_DATA::GetNetItems(), LIB_SYMBOL::GetNextDrawItem(), PCB_SHAPE::GetParentFootprint(), BOARD_ITEM::GetParentFootprint(), LIB_SYMBOL::GetPin(), SCH_SYMBOL::GetPinPhysicalPosition(), SCH_FIELD::GetPosition(), KIGFX::SCH_PAINTER::getRenderColor(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TRACK::GetSelectMenuText(), DRC_ENGINE::GetShape(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), CONVERT_TOOL::getStartEndPoints(), getTopLevelGroup(), PCB_EXPR_TYPE_REF::GetValue(), GROUP_TOOL::Group(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_EDIT_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), EE_RTREE::insert(), DRC_RTREE::Insert(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), CONNECTIVITY_DATA::IsConnectedOnLayer(), isCopper(), CN_ANCHOR::IsDangling(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), SCH_FIELD::IsHypertext(), isKeepoutZone(), DRC_ENGINE::IsNetTie(), PCB_TRACK::IsNull(), SCH_LINE::IsParallel(), isPlated(), SCH_FIELD::IsReplaceable(), PNS::ROUTER::isStartingPointRoutable(), BOARD_ITEM::IsTrack(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), CLIPBOARD_IO::Load(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EE_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), NETLIST_EXPORTER_XML::makeListOfNets(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromSegs(), SCH_SCREEN::MarkConnections(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), SCH_FIELD::Matches(), memberOf(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), EDA_3D_CANVAS::OnMouseMove(), PCB_POINT_EDITOR::OnSelectionChange(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), LIB_ITEM::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::operator=(), LIB_ITEM::operator==(), PAD::PAD(), EDIT_TOOL::PadFilter(), BOARD_EDITOR_CONTROL::PageSettings(), BOARD_COMMIT::parentObject(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), SCH_FIELD::Plot(), SCH_SCREEN::Plot(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_FIELD::Print(), SCH_SCREEN::Print(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_CONNECTION::recacheName(), SCH_BASE_FRAME::RefreshSelection(), KIGFX::PCB_VIEW::Remove(), EE_RTREE::remove(), FOOTPRINT::Remove(), CN_CONNECTIVITY_ALGO::Remove(), SCH_SCREEN::Remove(), BOARD::Remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_SYMBOL::RemoveDrawItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), PCB_SELECTION_TOOL::RequestSelection(), SCHEMATIC::ResolveCrossReference(), PCB_PARSER::resolveGroups(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), EE_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectConnectedTracks(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_POINT_EDITOR::setAltConstraint(), SCH_FIELD::SetId(), ITEM_PICKER::SetItem(), SCH_FIELD::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::SetTitle(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), BOARD_COMMIT::Stage(), SCH_JUNCTION::SwapData(), SCH_NO_CONNECT::SwapData(), SCH_BITMAP::SwapData(), PCB_TARGET::SwapData(), SCH_SHEET_PIN::SwapData(), SCH_FIELD::SwapData(), PCB_GROUP::SwapData(), PCB_TEXT::SwapData(), PCB_TRACK::SwapData(), SCH_SHEET::SwapData(), PCB_ARC::SwapData(), PCB_DIM_ALIGNED::SwapData(), PCB_DIM_ORTHOGONAL::SwapData(), SCH_SYMBOL::SwapData(), PCB_VIA::SwapData(), PCB_DIM_LEADER::SwapData(), PCB_DIM_CENTER::SwapData(), PAD::SwapData(), FOOTPRINT::SwapData(), ZONE::SwapData(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), ERC_TESTER::TestMultUnitPinConflicts(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), SCH_TEXT::UpdateDanglingState(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), SCH_BASE_FRAME::UpdateItem(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), EE_POINT_EDITOR::updateParentItem(), SCH_EDITOR_CONTROL::updatePastedSheet(), EE_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), PCB_GROUP::Visit(), PCB_TRACK::Visit(), GERBER_DRAW_ITEM::Visit(), SCH_GLOBALLABEL::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and NETLIST_EXPORTER_CADSTAR::writeListOfNets().

ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns

the current bounding box.

Implements KIGFX::VIEW_ITEM.

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

Definition at line 257 of file eda_item.cpp.

{
 // Basic fallback
 EDA_RECT bbox = GetBoundingBox();

 return BOX2I( bbox.GetOrigin(), bbox.GetSize() );
}

References EDA_ITEM::GetBoundingBox(), EDA_RECT::GetOrigin(), and EDA_RECT::GetSize().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), PCB_SHAPE::ViewBBox(), and PCB_DIMENSION_BASE::ViewBBox().

ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 106 of file view_item.h.

 {}

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

ViewGetLayers()

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

overridevirtual

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

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

Parameters

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

Reimplemented from LIB_ITEM.

Definition at line 1064 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 FP_ZONE, PAD, FOOTPRINT, PCB_VIA, GERBER_DRAW_ITEM, FP_TEXT, PCB_TRACK, ZONE, PCB_GROUP, and FP_SHAPE.

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(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

viewPrivData()

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

inlineinherited

Definition at line 138 of file view_item.h.

 {
 return m_viewPrivData;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::DRAW_ITEM_VISITOR::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::QUERY_VISITOR< CONTAINER >::operator()(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::Remove(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

Visit()

SEARCH_RESULT EDA_ITEM::Visit ( INSPECTOR  inspector, void *  testData, const KICAD_T  scanTypes[]  )

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 scanTypes[], 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.
scanTypes	Which# KICAD_T types are of interest and the order is significant too, terminated by EOT.

Returns

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

Reimplemented in BOARD, SCH_SYMBOL, FOOTPRINT, LIB_SYMBOL, SCH_SHEET, SCH_GLOBALLABEL, GERBER_FILE_IMAGE, GERBER_DRAW_ITEM, PCB_TRACK, PCB_GROUP, and GBR_LAYOUT.

Definition at line 93 of file eda_item.cpp.

{
#if 0 && defined(DEBUG)
 std::cout << GetClass().mb_str() << ' ';
#endif

 if( IsType( scanTypes ) )
 {
 if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
 return SEARCH_RESULT::QUIT;
 }

 return SEARCH_RESULT::CONTINUE;
}

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

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

Member Data Documentation

m_alternates

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

protected

Definition at line 290 of file lib_pin.h.

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

m_attributes

int LIB_PIN::m_attributes

protected

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

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

m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 480 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), HitTest(), LIB_ITEM::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::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::IsSelected(), 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 479 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 280 of file lib_pin.h.

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

m_name

wxString LIB_PIN::m_name

protected

Definition at line 285 of file lib_pin.h.

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

m_nameTextSize

int LIB_PIN::m_nameTextSize

protected

Definition at line 288 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 286 of file lib_pin.h.

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

m_numTextSize

int LIB_PIN::m_numTextSize

protected

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

Referenced by 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 478 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextMenu(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetContextualTextVars(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), LIB_ITEM::GetParent(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), 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(), PCB_SHAPE::SwapData(), and FP_TEXT::TransformShapeWithClearanceToPolygon().

m_position

wxPoint LIB_PIN::m_position

protected

Definition at line 279 of file lib_pin.h.

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

m_shape

GRAPHIC_PINSHAPE LIB_PIN::m_shape

protected

Definition at line 282 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 477 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_type

ELECTRICAL_PINTYPE LIB_PIN::m_type

protected

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

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

m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 474 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_FIXTURE_TEST_CASE(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), LIB_SYMBOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD_EDITOR_CONTROL::ExportNetlist(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), SCH_SEXPR_PLUGIN::Format(), PCB_PLUGIN::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), SCH_SCREEN::GetSheets(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LEGACY_PLUGIN::loadTrackList(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_EDITOR_CONTROL::nextMatch(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), SCH_ITEM::operator<(), SCH_SYMBOL::operator<(), PAD::PAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

---

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

• lib_pin.h
• lib_pin.cpp