The base class for drawable items used by schematic library components. More...

#include <lib_item.h>

Inheritance diagram for LIB_ITEM:

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

enum	COMPARE_FLAGS : int { NORMAL = 0x00, UNIT = 0x01 }
	The list of flags used by the compare function. More...

Public Member Functions
	LIB_ITEM (KICAD_T aType, LIB_PART *aComponent=NULL, int aUnit=0, int aConvert=0, FILL_TYPE aFillType=FILL_TYPE::NO_FILL)

virtual	~LIB_ITEM ()

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

virtual void	BeginEdit (const wxPoint aPosition)
	Begin drawing a component 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	CalcEdit (const wxPoint &aPosition)
	Calculates the attributes of an item at aPosition when it is being edited. More...

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

virtual int	GetPenWidth () const =0

LIB_PART *	GetParent () const

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

bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Function HitTest tests if aPosition is contained within or on the bounding box of an item. More...

bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Function HitTest tests if aRect intersects or is contained within the bounding box of an item. More...

const EDA_RECT	GetBoundingBox () const override

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

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

virtual void	Offset (const wxPoint &aOffset)=0
	Set the drawing object by aOffset from the current position. More...

virtual void	MoveTo (const wxPoint &aPosition)=0
	Move a draw object to aPosition. More...

void	SetPosition (const wxPoint &aPosition) override

virtual void	MirrorHorizontal (const wxPoint &aCenter)=0
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...

virtual void	MirrorVertical (const wxPoint &aCenter)=0
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...

virtual void	Rotate (const wxPoint &aCenter, bool aRotateCCW=true)=0
	Rotate the object about aCenter point. More...

virtual void	Plot (PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform)=0
	Plot the draw item using the plot object. More...

virtual int	GetWidth () const =0

virtual void	SetWidth (int aWidth)=0

bool	IsFillable () const
	Check if draw object can be filled. More...

void	SetUnit (int aUnit)

int	GetUnit () const

void	SetConvert (int aConvert)

int	GetConvert () const

void	SetFillMode (FILL_TYPE aFillMode)

FILL_TYPE	GetFillMode () const

KICAD_T	Type () const
	Function Type() 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	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (int type) const

void	SetState (int type, int state)

STATUS_FLAGS	GetStatus () const

void	SetStatus (STATUS_FLAGS aStatus)

void	SetFlags (STATUS_FLAGS aMask)

void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

STATUS_FLAGS	GetFlags () const

bool	HasFlag (STATUS_FLAGS aFlag)

STATUS_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Function IsType Checks whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Function SetForceVisible is used to set and cleag 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 wxPoint	GetPosition () const

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

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

virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...

virtual wxString	GetClass () const =0
	Function GetClass returns the class name. More...

virtual wxString	GetSelectMenuText (EDA_UNITS aUnits) const
	Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

virtual BITMAP_DEF	GetMenuImage () const
	Function GetMenuImage returns a pointer to an image to be used in menus. More...

virtual bool	Matches (wxFindReplaceData &aSearchData, void *aAuxData)
	Function Matches compares the item against the search criteria in aSearchData. More...

virtual bool	Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
	Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Function IsReplaceable. More...

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

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

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

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Function ViewGetLOD() Returns 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
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	IterateForward( EDA_ITEM, INSPECTOR, void, const KICAD_T ) More...

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

static bool	Replace (wxFindReplaceData &aSearchData, wxString &aText)
	Helper function used in search and replace dialog Function Replace performs 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)
	Function Sort is a 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
virtual int	compare (const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
	Provide the draw object specific comparison called by the == and < operators. More...

bool	Matches (const wxString &aText, wxFindReplaceData &aSearchData)
	Function Matches compares aText against search criteria in aSearchData. More...

Protected Attributes
int	m_Unit
	Unit identification for multiple parts per package. More...

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

FILL_TYPE	m_Fill
	The body fill type. More...

bool	m_isFillable

STATUS_FLAGS	m_status

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

bool	m_forceVisible

STATUS_FLAGS	m_flags

Private Member Functions
virtual void	print (RENDER_SETTINGS aSettings, const wxPoint &aOffset, void aData, const TRANSFORM &aTransform)=0
	Print the item to aDC. More...

Friends
class	LIB_PART

Detailed Description

The base class for drawable items used by schematic library components.

Definition at line 62 of file lib_item.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int

The list of flags used by the compare function.

NORMAL This compares everthing between two LIB_ITEM objects.
UNIT This compare flag ignores unit and convert and pin number information when comparing LIB_ITEM objects for unit comparison.

Enumerator
NORMAL
UNIT

Definition at line 117 of file lib_item.h.

117 : int { NORMAL = 0x00, UNIT = 0x01 };

LIB_ITEM::UNIT

Definition: lib_item.h:117

LIB_ITEM::NORMAL

Definition: lib_item.h:117

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

Enumerator
BASE
DEMORGAN

Definition at line 108 of file lib_item.h.

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

LIB_ITEM::BASE

Definition: lib_item.h:108

LIB_ITEM::DEMORGAN

Definition: lib_item.h:108

Constructor & Destructor Documentation

◆ LIB_ITEM()

LIB_ITEM::LIB_ITEM	(	KICAD_T	aType,
		LIB_PART *	aComponent = `NULL`,
		int	aUnit = `0`,
		int	aConvert = `0`,
		FILL_TYPE	aFillType = `FILL_TYPE::NO_FILL`
	)

Definition at line 35 of file lib_item.cpp.

                                                   :
     EDA_ITEM( aType )
 {
     m_Unit              = aUnit;
     m_Convert           = aConvert;
     m_Fill              = aFillType;
     m_parent            = (EDA_ITEM*) aComponent;
     m_isFillable        = false;
 }

References m_Convert, m_Fill, m_isFillable, EDA_ITEM::m_parent, and m_Unit.

◆ ~LIB_ITEM()

virtual LIB_ITEM::~LIB_ITEM ( )

inlinevirtual

Definition at line 104 of file lib_item.h.

104 { }

Member Function Documentation

◆ BeginEdit()

virtual void LIB_ITEM::BeginEdit ( const wxPoint aPosition )

inlinevirtual

Begin drawing a component library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the component 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_POLYLINE, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 134 of file lib_item.h.

134 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ CalcEdit()

virtual void LIB_ITEM::CalcEdit ( const wxPoint & aPosition )

inlinevirtual

Calculates 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 component library editor. Therefore, the default method does nothing.

Parameters

aPosition The current mouse position in drawing coordinates.

Reimplemented in LIB_PIN, LIB_POLYLINE, LIB_ARC, LIB_FIELD, LIB_TEXT, LIB_RECTANGLE, and LIB_CIRCLE.

Definition at line 164 of file lib_item.h.

164 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 200 of file eda_item.h.

200 { ClearFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:221

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 239 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(), LIB_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and LIB_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 221 of file eda_item.h.

221 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

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(), LIB_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), 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 199 of file eda_item.h.

199 { ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: eda_item.h:113

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:221

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_PART::LIB_PART(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 233 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 154 of file view_item.h.

     {
         m_viewPrivData = NULL;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns: A clone of the item.

Reimplemented in FP_ZONE, ZONE, SCH_COMPONENT, PAD, FOOTPRINT, SCH_SHEET, CENTER_DIMENSION, SCH_HIERLABEL, LEADER, VIA, ORTHOGONAL_DIMENSION, SCH_GLOBALLABEL, SCH_LABEL, ALIGNED_DIMENSION, ARC, PCB_SHAPE, SCH_TEXT, LIB_PIN, SCH_LINE, TRACK, FP_TEXT, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_FIELD, LIB_FIELD, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, FP_SHAPE, LIB_ARC, PCB_TEXT, PCB_GROUP, SCH_JUNCTION, SCH_NO_CONNECT, LIB_POLYLINE, SCH_MARKER, LIB_TEXT, PCB_TARGET, LIB_CIRCLE, LIB_BEZIER, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 97 of file eda_item.cpp.

 {
     wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
                  wxT( ".  Bad programmer!" ) );
 }

References EDA_ITEM::GetClass(), and NULL.

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), DIMENSION_BASE::GetEffectiveShape(), LIB_PART::LIB_PART(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), new_clone(), LIB_PART::operator=(), LIB_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_PART::SetConversion(), LIB_PART::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), LIB_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ compare()

int LIB_ITEM::compare	(	const LIB_ITEM &	aOther,
		LIB_ITEM::COMPARE_FLAGS	aCompareFlags = `LIB_ITEM::COMPARE_FLAGS::NORMAL`
	)		const

protectedvirtual

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:

Component alternate part (DeMorgan) number.
Component 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 ojbect, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

Reimplemented in LIB_PIN, LIB_FIELD, LIB_ARC, LIB_POLYLINE, LIB_TEXT, LIB_RECTANGLE, LIB_CIRCLE, and LIB_BEZIER.

Definition at line 74 of file lib_item.cpp.

 {
     if( Type() != aOther.Type() )
         return Type() - aOther.Type();
 
     // When comparing unit LIB_ITEM objects, we ignore the unit number.
     if( !( aCompareFlags & COMPARE_FLAGS::UNIT ) && m_Unit != aOther.m_Unit )
         return m_Unit - aOther.m_Unit;
 
     if( !( aCompareFlags & COMPARE_FLAGS::UNIT ) && m_Convert != aOther.m_Convert )
        return m_Convert - m_Convert;
 
     if( m_Fill != aOther.m_Fill )
         return static_cast<int>( m_Fill ) - static_cast<int>( aOther.m_Fill );
 
     return 0;
 }

References m_Convert, m_Fill, m_Unit, and EDA_ITEM::Type().

Referenced by LIB_BEZIER::compare(), LIB_CIRCLE::compare(), LIB_RECTANGLE::compare(), LIB_TEXT::compare(), LIB_POLYLINE::compare(), LIB_ARC::compare(), LIB_FIELD::compare(), LIB_PIN::compare(), operator<(), and operator==().

◆ ContinueEdit()

virtual bool LIB_ITEM::ContinueEdit ( const wxPoint aPosition )

inlinevirtual

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

Definition at line 146 of file lib_item.h.

146 { return false; }

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ EndEdit()

virtual void LIB_ITEM::EndEdit ( )

inlinevirtual

End an object editing action.

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

Reimplemented in LIB_POLYLINE.

Definition at line 153 of file lib_item.h.

153 {}

Referenced by LIB_DRAWING_TOOLS::DrawShape().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 84 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 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 93 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 102 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;
 
         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().

◆ GetBoundingBox()

const EDA_RECT LIB_ITEM::GetBoundingBox ( ) const

inlineoverridevirtual

Returns: the boundary box for this, in library coordinates

Reimplemented from EDA_ITEM.

Reimplemented in LIB_PIN, LIB_POLYLINE, LIB_TEXT, and LIB_RECTANGLE.

Definition at line 202 of file lib_item.h.

202 { return EDA_ITEM::GetBoundingBox(); }

EDA_ITEM::GetBoundingBox

virtual const EDA_RECT GetBoundingBox() const

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

Definition: eda_item.cpp:89

References EDA_ITEM::GetBoundingBox().

Referenced by HitTest().

◆ GetClass()

virtual wxString EDA_ITEM::GetClass ( ) const

pure virtualinherited

Function GetClass returns the class name.

Returns: wxString

Implemented in BOARD, FOOTPRINT, EDIT_POINTS, PAD, CENTER_DIMENSION, ZONE, LEADER, SCH_HIERLABEL, ORTHOGONAL_DIMENSION, VIA, DELETED_BOARD_ITEM, SCH_GLOBALLABEL, ALIGNED_DIMENSION, SCH_LABEL, WS_DRAW_ITEM_BITMAP, ARC, WS_DRAW_ITEM_TEXT, PCB_SHAPE, GERBER_DRAW_ITEM, WS_DRAW_ITEM_PAGE, SCH_SHEET, GERBER_FILE_IMAGE, SCH_ITEM, WS_DRAW_ITEM_RECT, TRACK, SCH_TEXT, FP_TEXT, SCH_BUS_BUS_ENTRY, WS_DRAW_ITEM_POLYPOLYGONS, SCH_SCREEN, SCH_COMPONENT, LIB_PART, SCH_BUS_WIRE_ENTRY, FP_SHAPE, BASE_SCREEN, WS_DRAW_ITEM_LINE, KIGFX::WS_PROXY_VIEW_ITEM, LIB_PIN, SCH_SHEET_PIN, PCB_MARKER, PCB_TEXT, ROUTER_PREVIEW_ITEM, LIB_FIELD, NETINFO_ITEM, SCH_BITMAP, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, PCB_TARGET, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, SCHEMATIC, BRIGHT_BOX, KIGFX::PREVIEW::SELECTION_AREA, SCH_FIELD, KIGFX::RATSNEST_VIEWITEM, KIGFX::PREVIEW::RULER_ITEM, SCH_LINE, MY_DRAWING, LIB_ARC, KIGFX::PREVIEW::ARC_ASSISTANT, SCH_PIN, PCB_GROUP, DELETED_SHEET_ITEM, GBR_LAYOUT, SCH_NO_CONNECT, SCH_JUNCTION, LIB_TEXT, WS_PROXY_UNDO_ITEM, LIB_BEZIER, LIB_RECTANGLE, LIB_CIRCLE, LIB_POLYLINE, and SCH_MARKER.

Referenced by PNS::INDEX::Add(), EDA_ITEM::Clone(), PNS::ITEM::collideSimple(), FOOTPRINT::DuplicateItem(), BOARD_ITEM::Flip(), PCB_IO::Format(), BOARD_ITEM::GetEffectiveShape(), EDA_ITEM::GetSelectMenuText(), BOARD_ITEM::Move(), EDA_ITEM::operator<(), BOARD_ITEM::Rotate(), and EDA_ITEM::Visit().

◆ GetConvert()

int LIB_ITEM::GetConvert ( ) const

inline

Definition at line 299 of file lib_item.h.

299 { return m_Convert; }

LIB_ITEM::m_Convert

int m_Convert

Shape identification for alternate body styles.

Definition: lib_item.h:88

References m_Convert.

Referenced by EE_INSPECTION_TOOL::CheckSymbol(), LIB_EDIT_TOOL::DoDelete(), LIB_PIN_TOOL::EditPinProperties(), SCH_PIN::GetMsgPanelInfo(), SCH_SCREEN::GetPin(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), LIB_MOVE_TOOL::Main(), LIB_EDIT_TOOL::Paste(), LIB_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_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 225 of file eda_item.h.

     {
         constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
                                IS_WIRE_IMAGE | STRUCT_DELETED );
 
         return m_flags & mask;
     }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetFillMode()

FILL_TYPE LIB_ITEM::GetFillMode ( ) const

inline

Definition at line 302 of file lib_item.h.

302 { return m_Fill; }

LIB_ITEM::m_Fill

FILL_TYPE m_Fill

The body fill type.

Definition: lib_item.h:94

References m_Fill.

Referenced by formatFill(), LIB_CIRCLE::GetPenWidth(), LIB_RECTANGLE::GetPenWidth(), LIB_ARC::GetPenWidth(), LIB_POLYLINE::GetPenWidth(), LIB_BEZIER::GetPenWidth(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), KIGFX::SCH_PAINTER::setDeviceColors(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

◆ GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 333 of file eda_item.h.

333 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:325

References EDA_ITEM::GetPosition().

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

◆ GetMenuImage()

BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns: The menu image associated with the item.

Reimplemented in ZONE, SCH_COMPONENT, FOOTPRINT, PAD, SCH_SHEET, CENTER_DIMENSION, SCH_HIERLABEL, LEADER, VIA, ORTHOGONAL_DIMENSION, SCH_GLOBALLABEL, SCH_LABEL, ALIGNED_DIMENSION, PCB_SHAPE, SCH_TEXT, GERBER_DRAW_ITEM, LIB_PIN, SCH_LINE, TRACK, FP_TEXT, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, LIB_FIELD, SCH_FIELD, PCB_GROUP, SCH_BUS_WIRE_ENTRY, FP_SHAPE, SCH_BITMAP, LIB_ARC, PCB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, SCH_MARKER, LIB_TEXT, PCB_TARGET, SCH_JUNCTION, PCB_MARKER, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 221 of file eda_item.cpp.

 {
     return dummy_xpm;
 }

References dummy_xpm.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

void LIB_ITEM::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 EDA_ITEM.

Reimplemented in LIB_PIN, LIB_POLYLINE, LIB_TEXT, and LIB_RECTANGLE.

Definition at line 50 of file lib_item.cpp.

 {
     wxString msg;
 
     aList.push_back( MSG_PANEL_ITEM( _( "Type" ), GetTypeName() ) );
 
     if( m_Unit == 0 )
         msg = _( "All" );
     else
         msg.Printf( wxT( "%d" ), m_Unit );
 
     aList.push_back( MSG_PANEL_ITEM( _( "Unit" ), msg ) );
 
     if( m_Convert == LIB_ITEM::LIB_CONVERT::BASE )
         msg = _( "no" );
     else if( m_Convert == LIB_ITEM::LIB_CONVERT::DEMORGAN )
         msg = _( "yes" );
     else
         msg = wxT( "?" );
 
     aList.push_back( MSG_PANEL_ITEM( _( "Converted" ), msg ) );
 }

References _, GetTypeName(), m_Convert, and m_Unit.

Referenced by LIB_EDIT_TOOL::editGraphicProperties(), LIB_CIRCLE::GetMsgPanelInfo(), LIB_RECTANGLE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_ARC::GetMsgPanelInfo(), LIB_POLYLINE::GetMsgPanelInfo(), LIB_BEZIER::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), and LIB_PIN::GetMsgPanelInfo().

◆ GetParent()

LIB_PART* LIB_ITEM::GetParent ( void ) const

inline

Definition at line 183 of file lib_item.h.

     {
         return (LIB_PART*) m_parent;
     }

References EDA_ITEM::m_parent.

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), LIB_PIN_TOOL::CreateImagePins(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::editFieldProperties(), LIB_PIN_TOOL::EditPinProperties(), CONNECTION_GRAPH::ercCheckNoConnects(), LIB_PIN::GetBoundingBox(), LIB_FIELD::GetFullText(), LIB_PIN::IsPowerConnection(), LIB_PIN::Plot(), LIB_PIN::print(), LIB_EDIT_TOOL::Properties(), ERC_TESTER::TestMultUnitPinConflicts(), DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow(), and DIALOG_LIB_EDIT_ONE_FIELD::UpdateField().

◆ GetPenWidth()

virtual int LIB_ITEM::GetPenWidth ( ) const

pure virtual

Implemented in LIB_PIN, LIB_FIELD, LIB_BEZIER, LIB_ARC, LIB_POLYLINE, LIB_TEXT, LIB_RECTANGLE, and LIB_CIRCLE.

Referenced by KIGFX::SCH_PAINTER::getLineWidth(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ GetPosition()

virtual wxPoint EDA_ITEM::GetPosition ( ) const

inlinevirtualinherited

Reimplemented in SCH_COMPONENT, SCH_SHEET, VIA, DELETED_BOARD_ITEM, WS_DRAW_ITEM_BITMAP, BOARD, SCH_TEXT, ARC, WS_DRAW_ITEM_TEXT, WS_DRAW_ITEM_PAGE, LIB_PIN, SCH_LINE, WS_DRAW_ITEM_RECT, FOOTPRINT, GERBER_DRAW_ITEM, SCH_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, LIB_FIELD, PAD, SCH_BITMAP, WS_DRAW_ITEM_LINE, PCB_SHAPE, DIMENSION_BASE, ZONE, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, PCB_GROUP, NETINFO_ITEM, TRACK, SCH_MARKER, KIGFX::ORIGIN_VIEWITEM, SCH_JUNCTION, LIB_POLYLINE, LIB_ARC, SCH_PIN, FP_TEXT, LIB_TEXT, LIB_BEZIER, LIB_RECTANGLE, LIB_CIRCLE, PCB_TEXT, PCB_MARKER, and PCB_TARGET.

Definition at line 325 of file eda_item.h.

325 { return wxPoint(); }

Referenced by EE_GRID_HELPER::computeAnchors(), GRID_HELPER::computeAnchors(), SCH_EDIT_FRAME::DeleteJunction(), KIGFX::PCB_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), SELECTION_TOOL::findCallback(), GERBVIEW_SELECTION::GetCenter(), EDA_ITEM::GetFocusPosition(), SCH_FIELD::GetParentPosition(), POSITION_RELATIVE_TOOL::GetSelectionAnchorPosition(), SCH_SCREEN::GetSheets(), PCBNEW_SELECTION::GetTopLeftItem(), EE_SELECTION::GetTopLeftItem(), BOARD_ITEM::GetX(), BOARD_ITEM::GetY(), LIB_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_ITEM::operator<(), PL_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), SELECTION_TOOL::selectConnectedTracks(), RC_ITEM::ShowReport(), TransformItem(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), PL_EDIT_TOOL::updateModificationPoint(), and EE_POINT_EDITOR::updatePoints().

◆ GetSelectMenuText()

wxString EDA_ITEM::GetSelectMenuText ( EDA_UNITS aUnits ) const

virtualinherited

Function GetSelectMenuText returns 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 in ZONE, SCH_COMPONENT, FOOTPRINT, PAD, BOARD, SCH_SHEET, SCH_HIERLABEL, VIA, SCH_GLOBALLABEL, DELETED_BOARD_ITEM, SCH_LABEL, WS_DRAW_ITEM_BITMAP, PCB_SHAPE, WS_DRAW_ITEM_TEXT, SCH_TEXT, GERBER_DRAW_ITEM, LIB_PIN, WS_DRAW_ITEM_PAGE, DIMENSION_BASE, WS_DRAW_ITEM_RECT, SCH_LINE, TRACK, FP_TEXT, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, LIB_FIELD, WS_DRAW_ITEM_POLYPOLYGONS, SCH_FIELD, PCB_GROUP, SCH_BUS_WIRE_ENTRY, WS_DRAW_ITEM_LINE, FP_SHAPE, LIB_ARC, SCH_BITMAP, PCB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, PCB_TARGET, PCB_MARKER, LIB_CIRCLE, LIB_RECTANGLE, SCH_JUNCTION, SCH_PIN, and DELETED_SHEET_ITEM.

Definition at line 123 of file eda_item.cpp.

 {
     wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
                 GetClass() );
 
     return wxString( wxT( "Undefined menu text for " ) + GetClass() );
 }

References EDA_ITEM::GetClass().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), DRC_ENGINE::EvalRulesForItems(), PCB_MARKER::GetMsgPanelInfo(), RC_TREE_MODEL::GetValue(), PCB_INSPECTION_TOOL::InspectClearance(), PCB_INSPECTION_TOOL::InspectConstraints(), RC_ITEM::ShowReport(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ GetState()

int EDA_ITEM::GetState ( int type ) const

inlineinherited

Definition at line 204 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 217 of file eda_item.h.

217 { return m_status; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:161

References EDA_ITEM::m_status.

◆ GetTypeName()

virtual wxString LIB_ITEM::GetTypeName ( ) const

pure virtual

Provide a user-consumable name of the object type.

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

Implemented in LIB_PIN, LIB_FIELD, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_RECTANGLE, LIB_CIRCLE, and LIB_POLYLINE.

Referenced by DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), and GetMsgPanelInfo().

◆ GetUnit()

int LIB_ITEM::GetUnit ( ) const

inline

Definition at line 296 of file lib_item.h.

296 { return m_Unit; }

LIB_ITEM::m_Unit

int m_Unit

Unit identification for multiple parts per package.

Definition: lib_item.h:82

References m_Unit.

Referenced by EE_INSPECTION_TOOL::CheckSymbol(), LIB_PIN_TOOL::CreateImagePins(), LIB_PIN_TOOL::EditPinProperties(), SCH_COMPONENT::GetEndPoints(), SCH_PIN::GetMsgPanelInfo(), SCH_SCREEN::GetPin(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), LIB_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_EDIT_DRAW_ITEM::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetWidth()

virtual int LIB_ITEM::GetWidth ( ) const

pure virtual

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

Referenced by DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS aFlag )

inlineinherited

Definition at line 223 of file eda_item.h.

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

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), LIB_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and EE_POINT_EDITOR::updateParentItem().

◆ HitTest() [1/2]

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

inlineoverridevirtual

Function HitTest tests if aPosition is contained within or on the bounding box of an 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 EDA_ITEM.

Reimplemented in LIB_PIN, LIB_POLYLINE, LIB_TEXT, and LIB_RECTANGLE.

Definition at line 190 of file lib_item.h.

     {
         // This is just here to prevent annoying compiler warnings about hidden overloaded
         // virtual functions
         return EDA_ITEM::HitTest( aPosition, aAccuracy );
     }

References EDA_ITEM::HitTest().

◆ HitTest() [2/2]

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

overridevirtual

Function HitTest tests if aRect intersects or is contained within the bounding box of an 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 EDA_ITEM.

Reimplemented in LIB_PIN, LIB_POLYLINE, and LIB_TEXT.

Definition at line 120 of file lib_item.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() );
 
     return sel.Intersects( GetBoundingBox() );
 }

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

193 { return m_flags & BRIGHTENED; }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::WS_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 189 of file eda_item.h.

189 { return m_flags & IS_DRAGGED; }

IS_DRAGGED

#define IS_DRAGGED

Item being dragged.

Definition: eda_item.h:108

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsFillable()

bool LIB_ITEM::IsFillable ( ) const

inline

Check if draw object can be filled.

The default setting is false. If the derived object support filling, set the m_isFillable member to true.

Definition at line 293 of file lib_item.h.

293 { return m_isFillable; }

LIB_ITEM::m_isFillable

bool m_isFillable

Definition: lib_item.h:95

References m_isFillable.

Referenced by LIB_EDIT_TOOL::editGraphicProperties(), formatFill(), and DIALOG_LIB_EDIT_DRAW_ITEM::TransferDataToWindow().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 274 of file eda_item.h.

274 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:163

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

186 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

std::function passed to nested users by ref, avoids copying std::function

Definition: eda_item.h:102

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 188 of file eda_item.h.

188 { return m_flags & IS_MOVED; }

IS_MOVED

#define IS_MOVED

Item being moved.

Definition: eda_item.h:105

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_MOVED, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 187 of file eda_item.h.

187 { return m_flags & IS_NEW; }

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item.h:106

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN_TOOL::EditPinProperties(), LIB_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Function IsReplaceable.

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

Definition at line 490 of file eda_item.h.

490 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 192 of file eda_item.h.

192 { return m_flags & IS_RESIZED; }

IS_RESIZED

#define IS_RESIZED

Item being resized.

Definition: eda_item.h:107

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 191 of file eda_item.h.

191 { return m_flags & SELECTED; }

SELECTED

#define SELECTED

Definition: eda_item.h:113

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags, and SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::WS_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(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), C3D_RENDER_OGL_LEGACY::render_3D_footprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), and WS_PROXY_UNDO_ITEM::WS_PROXY_UNDO_ITEM().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

Function IsType Checks 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 VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 250 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_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), FP_TEXT::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), 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().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_flags & IS_WIRE_IMAGE; }

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item.h:110

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

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

Definition at line 372 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

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 393 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	(	wxFindReplaceData &	aSearchData,
		void *	aAuxData
	)

inlinevirtualinherited

Function Matches compares 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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 446 of file eda_item.h.

     {
         return false;
     }

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

◆ Matches() [2/2]

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

protectedinherited

Function Matches compares 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 132 of file eda_item.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

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

◆ MirrorHorizontal()

virtual void LIB_ITEM::MirrorHorizontal ( const wxPoint & aCenter )

pure virtual

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

Parameters

aCenter Point to mirror around.

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

Referenced by LIB_EDIT_TOOL::Mirror().

◆ MirrorVertical()

virtual void LIB_ITEM::MirrorVertical ( const wxPoint & aCenter )

pure virtual

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

Parameters

aCenter Point to mirror around.

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

Referenced by LIB_EDIT_TOOL::Mirror().

◆ MoveTo()

virtual void LIB_ITEM::MoveTo ( const wxPoint & aPosition )

pure virtual

Move a draw object to aPosition.

Parameters

aPosition Position to move draw item to.

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_RECTANGLE, and LIB_CIRCLE.

Referenced by SetPosition().

◆ Offset()

virtual void LIB_ITEM::Offset ( const wxPoint & aOffset )

pure virtual

Set the drawing object by aOffset from the current position.

Parameters

aOffset Coordinates to offset the item position.

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, LIB_CIRCLE, and LIB_BEZIER.

◆ operator<() [1/2]

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

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

 {
     int result = m_Convert - aOther.m_Convert;
 
     if( result != 0 )
         return result < 0;
 
     result = m_Unit - aOther.m_Unit;
 
     if( result != 0 )
         return result < 0;
 
     result = Type() - aOther.Type();
 
     if( result != 0 )
         return result < 0;
 
     return ( compare( aOther ) < 0 );
 }

References compare(), m_Convert, m_Unit, 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 185 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

Test LIB_ITEM objects for equivalence.

Parameters

aOther Object to test against.

Returns: True if object is identical to this object.

Definition at line 93 of file lib_item.cpp.

 {
     return compare( aOther ) == 0;
 }

References compare().

◆ operator==() [2/2]

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

inline

Definition at line 222 of file lib_item.h.

     {
         return *this == *aOther;
     }

◆ Plot()

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

pure virtual

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.

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

◆ print()

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

privatepure virtual

Print the item to aDC.

Parameters

aOffset	A reference to a wxPoint object containing the offset where to draw from the object's current position.
aData	A pointer to any object specific data required to perform the draw.
aTransform	A reference to a TRANSFORM object containing drawing transform.

Implemented in LIB_PIN, LIB_CIRCLE, LIB_BEZIER, LIB_FIELD, LIB_ARC, LIB_TEXT, LIB_RECTANGLE, and LIB_POLYLINE.

Referenced by Print().

◆ Print()

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

virtual

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 component for pins.
aTransform	Transform Matrix (rotation, mirror ..)

Definition at line 137 of file lib_item.cpp.

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

References print().

Referenced by DIALOG_PIN_PROPERTIES::OnPaintShowPanel().

◆ Replace() [1/2]

bool EDA_ITEM::Replace	(	wxFindReplaceData &	aSearchData,
		wxString &	aText
	)

staticinherited

Helper function used in search and replace dialog Function Replace performs 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 159 of file eda_item.cpp.

 {
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

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

◆ Replace() [2/2]

virtual bool EDA_ITEM::Replace	(	wxFindReplaceData &	aSearchData,
		void *	aAuxData = `NULL`
	)

inlinevirtualinherited

Function Replace performs 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_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 478 of file eda_item.h.

478 { return false; }

◆ Rotate()

virtual void LIB_ITEM::Rotate	(	const wxPoint &	aCenter,
		bool	aRotateCCW = `true`
	)

pure virtual

Rotate the object about aCenter point.

Parameters

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

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

Referenced by LIB_EDIT_TOOL::Rotate().

◆ Set() [1/3]

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

inlineinherited

Definition at line 40 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 53 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 66 of file inspectable.h.

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

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 197 of file eda_item.h.

197 { SetFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:220

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetConvert()

void LIB_ITEM::SetConvert ( int aConvert )

inline

Definition at line 298 of file lib_item.h.

298 { m_Convert = aConvert; }

LIB_ITEM::m_Convert

int m_Convert

Shape identification for alternate body styles.

Definition: lib_item.h:88

References m_Convert.

Referenced by LIB_PIN_TOOL::CreatePin(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::editGraphicProperties(), LIB_PIN::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::loadRectangle(), SCH_LEGACY_PLUGIN_CACHE::loadText(), LIB_EDIT_TOOL::Paste(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), and DIALOG_PIN_PROPERTIES::TransferDataFromWindow().

◆ SetFillMode()

void LIB_ITEM::SetFillMode ( FILL_TYPE aFillMode )

inline

Definition at line 301 of file lib_item.h.

301 { m_Fill = aFillMode; }

LIB_ITEM::m_Fill

FILL_TYPE m_Fill

The body fill type.

Definition: lib_item.h:94

References m_Fill.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_DRAWING_TOOLS::DrawShape(), LIB_EDIT_TOOL::editGraphicProperties(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRectangle(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParseRectangle(), and SCH_ALTIUM_PLUGIN::ParseRoundRectangle().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS aMask )

inlineinherited

Definition at line 220 of file eda_item.h.

220 { m_flags |= aMask; }

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Function SetForceVisible is used to set and cleag 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 272 of file eda_item.h.

272 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 79 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 LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 184 of file eda_item.h.

184 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:162

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), 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_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetPosition()

void LIB_ITEM::SetPosition ( const wxPoint & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Reimplemented in LIB_PIN.

Definition at line 249 of file lib_item.h.

249 { MoveTo( aPosition ); }

LIB_ITEM::MoveTo

virtual void MoveTo(const wxPoint &aPosition)=0

Move a draw object to aPosition.

References MoveTo().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), HelperGeneratePowerPortGraphics(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_LEGACY_PLUGIN_CACHE::loadRectangle(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and EE_POINT_EDITOR::updateParentItem().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 196 of file eda_item.h.

196 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:220

SELECTED

#define SELECTED

Definition: eda_item.h:113

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), WS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and GROUP_TOOL::Ungroup().

◆ SetState()

void EDA_ITEM::SetState	(	int	type,
		int	state
	)

inlineinherited

Definition at line 209 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(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS aStatus )

inlineinherited

Definition at line 218 of file eda_item.h.

218 { m_status = aStatus; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetUnit()

void LIB_ITEM::SetUnit ( int aUnit )

inline

Definition at line 295 of file lib_item.h.

295 { m_Unit = aUnit; }

LIB_ITEM::m_Unit

int m_Unit

Unit identification for multiple parts per package.

Definition: lib_item.h:82

References m_Unit.

◆ SetWidth()

virtual void LIB_ITEM::SetWidth ( int aWidth )

pure virtual

Implemented in LIB_PIN, LIB_FIELD, LIB_POLYLINE, LIB_ARC, LIB_TEXT, LIB_BEZIER, LIB_CIRCLE, and LIB_RECTANGLE.

Referenced by LIB_DRAWING_TOOLS::DrawShape(), and LIB_EDIT_TOOL::editGraphicProperties().

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 195 of file eda_item.h.

195 { SetFlags( IS_WIRE_IMAGE ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:220

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item.h:110

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ Sort()

static bool EDA_ITEM::Sort	(	const EDA_ITEM *	aLeft,
		const EDA_ITEM *	aRight
	)

inlinestaticinherited

Function Sort is a 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 509 of file eda_item.h.

509 { return *aLeft < *aRight; }

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Function Type()

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

Returns: KICAD_T - the type of object.

Definition at line 181 of file eda_item.h.

181 { return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

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

Definition: eda_item.h:158

References EDA_ITEM::m_structType.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Function ViewBBox() returns the bounding box of the item covering all its layers.

Returns: BOX2I - the current bounding box

Implements KIGFX::VIEW_ITEM.

Reimplemented in PAD, FOOTPRINT, EDIT_POINTS, CENTER_DIMENSION, PCB_SHAPE, GERBER_DRAW_ITEM, DIMENSION_BASE, TRACK, FP_TEXT, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, PCB_MARKER, MY_DRAWING, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, BRIGHT_BOX, and KIGFX::PREVIEW::ARC_ASSISTANT.

Definition at line 206 of file eda_item.cpp.

 {
     // Basic fallback
     return BOX2I( VECTOR2I( GetBoundingBox().GetOrigin() ),
                   VECTOR2I( GetBoundingBox().GetSize() ) );
 }

References EDA_ITEM::GetBoundingBox().

Referenced by GERBVIEW_FRAME::GetDocumentExtents(), BRIGHT_BOX::ViewBBox(), DIMENSION_BASE::ViewBBox(), PCB_SHAPE::ViewBBox(), and BRIGHT_BOX::ViewDraw().

◆ ViewDraw()

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

inlinevirtualinherited

Function ViewDraw() Draws the parts of the object belonging to layer aLayer.

viewDraw() is an alternative way for drawing objects if 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	current drawing layer
aView	pointer to the VIEW device we are drawing on

Reimplemented in EDIT_POINTS, KIGFX::WS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::RATSNEST_VIEWITEM, and PCB_BRIGHT_BOX.

Definition at line 117 of file view_item.h.

118 {}

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

◆ ViewGetLayers()

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

overridevirtual

Function ViewGetLayers() Returns 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[]	output layer index array
aCount	number of layer indices in aLayers[]

Reimplemented from EDA_ITEM.

Reimplemented in LIB_TEXT.

Definition at line 144 of file lib_item.cpp.

 {
     // Basic fallback
     aCount      = 3;
     aLayers[0]  = LAYER_DEVICE;
     aLayers[1]  = LAYER_DEVICE_BACKGROUND;
     aLayers[2]  = LAYER_SELECTION_SHADOWS;
 }

References LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, and LAYER_SELECTION_SHADOWS.

◆ ViewGetLOD()

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

inlinevirtualinherited

Function ViewGetLOD() Returns 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	current drawing layer
aView	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, VIA, GERBER_DRAW_ITEM, TRACK, FP_TEXT, ZONE, PCB_GROUP, and FP_SHAPE.

Definition at line 141 of file view_item.h.

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

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::drawItem::operator()(), EE_GRID_HELPER::queryVisible(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ viewPrivData()

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

inlineinherited

Definition at line 149 of file view_item.h.

     {
         return m_viewPrivData;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::drawItem::deferredDraw(), KIGFX::VIEW::draw(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::OnDestroy(), KIGFX::queryVisitor< Container >::operator()(), KIGFX::VIEW::updateItemsColor::operator()(), KIGFX::VIEW::changeItemsDepth::operator()(), KIGFX::VIEW::drawItem::operator()(), KIGFX::VIEW::recacheItem::operator()(), KIGFX::VIEW::clearLayerCache::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

Function Visit 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_COMPONENT, FOOTPRINT, SCH_SHEET, LIB_PART, GERBER_FILE_IMAGE, SCH_GLOBALLABEL, GERBER_DRAW_ITEM, TRACK, PCB_GROUP, and GBR_LAYOUT.

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

Friends And Related Function Documentation

◆ LIB_PART

friend class LIB_PART

friend

Definition at line 75 of file lib_item.h.

Member Data Documentation

◆ m_Convert

int LIB_ITEM::m_Convert

protected

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

Referenced by LIB_TEXT::Clone(), compare(), GetConvert(), GetMsgPanelInfo(), LIB_ITEM(), operator<(), LIB_PART::SetConversion(), and SetConvert().

◆ m_Fill

FILL_TYPE LIB_ITEM::m_Fill

protected

The body fill type.

This has meaning only for some items. For a list of fill types see FILL_TYPE.

Definition at line 94 of file lib_item.h.

Referenced by compare(), GetFillMode(), LIB_POLYLINE::HitTest(), LIB_ARC::LIB_ARC(), LIB_BEZIER::LIB_BEZIER(), LIB_CIRCLE::LIB_CIRCLE(), LIB_ITEM(), LIB_POLYLINE::LIB_POLYLINE(), LIB_RECTANGLE::LIB_RECTANGLE(), LIB_RECTANGLE::Plot(), LIB_CIRCLE::Plot(), LIB_BEZIER::Plot(), LIB_ARC::Plot(), LIB_POLYLINE::Plot(), LIB_POLYLINE::print(), LIB_RECTANGLE::print(), LIB_ARC::print(), LIB_BEZIER::print(), LIB_CIRCLE::print(), and SetFillMode().

◆ m_flags

STATUS_FLAGS EDA_ITEM::m_flags

protectedinherited

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 163 of file eda_item.h.

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

◆ m_isFillable

bool LIB_ITEM::m_isFillable

protected

Definition at line 95 of file lib_item.h.

Referenced by IsFillable(), LIB_ARC::LIB_ARC(), LIB_BEZIER::LIB_BEZIER(), LIB_CIRCLE::LIB_CIRCLE(), LIB_ITEM(), LIB_POLYLINE::LIB_POLYLINE(), and LIB_RECTANGLE::LIB_RECTANGLE().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 162 of file eda_item.h.

Referenced by LIB_FIELD::Copy(), SCH_FIELD::DoHypertextMenu(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_TEXT::GetContextualTextVars(), FP_TEXT::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PCB_TEXT::GetMsgPanelInfo(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), SCH_FIELD::GetName(), PAD::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), GetParent(), EDA_ITEM::GetParent(), PCB_SHAPE::GetParentFootprint(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), LIB_ITEM(), PCB_SHAPE::MakeEffectiveShapes(), SCH_FIELD::Matches(), LIB_FIELD::operator=(), EDA_ITEM::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_COMPONENT::SCH_COMPONENT(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), and PCB_SHAPE::SwapData().

◆ m_status

STATUS_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 161 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_Unit

int LIB_ITEM::m_Unit

protected

Unit identification for multiple parts per package.

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

Definition at line 82 of file lib_item.h.

Referenced by LIB_TEXT::Clone(), compare(), GetMsgPanelInfo(), GetUnit(), LIB_ITEM(), operator<(), SetUnit(), and LIB_PART::SetUnitCount().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 151 of file eda_item.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddHierarchicalReference(), RC_ITEM::AddItem(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SHEET_PATH::Cmp(), SCHEMATIC::ConvertRefsToKIIDs(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), BOARD::GetItem(), SCH_SHEET_LIST::GetItem(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), SCH_REFERENCE::GetPath(), SCH_MARKER::GetUUID(), PCB_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), LEGACY_PLUGIN::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), SCH_ITEM::operator<(), SCH_COMPONENT::operator<(), PAD::PAD(), PCB_PARSER::parseDIMENSION(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_COMPONENT::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProject(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_COMPONENT::SCH_COMPONENT(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), RC_ITEM::SetItems(), SwapItemData(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), SCH_EDITOR_CONTROL::updatePastedInstances(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ LIB_CONVERT

Constructor & Destructor Documentation

◆ LIB_ITEM()

◆ ~LIB_ITEM()

Member Function Documentation

◆ BeginEdit()

◆ CalcEdit()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ compare()

◆ ContinueEdit()

◆ EndEdit()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoundingBox()

◆ GetClass()

◆ GetConvert()

◆ GetEditFlags()

◆ GetFillMode()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetParent()

◆ GetPenWidth()

◆ GetPosition()

◆ GetSelectMenuText()

◆ GetState()

◆ GetStatus()

◆ GetTypeName()

◆ GetUnit()

◆ GetWidth()

◆ HasFlag()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ IsBrightened()

◆ IsDragging()

◆ IsFillable()

◆ IsForceVisible()

◆ IsModified()

◆ IsMoving()

◆ IsNew()

◆ IsReplaceable()

◆ IsResized()

◆ IsSelected()

◆ IsType()

◆ IsWireImage()

◆ IterateForward() [1/2]

◆ IterateForward() [2/2]

◆ Matches() [1/2]

◆ Matches() [2/2]

◆ MirrorHorizontal()

◆ MirrorVertical()

◆ MoveTo()

◆ Offset()

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ Plot()

◆ print()

◆ Print()

◆ Replace() [1/2]